sdk.lusid.api.translation_api.TranslationApi
- class TranslationApi(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
[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments # noqa: E501
[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments # noqa: E501
[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket # noqa: E501
[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket # noqa: E501
- translate_instrument_definitions(translate_instrument_definitions_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments # noqa: E501
Translates one or more instruments into the given target dialect. In the request each instrument definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each instrument in the response. Any instrument that is not already in the LUSID dialect should be given as an ExoticInstrument. The response will return both the collection of successfully translated instruments in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the instrument could not be updated or inserted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.translate_instrument_definitions(translate_instrument_definitions_request, async_req=True) >>> result = thread.get()
- Parameters:
translate_instrument_definitions_request (TranslateInstrumentDefinitionsRequest) – The definitions of the instruments to translate along with the target dialect. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- translate_instrument_definitions_with_http_info(translate_instrument_definitions_request, **kwargs)[source]
[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments # noqa: E501
Translates one or more instruments into the given target dialect. In the request each instrument definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each instrument in the response. Any instrument that is not already in the LUSID dialect should be given as an ExoticInstrument. The response will return both the collection of successfully translated instruments in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the instrument could not be updated or inserted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.translate_instrument_definitions_with_http_info(translate_instrument_definitions_request, async_req=True) >>> result = thread.get()
- Parameters:
translate_instrument_definitions_request (TranslateInstrumentDefinitionsRequest) – The definitions of the instruments to translate along with the target dialect. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(TranslateInstrumentDefinitionsResponse, status_code(int), headers(HTTPHeaderDict))
- translate_trade_tickets(translate_trade_ticket_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket # noqa: E501
Translates one or more trade tickets into the given target dialect. In the request each trade ticket definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each trade ticket in the response. The response will return both the collection of successfully translated trade tickets in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the trade ticket could not be updated or inserted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.translate_trade_tickets(translate_trade_ticket_request, async_req=True) >>> result = thread.get()
- Parameters:
translate_trade_ticket_request (TranslateTradeTicketRequest) – The definitions of the trade ticket to translate along with the target dialect. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- translate_trade_tickets_with_http_info(translate_trade_ticket_request, **kwargs)[source]
[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket # noqa: E501
Translates one or more trade tickets into the given target dialect. In the request each trade ticket definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each trade ticket in the response. The response will return both the collection of successfully translated trade tickets in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the trade ticket could not be updated or inserted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.translate_trade_tickets_with_http_info(translate_trade_ticket_request, async_req=True) >>> result = thread.get()
- Parameters:
translate_trade_ticket_request (TranslateTradeTicketRequest) – The definitions of the trade ticket to translate along with the target dialect. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(TranslateTradeTicketsResponse, status_code(int), headers(HTTPHeaderDict))