sdk.lusid.api.transfer_agency_api.TransferAgencyApi

class TransferAgencyApi(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

`calculate_order_dates`	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders # noqa: E501
`calculate_order_dates_with_http_info`	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders # noqa: E501
`upsert_transfer_agency_orders`	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders # noqa: E501
`upsert_transfer_agency_orders_with_http_info`	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders # noqa: E501

calculate_order_dates(request_body, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders # noqa: E501

The response contains both the collection of successfully calculated dates and any failed calculations, each in the form of a dictionary keyed by the request’s keys. 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.calculate_order_dates(request_body, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, CalculateOrderDatesRequest]) – The request containing the dates used for calculation (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:

CalculateOrderDatesResponse

calculate_order_dates_with_http_info(request_body, **kwargs)[source]

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders # noqa: E501

The response contains both the collection of successfully calculated dates and any failed calculations, each in the form of a dictionary keyed by the request’s keys. 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.calculate_order_dates_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, CalculateOrderDatesRequest]) – The request containing the dates used for calculation (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(CalculateOrderDatesResponse, status_code(int), headers(HTTPHeaderDict))

upsert_transfer_agency_orders(request_body, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders # noqa: E501

Creates a transaction and updates the relevant order for each order supplied. The response contains both successfully processed orders and any failures, each in the form of a dictionary keyed by the request’s keys. 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.upsert_transfer_agency_orders(request_body, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, UpsertTransferAgencyOrderRequest]) – The transfer agency orders to upsert, keyed by a unique request identifier. (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:

TransferAgencyOrdersResponse

upsert_transfer_agency_orders_with_http_info(request_body, **kwargs)[source]

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders # noqa: E501

Creates a transaction and updates the relevant order for each order supplied. The response contains both successfully processed orders and any failures, each in the form of a dictionary keyed by the request’s keys. 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.upsert_transfer_agency_orders_with_http_info(request_body, async_req=True)
>>> result = thread.get()

Parameters:

request_body (Dict[str, UpsertTransferAgencyOrderRequest]) – The transfer agency orders to upsert, keyed by a unique request identifier. (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(TransferAgencyOrdersResponse, status_code(int), headers(HTTPHeaderDict))