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

Inheritance diagram for Lusid.Sdk.Api.IScriptedTranslationApiSync:

[legend]

Public Member Functions
Dialect	GetTranslationDialect (string scope, string vendor, string sourceSystem, string entityType, string serialisationFormat, string version, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetTranslationDialect: Get a dialect. More...

ApiResponse< Dialect >	GetTranslationDialectWithHttpInfo (string scope, string vendor, string sourceSystem, string entityType, string serialisationFormat, string version, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetTranslationDialect: Get a dialect. More...

TranslationScript	GetTranslationScript (string scope, string code, string version, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetTranslationScript: Retrieve a translation script by its identifier. More...

ApiResponse< TranslationScript >	GetTranslationScriptWithHttpInfo (string scope, string code, string version, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetTranslationScript: Retrieve a translation script by its identifier. More...

PagedResourceListOfDialectId	ListDialectIds (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter. More...

ApiResponse< PagedResourceListOfDialectId >	ListDialectIdsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter. More...

PagedResourceListOfTranslationScriptId	ListTranslationScriptIds (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers. More...

ApiResponse< PagedResourceListOfTranslationScriptId >	ListTranslationScriptIdsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int? limit=default(int?), string? filter=default(string?), string? page=default(string?), int operationIndex=0)
	[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers. More...

TranslateEntitiesResponse	TranslateEntities (TranslateEntitiesRequest translateEntitiesRequest, int operationIndex=0)
	[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script. More...

ApiResponse< TranslateEntitiesResponse >	TranslateEntitiesWithHttpInfo (TranslateEntitiesRequest translateEntitiesRequest, int operationIndex=0)
	[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script. More...

TranslateEntitiesResponse	TranslateEntitiesInlined (TranslateEntitiesInlinedRequest translateEntitiesInlinedRequest, int operationIndex=0)
	[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script. More...

ApiResponse< TranslateEntitiesResponse >	TranslateEntitiesInlinedWithHttpInfo (TranslateEntitiesInlinedRequest translateEntitiesInlinedRequest, int operationIndex=0)
	[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script. More...

Dialect	UpsertTranslationDialect (UpsertDialectRequest upsertDialectRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertTranslationDialect: Upsert a Dialect. More...

ApiResponse< Dialect >	UpsertTranslationDialectWithHttpInfo (UpsertDialectRequest upsertDialectRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertTranslationDialect: Upsert a Dialect. More...

TranslationScript	UpsertTranslationScript (UpsertTranslationScriptRequest upsertTranslationScriptRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertTranslationScript: Upsert a translation script. More...

ApiResponse< TranslationScript >	UpsertTranslationScriptWithHttpInfo (UpsertTranslationScriptRequest upsertTranslationScriptRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertTranslationScript: Upsert a translation script. 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

◆ GetTranslationDialect()

Dialect Lusid.Sdk.Api.IScriptedTranslationApiSync.GetTranslationDialect	(	string	scope,
		string	vendor,
		string	sourceSystem,
		string	entityType,
		string	serialisationFormat,
		string	version,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetTranslationDialect: Get a dialect.

Get the dialect with the given identifier at the specific asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the dialect.
vendor	The vendor of the dialect, the entity that created it. e.g. ISDA, FINBOURNE.
sourceSystem	The source system of the dialect, the system that understands it. e.g. LUSID, QuantLib.
entityType	The type of entity this dialect describes e.g. Instrument.
serialisationFormat	The serialisation format of a document in this dialect. e.g. JSON, XML.
version	The semantic version of the dialect: MAJOR.MINOR.PATCH.
asAt	The asAt datetime at which to retrieve the dialect. Defaults to return the latest version of the dialect if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: Dialect

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ GetTranslationDialectWithHttpInfo()

ApiResponse<Dialect> Lusid.Sdk.Api.IScriptedTranslationApiSync.GetTranslationDialectWithHttpInfo	(	string	scope,
		string	vendor,
		string	sourceSystem,
		string	entityType,
		string	serialisationFormat,
		string	version,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetTranslationDialect: Get a dialect.

Get the dialect with the given identifier at the specific asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the dialect.
vendor	The vendor of the dialect, the entity that created it. e.g. ISDA, FINBOURNE.
sourceSystem	The source system of the dialect, the system that understands it. e.g. LUSID, QuantLib.
entityType	The type of entity this dialect describes e.g. Instrument.
serialisationFormat	The serialisation format of a document in this dialect. e.g. JSON, XML.
version	The semantic version of the dialect: MAJOR.MINOR.PATCH.
asAt	The asAt datetime at which to retrieve the dialect. Defaults to return the latest version of the dialect if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dialect

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ GetTranslationScript()

TranslationScript Lusid.Sdk.Api.IScriptedTranslationApiSync.GetTranslationScript	(	string	scope,
		string	code,
		string	version,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetTranslationScript: Retrieve a translation script by its identifier.

Retrieves a translation script to be used for translating financial entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the translation script.
code	Code of the translation script.
version	Semantic version of the translation script.
asAt	The asAt datetime at which to retrieve the translation script. Defaults to latest. (optional)
operationIndex	Index associated with the operation.

Returns: TranslationScript

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ GetTranslationScriptWithHttpInfo()

ApiResponse<TranslationScript> Lusid.Sdk.Api.IScriptedTranslationApiSync.GetTranslationScriptWithHttpInfo	(	string	scope,
		string	code,
		string	version,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetTranslationScript: Retrieve a translation script by its identifier.

Retrieves a translation script to be used for translating financial entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	Scope of the translation script.
code	Code of the translation script.
version	Semantic version of the translation script.
asAt	The asAt datetime at which to retrieve the translation script. Defaults to latest. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslationScript

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ ListDialectIds()

PagedResourceListOfDialectId Lusid.Sdk.Api.IScriptedTranslationApiSync.ListDialectIds	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter.

List the stored dialects' identifiers with pagination and filtering at the specified asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified. (optional)
page	The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfDialectId

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ ListDialectIdsWithHttpInfo()

ApiResponse<PagedResourceListOfDialectId> Lusid.Sdk.Api.IScriptedTranslationApiSync.ListDialectIdsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter.

List the stored dialects' identifiers with pagination and filtering at the specified asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the dialects. Defaults to return the latest version of the dialect if not specified. (optional)
page	The pagination token to use to continue listing dialect IDs from a previous call to list dialect IDs. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfDialectId

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ ListTranslationScriptIds()

PagedResourceListOfTranslationScriptId Lusid.Sdk.Api.IScriptedTranslationApiSync.ListTranslationScriptIds	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers.

List translation script ids.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the script identifiers. Defaults to latest. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope. (optional)
page	The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfTranslationScriptId

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ ListTranslationScriptIdsWithHttpInfo()

ApiResponse<PagedResourceListOfTranslationScriptId> Lusid.Sdk.Api.IScriptedTranslationApiSync.ListTranslationScriptIdsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers.

List translation script ids.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the script identifiers. Defaults to latest. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, Id.Version.Major eq 1 to list IDs with major version 1 or Id.Scope eq 'my-scripts' to list result only for a particular scope. (optional)
page	The pagination token to use to continue listing translation script IDs; this value is returned from the previous call. If a pagination token is provided, the filter field must not have changed since the original request. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfTranslationScriptId

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ TranslateEntities()

TranslateEntitiesResponse Lusid.Sdk.Api.IScriptedTranslationApiSync.TranslateEntities	(	TranslateEntitiesRequest	translateEntitiesRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script.

Run the provided translation request. The entities to translate are specified in the request body as a dictionary with (ephemeral) unique correlation IDs. The script to use and optional dialect to validate results against are sourced from the database.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

translateEntitiesRequest	The entities to translate, along with identifiers for the script and (optional) dialect to use.
operationIndex	Index associated with the operation.

Returns: TranslateEntitiesResponse

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ TranslateEntitiesInlined()

TranslateEntitiesResponse Lusid.Sdk.Api.IScriptedTranslationApiSync.TranslateEntitiesInlined	(	TranslateEntitiesInlinedRequest	translateEntitiesInlinedRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script.

Run the provided translation request. The entities to translate, script to use and dialect to validate results against are all specified in the request body. The entities are given as a dictionary with (ephemeral) unique correlation IDs.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

translateEntitiesInlinedRequest	The entities to translate, along with the script to use and an optional schema for validation.
operationIndex	Index associated with the operation.

Returns: TranslateEntitiesResponse

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ TranslateEntitiesInlinedWithHttpInfo()

ApiResponse<TranslateEntitiesResponse> Lusid.Sdk.Api.IScriptedTranslationApiSync.TranslateEntitiesInlinedWithHttpInfo	(	TranslateEntitiesInlinedRequest	translateEntitiesInlinedRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script.

Run the provided translation request. The entities to translate, script to use and dialect to validate results against are all specified in the request body. The entities are given as a dictionary with (ephemeral) unique correlation IDs.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

translateEntitiesInlinedRequest	The entities to translate, along with the script to use and an optional schema for validation.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslateEntitiesResponse

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ TranslateEntitiesWithHttpInfo()

ApiResponse<TranslateEntitiesResponse> Lusid.Sdk.Api.IScriptedTranslationApiSync.TranslateEntitiesWithHttpInfo	(	TranslateEntitiesRequest	translateEntitiesRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script.

Run the provided translation request. The entities to translate are specified in the request body as a dictionary with (ephemeral) unique correlation IDs. The script to use and optional dialect to validate results against are sourced from the database.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

translateEntitiesRequest	The entities to translate, along with identifiers for the script and (optional) dialect to use.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslateEntitiesResponse

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ UpsertTranslationDialect()

Dialect Lusid.Sdk.Api.IScriptedTranslationApiSync.UpsertTranslationDialect	(	UpsertDialectRequest	upsertDialectRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertTranslationDialect: Upsert a Dialect.

Upsert the given dialect.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertDialectRequest	The dialect to upsert.
operationIndex	Index associated with the operation.

Returns: Dialect

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ UpsertTranslationDialectWithHttpInfo()

ApiResponse<Dialect> Lusid.Sdk.Api.IScriptedTranslationApiSync.UpsertTranslationDialectWithHttpInfo	(	UpsertDialectRequest	upsertDialectRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertTranslationDialect: Upsert a Dialect.

Upsert the given dialect.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertDialectRequest	The dialect to upsert.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dialect

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ UpsertTranslationScript()

TranslationScript Lusid.Sdk.Api.IScriptedTranslationApiSync.UpsertTranslationScript	(	UpsertTranslationScriptRequest	upsertTranslationScriptRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertTranslationScript: Upsert a translation script.

Upserts a translation script to be used for translating financial entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertTranslationScriptRequest	The translation script to be upserted.
operationIndex	Index associated with the operation.

Returns: TranslationScript

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

◆ UpsertTranslationScriptWithHttpInfo()

ApiResponse<TranslationScript> Lusid.Sdk.Api.IScriptedTranslationApiSync.UpsertTranslationScriptWithHttpInfo	(	UpsertTranslationScriptRequest	upsertTranslationScriptRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertTranslationScript: Upsert a translation script.

Upserts a translation script to be used for translating financial entities.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertTranslationScriptRequest	The translation script to be upserted.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TranslationScript

Implemented in Lusid.Sdk.Api.ScriptedTranslationApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetTranslationDialect()

◆ GetTranslationDialectWithHttpInfo()

◆ GetTranslationScript()

◆ GetTranslationScriptWithHttpInfo()

◆ ListDialectIds()

◆ ListDialectIdsWithHttpInfo()

◆ ListTranslationScriptIds()

◆ ListTranslationScriptIdsWithHttpInfo()

◆ TranslateEntities()

◆ TranslateEntitiesInlined()

◆ TranslateEntitiesInlinedWithHttpInfo()

◆ TranslateEntitiesWithHttpInfo()

◆ UpsertTranslationDialect()

◆ UpsertTranslationDialectWithHttpInfo()

◆ UpsertTranslationScript()

◆ UpsertTranslationScriptWithHttpInfo()