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

Inheritance diagram for Lusid.Sdk.Api.IOrderInstructionsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteOrderInstructionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteOrderInstructionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction More...

System.Threading.Tasks.Task< OrderInstruction >	GetOrderInstructionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction More...

System.Threading.Tasks.Task< ApiResponse< OrderInstruction > >	GetOrderInstructionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction More...

System.Threading.Tasks.Task< PagedResourceListOfOrderInstruction >	ListOrderInstructionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfOrderInstruction > >	ListOrderInstructionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions More...

System.Threading.Tasks.Task< ResourceListOfOrderInstruction >	UpsertOrderInstructionsAsync (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfOrderInstruction > >	UpsertOrderInstructionsWithHttpInfoAsync (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction 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

◆ DeleteOrderInstructionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IOrderInstructionsApiAsync.DeleteOrderInstructionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction

Delete an orderInstruction. Deletion will be valid from the orderInstruction's creation datetime. This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The orderInstruction scope.
code	The orderInstruction's code. This, together with the scope uniquely identifies the orderInstruction to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ DeleteOrderInstructionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IOrderInstructionsApiAsync.DeleteOrderInstructionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction

Delete an orderInstruction. Deletion will be valid from the orderInstruction's creation datetime. This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The orderInstruction scope.
code	The orderInstruction's code. This, together with the scope uniquely identifies the orderInstruction to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ GetOrderInstructionAsync()

System.Threading.Tasks.Task<OrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiAsync.GetOrderInstructionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction

Fetch a OrderInstruction that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the orderInstruction belongs.
code	The orderInstruction's unique identifier.
asAt	The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. (optional)
propertyKeys	A list of property keys from the "OrderInstruction" domain to decorate onto the orderInstruction. These take the format {domain}/{scope}/{code} e.g. "OrderInstruction/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of OrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ GetOrderInstructionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<OrderInstruction> > Lusid.Sdk.Api.IOrderInstructionsApiAsync.GetOrderInstructionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction

Fetch a OrderInstruction that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the orderInstruction belongs.
code	The orderInstruction's unique identifier.
asAt	The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. (optional)
propertyKeys	A list of property keys from the "OrderInstruction" domain to decorate onto the orderInstruction. These take the format {domain}/{scope}/{code} e.g. "OrderInstruction/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (OrderInstruction)

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ ListOrderInstructionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfOrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiAsync.ListOrderInstructionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions

Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. (optional)
page	The pagination token to use to continue listing orderInstructions from a previous call to list orderInstructions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "OrderInstruction" domain to decorate onto each orderInstruction. These take the format {domain}/{scope}/{code} e.g. "OrderInstruction/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfOrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ ListOrderInstructionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfOrderInstruction> > Lusid.Sdk.Api.IOrderInstructionsApiAsync.ListOrderInstructionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions

Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified. (optional)
page	The pagination token to use to continue listing orderInstructions from a previous call to list orderInstructions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "OrderInstruction" domain to decorate onto each orderInstruction. These take the format {domain}/{scope}/{code} e.g. "OrderInstruction/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfOrderInstruction)

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ UpsertOrderInstructionsAsync()

System.Threading.Tasks.Task<ResourceListOfOrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiAsync.UpsertOrderInstructionsAsync	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction

Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise.

Exceptions

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

Parameters

orderInstructionSetRequest	The collection of orderInstruction requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfOrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ UpsertOrderInstructionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfOrderInstruction> > Lusid.Sdk.Api.IOrderInstructionsApiAsync.UpsertOrderInstructionsWithHttpInfoAsync	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction

Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise.

Exceptions

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

Parameters

orderInstructionSetRequest	The collection of orderInstruction requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfOrderInstruction)

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteOrderInstructionAsync()

◆ DeleteOrderInstructionWithHttpInfoAsync()

◆ GetOrderInstructionAsync()

◆ GetOrderInstructionWithHttpInfoAsync()

◆ ListOrderInstructionsAsync()

◆ ListOrderInstructionsWithHttpInfoAsync()

◆ UpsertOrderInstructionsAsync()

◆ UpsertOrderInstructionsWithHttpInfoAsync()