LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IOrdersApiSync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IOrdersApiSync:
Inheritance graph
[legend]

Public Member Functions

DeletedEntityResponse DeleteOrder (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteOrder: Delete order More...
 
ApiResponse< DeletedEntityResponseDeleteOrderWithHttpInfo (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< OrderGetOrderWithHttpInfo (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)
 ListOrders: List Orders More...
 
ApiResponse< PagedResourceListOfOrderListOrdersWithHttpInfo (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)
 ListOrders: List Orders More...
 
ResourceListOfOrder UpsertOrders (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0)
 UpsertOrders: Upsert Order More...
 
ApiResponse< ResourceListOfOrderUpsertOrdersWithHttpInfo (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0)
 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&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe order scope.
codeThe order&#39;s code. This, together with the scope uniquely identifies the order to delete.
operationIndexIndex 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&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe order scope.
codeThe order&#39;s code. This, together with the scope uniquely identifies the order to delete.
operationIndexIndex 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the order belongs.
codeThe order&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified. (optional)
propertyKeysA list of property keys from the &quot;Orders&quot; domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. &quot;Orders/system/Name&quot;. (optional)
operationIndexIndex 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the order belongs.
codeThe order&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified. (optional)
propertyKeysA list of property keys from the &quot;Orders&quot; domain to decorate onto the order. These take the format {domain}/{scope}/{code} e.g. &quot;Orders/system/Name&quot;. (optional)
operationIndexIndex 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 
)

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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Orders&quot; domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. &quot;Orders/system/Name&quot;. (optional)
operationIndexIndex 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 
)

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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Orders&quot; domain to decorate onto each order. These take the format {domain}/{scope}/{code} e.g. &quot;Orders/system/Name&quot;. (optional)
operationIndexIndex 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 
)

UpsertOrders: Upsert Order

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
orderSetRequestThe collection of order requests. (optional)
operationIndexIndex 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 
)

UpsertOrders: Upsert Order

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
orderSetRequestThe collection of order requests. (optional)
operationIndexIndex 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: