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

Inheritance diagram for Lusid.Sdk.Api.IInstrumentEventsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< ResourceListOfApplicableInstrumentEvent >	QueryApplicableInstrumentEventsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), QueryApplicableInstrumentEventsRequest? queryApplicableInstrumentEventsRequest=default(QueryApplicableInstrumentEventsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfApplicableInstrumentEvent > >	QueryApplicableInstrumentEventsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), QueryApplicableInstrumentEventsRequest? queryApplicableInstrumentEventsRequest=default(QueryApplicableInstrumentEventsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< BucketedCashFlowResponse >	QueryBucketedCashFlowsAsync (QueryBucketedCashFlowsRequest? queryBucketedCashFlowsRequest=default(QueryBucketedCashFlowsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ApiResponse< BucketedCashFlowResponse > >	QueryBucketedCashFlowsWithHttpInfoAsync (QueryBucketedCashFlowsRequest? queryBucketedCashFlowsRequest=default(QueryBucketedCashFlowsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ResourceListOfInstrumentCashFlow >	QueryCashFlowsAsync (int? limit=default(int?), string? page=default(string?), QueryCashFlowsRequest? queryCashFlowsRequest=default(QueryCashFlowsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfInstrumentCashFlow > >	QueryCashFlowsWithHttpInfoAsync (int? limit=default(int?), string? page=default(string?), QueryCashFlowsRequest? queryCashFlowsRequest=default(QueryCashFlowsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ResourceListOfInstrumentEventHolder >	QueryInstrumentEventsAsync (int? limit=default(int?), string? page=default(string?), QueryInstrumentEventsRequest? queryInstrumentEventsRequest=default(QueryInstrumentEventsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfInstrumentEventHolder > >	QueryInstrumentEventsWithHttpInfoAsync (int? limit=default(int?), string? page=default(string?), QueryInstrumentEventsRequest? queryInstrumentEventsRequest=default(QueryInstrumentEventsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ResourceListOfPortfolioTradeTicket >	QueryTradeTicketsAsync (int? limit=default(int?), string? page=default(string?), QueryTradeTicketsRequest? queryTradeTicketsRequest=default(QueryTradeTicketsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolioTradeTicket > >	QueryTradeTicketsWithHttpInfoAsync (int? limit=default(int?), string? page=default(string?), QueryTradeTicketsRequest? queryTradeTicketsRequest=default(QueryTradeTicketsRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ QueryApplicableInstrumentEventsAsync()

System.Threading.Tasks.Task<ResourceListOfApplicableInstrumentEvent> Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryApplicableInstrumentEventsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryApplicableInstrumentEventsRequest?	queryApplicableInstrumentEventsRequest = `default(QueryApplicableInstrumentEventsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.

Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

asAt	The as at time to use. (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)
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 (optional)
queryApplicableInstrumentEventsRequest	The filter parameters used to retrieve applicable instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfApplicableInstrumentEvent

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryApplicableInstrumentEventsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfApplicableInstrumentEvent> > Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryApplicableInstrumentEventsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryApplicableInstrumentEventsRequest?	queryApplicableInstrumentEventsRequest = `default(QueryApplicableInstrumentEventsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.

Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

asAt	The as at time to use. (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)
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 (optional)
queryApplicableInstrumentEventsRequest	The filter parameters used to retrieve applicable instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfApplicableInstrumentEvent)

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryBucketedCashFlowsAsync()

System.Threading.Tasks.Task<BucketedCashFlowResponse> Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryBucketedCashFlowsAsync	(	QueryBucketedCashFlowsRequest?	queryBucketedCashFlowsRequest = `default(QueryBucketedCashFlowsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.

Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

queryBucketedCashFlowsRequest	The Query Information. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of BucketedCashFlowResponse

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryBucketedCashFlowsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<BucketedCashFlowResponse> > Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryBucketedCashFlowsWithHttpInfoAsync	(	QueryBucketedCashFlowsRequest?	queryBucketedCashFlowsRequest = `default(QueryBucketedCashFlowsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.

Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

queryBucketedCashFlowsRequest	The Query Information. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (BucketedCashFlowResponse)

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryCashFlowsAsync()

System.Threading.Tasks.Task<ResourceListOfInstrumentCashFlow> Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryCashFlowsAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryCashFlowsRequest?	queryCashFlowsRequest = `default(QueryCashFlowsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.

Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryCashFlowsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfInstrumentCashFlow

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryCashFlowsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfInstrumentCashFlow> > Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryCashFlowsWithHttpInfoAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryCashFlowsRequest?	queryCashFlowsRequest = `default(QueryCashFlowsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.

Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryCashFlowsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfInstrumentCashFlow)

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryInstrumentEventsAsync()

System.Threading.Tasks.Task<ResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryInstrumentEventsAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryInstrumentEventsRequest?	queryInstrumentEventsRequest = `default(QueryInstrumentEventsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.

Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryInstrumentEventsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfInstrumentEventHolder

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryInstrumentEventsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfInstrumentEventHolder> > Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryInstrumentEventsWithHttpInfoAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryInstrumentEventsRequest?	queryInstrumentEventsRequest = `default(QueryInstrumentEventsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.

Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryInstrumentEventsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfInstrumentEventHolder)

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryTradeTicketsAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolioTradeTicket> Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryTradeTicketsAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryTradeTicketsRequest?	queryTradeTicketsRequest = `default(QueryTradeTicketsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.

Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryTradeTicketsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPortfolioTradeTicket

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryTradeTicketsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolioTradeTicket> > Lusid.Sdk.Api.IInstrumentEventsApiAsync.QueryTradeTicketsWithHttpInfoAsync	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryTradeTicketsRequest?	queryTradeTicketsRequest = `default(QueryTradeTicketsRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.

Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration.

Exceptions

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

Parameters

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, queryBody, and limit must not be modified. (optional)
queryTradeTicketsRequest	The filter parameters used to retrieve instrument events. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPortfolioTradeTicket)

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

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/InstrumentEventsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ QueryApplicableInstrumentEventsAsync()

◆ QueryApplicableInstrumentEventsWithHttpInfoAsync()

◆ QueryBucketedCashFlowsAsync()

◆ QueryBucketedCashFlowsWithHttpInfoAsync()

◆ QueryCashFlowsAsync()

◆ QueryCashFlowsWithHttpInfoAsync()

◆ QueryInstrumentEventsAsync()

◆ QueryInstrumentEventsWithHttpInfoAsync()

◆ QueryTradeTicketsAsync()

◆ QueryTradeTicketsWithHttpInfoAsync()