LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IAllocationsApiSync Interface Reference

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

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

Public Member Functions

DeletedEntityResponse DeleteAllocation (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteAllocation: Delete allocation More...
 
ApiResponse< DeletedEntityResponseDeleteAllocationWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteAllocation: Delete allocation 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 More...
 
ApiResponse< AllocationGetAllocationWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetAllocation: Get Allocation 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 More...
 
ApiResponse< PagedResourceListOfAllocationListAllocationsWithHttpInfo (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 More...
 
ResourceListOfAllocation UpsertAllocations (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0)
 UpsertAllocations: Upsert Allocations More...
 
ApiResponse< ResourceListOfAllocationUpsertAllocationsWithHttpInfo (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0)
 UpsertAllocations: Upsert Allocations 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

◆ DeleteAllocation()

DeletedEntityResponse Lusid.Sdk.Api.IAllocationsApiSync.DeleteAllocation ( string  scope,
string  code,
int  operationIndex = 0 
)

[EARLY ACCESS] DeleteAllocation: Delete allocation

Delete an allocation. Deletion will be valid from the allocation&#39;s creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ DeleteAllocationWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IAllocationsApiSync.DeleteAllocationWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

[EARLY ACCESS] DeleteAllocation: Delete allocation

Delete an allocation. Deletion will be valid from the allocation&#39;s creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ GetAllocation()

Allocation Lusid.Sdk.Api.IAllocationsApiSync.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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
Allocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ GetAllocationWithHttpInfo()

ApiResponse<Allocation> Lusid.Sdk.Api.IAllocationsApiSync.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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Allocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ ListAllocations()

PagedResourceListOfAllocation Lusid.Sdk.Api.IAllocationsApiSync.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).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ ListAllocationsWithHttpInfo()

ApiResponse<PagedResourceListOfAllocation> Lusid.Sdk.Api.IAllocationsApiSync.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).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ UpsertAllocations()

ResourceListOfAllocation Lusid.Sdk.Api.IAllocationsApiSync.UpsertAllocations ( AllocationSetRequest allocationSetRequest = default(AllocationSetRequest?),
int  operationIndex = 0 
)

UpsertAllocations: Upsert Allocations

Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ UpsertAllocationsWithHttpInfo()

ApiResponse<ResourceListOfAllocation> Lusid.Sdk.Api.IAllocationsApiSync.UpsertAllocationsWithHttpInfo ( AllocationSetRequest allocationSetRequest = default(AllocationSetRequest?),
int  operationIndex = 0 
)

UpsertAllocations: Upsert Allocations

Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.


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