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

Inheritance diagram for Lusid.Sdk.Api.IOrdersApiAsync:

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteOrderAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete order More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteOrderWithHttpInfoAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete order More...

System.Threading.Tasks.Task< Order >	GetOrderAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Order More...

System.Threading.Tasks.Task< ApiResponse< Order > >	GetOrderWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Order More...

System.Threading.Tasks.Task< PagedResourceListOfOrder >	ListOrdersAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Orders More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfOrder > >	ListOrdersWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Orders More...

System.Threading.Tasks.Task< ResourceListOfOrder >	UpsertOrdersAsync (OrderSetRequest orderSetRequest=default(OrderSetRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Order More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfOrder > >	UpsertOrdersWithHttpInfoAsync (OrderSetRequest orderSetRequest=default(OrderSetRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Order 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

◆ DeleteOrderAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IOrdersApiAsync.DeleteOrderAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete order

Delete an order. Deletion will be valid from the order's creation datetime. This means that the order 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 order scope.
code	The order's code. This, together with the scope uniquely identifies the order to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ DeleteOrderWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IOrdersApiAsync.DeleteOrderWithHttpInfoAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Delete order

Delete an order. Deletion will be valid from the order's creation datetime. This means that the order 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 order scope.
code	The order's code. This, together with the scope uniquely identifies the order to delete.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ GetOrderAsync()

System.Threading.Tasks.Task<Order> Lusid.Sdk.Api.IOrdersApiAsync.GetOrderAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get Order

Fetch an Order that matches the specified identifier

Exceptions

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

Parameters

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

Returns: Task of Order

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ GetOrderWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Order> > Lusid.Sdk.Api.IOrdersApiAsync.GetOrderWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Get Order

Fetch an Order that matches the specified identifier

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (Order)

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ ListOrdersAsync()

System.Threading.Tasks.Task<PagedResourceListOfOrder> Lusid.Sdk.Api.IOrdersApiAsync.ListOrdersAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List< string >)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List Orders

Fetch the last pre-AsAt date version of each order 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 order. Defaults to return the latest version of the order if not specified. (optional)
page	The pagination token to use to continue listing orders from a previous call to list orders. 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. Also, if set, a start value cannot be provided. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
start	When paginating, skip this number of results. (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, default to "")
propertyKeys	A list of property keys from the "Orders" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. "Orders/system/Name". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfOrder

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ ListOrdersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfOrder> > Lusid.Sdk.Api.IOrdersApiAsync.ListOrdersWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List< string >)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] List Orders

Fetch the last pre-AsAt date version of each order 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 order. Defaults to return the latest version of the order if not specified. (optional)
page	The pagination token to use to continue listing orders from a previous call to list orders. 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. Also, if set, a start value cannot be provided. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
start	When paginating, skip this number of results. (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, default to "")
propertyKeys	A list of property keys from the "Orders" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. "Orders/system/Name". (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfOrder)

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ UpsertOrdersAsync()

System.Threading.Tasks.Task<ResourceListOfOrder> Lusid.Sdk.Api.IOrdersApiAsync.UpsertOrdersAsync	(	OrderSetRequest	orderSetRequest = `default(OrderSetRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Upsert Order

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

Exceptions

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

Parameters

orderSetRequest	The collection of order requests. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfOrder

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ UpsertOrdersWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfOrder> > Lusid.Sdk.Api.IOrdersApiAsync.UpsertOrdersWithHttpInfoAsync	(	OrderSetRequest	orderSetRequest = `default(OrderSetRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] Upsert Order

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

Exceptions

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

Parameters

orderSetRequest	The collection of order requests. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfOrder)

Implemented in Lusid.Sdk.Api.OrdersApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/stable/sdk/Lusid.Sdk/Api/OrdersApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteOrderAsync()

◆ DeleteOrderWithHttpInfoAsync()

◆ GetOrderAsync()

◆ GetOrderWithHttpInfoAsync()

◆ ListOrdersAsync()

◆ ListOrdersWithHttpInfoAsync()

◆ UpsertOrdersAsync()

◆ UpsertOrdersWithHttpInfoAsync()