LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ITranslationApiAsync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ITranslationApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< TranslateInstrumentDefinitionsResponseTranslateInstrumentDefinitionsAsync (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments More...
 
System.Threading.Tasks.Task< ApiResponse< TranslateInstrumentDefinitionsResponse > > TranslateInstrumentDefinitionsWithHttpInfoAsync (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments More...
 
System.Threading.Tasks.Task< TranslateTradeTicketsResponseTranslateTradeTicketsAsync (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket More...
 
System.Threading.Tasks.Task< ApiResponse< TranslateTradeTicketsResponse > > TranslateTradeTicketsWithHttpInfoAsync (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ TranslateInstrumentDefinitionsAsync()

System.Threading.Tasks.Task<TranslateInstrumentDefinitionsResponse> Lusid.Sdk.Api.ITranslationApiAsync.TranslateInstrumentDefinitionsAsync ( TranslateInstrumentDefinitionsRequest  translateInstrumentDefinitionsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
translateInstrumentDefinitionsRequestThe definitions of the instruments to translate along with the target dialect.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of TranslateInstrumentDefinitionsResponse

Implemented in Lusid.Sdk.Api.TranslationApi.

◆ TranslateInstrumentDefinitionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TranslateInstrumentDefinitionsResponse> > Lusid.Sdk.Api.ITranslationApiAsync.TranslateInstrumentDefinitionsWithHttpInfoAsync ( TranslateInstrumentDefinitionsRequest  translateInstrumentDefinitionsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
translateInstrumentDefinitionsRequestThe definitions of the instruments to translate along with the target dialect.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (TranslateInstrumentDefinitionsResponse)

Implemented in Lusid.Sdk.Api.TranslationApi.

◆ TranslateTradeTicketsAsync()

System.Threading.Tasks.Task<TranslateTradeTicketsResponse> Lusid.Sdk.Api.ITranslationApiAsync.TranslateTradeTicketsAsync ( TranslateTradeTicketRequest  translateTradeTicketRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
translateTradeTicketRequestThe definitions of the trade ticket to translate along with the target dialect.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of TranslateTradeTicketsResponse

Implemented in Lusid.Sdk.Api.TranslationApi.

◆ TranslateTradeTicketsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TranslateTradeTicketsResponse> > Lusid.Sdk.Api.ITranslationApiAsync.TranslateTradeTicketsWithHttpInfoAsync ( TranslateTradeTicketRequest  translateTradeTicketRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
translateTradeTicketRequestThe definitions of the trade ticket to translate along with the target dialect.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (TranslateTradeTicketsResponse)

Implemented in Lusid.Sdk.Api.TranslationApi.


The documentation for this interface was generated from the following file: