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

Inheritance diagram for Lusid.Sdk.Api.OrderInstructionsApi:

[legend]

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

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

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

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

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

DeletedEntityResponse	DeleteOrderInstruction (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteOrderInstructionWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteOrderInstructionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteOrderInstructionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	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. More...

OrderInstruction	GetOrderInstruction (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetOrderInstruction: Get OrderInstruction Fetch a OrderInstruction that matches the specified identifier More...

Lusid.Sdk.Client.ApiResponse< OrderInstruction >	GetOrderInstructionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetOrderInstruction: Get OrderInstruction Fetch a OrderInstruction that matches the specified identifier More...

async 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), ConfigurationOptions? opts=null)
	GetOrderInstruction: Get OrderInstruction Fetch a OrderInstruction that matches the specified identifier More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null)
	GetOrderInstruction: Get OrderInstruction Fetch a OrderInstruction that matches the specified identifier 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, ConfigurationOptions? opts=null)
	ListOrderInstructions: List OrderInstructions Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). More...

Lusid.Sdk.Client.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, ConfigurationOptions? opts=null)
	ListOrderInstructions: List OrderInstructions Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). More...

async 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), ConfigurationOptions? opts=null)
	ListOrderInstructions: List OrderInstructions Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null)
	ListOrderInstructions: List OrderInstructions Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). More...

ResourceListOfOrderInstruction	UpsertOrderInstructions (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpsertOrderInstructions: Upsert OrderInstruction Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfOrderInstruction >	UpsertOrderInstructionsWithHttpInfo (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpsertOrderInstructions: Upsert OrderInstruction Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. More...

async System.Threading.Tasks.Task< ResourceListOfOrderInstruction >	UpsertOrderInstructionsAsync (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertOrderInstructions: Upsert OrderInstruction Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfOrderInstruction > >	UpsertOrderInstructionsWithHttpInfoAsync (OrderInstructionSetRequest? orderInstructionSetRequest=default(OrderInstructionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertOrderInstructions: Upsert OrderInstruction Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ OrderInstructionsApi() [1/4]

Lusid.Sdk.Api.OrderInstructionsApi.OrderInstructionsApi ( )

inline

Initializes a new instance of the OrderInstructionsApi class.

Returns

◆ OrderInstructionsApi() [2/4]

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

inline

Initializes a new instance of the OrderInstructionsApi class.

Returns

◆ OrderInstructionsApi() [3/4]

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

inline

Initializes a new instance of the OrderInstructionsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ OrderInstructionsApi() [4/4]

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

inline

Initializes a new instance of the OrderInstructionsApi 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

◆ DeleteOrderInstruction()

DeletedEntityResponse Lusid.Sdk.Api.OrderInstructionsApi.DeleteOrderInstruction	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ DeleteOrderInstructionAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.OrderInstructionsApi.DeleteOrderInstructionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ DeleteOrderInstructionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.OrderInstructionsApi.DeleteOrderInstructionWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ DeleteOrderInstructionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.OrderInstructionsApi.DeleteOrderInstructionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetOrderInstruction()

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

inline

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.
opts	Options for this request.

Returns: OrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ GetOrderInstructionAsync()

async System.Threading.Tasks.Task<OrderInstruction> Lusid.Sdk.Api.OrderInstructionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: Task of OrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ GetOrderInstructionWithHttpInfo()

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

inline

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.
opts	Options for this request.

Returns: ApiResponse of OrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ GetOrderInstructionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<OrderInstruction> > Lusid.Sdk.Api.OrderInstructionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: Task of ApiResponse (OrderInstruction)

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ ListOrderInstructions()

PagedResourceListOfOrderInstruction Lusid.Sdk.Api.OrderInstructionsApi.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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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". All properties, except derived properties, are returned by default, without specifying here. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ ListOrderInstructionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfOrderInstruction> Lusid.Sdk.Api.OrderInstructionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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". All properties, except derived properties, are returned by default, without specifying here. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ ListOrderInstructionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderInstruction> Lusid.Sdk.Api.OrderInstructionsApi.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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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". All properties, except derived properties, are returned by default, without specifying here. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ ListOrderInstructionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfOrderInstruction> > Lusid.Sdk.Api.OrderInstructionsApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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". All properties, except derived properties, are returned by default, without specifying here. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfOrderInstruction)

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ UpsertOrderInstructions()

ResourceListOfOrderInstruction Lusid.Sdk.Api.OrderInstructionsApi.UpsertOrderInstructions	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ UpsertOrderInstructionsAsync()

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

inline

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.
opts	Options for this request.

Returns: Task of ResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

◆ UpsertOrderInstructionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfOrderInstruction> Lusid.Sdk.Api.OrderInstructionsApi.UpsertOrderInstructionsWithHttpInfo	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfOrderInstruction

Implements Lusid.Sdk.Api.IOrderInstructionsApiSync.

◆ UpsertOrderInstructionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfOrderInstruction> > Lusid.Sdk.Api.OrderInstructionsApi.UpsertOrderInstructionsWithHttpInfoAsync	(	OrderInstructionSetRequest?	orderInstructionSetRequest = `default(OrderInstructionSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfOrderInstruction)

Implements Lusid.Sdk.Api.IOrderInstructionsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.OrderInstructionsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.OrderInstructionsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.OrderInstructionsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.OrderInstructionsApi.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/OrderInstructionsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ OrderInstructionsApi() [1/4]

◆ OrderInstructionsApi() [2/4]

◆ OrderInstructionsApi() [3/4]

◆ OrderInstructionsApi() [4/4]

Member Function Documentation

◆ DeleteOrderInstruction()

◆ DeleteOrderInstructionAsync()

◆ DeleteOrderInstructionWithHttpInfo()

◆ DeleteOrderInstructionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetOrderInstruction()

◆ GetOrderInstructionAsync()

◆ GetOrderInstructionWithHttpInfo()

◆ GetOrderInstructionWithHttpInfoAsync()

◆ ListOrderInstructions()

◆ ListOrderInstructionsAsync()

◆ ListOrderInstructionsWithHttpInfo()

◆ ListOrderInstructionsWithHttpInfoAsync()

◆ UpsertOrderInstructions()

◆ UpsertOrderInstructionsAsync()

◆ UpsertOrderInstructionsWithHttpInfo()

◆ UpsertOrderInstructionsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory