LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.SequencesApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.SequencesApi:
Inheritance graph
[legend]

Public Member Functions

 SequencesApi ()
 Initializes a new instance of the SequencesApi class. More...
 
 SequencesApi (string basePath)
 Initializes a new instance of the SequencesApi class. More...
 
 SequencesApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the SequencesApi class using Configuration object More...
 
 SequencesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the SequencesApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
SequenceDefinition CreateSequence (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence More...
 
Lusid.Sdk.Client.ApiResponse< SequenceDefinitionCreateSequenceWithHttpInfo (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence More...
 
async System.Threading.Tasks.Task< SequenceDefinitionCreateSequenceAsync (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< SequenceDefinition > > CreateSequenceWithHttpInfoAsync (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence More...
 
SequenceDefinition GetSequence (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence More...
 
Lusid.Sdk.Client.ApiResponse< SequenceDefinitionGetSequenceWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence More...
 
async System.Threading.Tasks.Task< SequenceDefinitionGetSequenceAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< SequenceDefinition > > GetSequenceWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence More...
 
PagedResourceListOfSequenceDefinition ListSequences (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfSequenceDefinitionListSequencesWithHttpInfo (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria. More...
 
async System.Threading.Tasks.Task< PagedResourceListOfSequenceDefinitionListSequencesAsync (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfSequenceDefinition > > ListSequencesWithHttpInfoAsync (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria. More...
 
NextValueInSequenceResponse Next (string scope, string code, int? batch=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence More...
 
Lusid.Sdk.Client.ApiResponse< NextValueInSequenceResponseNextWithHttpInfo (string scope, string code, int? batch=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence More...
 
async System.Threading.Tasks.Task< NextValueInSequenceResponseNextAsync (string scope, string code, int? batch=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< NextValueInSequenceResponse > > NextWithHttpInfoAsync (string scope, string code, int? batch=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ SequencesApi() [1/4]

Lusid.Sdk.Api.SequencesApi.SequencesApi ( )
inline

Initializes a new instance of the SequencesApi class.

Returns

◆ SequencesApi() [2/4]

Lusid.Sdk.Api.SequencesApi.SequencesApi ( string  basePath)
inline

Initializes a new instance of the SequencesApi class.

Returns

◆ SequencesApi() [3/4]

Lusid.Sdk.Api.SequencesApi.SequencesApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the SequencesApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ SequencesApi() [4/4]

Lusid.Sdk.Api.SequencesApi.SequencesApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the SequencesApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateSequence()

SequenceDefinition Lusid.Sdk.Api.SequencesApi.CreateSequence ( string  scope,
CreateSequenceRequest  createSequenceRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
createSequenceRequestRequest to create sequence
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ CreateSequenceAsync()

async System.Threading.Tasks.Task<SequenceDefinition> Lusid.Sdk.Api.SequencesApi.CreateSequenceAsync ( string  scope,
CreateSequenceRequest  createSequenceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
createSequenceRequestRequest to create sequence
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ CreateSequenceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<SequenceDefinition> Lusid.Sdk.Api.SequencesApi.CreateSequenceWithHttpInfo ( string  scope,
CreateSequenceRequest  createSequenceRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
createSequenceRequestRequest to create sequence
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ CreateSequenceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<SequenceDefinition> > Lusid.Sdk.Api.SequencesApi.CreateSequenceWithHttpInfoAsync ( string  scope,
CreateSequenceRequest  createSequenceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateSequence: Create a new sequence Create a new sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
createSequenceRequestRequest to create sequence
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (SequenceDefinition)

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.SequencesApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

◆ GetSequence()

SequenceDefinition Lusid.Sdk.Api.SequencesApi.GetSequence ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ GetSequenceAsync()

async System.Threading.Tasks.Task<SequenceDefinition> Lusid.Sdk.Api.SequencesApi.GetSequenceAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ GetSequenceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<SequenceDefinition> Lusid.Sdk.Api.SequencesApi.GetSequenceWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of SequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ GetSequenceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<SequenceDefinition> > Lusid.Sdk.Api.SequencesApi.GetSequenceWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetSequence: Get a specified sequence Return the details of a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (SequenceDefinition)

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ ListSequences()

PagedResourceListOfSequenceDefinition Lusid.Sdk.Api.SequencesApi.ListSequences ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfSequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ ListSequencesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfSequenceDefinition> Lusid.Sdk.Api.SequencesApi.ListSequencesAsync ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfSequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ ListSequencesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfSequenceDefinition> Lusid.Sdk.Api.SequencesApi.ListSequencesWithHttpInfo ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfSequenceDefinition

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ ListSequencesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfSequenceDefinition> > Lusid.Sdk.Api.SequencesApi.ListSequencesWithHttpInfoAsync ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListSequences: List Sequences List sequences which satisfies filtering criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfSequenceDefinition)

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ Next()

NextValueInSequenceResponse Lusid.Sdk.Api.SequencesApi.Next ( string  scope,
string  code,
int?  batch = default(int?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
batchNumber of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
NextValueInSequenceResponse

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ NextAsync()

async System.Threading.Tasks.Task<NextValueInSequenceResponse> Lusid.Sdk.Api.SequencesApi.NextAsync ( string  scope,
string  code,
int?  batch = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
batchNumber of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of NextValueInSequenceResponse

Implements Lusid.Sdk.Api.ISequencesApiAsync.

◆ NextWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<NextValueInSequenceResponse> Lusid.Sdk.Api.SequencesApi.NextWithHttpInfo ( string  scope,
string  code,
int?  batch = default(int?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
batchNumber of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of NextValueInSequenceResponse

Implements Lusid.Sdk.Api.ISequencesApiSync.

◆ NextWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<NextValueInSequenceResponse> > Lusid.Sdk.Api.SequencesApi.NextWithHttpInfoAsync ( string  scope,
string  code,
int?  batch = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] Next: Get next values from sequence Get the next set of values from a specified sequence

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the sequence.
codeCode of the sequence. This together with stated scope uniquely identifies the sequence.
batchNumber of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (NextValueInSequenceResponse)

Implements Lusid.Sdk.Api.ISequencesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.SequencesApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.SequencesApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.SequencesApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.SequencesApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: