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

Inheritance diagram for Lusid.Sdk.Api.IInstrumentEventsApiSync:

[legend]

Public Member Functions
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. More...

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

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

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

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

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

◆ QueryApplicableInstrumentEvents()

ResourceListOfApplicableInstrumentEvent Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryApplicableInstrumentEventsWithHttpInfo()

ApiResponse<ResourceListOfApplicableInstrumentEvent> Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryBucketedCashFlows()

BucketedCashFlowResponse Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryBucketedCashFlowsWithHttpInfo()

ApiResponse<BucketedCashFlowResponse> Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryCashFlows()

ResourceListOfInstrumentCashFlow Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryCashFlowsWithHttpInfo()

ApiResponse<ResourceListOfInstrumentCashFlow> Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryInstrumentEvents()

ResourceListOfInstrumentEventHolder Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryInstrumentEventsWithHttpInfo()

ApiResponse<ResourceListOfInstrumentEventHolder> Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryTradeTickets()

ResourceListOfPortfolioTradeTicket Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

Implemented in Lusid.Sdk.Api.InstrumentEventsApi.

◆ QueryTradeTicketsWithHttpInfo()

ApiResponse<ResourceListOfPortfolioTradeTicket> Lusid.Sdk.Api.IInstrumentEventsApiSync.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.

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

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

◆ QueryApplicableInstrumentEvents()

◆ QueryApplicableInstrumentEventsWithHttpInfo()

◆ QueryBucketedCashFlows()

◆ QueryBucketedCashFlowsWithHttpInfo()

◆ QueryCashFlows()

◆ QueryCashFlowsWithHttpInfo()

◆ QueryInstrumentEvents()

◆ QueryInstrumentEventsWithHttpInfo()

◆ QueryTradeTickets()

◆ QueryTradeTicketsWithHttpInfo()