LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
AllocationsApi () | |
Initializes a new instance of the AllocationsApi class. More... | |
AllocationsApi (string basePath) | |
Initializes a new instance of the AllocationsApi class. More... | |
AllocationsApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the AllocationsApi class using Configuration object More... | |
AllocationsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the AllocationsApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
DeletedEntityResponse | DeleteAllocation (string scope, string code, int operationIndex=0) |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteAllocationWithHttpInfo (string scope, string code, int operationIndex=0) |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteAllocationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 > > | DeleteAllocationWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
Allocation | GetAllocation (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More... | |
Lusid.Sdk.Client.ApiResponse< Allocation > | GetAllocationWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0) |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More... | |
async System.Threading.Tasks.Task< Allocation > | GetAllocationAsync (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] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Allocation > > | GetAllocationWithHttpInfoAsync (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] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More... | |
PagedResourceListOfAllocation | ListAllocations (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] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAllocation > | ListAllocationsWithHttpInfo (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] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< PagedResourceListOfAllocation > | ListAllocationsAsync (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] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAllocation > > | ListAllocationsWithHttpInfoAsync (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] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More... | |
ResourceListOfAllocation | UpsertAllocations (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfAllocation > | UpsertAllocationsWithHttpInfo (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More... | |
async System.Threading.Tasks.Task< ResourceListOfAllocation > | UpsertAllocationsAsync (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAllocation > > | UpsertAllocationsWithHttpInfoAsync (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations 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 AllocationsApi class.
|
inline |
Initializes a new instance of the AllocationsApi class.
|
inline |
Initializes a new instance of the AllocationsApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the AllocationsApi 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] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 allocation scope. |
code | The allocation's code. This, together with the scope uniquely identifies the allocation to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 allocation scope. |
code | The allocation's code. This, together with the scope uniquely identifies the allocation to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 allocation scope. |
code | The allocation's code. This, together with the scope uniquely identifies the allocation to delete. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation 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 allocation scope. |
code | The allocation's code. This, together with the scope uniquely identifies the allocation to delete. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the allocation belongs. |
code | The allocation's unique identifier. |
asAt | The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
propertyKeys | A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the allocation belongs. |
code | The allocation's unique identifier. |
asAt | The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
propertyKeys | A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the allocation belongs. |
code | The allocation's unique identifier. |
asAt | The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
propertyKeys | A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to which the allocation belongs. |
code | The allocation's unique identifier. |
asAt | The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
propertyKeys | A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
|
inline |
[EARLY ACCESS] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation 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 allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
page | The pagination token to use to continue listing allocations from a previous call to list allocations. 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 "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation 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 allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
page | The pagination token to use to continue listing allocations from a previous call to list allocations. 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 "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation 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 allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
page | The pagination token to use to continue listing allocations from a previous call to list allocations. 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 "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation 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 allocation. Defaults to return the latest version of the allocation if not specified. (optional) |
page | The pagination token to use to continue listing allocations from a previous call to list allocations. 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 "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
inline |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IAllocationsApiSync.
|
inline |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IAllocationsApiAsync.
|
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.