sdk.lusid.api.orders_api.OrdersApi
- class OrdersApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
[EARLY ACCESS] GetOrder: Get Order # noqa: E501
[EARLY ACCESS] GetOrder: Get Order # noqa: E501
ListOrders: List Orders # noqa: E501
ListOrders: List Orders # noqa: E501
UpsertOrders: Upsert Order # noqa: E501
UpsertOrders: Upsert Order # noqa: E501
- delete_order(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_order(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The order scope. (required)
code (str) – The order’s code. This, together with the scope uniquely identifies the order to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_order_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteOrder: Delete order # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_order_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The order scope. (required)
code (str) – The order’s code. This, together with the scope uniquely identifies the order to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- get_order(scope, code, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetOrder: Get Order # noqa: E501
Fetch an Order that matches the specified identifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_order(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the order belongs. (required)
code (str) – The order’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
property_keys (List[str]) – 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”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_order_with_http_info(scope, code, as_at=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] GetOrder: Get Order # noqa: E501
Fetch an Order that matches the specified identifier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_order_with_http_info(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the order belongs. (required)
code (str) – The order’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
property_keys (List[str]) – 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”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_orders(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, data_model_scope=None, data_model_code=None, membership_type=None, get_derived_compliance_statuses=None, async_req=None, **kwargs)[source]
ListOrders: List Orders # noqa: E501
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_orders(as_at, page, sort_by, limit, filter, property_keys, data_model_scope, data_model_code, membership_type, get_derived_compliance_statuses, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
page (str) – 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.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – 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”. All properties, except derived properties, are returned by default, without specifying here.
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
membership_type (str) – The membership types of the specified Custom Data Model to return. Default value: Member. Available values: All, Member, Candidate.
get_derived_compliance_statuses (bool) – If true, derives and decorates ComplianceState and ApprovalState onto each order using the V2 compliance engine. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_orders_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, data_model_scope=None, data_model_code=None, membership_type=None, get_derived_compliance_statuses=None, **kwargs)[source]
ListOrders: List Orders # noqa: E501
Fetch the last pre-AsAt date version of each order with optional filtering (does not fetch the entire history). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_orders_with_http_info(as_at, page, sort_by, limit, filter, property_keys, data_model_scope, data_model_code, membership_type, get_derived_compliance_statuses, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the order. Defaults to return the latest version of the order if not specified.
page (str) – 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.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – 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”. All properties, except derived properties, are returned by default, without specifying here.
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
membership_type (str) – The membership types of the specified Custom Data Model to return. Default value: Member. Available values: All, Member, Candidate.
get_derived_compliance_statuses (bool) – If true, derives and decorates ComplianceState and ApprovalState onto each order using the V2 compliance engine. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(PagedResourceListOfOrder, status_code(int), headers(HTTPHeaderDict))
- upsert_orders(order_set_request, data_model_scope=None, data_model_code=None, async_req=None, **kwargs)[source]
UpsertOrders: Upsert Order # noqa: E501
Upsert; update existing orders with given ids, or create new orders otherwise. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_orders(order_set_request, data_model_scope, data_model_code, async_req=True) >>> result = thread.get()
- Parameters:
order_set_request (OrderSetRequest) – The collection of order requests. (required)
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- upsert_orders_with_http_info(order_set_request, data_model_scope=None, data_model_code=None, **kwargs)[source]
UpsertOrders: Upsert Order # noqa: E501
Upsert; update existing orders with given ids, or create new orders otherwise. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_orders_with_http_info(order_set_request, data_model_scope, data_model_code, async_req=True) >>> result = thread.get()
- Parameters:
order_set_request (OrderSetRequest) – The collection of order requests. (required)
data_model_scope (str) – The optional scope of a Custom Data Model to use
data_model_code (str) – The optional code of a Custom Data Model to use
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfOrder, status_code(int), headers(HTTPHeaderDict))