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

Inheritance diagram for Lusid.Sdk.Api.IOrderInstructionsApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteOrderInstruction (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction More...

ApiResponse< DeletedEntityResponse >	DeleteOrderInstructionWithHttpInfo (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction More...

OrderInstruction	GetOrderInstruction (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction More...

ApiResponse< OrderInstruction >	GetOrderInstructionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction More...

PagedResourceListOfOrderInstruction	ListOrderInstructions (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)
	[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions More...

ApiResponse< PagedResourceListOfOrderInstruction >	ListOrderInstructionsWithHttpInfo (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)
	[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions More...

ResourceListOfOrderInstruction	UpsertOrderInstructions (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0)
	[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction More...

ApiResponse< ResourceListOfOrderInstruction >	UpsertOrderInstructionsWithHttpInfo (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0)
	[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

◆ DeleteOrderInstruction()

DeletedEntityResponse Lusid.Sdk.Api.IOrderInstructionsApiSync.DeleteOrderInstruction	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

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

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ DeleteOrderInstructionWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IOrderInstructionsApiSync.DeleteOrderInstructionWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

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

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ GetOrderInstruction()

OrderInstruction Lusid.Sdk.Api.IOrderInstructionsApiSync.GetOrderInstruction	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

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

Returns: OrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ GetOrderInstructionWithHttpInfo()

ApiResponse<OrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiSync.GetOrderInstructionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

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

Returns: ApiResponse of OrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ ListOrderInstructions()

PagedResourceListOfOrderInstruction Lusid.Sdk.Api.IOrderInstructionsApiSync.ListOrderInstructions	(	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`
	)

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

Returns: PagedResourceListOfOrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ ListOrderInstructionsWithHttpInfo()

ApiResponse<PagedResourceListOfOrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiSync.ListOrderInstructionsWithHttpInfo	(	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`
	)

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

Returns: ApiResponse of PagedResourceListOfOrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ UpsertOrderInstructions()

ResourceListOfOrderInstruction Lusid.Sdk.Api.IOrderInstructionsApiSync.UpsertOrderInstructions	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`
	)

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

Returns: ResourceListOfOrderInstruction

Implemented in Lusid.Sdk.Api.OrderInstructionsApi.

◆ UpsertOrderInstructionsWithHttpInfo()

ApiResponse<ResourceListOfOrderInstruction> Lusid.Sdk.Api.IOrderInstructionsApiSync.UpsertOrderInstructionsWithHttpInfo	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`
	)

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

Returns: ApiResponse of 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

◆ DeleteOrderInstruction()

◆ DeleteOrderInstructionWithHttpInfo()

◆ GetOrderInstruction()

◆ GetOrderInstructionWithHttpInfo()

◆ ListOrderInstructions()

◆ ListOrderInstructionsWithHttpInfo()

◆ UpsertOrderInstructions()

◆ UpsertOrderInstructionsWithHttpInfo()