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

Inheritance diagram for Lusid.Sdk.Api.InstrumentEventsApi:

[legend]

Public Member Functions
	InstrumentEventsApi ()
	Initializes a new instance of the InstrumentEventsApi class. More...

	InstrumentEventsApi (string basePath)
	Initializes a new instance of the InstrumentEventsApi class. More...

	InstrumentEventsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the InstrumentEventsApi class using Configuration object More...

	InstrumentEventsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the InstrumentEventsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

ResourceListOfApplicableInstrumentEvent	QueryApplicableInstrumentEvents (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), QueryApplicableInstrumentEventsRequest? queryApplicableInstrumentEventsRequest=default(QueryApplicableInstrumentEventsRequest?), int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfApplicableInstrumentEvent >	QueryApplicableInstrumentEventsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? page=default(string?), QueryApplicableInstrumentEventsRequest? queryApplicableInstrumentEventsRequest=default(QueryApplicableInstrumentEventsRequest?), int operationIndex=0)
	[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. More...

async 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. Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. More...

BucketedCashFlowResponse	QueryBucketedCashFlows (QueryBucketedCashFlowsRequest? queryBucketedCashFlowsRequest=default(QueryBucketedCashFlowsRequest?), int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< BucketedCashFlowResponse >	QueryBucketedCashFlowsWithHttpInfo (QueryBucketedCashFlowsRequest? queryBucketedCashFlowsRequest=default(QueryBucketedCashFlowsRequest?), int operationIndex=0)
	[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. More...

async 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. Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query. More...

ResourceListOfInstrumentCashFlow	QueryCashFlows (int? limit=default(int?), string? page=default(string?), QueryCashFlowsRequest? queryCashFlowsRequest=default(QueryCashFlowsRequest?), int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentCashFlow >	QueryCashFlowsWithHttpInfo (int? limit=default(int?), string? page=default(string?), QueryCashFlowsRequest? queryCashFlowsRequest=default(QueryCashFlowsRequest?), int operationIndex=0)
	[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. More...

async 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. Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. More...

ResourceListOfInstrumentEventHolder	QueryInstrumentEvents (int? limit=default(int?), string? page=default(string?), QueryInstrumentEventsRequest? queryInstrumentEventsRequest=default(QueryInstrumentEventsRequest?), int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfInstrumentEventHolder >	QueryInstrumentEventsWithHttpInfo (int? limit=default(int?), string? page=default(string?), QueryInstrumentEventsRequest? queryInstrumentEventsRequest=default(QueryInstrumentEventsRequest?), int operationIndex=0)
	[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. More...

async 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. Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. More...

ResourceListOfPortfolioTradeTicket	QueryTradeTickets (int? limit=default(int?), string? page=default(string?), QueryTradeTicketsRequest? queryTradeTicketsRequest=default(QueryTradeTicketsRequest?), int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolioTradeTicket >	QueryTradeTicketsWithHttpInfo (int? limit=default(int?), string? page=default(string?), QueryTradeTicketsRequest? queryTradeTicketsRequest=default(QueryTradeTicketsRequest?), int operationIndex=0)
	[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. More...

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

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

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

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

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ InstrumentEventsApi() [1/4]

Lusid.Sdk.Api.InstrumentEventsApi.InstrumentEventsApi ( )

inline

Initializes a new instance of the InstrumentEventsApi class.

Returns

◆ InstrumentEventsApi() [2/4]

Lusid.Sdk.Api.InstrumentEventsApi.InstrumentEventsApi ( string basePath )

inline

Initializes a new instance of the InstrumentEventsApi class.

Returns

◆ InstrumentEventsApi() [3/4]

Lusid.Sdk.Api.InstrumentEventsApi.InstrumentEventsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the InstrumentEventsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ InstrumentEventsApi() [4/4]

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

inline

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

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetBasePath()

string Lusid.Sdk.Api.InstrumentEventsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ QueryApplicableInstrumentEvents()

ResourceListOfApplicableInstrumentEvent Lusid.Sdk.Api.InstrumentEventsApi.QueryApplicableInstrumentEvents	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryApplicableInstrumentEventsRequest?	queryApplicableInstrumentEventsRequest = `default(QueryApplicableInstrumentEventsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ResourceListOfApplicableInstrumentEvent

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryApplicableInstrumentEventsAsync()

async System.Threading.Tasks.Task<ResourceListOfApplicableInstrumentEvent> Lusid.Sdk.Api.InstrumentEventsApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryApplicableInstrumentEventsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfApplicableInstrumentEvent> Lusid.Sdk.Api.InstrumentEventsApi.QueryApplicableInstrumentEventsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryApplicableInstrumentEventsRequest?	queryApplicableInstrumentEventsRequest = `default(QueryApplicableInstrumentEventsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of ResourceListOfApplicableInstrumentEvent

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryApplicableInstrumentEventsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfApplicableInstrumentEvent> > Lusid.Sdk.Api.InstrumentEventsApi.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)`
	)

inline

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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryBucketedCashFlows()

BucketedCashFlowResponse Lusid.Sdk.Api.InstrumentEventsApi.QueryBucketedCashFlows	(	QueryBucketedCashFlowsRequest?	queryBucketedCashFlowsRequest = `default(QueryBucketedCashFlowsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: BucketedCashFlowResponse

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryBucketedCashFlowsAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryBucketedCashFlowsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BucketedCashFlowResponse> Lusid.Sdk.Api.InstrumentEventsApi.QueryBucketedCashFlowsWithHttpInfo	(	QueryBucketedCashFlowsRequest?	queryBucketedCashFlowsRequest = `default(QueryBucketedCashFlowsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of BucketedCashFlowResponse

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryBucketedCashFlowsWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryCashFlows()

ResourceListOfInstrumentCashFlow Lusid.Sdk.Api.InstrumentEventsApi.QueryCashFlows	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryCashFlowsRequest?	queryCashFlowsRequest = `default(QueryCashFlowsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ResourceListOfInstrumentCashFlow

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryCashFlowsAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryCashFlowsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfInstrumentCashFlow> Lusid.Sdk.Api.InstrumentEventsApi.QueryCashFlowsWithHttpInfo	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryCashFlowsRequest?	queryCashFlowsRequest = `default(QueryCashFlowsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of ResourceListOfInstrumentCashFlow

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryCashFlowsWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryInstrumentEvents()

ResourceListOfInstrumentEventHolder Lusid.Sdk.Api.InstrumentEventsApi.QueryInstrumentEvents	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryInstrumentEventsRequest?	queryInstrumentEventsRequest = `default(QueryInstrumentEventsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ResourceListOfInstrumentEventHolder

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryInstrumentEventsAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryInstrumentEventsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.InstrumentEventsApi.QueryInstrumentEventsWithHttpInfo	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryInstrumentEventsRequest?	queryInstrumentEventsRequest = `default(QueryInstrumentEventsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of ResourceListOfInstrumentEventHolder

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryInstrumentEventsWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryTradeTickets()

ResourceListOfPortfolioTradeTicket Lusid.Sdk.Api.InstrumentEventsApi.QueryTradeTickets	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryTradeTicketsRequest?	queryTradeTicketsRequest = `default(QueryTradeTicketsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ResourceListOfPortfolioTradeTicket

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryTradeTicketsAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

◆ QueryTradeTicketsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolioTradeTicket> Lusid.Sdk.Api.InstrumentEventsApi.QueryTradeTicketsWithHttpInfo	(	int?	limit = `default(int?)`,
		string?	page = `default(string?)`,
		QueryTradeTicketsRequest?	queryTradeTicketsRequest = `default(QueryTradeTicketsRequest?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of ResourceListOfPortfolioTradeTicket

Implements Lusid.Sdk.Api.IInstrumentEventsApiSync.

◆ QueryTradeTicketsWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IInstrumentEventsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.InstrumentEventsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.InstrumentEventsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.InstrumentEventsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.InstrumentEventsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentEventsApi() [1/4]

◆ InstrumentEventsApi() [2/4]

◆ InstrumentEventsApi() [3/4]

◆ InstrumentEventsApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ QueryApplicableInstrumentEvents()

◆ QueryApplicableInstrumentEventsAsync()

◆ QueryApplicableInstrumentEventsWithHttpInfo()

◆ QueryApplicableInstrumentEventsWithHttpInfoAsync()

◆ QueryBucketedCashFlows()

◆ QueryBucketedCashFlowsAsync()

◆ QueryBucketedCashFlowsWithHttpInfo()

◆ QueryBucketedCashFlowsWithHttpInfoAsync()

◆ QueryCashFlows()

◆ QueryCashFlowsAsync()

◆ QueryCashFlowsWithHttpInfo()

◆ QueryCashFlowsWithHttpInfoAsync()

◆ QueryInstrumentEvents()

◆ QueryInstrumentEventsAsync()

◆ QueryInstrumentEventsWithHttpInfo()

◆ QueryInstrumentEventsWithHttpInfoAsync()

◆ QueryTradeTickets()

◆ QueryTradeTicketsAsync()

◆ QueryTradeTicketsWithHttpInfo()

◆ QueryTradeTicketsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory