LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.StagedModificationsApi Class Reference

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

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

Public Member Functions

 StagedModificationsApi ()
 Initializes a new instance of the StagedModificationsApi class. More...
 
 StagedModificationsApi (string basePath)
 Initializes a new instance of the StagedModificationsApi class. More...
 
 StagedModificationsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the StagedModificationsApi class using Configuration object More...
 
 StagedModificationsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the StagedModificationsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
StagedModification AddDecision (string id, StagedModificationDecisionRequest stagedModificationDecisionRequest, int operationIndex=0)
 [EXPERIMENTAL] AddDecision: AddDecision Add decision to staged modification, Approve or Reject. More...
 
Lusid.Sdk.Client.ApiResponse< StagedModificationAddDecisionWithHttpInfo (string id, StagedModificationDecisionRequest stagedModificationDecisionRequest, int operationIndex=0)
 [EXPERIMENTAL] AddDecision: AddDecision Add decision to staged modification, Approve or Reject. More...
 
async System.Threading.Tasks.Task< StagedModificationAddDecisionAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< StagedModification > > 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. More...
 
StagedModification GetStagedModification (string id, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetStagedModification: GetStagedModification Retrieve the details of a staged modification. More...
 
Lusid.Sdk.Client.ApiResponse< StagedModificationGetStagedModificationWithHttpInfo (string id, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetStagedModification: GetStagedModification Retrieve the details of a staged modification. More...
 
async 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 Retrieve the details of a staged modification. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< StagedModification > > 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. More...
 
PagedResourceListOfStagedModificationsRequestedChangeInterval ListRequestedChanges (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)
 [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges List the requested changes for a staged modification. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfStagedModificationsRequestedChangeIntervalListRequestedChangesWithHttpInfo (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)
 [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges List the requested changes for a staged modification. More...
 
async 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 List the requested changes for a staged modification. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List the requested changes for a staged modification. More...
 
PagedResourceListOfStagedModification ListStagedModifications (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)
 [EXPERIMENTAL] ListStagedModifications: ListStagedModifications List summaries of the staged modifications. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfStagedModificationListStagedModificationsWithHttpInfo (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)
 [EXPERIMENTAL] ListStagedModifications: ListStagedModifications List summaries of the staged modifications. More...
 
async 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 List summaries of the staged modifications. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List summaries of the staged modifications. 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ StagedModificationsApi() [1/4]

Lusid.Sdk.Api.StagedModificationsApi.StagedModificationsApi ( )
inline

Initializes a new instance of the StagedModificationsApi class.

Returns

◆ StagedModificationsApi() [2/4]

Lusid.Sdk.Api.StagedModificationsApi.StagedModificationsApi ( string  basePath)
inline

Initializes a new instance of the StagedModificationsApi class.

Returns

◆ StagedModificationsApi() [3/4]

Lusid.Sdk.Api.StagedModificationsApi.StagedModificationsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the StagedModificationsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ StagedModificationsApi() [4/4]

Lusid.Sdk.Api.StagedModificationsApi.StagedModificationsApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the StagedModificationsApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ AddDecision()

StagedModification Lusid.Sdk.Api.StagedModificationsApi.AddDecision ( string  id,
StagedModificationDecisionRequest  stagedModificationDecisionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
StagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ AddDecisionAsync()

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

[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

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ AddDecisionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<StagedModification> Lusid.Sdk.Api.StagedModificationsApi.AddDecisionWithHttpInfo ( string  id,
StagedModificationDecisionRequest  stagedModificationDecisionRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of StagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ AddDecisionWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.StagedModificationsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetStagedModification()

StagedModification Lusid.Sdk.Api.StagedModificationsApi.GetStagedModification ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
StagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ GetStagedModificationAsync()

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

[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

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ GetStagedModificationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<StagedModification> Lusid.Sdk.Api.StagedModificationsApi.GetStagedModificationWithHttpInfo ( string  id,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of StagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ GetStagedModificationWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ ListRequestedChanges()

PagedResourceListOfStagedModificationsRequestedChangeInterval Lusid.Sdk.Api.StagedModificationsApi.ListRequestedChanges ( 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 
)
inline

[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.
Returns
PagedResourceListOfStagedModificationsRequestedChangeInterval

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ ListRequestedChangesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfStagedModificationsRequestedChangeInterval> Lusid.Sdk.Api.StagedModificationsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ ListRequestedChangesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagedModificationsRequestedChangeInterval> Lusid.Sdk.Api.StagedModificationsApi.ListRequestedChangesWithHttpInfo ( 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 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfStagedModificationsRequestedChangeInterval

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ ListRequestedChangesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagedModificationsRequestedChangeInterval> > Lusid.Sdk.Api.StagedModificationsApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ ListStagedModifications()

PagedResourceListOfStagedModification Lusid.Sdk.Api.StagedModificationsApi.ListStagedModifications ( 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 
)
inline

[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.
Returns
PagedResourceListOfStagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ ListStagedModificationsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfStagedModification> Lusid.Sdk.Api.StagedModificationsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

◆ ListStagedModificationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagedModification> Lusid.Sdk.Api.StagedModificationsApi.ListStagedModificationsWithHttpInfo ( 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 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfStagedModification

Implements Lusid.Sdk.Api.IStagedModificationsApiSync.

◆ ListStagedModificationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagedModification> > Lusid.Sdk.Api.StagedModificationsApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IStagedModificationsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.StagedModificationsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.StagedModificationsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.StagedModificationsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.StagedModificationsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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