Stellards.SDK 1.0.5

StellarDS.SDK - the C# library for the Stellar DataStore

The Stellar DataStore service is your instantly available, secure and worry-free cloud data storage service. Sign-up now and minutes later, you can start putting your data in the cloud.

• API version: v1
• SDK version: 1.0.0
• Generator version: 7.11.0

<a id="frameworks-supported"></a>

Frameworks supported

• .Net 9.0

<a id="dependencies"></a>

Dependencies

• RestSharp - 112.0.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

<a id="installation"></a>

Installation

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Stellards.SDK.Api;
using Stellards.SDK.Client;
using Stellards.SDK.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure API key authorization: Bearer
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi(config);
            var project = "project_example";  // Guid | The project containing the table.
            var table = 789L;  // long | The table containing the records.
            var record = 789L;  // long | The record to be queried.
            var field = "field_example";  // string | The field of the record.

            try
            {
                // Download a file from a blob field as a stream.
                Stream result = apiInstance.BlobGet(project, table, record, field);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DataApi.BlobGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to http://localhost

<a id="documentation-for-models"></a>

Documentation for Models

• Model.AbstractObjectQueryResult
• Model.AbstractObjectServiceResult
• Model.CreateRecordRequest
• Model.FieldRequest
• Model.FieldResponse
• Model.FieldResponseServiceResult
• Model.IServiceResult
• Model.ProjectRequest
• Model.RevokeTokenRequest
• Model.ServiceMessage
• Model.ServiceMessageType
• Model.ServiceResult
• Model.Stream
• Model.TableRequest
• Model.TableResponse
• Model.TableResponseIEnumerableServiceResult
• Model.TokenResponse
• Model.UpdateRecordRequest

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="Bearer"></a>

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header