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

Inheritance diagram for Lusid.Sdk.Api.ICorporateActionSourcesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< UpsertCorporateActionsResponse >	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)
	[EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source. More...

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. More...

System.Threading.Tasks.Task< CorporateActionSource >	CreateCorporateActionSourceAsync (CreateCorporateActionSourceRequest createCorporateActionSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateCorporateActionSource: Create corporate action source More...

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 More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCorporateActionSourceAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[BETA] DeleteCorporateActionSource: Delete a corporate action source More...

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 a corporate action source More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteCorporateActionsAsync (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 (instrument transition events) from a corporate action source More...

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 (instrument transition events) from a corporate action source More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteInstrumentEventsAsync (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 instrument events from a corporate action source More...

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 instrument events from a corporate action source More...

System.Threading.Tasks.Task< ResourceListOfCorporateAction >	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)
	[EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source. More...

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. More...

System.Threading.Tasks.Task< PagedResourceListOfInstrumentEventHolder >	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)
	[EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source. More...

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. More...

System.Threading.Tasks.Task< PagedResourceListOfCorporateActionSource >	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)
	[EARLY ACCESS] ListCorporateActionSources: List corporate action sources More...

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 More...

System.Threading.Tasks.Task< UpsertInstrumentEventsResponse >	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)
	[EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source. More...

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. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ BatchUpsertCorporateActionsAsync()

System.Threading.Tasks.Task<UpsertCorporateActionsResponse> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of corporate action source
code	The code of the corporate action source
upsertCorporateActionRequest	The corporate action definitions (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of UpsertCorporateActionsResponse

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ BatchUpsertCorporateActionsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertCorporateActionsResponse> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of corporate action source
code	The code of the corporate action source
upsertCorporateActionRequest	The corporate action definitions (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (UpsertCorporateActionsResponse)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ CreateCorporateActionSourceAsync()

System.Threading.Tasks.Task<CorporateActionSource> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.CreateCorporateActionSourceAsync	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createCorporateActionSourceRequest	The corporate action source definition
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CorporateActionSource

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ CreateCorporateActionSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CorporateActionSource> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createCorporateActionSourceRequest	The corporate action source definition
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CorporateActionSource)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteCorporateActionsAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.DeleteCorporateActionsAsync	(	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 (instrument transition events) from a corporate action source

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source
code	The code of the corporate action source
corporateActionIds	The IDs of the corporate actions to delete
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteCorporateActionSourceAsync()

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

[BETA] DeleteCorporateActionSource: Delete a corporate action source

Deletes a single corporate action source

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source to be deleted
code	The code of the corporate action source to be deleted
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteCorporateActionSourceWithHttpInfoAsync()

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

[BETA] DeleteCorporateActionSource: Delete a corporate action source

Deletes a single corporate action source

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source to be deleted
code	The code of the corporate action source to be deleted
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteCorporateActionsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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 (instrument transition events) from a corporate action source

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source
code	The code of the corporate action source
corporateActionIds	The IDs of the corporate actions to delete
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteInstrumentEventsAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.DeleteInstrumentEventsAsync	(	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 instrument events from a 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source
code	The code of the corporate action source
instrumentEventIds	The IDs of the instrument events to delete
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ DeleteInstrumentEventsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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 instrument events from a 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source
code	The code of the corporate action source
instrumentEventIds	The IDs of the instrument events to delete
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ GetCorporateActionsAsync()

System.Threading.Tasks.Task<ResourceListOfCorporateAction> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
fromEffectiveAt	Optional. The start effective date of the data range. (optional)
toEffectiveAt	Optional. The end effective date of the data range. (optional)
asAt	Optional. The AsAt date of the data. (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the results to this number. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Announcement Date, use "announcementDate eq '2020-03-06'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfCorporateAction

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ GetCorporateActionsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfCorporateAction> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
fromEffectiveAt	Optional. The start effective date of the data range. (optional)
toEffectiveAt	Optional. The end effective date of the data range. (optional)
asAt	Optional. The AsAt date of the data. (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the results to this number. (optional)
filter	Optional. Expression to filter the result set. For example, to filter on the Announcement Date, use "announcementDate eq '2020-03-06'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfCorporateAction)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ GetInstrumentEventsAsync()

System.Threading.Tasks.Task<PagedResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
asAt	Optional. The AsAt date of the data. (optional)
limit	Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
page	Optional. 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)
filter	Optional. Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfInstrumentEventHolder

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ GetInstrumentEventsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventHolder> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
asAt	Optional. The AsAt date of the data. (optional)
limit	Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. (optional, default to 1000)
page	Optional. 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)
filter	Optional. Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfInstrumentEventHolder)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ ListCorporateActionSourcesAsync()

System.Threading.Tasks.Task<PagedResourceListOfCorporateActionSource> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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`
	)

[EARLY ACCESS] ListCorporateActionSources: List corporate action sources

Gets a list of all corporate action sources

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	Optional. The AsAt date of the data (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	Optional. 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)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfCorporateActionSource

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ ListCorporateActionSourcesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCorporateActionSource> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	Optional. The AsAt date of the data (optional)
sortBy	Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName (optional)
limit	Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. (optional, default to 100)
filter	Optional. Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	Optional. 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)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfCorporateActionSource)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ UpsertInstrumentEventsAsync()

System.Threading.Tasks.Task<UpsertInstrumentEventsResponse> Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
upsertInstrumentEventRequest	The instrument event definitions. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of UpsertInstrumentEventsResponse

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

◆ UpsertInstrumentEventsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertInstrumentEventsResponse> > Lusid.Sdk.Api.ICorporateActionSourcesApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the corporate action source.
code	The code of the corporate action source.
upsertInstrumentEventRequest	The instrument event definitions. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (UpsertInstrumentEventsResponse)

Implemented in Lusid.Sdk.Api.CorporateActionSourcesApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/CorporateActionSourcesApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ BatchUpsertCorporateActionsAsync()

◆ BatchUpsertCorporateActionsWithHttpInfoAsync()

◆ CreateCorporateActionSourceAsync()

◆ CreateCorporateActionSourceWithHttpInfoAsync()

◆ DeleteCorporateActionsAsync()

◆ DeleteCorporateActionSourceAsync()

◆ DeleteCorporateActionSourceWithHttpInfoAsync()

◆ DeleteCorporateActionsWithHttpInfoAsync()

◆ DeleteInstrumentEventsAsync()

◆ DeleteInstrumentEventsWithHttpInfoAsync()

◆ GetCorporateActionsAsync()

◆ GetCorporateActionsWithHttpInfoAsync()

◆ GetInstrumentEventsAsync()

◆ GetInstrumentEventsWithHttpInfoAsync()

◆ ListCorporateActionSourcesAsync()

◆ ListCorporateActionSourcesWithHttpInfoAsync()

◆ UpsertInstrumentEventsAsync()

◆ UpsertInstrumentEventsWithHttpInfoAsync()