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

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

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

Public Member Functions

 CorporateActionSourcesApi ()
 Initializes a new instance of the CorporateActionSourcesApi class. More...
 
 CorporateActionSourcesApi (string basePath)
 Initializes a new instance of the CorporateActionSourcesApi class. More...
 
 CorporateActionSourcesApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the CorporateActionSourcesApi class using Configuration object More...
 
 CorporateActionSourcesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the CorporateActionSourcesApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
UpsertCorporateActionsResponse BatchUpsertCorporateActions (string scope, string code, List< UpsertCorporateActionRequest >? upsertCorporateActionRequest=default(List< UpsertCorporateActionRequest >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertCorporateActionsResponseBatchUpsertCorporateActionsWithHttpInfo (string scope, string code, List< UpsertCorporateActionRequest >? upsertCorporateActionRequest=default(List< UpsertCorporateActionRequest >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000. More...
 
async System.Threading.Tasks.Task< UpsertCorporateActionsResponseBatchUpsertCorporateActionsAsync (string scope, string code, List< UpsertCorporateActionRequest >? upsertCorporateActionRequest=default(List< UpsertCorporateActionRequest >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertCorporateActionsResponse > > BatchUpsertCorporateActionsWithHttpInfoAsync (string scope, string code, List< UpsertCorporateActionRequest >? upsertCorporateActionRequest=default(List< UpsertCorporateActionRequest >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000. More...
 
CorporateActionSource CreateCorporateActionSource (CreateCorporateActionSourceRequest createCorporateActionSourceRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source. More...
 
Lusid.Sdk.Client.ApiResponse< CorporateActionSourceCreateCorporateActionSourceWithHttpInfo (CreateCorporateActionSourceRequest createCorporateActionSourceRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source. More...
 
async System.Threading.Tasks.Task< CorporateActionSourceCreateCorporateActionSourceAsync (CreateCorporateActionSourceRequest createCorporateActionSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CorporateActionSource > > CreateCorporateActionSourceWithHttpInfoAsync (CreateCorporateActionSourceRequest createCorporateActionSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source. More...
 
DeletedEntityResponse DeleteCorporateActionSource (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteCorporateActionSourceWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteCorporateActionSourceAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteCorporateActionSourceWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source More...
 
DeletedEntityResponse DeleteCorporateActions (string scope, string code, List< string > corporateActionIds, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteCorporateActionsWithHttpInfo (string scope, string code, List< string > corporateActionIds, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteCorporateActionsAsync (string scope, string code, List< string > corporateActionIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteCorporateActionsWithHttpInfoAsync (string scope, string code, List< string > corporateActionIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. More...
 
DeletedEntityResponse DeleteInstrumentEvents (string scope, string code, List< string > instrumentEventIds, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteInstrumentEventsWithHttpInfo (string scope, string code, List< string > instrumentEventIds, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteInstrumentEventsAsync (string scope, string code, List< string > instrumentEventIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteInstrumentEventsWithHttpInfoAsync (string scope, string code, List< string > instrumentEventIds, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. More...
 
ResourceListOfCorporateAction GetCorporateActions (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfCorporateActionGetCorporateActionsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source. More...
 
async System.Threading.Tasks.Task< ResourceListOfCorporateActionGetCorporateActionsAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfCorporateAction > > GetCorporateActionsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source. More...
 
PagedResourceListOfInstrumentEventHolder GetInstrumentEvents (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrumentEventHolderGetInstrumentEventsWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source More...
 
async System.Threading.Tasks.Task< PagedResourceListOfInstrumentEventHolderGetInstrumentEventsAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrumentEventHolder > > GetInstrumentEventsWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source More...
 
PagedResourceListOfCorporateActionSource ListCorporateActionSources (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCorporateActionSourceListCorporateActionSourcesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources More...
 
async System.Threading.Tasks.Task< PagedResourceListOfCorporateActionSourceListCorporateActionSourcesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCorporateActionSource > > ListCorporateActionSourcesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources More...
 
UpsertInstrumentEventsResponse UpsertInstrumentEvents (string scope, string code, List< UpsertInstrumentEventRequest >? upsertInstrumentEventRequest=default(List< UpsertInstrumentEventRequest >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertInstrumentEventsResponseUpsertInstrumentEventsWithHttpInfo (string scope, string code, List< UpsertInstrumentEventRequest >? upsertInstrumentEventRequest=default(List< UpsertInstrumentEventRequest >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000. More...
 
async System.Threading.Tasks.Task< UpsertInstrumentEventsResponseUpsertInstrumentEventsAsync (string scope, string code, List< UpsertInstrumentEventRequest >? upsertInstrumentEventRequest=default(List< UpsertInstrumentEventRequest >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertInstrumentEventsResponse > > UpsertInstrumentEventsWithHttpInfoAsync (string scope, string code, List< UpsertInstrumentEventRequest >? upsertInstrumentEventRequest=default(List< UpsertInstrumentEventRequest >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000. 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ CorporateActionSourcesApi() [1/4]

Lusid.Sdk.Api.CorporateActionSourcesApi.CorporateActionSourcesApi ( )
inline

Initializes a new instance of the CorporateActionSourcesApi class.

Returns

◆ CorporateActionSourcesApi() [2/4]

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

Initializes a new instance of the CorporateActionSourcesApi class.

Returns

◆ CorporateActionSourcesApi() [3/4]

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

Initializes a new instance of the CorporateActionSourcesApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ CorporateActionSourcesApi() [4/4]

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

Initializes a new instance of the CorporateActionSourcesApi 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

◆ BatchUpsertCorporateActions()

UpsertCorporateActionsResponse Lusid.Sdk.Api.CorporateActionSourcesApi.BatchUpsertCorporateActions ( string  scope,
string  code,
List< UpsertCorporateActionRequest >?  upsertCorporateActionRequest = default(List<UpsertCorporateActionRequest>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of corporate action source
codeThe code of the corporate action source
upsertCorporateActionRequestThe corporate action definitions (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpsertCorporateActionsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ BatchUpsertCorporateActionsAsync()

async System.Threading.Tasks.Task<UpsertCorporateActionsResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.BatchUpsertCorporateActionsAsync ( string  scope,
string  code,
List< UpsertCorporateActionRequest >?  upsertCorporateActionRequest = default(List<UpsertCorporateActionRequest>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of corporate action source
codeThe code of the corporate action source
upsertCorporateActionRequestThe corporate action definitions (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpsertCorporateActionsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ BatchUpsertCorporateActionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertCorporateActionsResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.BatchUpsertCorporateActionsWithHttpInfo ( string  scope,
string  code,
List< UpsertCorporateActionRequest >?  upsertCorporateActionRequest = default(List<UpsertCorporateActionRequest>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of corporate action source
codeThe code of the corporate action source
upsertCorporateActionRequestThe corporate action definitions (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpsertCorporateActionsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ BatchUpsertCorporateActionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertCorporateActionsResponse> > Lusid.Sdk.Api.CorporateActionSourcesApi.BatchUpsertCorporateActionsWithHttpInfoAsync ( string  scope,
string  code,
List< UpsertCorporateActionRequest >?  upsertCorporateActionRequest = default(List<UpsertCorporateActionRequest>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. Create or update one or more corporate actions in a particular corporate action source. Failures are identified in the body of the response. If a corporate action is upserted at exactly the same effective datetime as a transaction for the same instrument, the corporate action takes precedence. Depending on the nature of the corporate action, this may mean it affects the transaction. The maximum number of corporate actions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of corporate action source
codeThe code of the corporate action source
upsertCorporateActionRequestThe corporate action definitions (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpsertCorporateActionsResponse)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ CreateCorporateActionSource()

CorporateActionSource Lusid.Sdk.Api.CorporateActionSourcesApi.CreateCorporateActionSource ( CreateCorporateActionSourceRequest  createCorporateActionSourceRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCorporateActionSourceRequestThe corporate action source definition
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ CreateCorporateActionSourceAsync()

async System.Threading.Tasks.Task<CorporateActionSource> Lusid.Sdk.Api.CorporateActionSourcesApi.CreateCorporateActionSourceAsync ( CreateCorporateActionSourceRequest  createCorporateActionSourceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCorporateActionSourceRequestThe corporate action source definition
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ CreateCorporateActionSourceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CorporateActionSource> Lusid.Sdk.Api.CorporateActionSourcesApi.CreateCorporateActionSourceWithHttpInfo ( CreateCorporateActionSourceRequest  createCorporateActionSourceRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCorporateActionSourceRequestThe corporate action source definition
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ CreateCorporateActionSourceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CorporateActionSource> > Lusid.Sdk.Api.CorporateActionSourcesApi.CreateCorporateActionSourceWithHttpInfoAsync ( CreateCorporateActionSourceRequest  createCorporateActionSourceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source Create a corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCorporateActionSourceRequestThe corporate action source definition
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CorporateActionSource)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteCorporateActions()

DeletedEntityResponse Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActions ( string  scope,
string  code,
List< string >  corporateActionIds,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
corporateActionIdsThe IDs of the corporate actions to delete
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteCorporateActionsAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionsAsync ( string  scope,
string  code,
List< string >  corporateActionIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
corporateActionIdsThe IDs of the corporate actions to delete
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteCorporateActionSource()

DeletedEntityResponse Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionSource ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source to be deleted
codeThe code of the corporate action source to be deleted
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteCorporateActionSourceAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionSourceAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source to be deleted
codeThe code of the corporate action source to be deleted
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteCorporateActionSourceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionSourceWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source to be deleted
codeThe code of the corporate action source to be deleted
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteCorporateActionSourceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionSourceWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. Deletes a single corporate action source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source to be deleted
codeThe code of the corporate action source to be deleted
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteCorporateActionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionsWithHttpInfo ( string  scope,
string  code,
List< string >  corporateActionIds,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
corporateActionIdsThe IDs of the corporate actions to delete
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteCorporateActionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteCorporateActionsWithHttpInfoAsync ( string  scope,
string  code,
List< string >  corporateActionIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
corporateActionIdsThe IDs of the corporate actions to delete
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteInstrumentEvents()

DeletedEntityResponse Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteInstrumentEvents ( string  scope,
string  code,
List< string >  instrumentEventIds,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
instrumentEventIdsThe IDs of the instrument events to delete
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteInstrumentEventsAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteInstrumentEventsAsync ( string  scope,
string  code,
List< string >  instrumentEventIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
instrumentEventIdsThe IDs of the instrument events to delete
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ DeleteInstrumentEventsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteInstrumentEventsWithHttpInfo ( string  scope,
string  code,
List< string >  instrumentEventIds,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
instrumentEventIdsThe IDs of the instrument events to delete
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ DeleteInstrumentEventsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.CorporateActionSourcesApi.DeleteInstrumentEventsWithHttpInfoAsync ( string  scope,
string  code,
List< string >  instrumentEventIds,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source
codeThe code of the corporate action source
instrumentEventIdsThe IDs of the instrument events to delete
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

◆ GetCorporateActions()

ResourceListOfCorporateAction Lusid.Sdk.Api.CorporateActionSourcesApi.GetCorporateActions ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
fromEffectiveAtOptional. The start effective date of the data range. (optional)
toEffectiveAtOptional. The end effective date of the data range. (optional)
asAtOptional. The AsAt date of the data. (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the results to this number. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Announcement Date, use &quot;announcementDate eq &#39;2020-03-06&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfCorporateAction

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ GetCorporateActionsAsync()

async System.Threading.Tasks.Task<ResourceListOfCorporateAction> Lusid.Sdk.Api.CorporateActionSourcesApi.GetCorporateActionsAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
fromEffectiveAtOptional. The start effective date of the data range. (optional)
toEffectiveAtOptional. The end effective date of the data range. (optional)
asAtOptional. The AsAt date of the data. (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the results to this number. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Announcement Date, use &quot;announcementDate eq &#39;2020-03-06&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfCorporateAction

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ GetCorporateActionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfCorporateAction> Lusid.Sdk.Api.CorporateActionSourcesApi.GetCorporateActionsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
fromEffectiveAtOptional. The start effective date of the data range. (optional)
toEffectiveAtOptional. The end effective date of the data range. (optional)
asAtOptional. The AsAt date of the data. (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the results to this number. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Announcement Date, use &quot;announcementDate eq &#39;2020-03-06&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfCorporateAction

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ GetCorporateActionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfCorporateAction> > Lusid.Sdk.Api.CorporateActionSourcesApi.GetCorporateActionsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. Get corporate actions from a particular corporate action source.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
fromEffectiveAtOptional. The start effective date of the data range. (optional)
toEffectiveAtOptional. The end effective date of the data range. (optional)
asAtOptional. The AsAt date of the data. (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the results to this number. (optional)
filterOptional. Expression to filter the result set. For example, to filter on the Announcement Date, use &quot;announcementDate eq &#39;2020-03-06&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfCorporateAction)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ GetInstrumentEvents()

PagedResourceListOfInstrumentEventHolder Lusid.Sdk.Api.CorporateActionSourcesApi.GetInstrumentEvents ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int?  limit = default(int?),
string?  page = default(string?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
asAtOptional. The AsAt date of the data. (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, asAt, filter and limit must not be modified. (optional)
filterOptional. Expression to filter the result set. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfInstrumentEventHolder

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ GetInstrumentEventsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.CorporateActionSourcesApi.GetInstrumentEventsAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int?  limit = default(int?),
string?  page = default(string?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
asAtOptional. The AsAt date of the data. (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, asAt, filter and limit must not be modified. (optional)
filterOptional. Expression to filter the result set. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfInstrumentEventHolder

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ GetInstrumentEventsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.CorporateActionSourcesApi.GetInstrumentEventsWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int?  limit = default(int?),
string?  page = default(string?),
string?  filter = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
asAtOptional. The AsAt date of the data. (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, asAt, filter and limit must not be modified. (optional)
filterOptional. Expression to filter the result set. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfInstrumentEventHolder

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ GetInstrumentEventsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventHolder> > Lusid.Sdk.Api.CorporateActionSourcesApi.GetInstrumentEventsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int?  limit = default(int?),
string?  page = default(string?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. Retrieves extrinsic corporate actions out of a corporate actions source

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
asAtOptional. The AsAt date of the data. (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, asAt, filter and limit must not be modified. (optional)
filterOptional. Expression to filter the result set. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfInstrumentEventHolder)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ ListCorporateActionSources()

PagedResourceListOfCorporateActionSource Lusid.Sdk.Api.CorporateActionSourcesApi.ListCorporateActionSources ( DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The AsAt date of the data (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, the filter, asAt, and limit must not be modified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfCorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ ListCorporateActionSourcesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCorporateActionSource> Lusid.Sdk.Api.CorporateActionSourcesApi.ListCorporateActionSourcesAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The AsAt date of the data (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, the filter, asAt, and limit must not be modified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfCorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ ListCorporateActionSourcesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCorporateActionSource> Lusid.Sdk.Api.CorporateActionSourcesApi.ListCorporateActionSourcesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The AsAt date of the data (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, the filter, asAt, and limit must not be modified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfCorporateActionSource

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ ListCorporateActionSourcesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCorporateActionSource> > Lusid.Sdk.Api.CorporateActionSourcesApi.ListCorporateActionSourcesWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  sortBy = default(List<string>?),
int?  limit = default(int?),
string?  filter = default(string?),
string?  page = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListCorporateActionSources: List corporate action sources Gets a list of all corporate action sources

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The AsAt date of the data (optional)
sortByOptional. Order the results by these fields. Use use the &#39;-&#39; sign to denote descending order e.g. -MyFieldName (optional)
limitOptional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filterOptional. Expression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageOptional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, the filter, asAt, and limit must not be modified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfCorporateActionSource)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ UpsertInstrumentEvents()

UpsertInstrumentEventsResponse Lusid.Sdk.Api.CorporateActionSourcesApi.UpsertInstrumentEvents ( string  scope,
string  code,
List< UpsertInstrumentEventRequest >?  upsertInstrumentEventRequest = default(List<UpsertInstrumentEventRequest>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
upsertInstrumentEventRequestThe instrument event definitions. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpsertInstrumentEventsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ UpsertInstrumentEventsAsync()

async System.Threading.Tasks.Task<UpsertInstrumentEventsResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.UpsertInstrumentEventsAsync ( string  scope,
string  code,
List< UpsertInstrumentEventRequest >?  upsertInstrumentEventRequest = default(List<UpsertInstrumentEventRequest>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
upsertInstrumentEventRequestThe instrument event definitions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpsertInstrumentEventsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

◆ UpsertInstrumentEventsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertInstrumentEventsResponse> Lusid.Sdk.Api.CorporateActionSourcesApi.UpsertInstrumentEventsWithHttpInfo ( string  scope,
string  code,
List< UpsertInstrumentEventRequest >?  upsertInstrumentEventRequest = default(List<UpsertInstrumentEventRequest>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
upsertInstrumentEventRequestThe instrument event definitions. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpsertInstrumentEventsResponse

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiSync.

◆ UpsertInstrumentEventsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInstrumentEventsResponse> > Lusid.Sdk.Api.CorporateActionSourcesApi.UpsertInstrumentEventsWithHttpInfoAsync ( string  scope,
string  code,
List< UpsertInstrumentEventRequest >?  upsertInstrumentEventRequest = default(List<UpsertInstrumentEventRequest>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. Batch upsert instrument events to corporate action sources. The maximum number of instrument events that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the corporate action source.
codeThe code of the corporate action source.
upsertInstrumentEventRequestThe instrument event definitions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpsertInstrumentEventsResponse)

Implements Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CorporateActionSourcesApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.CorporateActionSourcesApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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