sdk.lusid.api.order_management_api.OrderManagementApi

class OrderManagementApi(api_client=None)

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

book_transactions	[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
book_transactions_with_http_info	[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
cancel_orders	[EARLY ACCESS] CancelOrders: Cancel existing orders # noqa: E501
cancel_orders_and_move_remaining	[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks # noqa: E501
cancel_orders_and_move_remaining_with_http_info	[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks # noqa: E501
cancel_orders_with_http_info	[EARLY ACCESS] CancelOrders: Cancel existing orders # noqa: E501
cancel_placements	[EARLY ACCESS] CancelPlacements: Cancel existing placements # noqa: E501
cancel_placements_with_http_info	[EARLY ACCESS] CancelPlacements: Cancel existing placements # noqa: E501
create_orders	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
create_orders_with_http_info	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501
get_order_history	[EXPERIMENTAL] GetOrderHistory: Get the history of an order and related entity changes # noqa: E501
get_order_history_with_http_info	[EXPERIMENTAL] GetOrderHistory: Get the history of an order and related entity changes # noqa: E501
move_orders	[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
move_orders_with_http_info	[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501
place_blocks	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
place_blocks_with_http_info	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
run_allocation_service	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
run_allocation_service_with_http_info	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501
update_orders	[EARLY ACCESS] UpdateOrders: Update existing orders # noqa: E501
update_orders_with_http_info	[EARLY ACCESS] UpdateOrders: Update existing orders # noqa: E501
update_placements	[EARLY ACCESS] UpdatePlacements: Update existing placements # noqa: E501
update_placements_with_http_info	[EARLY ACCESS] UpdatePlacements: Update existing placements # noqa: E501

book_transactions(book_transactions_request, apply_fees_and_commission=None, mark_orders_and_allocations_as_booked=None, async_req=None, **kwargs)

[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. # noqa: E501

Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.book_transactions(book_transactions_request, apply_fees_and_commission, mark_orders_and_allocations_as_booked, async_req=True)
>>> result = thread.get()

Parameters:

• book_transactions_request (BookTransactionsRequest) – The allocations to create transactions for (required)

• apply_fees_and_commission (bool) – Whether to apply fees and commissions to transactions (default: true)

• mark_orders_and_allocations_as_booked (bool) – Whether to mark allocations and fully-booked orders with state Booked

• 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:

BookTransactionsResponse

book_transactions_with_http_info(book_transactions_request, apply_fees_and_commission=None, mark_orders_and_allocations_as_booked=None, **kwargs)

[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. # noqa: E501

Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.book_transactions_with_http_info(book_transactions_request, apply_fees_and_commission, mark_orders_and_allocations_as_booked, async_req=True)
>>> result = thread.get()

Parameters:

• book_transactions_request (BookTransactionsRequest) – The allocations to create transactions for (required)

• apply_fees_and_commission (bool) – Whether to apply fees and commissions to transactions (default: true)

• mark_orders_and_allocations_as_booked (bool) – Whether to mark allocations and fully-booked orders with state Booked

• 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(BookTransactionsResponse, status_code(int), headers(HTTPHeaderDict))

cancel_orders(request_body, async_req=None, **kwargs)

[EARLY ACCESS] CancelOrders: Cancel existing orders # noqa: E501

The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_orders(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, ResourceId]) – The request containing the ids of the orders to be cancelled. (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:

CancelOrdersResponse

cancel_orders_and_move_remaining(request_body, async_req=None, **kwargs)

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks # noqa: E501

Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_orders_and_move_remaining(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, CancelOrdersAndMoveRemainingRequest]) – The request containing the orders to be cancelled, and the destinations of remaining quantities. (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:

CancelOrdersAndMoveRemainingResponse

cancel_orders_and_move_remaining_with_http_info(request_body, **kwargs)

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks # noqa: E501

Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_orders_and_move_remaining_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, CancelOrdersAndMoveRemainingRequest]) – The request containing the orders to be cancelled, and the destinations of remaining quantities. (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(CancelOrdersAndMoveRemainingResponse, status_code(int), headers(HTTPHeaderDict))

cancel_orders_with_http_info(request_body, **kwargs)

[EARLY ACCESS] CancelOrders: Cancel existing orders # noqa: E501

The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_orders_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, ResourceId]) – The request containing the ids of the orders to be cancelled. (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(CancelOrdersResponse, status_code(int), headers(HTTPHeaderDict))

cancel_placements(request_body, async_req=None, **kwargs)

[EARLY ACCESS] CancelPlacements: Cancel existing placements # noqa: E501

The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_placements(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, ResourceId]) – The request containing the ids of the placements to be cancelled. (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:

CancelPlacementsResponse

cancel_placements_with_http_info(request_body, **kwargs)

[EARLY ACCESS] CancelPlacements: Cancel existing placements # noqa: E501

The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.cancel_placements_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, ResourceId]) – The request containing the ids of the placements to be cancelled. (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(CancelPlacementsResponse, status_code(int), headers(HTTPHeaderDict))

create_orders(block_and_orders_create_request, async_req=None, **kwargs)

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501

Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_orders(block_and_orders_create_request, async_req=True)
>>> result = thread.get()

Parameters:

• block_and_orders_create_request (BlockAndOrdersCreateRequest) – The collection of block and orders requests. (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:

ResourceListOfBlockAndOrders

create_orders_with_http_info(block_and_orders_create_request, **kwargs)

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders # noqa: E501

Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_orders_with_http_info(block_and_orders_create_request, async_req=True)
>>> result = thread.get()

Parameters:

• block_and_orders_create_request (BlockAndOrdersCreateRequest) – The collection of block and orders requests. (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(ResourceListOfBlockAndOrders, status_code(int), headers(HTTPHeaderDict))

get_order_history(scope, code, as_at=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetOrderHistory: Get the history of an order and related entity changes # noqa: E501

Get the changes that have happened to an order and related entities. # 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_history(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the order. (required)

• code (str) – The code of the order. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified.

• 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:

ResourceListOfChangeIntervalWithOrderManagementDetail

get_order_history_with_http_info(scope, code, as_at=None, **kwargs)

[EXPERIMENTAL] GetOrderHistory: Get the history of an order and related entity changes # noqa: E501

Get the changes that have happened to an order and related entities. # 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_history_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the order. (required)

• code (str) – The code of the order. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified.

• 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(ResourceListOfChangeIntervalWithOrderManagementDetail, status_code(int), headers(HTTPHeaderDict))

move_orders(move_orders_to_different_blocks_request, async_req=None, **kwargs)

[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501

Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.move_orders(move_orders_to_different_blocks_request, async_req=True)
>>> result = thread.get()

Parameters:

• move_orders_to_different_blocks_request (MoveOrdersToDifferentBlocksRequest) – The collection of order and destination block ids. (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:

ResourceListOfMovedOrderToDifferentBlockResponse

move_orders_with_http_info(move_orders_to_different_blocks_request, **kwargs)

[EARLY ACCESS] MoveOrders: Move orders to new or existing block # noqa: E501

Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.move_orders_with_http_info(move_orders_to_different_blocks_request, async_req=True)
>>> result = thread.get()

Parameters:

• move_orders_to_different_blocks_request (MoveOrdersToDifferentBlocksRequest) – The collection of order and destination block ids. (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(ResourceListOfMovedOrderToDifferentBlockResponse, status_code(int), headers(HTTPHeaderDict))

place_blocks(place_blocks_request=None, async_req=None, **kwargs)

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. # noqa: E501

The referenced block’s existence will be verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.place_blocks(place_blocks_request, async_req=True)
>>> result = thread.get()

Parameters:

• place_blocks_request (PlaceBlocksRequest) – The request containing the blocks to the placed.

• 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:

ResourceListOfPlacement

place_blocks_with_http_info(place_blocks_request=None, **kwargs)

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. # noqa: E501

The referenced block’s existence will be verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.place_blocks_with_http_info(place_blocks_request, async_req=True)
>>> result = thread.get()

Parameters:

• place_blocks_request (PlaceBlocksRequest) – The request containing the blocks to the placed.

• 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(ResourceListOfPlacement, status_code(int), headers(HTTPHeaderDict))

run_allocation_service(resource_id, allocation_algorithm=None, async_req=None, **kwargs)

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501

This will allocate executions for a given list of placements back to their originating orders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.run_allocation_service(resource_id, allocation_algorithm, async_req=True)
>>> result = thread.get()

Parameters:

• resource_id (List[ResourceId]) – The List of Placement IDs for which you wish to allocate executions. (required)

• allocation_algorithm (str) – A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. “PR-FIFO”. This defaults to “PR-FIFO”.

• 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:

AllocationServiceRunResponse

run_allocation_service_with_http_info(resource_id, allocation_algorithm=None, **kwargs)

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service # noqa: E501

This will allocate executions for a given list of placements back to their originating orders. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.run_allocation_service_with_http_info(resource_id, allocation_algorithm, async_req=True)
>>> result = thread.get()

Parameters:

• resource_id (List[ResourceId]) – The List of Placement IDs for which you wish to allocate executions. (required)

• allocation_algorithm (str) – A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. “PR-FIFO”. This defaults to “PR-FIFO”.

• 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(AllocationServiceRunResponse, status_code(int), headers(HTTPHeaderDict))

update_orders(request_body, async_req=None, **kwargs)

[EARLY ACCESS] UpdateOrders: Update existing orders # noqa: E501

The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_orders(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, OrderUpdateRequest]) – The request containing the orders to be updated. (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:

UpdateOrdersResponse

update_orders_with_http_info(request_body, **kwargs)

[EARLY ACCESS] UpdateOrders: Update existing orders # noqa: E501

The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_orders_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, OrderUpdateRequest]) – The request containing the orders to be updated. (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(UpdateOrdersResponse, status_code(int), headers(HTTPHeaderDict))

update_placements(request_body, async_req=None, **kwargs)

[EARLY ACCESS] UpdatePlacements: Update existing placements # noqa: E501

The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_placements(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, PlacementUpdateRequest]) – The request containing the placements to be updated. (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:

UpdatePlacementsResponse

update_placements_with_http_info(request_body, **kwargs)

[EARLY ACCESS] UpdatePlacements: Update existing placements # noqa: E501

The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_placements_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

• request_body (Dict[str, PlacementUpdateRequest]) – The request containing the placements to be updated. (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(UpdatePlacementsResponse, status_code(int), headers(HTTPHeaderDict))