LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
OrdersApi () | |
Initializes a new instance of the OrdersApi class. More... | |
OrdersApi (string basePath) | |
Initializes a new instance of the OrdersApi class. More... | |
OrdersApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the OrdersApi class using Configuration object More... | |
OrdersApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the OrdersApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
DeletedEntityResponse | 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. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | 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. More... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteOrderAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[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. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeleteOrderWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[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. 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 Fetch an Order that matches the specified identifier. More... | |
Lusid.Sdk.Client.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 Fetch an Order that matches the specified identifier. More... | |
async System.Threading.Tasks.Task< Order > | GetOrderAsync (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)) |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Order > > | GetOrderWithHttpInfoAsync (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)) |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier. 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 Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). More... | |
Lusid.Sdk.Client.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 Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< PagedResourceListOfOrder > | ListOrdersAsync (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)) |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfOrder > > | ListOrdersWithHttpInfoAsync (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)) |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). More... | |
ResourceListOfOrder | 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. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfOrder > | 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. More... | |
async System.Threading.Tasks.Task< ResourceListOfOrder > | UpsertOrdersAsync (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders otherwise. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfOrder > > | UpsertOrdersWithHttpInfoAsync (OrderSetRequest? orderSetRequest=default(OrderSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders 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... | |
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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the OrdersApi class.
|
inline |
Initializes a new instance of the OrdersApi class.
|
inline |
Initializes a new instance of the OrdersApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the OrdersApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
|
inline |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] GetOrder: Get Order Fetch an Order that matches the specified identifier.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] ListOrders: List Orders Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
orderSetRequest | The collection of order requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
orderSetRequest | The collection of order requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
inline |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
orderSetRequest | The collection of order requests. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IOrdersApiSync.
|
inline |
[EARLY ACCESS] UpsertOrders: Upsert Order Upsert; update existing orders with given ids, or create new orders otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
orderSetRequest | The collection of order requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IOrdersApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.