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

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

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

Public Member Functions

System.Threading.Tasks.Task< StagedModificationAddDecisionAsync (string id, StagedModificationDecisionRequest stagedModificationDecisionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AddDecision: AddDecision More...
 
System.Threading.Tasks.Task< ApiResponse< StagedModification > > AddDecisionWithHttpInfoAsync (string id, StagedModificationDecisionRequest stagedModificationDecisionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] AddDecision: AddDecision More...
 
System.Threading.Tasks.Task< StagedModificationGetStagedModificationAsync (string id, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetStagedModification: GetStagedModification More...
 
System.Threading.Tasks.Task< ApiResponse< StagedModification > > GetStagedModificationWithHttpInfoAsync (string id, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetStagedModification: GetStagedModification More...
 
System.Threading.Tasks.Task< PagedResourceListOfStagedModificationsRequestedChangeIntervalListRequestedChangesAsync (string id, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfStagedModificationsRequestedChangeInterval > > ListRequestedChangesWithHttpInfoAsync (string id, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges More...
 
System.Threading.Tasks.Task< PagedResourceListOfStagedModificationListStagedModificationsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListStagedModifications: ListStagedModifications More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfStagedModification > > ListStagedModificationsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListStagedModifications: ListStagedModifications 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

◆ AddDecisionAsync()

System.Threading.Tasks.Task<StagedModification> Lusid.Sdk.Api.IStagedModificationsApiAsync.AddDecisionAsync ( string  id,
StagedModificationDecisionRequest  stagedModificationDecisionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] AddDecision: AddDecision

Add decision to staged modification, Approve or Reject.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idUnique Id for a staged modification..
stagedModificationDecisionRequestThe decision on the requested staged modification, &quot;Approve&quot; or &quot;Reject&quot;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of StagedModification

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ AddDecisionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<StagedModification> > Lusid.Sdk.Api.IStagedModificationsApiAsync.AddDecisionWithHttpInfoAsync ( string  id,
StagedModificationDecisionRequest  stagedModificationDecisionRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] AddDecision: AddDecision

Add decision to staged modification, Approve or Reject.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idUnique Id for a staged modification..
stagedModificationDecisionRequestThe decision on the requested staged modification, &quot;Approve&quot; or &quot;Reject&quot;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (StagedModification)

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ GetStagedModificationAsync()

System.Threading.Tasks.Task<StagedModification> Lusid.Sdk.Api.IStagedModificationsApiAsync.GetStagedModificationAsync ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetStagedModification: GetStagedModification

Retrieve the details of a staged modification.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idThe unique identifier for a staged modification.
asAtThe asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of StagedModification

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ GetStagedModificationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<StagedModification> > Lusid.Sdk.Api.IStagedModificationsApiAsync.GetStagedModificationWithHttpInfoAsync ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GetStagedModification: GetStagedModification

Retrieve the details of a staged modification.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idThe unique identifier for a staged modification.
asAtThe asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (StagedModification)

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ ListRequestedChangesAsync()

System.Threading.Tasks.Task<PagedResourceListOfStagedModificationsRequestedChangeInterval> Lusid.Sdk.Api.IStagedModificationsApiAsync.ListRequestedChangesAsync ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges

List the requested changes for a staged modification.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idUnique Id for a staged modification..
asAtThe asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified. (optional)
pageThe pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfStagedModificationsRequestedChangeInterval

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ ListRequestedChangesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfStagedModificationsRequestedChangeInterval> > Lusid.Sdk.Api.IStagedModificationsApiAsync.ListRequestedChangesWithHttpInfoAsync ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges

List the requested changes for a staged modification.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idUnique Id for a staged modification..
asAtThe asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified. (optional)
pageThe pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfStagedModificationsRequestedChangeInterval)

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ ListStagedModificationsAsync()

System.Threading.Tasks.Task<PagedResourceListOfStagedModification> Lusid.Sdk.Api.IStagedModificationsApiAsync.ListStagedModificationsAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListStagedModifications: ListStagedModifications

List summaries of the staged modifications.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified. (optional)
pageThe pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfStagedModification

Implemented in Lusid.Sdk.Api.StagedModificationsApi.

◆ ListStagedModificationsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfStagedModification> > Lusid.Sdk.Api.IStagedModificationsApiAsync.ListStagedModificationsWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] ListStagedModifications: ListStagedModifications

List summaries of the staged modifications.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified. (optional)
pageThe pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfStagedModification)

Implemented in Lusid.Sdk.Api.StagedModificationsApi.


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