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

Inheritance diagram for Lusid.Sdk.Api.ISequencesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< SequenceDefinition >	CreateSequenceAsync (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 More...

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 More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteSequenceAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteSequence: Delete a sequence More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteSequenceWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteSequence: Delete a sequence More...

System.Threading.Tasks.Task< SequenceDefinition >	GetSequenceAsync (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 More...

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 More...

System.Threading.Tasks.Task< PagedResourceListOfSequenceDefinition >	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)
	[EARLY ACCESS] ListSequences: List Sequences More...

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 More...

System.Threading.Tasks.Task< NextValueInSequenceResponse >	NextAsync (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 More...

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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateSequenceAsync()

System.Threading.Tasks.Task<SequenceDefinition> Lusid.Sdk.Api.ISequencesApiAsync.CreateSequenceAsync	(	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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
createSequenceRequest	Request to create sequence
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of SequenceDefinition

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ CreateSequenceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<SequenceDefinition> > Lusid.Sdk.Api.ISequencesApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
createSequenceRequest	Request to create sequence
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (SequenceDefinition)

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ DeleteSequenceAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ISequencesApiAsync.DeleteSequenceAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] DeleteSequence: Delete a sequence

Delete a specific sequence WARNING! Deleting a sequence is an inherently unsafe operation. It would allow a new sequence using the same pattern to be created, which may result in existing values being returned.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ DeleteSequenceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ISequencesApiAsync.DeleteSequenceWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] DeleteSequence: Delete a sequence

Delete a specific sequence WARNING! Deleting a sequence is an inherently unsafe operation. It would allow a new sequence using the same pattern to be created, which may result in existing values being returned.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ GetSequenceAsync()

System.Threading.Tasks.Task<SequenceDefinition> Lusid.Sdk.Api.ISequencesApiAsync.GetSequenceAsync	(	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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of SequenceDefinition

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ GetSequenceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<SequenceDefinition> > Lusid.Sdk.Api.ISequencesApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (SequenceDefinition)

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ ListSequencesAsync()

System.Threading.Tasks.Task<PagedResourceListOfSequenceDefinition> Lusid.Sdk.Api.ISequencesApiAsync.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`
	)

[EARLY ACCESS] ListSequences: List Sequences

List sequences which satisfies filtering criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

page	The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfSequenceDefinition

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ ListSequencesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfSequenceDefinition> > Lusid.Sdk.Api.ISequencesApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

page	The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 500 if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfSequenceDefinition)

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ NextAsync()

System.Threading.Tasks.Task<NextValueInSequenceResponse> Lusid.Sdk.Api.ISequencesApiAsync.NextAsync	(	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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
batch	Number of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of NextValueInSequenceResponse

Implemented in Lusid.Sdk.Api.SequencesApi.

◆ NextWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<NextValueInSequenceResponse> > Lusid.Sdk.Api.ISequencesApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the sequence.
code	Code of the sequence. This together with stated scope uniquely identifies the sequence.
batch	Number of sequences items to return for the specified sequence. Default to 1 if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (NextValueInSequenceResponse)

Implemented in Lusid.Sdk.Api.SequencesApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/SequencesApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateSequenceAsync()

◆ CreateSequenceWithHttpInfoAsync()

◆ DeleteSequenceAsync()

◆ DeleteSequenceWithHttpInfoAsync()

◆ GetSequenceAsync()

◆ GetSequenceWithHttpInfoAsync()

◆ ListSequencesAsync()

◆ ListSequencesWithHttpInfoAsync()

◆ NextAsync()

◆ NextWithHttpInfoAsync()