LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
BlocksApi () | |
Initializes a new instance of the BlocksApi class. More... | |
BlocksApi (string basePath) | |
Initializes a new instance of the BlocksApi class. More... | |
BlocksApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the BlocksApi class using Configuration object More... | |
BlocksApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the BlocksApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
DeletedEntityResponse | DeleteBlock (string scope, string code, int operationIndex=0) |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteBlockWithHttpInfo (string scope, string code, int operationIndex=0) |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteBlockAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeleteBlockWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Block | GetBlock (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier More... | |
Lusid.Sdk.Client.ApiResponse< Block > | GetBlockWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier More... | |
async System.Threading.Tasks.Task< Block > | GetBlockAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Block > > | GetBlockWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier More... | |
PagedResourceListOfBlock | ListBlocks (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfBlock > | ListBlocksWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< PagedResourceListOfBlock > | ListBlocksAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfBlock > > | ListBlocksWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). More... | |
ResourceListOfBlock | UpsertBlocks (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0) |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfBlock > | UpsertBlocksWithHttpInfo (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0) |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise. More... | |
async System.Threading.Tasks.Task< ResourceListOfBlock > | UpsertBlocksAsync (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfBlock > > | UpsertBlocksWithHttpInfoAsync (BlockSetRequest? blockSetRequest=default(BlockSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise. 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... | |
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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the BlocksApi class.
|
inline |
Initializes a new instance of the BlocksApi class.
|
inline |
Initializes a new instance of the BlocksApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the BlocksApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The block scope. |
code | The block's code. This, together with the scope uniquely identifies the block to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The block scope. |
code | The block's code. This, together with the scope uniquely identifies the block to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The block scope. |
code | The block's code. This, together with the scope uniquely identifies the block to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] DeleteBlock: Delete block Delete an block. Deletion will be valid from the block's creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The block scope. |
code | The block's code. This, together with the scope uniquely identifies the block to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
|
inline |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the block belongs. |
code | The block's unique identifier. |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the block belongs. |
code | The block's unique identifier. |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the block belongs. |
code | The block's unique identifier. |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] GetBlock: Get Block Fetch a Block that matches the specified identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the block belongs. |
code | The block's unique identifier. |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
page | The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (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) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
page | The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (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) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
page | The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (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) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] ListBlocks: List Blocks Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified. (optional) |
page | The pagination token to use to continue listing blocks from a previous call to list blocks. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
limit | When paginating, limit the number of returned results to this many. (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) |
propertyKeys | A list of property keys from the "Block" domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. "Block/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
blockSetRequest | The collection of block requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
blockSetRequest | The collection of block requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
inline |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
blockSetRequest | The collection of block requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IBlocksApiSync.
|
inline |
[EARLY ACCESS] UpsertBlocks: Upsert Block Upsert; update existing blocks with given ids, or create new blocks otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
blockSetRequest | The collection of block requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IBlocksApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.