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

Inheritance diagram for Lusid.Sdk.Api.TranslationApi:

[legend]

Public Member Functions
	TranslationApi ()
	Initializes a new instance of the TranslationApi class. More...

	TranslationApi (string basePath)
	Initializes a new instance of the TranslationApi class. More...

	TranslationApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the TranslationApi class using Configuration object More...

	TranslationApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the TranslationApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

TranslateInstrumentDefinitionsResponse	TranslateInstrumentDefinitions (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< TranslateInstrumentDefinitionsResponse >	TranslateInstrumentDefinitionsWithHttpInfo (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0)
	[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. More...

async System.Threading.Tasks.Task< TranslateInstrumentDefinitionsResponse >	TranslateInstrumentDefinitionsAsync (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TranslateInstrumentDefinitionsResponse > >	TranslateInstrumentDefinitionsWithHttpInfoAsync (TranslateInstrumentDefinitionsRequest translateInstrumentDefinitionsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[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. More...

TranslateTradeTicketsResponse	TranslateTradeTickets (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< TranslateTradeTicketsResponse >	TranslateTradeTicketsWithHttpInfo (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0)
	[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. More...

async System.Threading.Tasks.Task< TranslateTradeTicketsResponse >	TranslateTradeTicketsAsync (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TranslateTradeTicketsResponse > >	TranslateTradeTicketsWithHttpInfoAsync (TranslateTradeTicketRequest translateTradeTicketRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[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. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Constructor & Destructor Documentation

◆ TranslationApi() [1/4]

Lusid.Sdk.Api.TranslationApi.TranslationApi ( )

inline

Initializes a new instance of the TranslationApi class.

Returns

◆ TranslationApi() [2/4]

Lusid.Sdk.Api.TranslationApi.TranslationApi ( string basePath )

inline

Initializes a new instance of the TranslationApi class.

Returns

◆ TranslationApi() [3/4]

Lusid.Sdk.Api.TranslationApi.TranslationApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the TranslationApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ TranslationApi() [4/4]

Lusid.Sdk.Api.TranslationApi.TranslationApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the TranslationApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetBasePath()

string Lusid.Sdk.Api.TranslationApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ TranslateInstrumentDefinitions()

TranslateInstrumentDefinitionsResponse Lusid.Sdk.Api.TranslationApi.TranslateInstrumentDefinitions	(	TranslateInstrumentDefinitionsRequest	translateInstrumentDefinitionsRequest,
		int	operationIndex = `0`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateInstrumentDefinitionsRequest	The definitions of the instruments to translate along with the target dialect.
operationIndex	Index associated with the operation.

Returns: TranslateInstrumentDefinitionsResponse

Implements Lusid.Sdk.Api.ITranslationApiSync.

◆ TranslateInstrumentDefinitionsAsync()

async System.Threading.Tasks.Task<TranslateInstrumentDefinitionsResponse> Lusid.Sdk.Api.TranslationApi.TranslateInstrumentDefinitionsAsync	(	TranslateInstrumentDefinitionsRequest	translateInstrumentDefinitionsRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateInstrumentDefinitionsRequest	The definitions of the instruments to translate along with the target dialect.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TranslateInstrumentDefinitionsResponse

Implements Lusid.Sdk.Api.ITranslationApiAsync.

◆ TranslateInstrumentDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TranslateInstrumentDefinitionsResponse> Lusid.Sdk.Api.TranslationApi.TranslateInstrumentDefinitionsWithHttpInfo	(	TranslateInstrumentDefinitionsRequest	translateInstrumentDefinitionsRequest,
		int	operationIndex = `0`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateInstrumentDefinitionsRequest	The definitions of the instruments to translate along with the target dialect.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslateInstrumentDefinitionsResponse

Implements Lusid.Sdk.Api.ITranslationApiSync.

◆ TranslateInstrumentDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TranslateInstrumentDefinitionsResponse> > Lusid.Sdk.Api.TranslationApi.TranslateInstrumentDefinitionsWithHttpInfoAsync	(	TranslateInstrumentDefinitionsRequest	translateInstrumentDefinitionsRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateInstrumentDefinitionsRequest	The definitions of the instruments to translate along with the target dialect.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TranslateInstrumentDefinitionsResponse)

Implements Lusid.Sdk.Api.ITranslationApiAsync.

◆ TranslateTradeTickets()

TranslateTradeTicketsResponse Lusid.Sdk.Api.TranslationApi.TranslateTradeTickets	(	TranslateTradeTicketRequest	translateTradeTicketRequest,
		int	operationIndex = `0`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateTradeTicketRequest	The definitions of the trade ticket to translate along with the target dialect.
operationIndex	Index associated with the operation.

Returns: TranslateTradeTicketsResponse

Implements Lusid.Sdk.Api.ITranslationApiSync.

◆ TranslateTradeTicketsAsync()

async System.Threading.Tasks.Task<TranslateTradeTicketsResponse> Lusid.Sdk.Api.TranslationApi.TranslateTradeTicketsAsync	(	TranslateTradeTicketRequest	translateTradeTicketRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateTradeTicketRequest	The definitions of the trade ticket to translate along with the target dialect.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TranslateTradeTicketsResponse

Implements Lusid.Sdk.Api.ITranslationApiAsync.

◆ TranslateTradeTicketsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TranslateTradeTicketsResponse> Lusid.Sdk.Api.TranslationApi.TranslateTradeTicketsWithHttpInfo	(	TranslateTradeTicketRequest	translateTradeTicketRequest,
		int	operationIndex = `0`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateTradeTicketRequest	The definitions of the trade ticket to translate along with the target dialect.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslateTradeTicketsResponse

Implements Lusid.Sdk.Api.ITranslationApiSync.

◆ TranslateTradeTicketsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TranslateTradeTicketsResponse> > Lusid.Sdk.Api.TranslationApi.TranslateTradeTicketsWithHttpInfoAsync	(	TranslateTradeTicketRequest	translateTradeTicketRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[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.ApiException Thrown when fails to make API call

Parameters

translateTradeTicketRequest	The definitions of the trade ticket to translate along with the target dialect.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TranslateTradeTicketsResponse)

Implements Lusid.Sdk.Api.ITranslationApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.TranslationApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.TranslationApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.TranslationApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.TranslationApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/TranslationApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TranslationApi() [1/4]

◆ TranslationApi() [2/4]

◆ TranslationApi() [3/4]

◆ TranslationApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ TranslateInstrumentDefinitions()

◆ TranslateInstrumentDefinitionsAsync()

◆ TranslateInstrumentDefinitionsWithHttpInfo()

◆ TranslateInstrumentDefinitionsWithHttpInfoAsync()

◆ TranslateTradeTickets()

◆ TranslateTradeTicketsAsync()

◆ TranslateTradeTicketsWithHttpInfo()

◆ TranslateTradeTicketsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory