Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.ISequencesApiSync:
Public Member Functions | |
| SequenceDefinition | CreateSequence (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0) |
| [EARLY ACCESS] CreateSequence: Create a new sequence More... | |
| ApiResponse< SequenceDefinition > | CreateSequenceWithHttpInfo (string scope, CreateSequenceRequest createSequenceRequest, int operationIndex=0) |
| [EARLY ACCESS] CreateSequence: Create a new sequence More... | |
| SequenceDefinition | GetSequence (string scope, string code, int operationIndex=0) |
| [EARLY ACCESS] GetSequence: Get a specified sequence More... | |
| ApiResponse< SequenceDefinition > | GetSequenceWithHttpInfo (string scope, string code, int operationIndex=0) |
| [EARLY ACCESS] GetSequence: Get a specified sequence More... | |
| PagedResourceListOfSequenceDefinition | ListSequences (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0) |
| [EARLY ACCESS] ListSequences: List Sequences More... | |
| ApiResponse< PagedResourceListOfSequenceDefinition > | ListSequencesWithHttpInfo (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0) |
| [EARLY ACCESS] ListSequences: List Sequences More... | |
| NextValueInSequenceResponse | Next (string scope, string code, int? batch=default(int?), int operationIndex=0) |
| [EARLY ACCESS] Next: Get next values from sequence More... | |
| ApiResponse< NextValueInSequenceResponse > | NextWithHttpInfo (string scope, string code, int? batch=default(int?), int operationIndex=0) |
| [EARLY ACCESS] Next: Get next values from sequence More... | |
 Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor | |
| string | GetBasePath () |
| Gets the base path of the API client. More... | |
Additional Inherited Members | |
| Properties inherited from Lusid.Sdk.Client.IApiAccessor | |
| IReadableConfiguration | Configuration [get, set] |
| Gets or sets the configuration object More... | |
| 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
Member Function Documentation
◆ CreateSequence()
| SequenceDefinition Lusid.Sdk.Api.ISequencesApiSync.CreateSequence | ( | string | scope, |
| CreateSequenceRequest | createSequenceRequest, | ||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- SequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ CreateSequenceWithHttpInfo()
| ApiResponse<SequenceDefinition> Lusid.Sdk.Api.ISequencesApiSync.CreateSequenceWithHttpInfo | ( | string | scope, |
| CreateSequenceRequest | createSequenceRequest, | ||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of SequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ GetSequence()
| SequenceDefinition Lusid.Sdk.Api.ISequencesApiSync.GetSequence | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- SequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ GetSequenceWithHttpInfo()
| ApiResponse<SequenceDefinition> Lusid.Sdk.Api.ISequencesApiSync.GetSequenceWithHttpInfo | ( | string | scope, |
| string | code, | ||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of SequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ ListSequences()
| PagedResourceListOfSequenceDefinition Lusid.Sdk.Api.ISequencesApiSync.ListSequences | ( | string? | page = default(string?), |
| int? | limit = default(int?), |
||
| string? | filter = default(string?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- PagedResourceListOfSequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ ListSequencesWithHttpInfo()
| ApiResponse<PagedResourceListOfSequenceDefinition> Lusid.Sdk.Api.ISequencesApiSync.ListSequencesWithHttpInfo | ( | string? | page = default(string?), |
| int? | limit = default(int?), |
||
| string? | filter = default(string?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of PagedResourceListOfSequenceDefinition
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ Next()
| NextValueInSequenceResponse Lusid.Sdk.Api.ISequencesApiSync.Next | ( | string | scope, |
| string | code, | ||
| int? | batch = default(int?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- NextValueInSequenceResponse
Implemented in Lusid.Sdk.Api.SequencesApi.
◆ NextWithHttpInfo()
| ApiResponse<NextValueInSequenceResponse> Lusid.Sdk.Api.ISequencesApiSync.NextWithHttpInfo | ( | string | scope, |
| string | code, | ||
| int? | batch = default(int?), |
||
| int | operationIndex = 0 |
||
| ) |
[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.
- Returns
- ApiResponse of 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
