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

Inheritance diagram for Lusid.Sdk.Api.IOrdersApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteOrder (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteOrder: Delete order More...

ApiResponse< DeletedEntityResponse >	DeleteOrderWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteOrder: Delete order More...

Order	GetOrder (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetOrder: Get Order More...

ApiResponse< Order >	GetOrderWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetOrder: Get Order More...

PagedResourceListOfOrder	ListOrders (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)
	[EARLY ACCESS] ListOrders: List Orders More...

ApiResponse< PagedResourceListOfOrder >	ListOrdersWithHttpInfo (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)
	[EARLY ACCESS] ListOrders: List Orders More...

ResourceListOfOrder	UpsertOrders (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0)
	[EARLY ACCESS] UpsertOrders: Upsert Order More...

ApiResponse< ResourceListOfOrder >	UpsertOrdersWithHttpInfo (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0)
	[EARLY ACCESS] UpsertOrders: 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

◆ DeleteOrder()

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

[EARLY ACCESS] DeleteOrder: 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.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ DeleteOrderWithHttpInfo()

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

[EARLY ACCESS] DeleteOrder: 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.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ GetOrder()

Order Lusid.Sdk.Api.IOrdersApiSync.GetOrder	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetOrder: 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)
operationIndex	Index associated with the operation.

Returns: Order

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ GetOrderWithHttpInfo()

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

[EARLY ACCESS] GetOrder: 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Order

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ ListOrders()

PagedResourceListOfOrder Lusid.Sdk.Api.IOrdersApiSync.ListOrders	(	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`
	)

[EARLY ACCESS] ListOrders: List Orders

Fetch the last pre-AsAt date version of each order with optional filtering (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. (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 "Orders" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. "Orders/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfOrder

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ ListOrdersWithHttpInfo()

ApiResponse<PagedResourceListOfOrder> Lusid.Sdk.Api.IOrdersApiSync.ListOrdersWithHttpInfo	(	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`
	)

[EARLY ACCESS] ListOrders: List Orders

Fetch the last pre-AsAt date version of each order with optional filtering (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. (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 "Orders" domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. "Orders/system/Name". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfOrder

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ UpsertOrders()

ResourceListOfOrder Lusid.Sdk.Api.IOrdersApiSync.UpsertOrders	(	OrderSetRequest?	orderSetRequest = `default(OrderSetRequest?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertOrders: 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)
operationIndex	Index associated with the operation.

Returns: ResourceListOfOrder

Implemented in Lusid.Sdk.Api.OrdersApi.

◆ UpsertOrdersWithHttpInfo()

ApiResponse<ResourceListOfOrder> Lusid.Sdk.Api.IOrdersApiSync.UpsertOrdersWithHttpInfo	(	OrderSetRequest?	orderSetRequest = `default(OrderSetRequest?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertOrders: 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of 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/latest/sdk/Lusid.Sdk/Api/OrdersApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteOrder()

◆ DeleteOrderWithHttpInfo()

◆ GetOrder()

◆ GetOrderWithHttpInfo()

◆ ListOrders()

◆ ListOrdersWithHttpInfo()

◆ UpsertOrders()

◆ UpsertOrdersWithHttpInfo()