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

Inheritance diagram for Lusid.Sdk.Api.TransferAgencyApi:

[legend]

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

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

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

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

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

CalculateOrderDatesResponse	CalculateOrderDates (Dictionary< string, CalculateOrderDatesRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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. More...

Lusid.Sdk.Client.ApiResponse< CalculateOrderDatesResponse >	CalculateOrderDatesWithHttpInfo (Dictionary< string, CalculateOrderDatesRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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. More...

async System.Threading.Tasks.Task< CalculateOrderDatesResponse >	CalculateOrderDatesAsync (Dictionary< string, CalculateOrderDatesRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CalculateOrderDatesResponse > >	CalculateOrderDatesWithHttpInfoAsync (Dictionary< string, CalculateOrderDatesRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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. More...

TransferAgencyOrdersResponse	UpsertTransferAgencyOrders (Dictionary< string, UpsertTransferAgencyOrderRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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. More...

Lusid.Sdk.Client.ApiResponse< TransferAgencyOrdersResponse >	UpsertTransferAgencyOrdersWithHttpInfo (Dictionary< string, UpsertTransferAgencyOrderRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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. More...

async System.Threading.Tasks.Task< TransferAgencyOrdersResponse >	UpsertTransferAgencyOrdersAsync (Dictionary< string, UpsertTransferAgencyOrderRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransferAgencyOrdersResponse > >	UpsertTransferAgencyOrdersWithHttpInfoAsync (Dictionary< string, UpsertTransferAgencyOrderRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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. 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ TransferAgencyApi() [1/4]

Lusid.Sdk.Api.TransferAgencyApi.TransferAgencyApi ( )

inline

Initializes a new instance of the TransferAgencyApi class.

Returns

◆ TransferAgencyApi() [2/4]

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

inline

Initializes a new instance of the TransferAgencyApi class.

Returns

◆ TransferAgencyApi() [3/4]

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

inline

Initializes a new instance of the TransferAgencyApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ TransferAgencyApi() [4/4]

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

inline

Initializes a new instance of the TransferAgencyApi 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

◆ CalculateOrderDates()

CalculateOrderDatesResponse Lusid.Sdk.Api.TransferAgencyApi.CalculateOrderDates	(	Dictionary< string, CalculateOrderDatesRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The request containing the dates used for calculation
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: CalculateOrderDatesResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiSync.

◆ CalculateOrderDatesAsync()

async System.Threading.Tasks.Task<CalculateOrderDatesResponse> Lusid.Sdk.Api.TransferAgencyApi.CalculateOrderDatesAsync	(	Dictionary< string, CalculateOrderDatesRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The request containing the dates used for calculation
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of CalculateOrderDatesResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiAsync.

◆ CalculateOrderDatesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CalculateOrderDatesResponse> Lusid.Sdk.Api.TransferAgencyApi.CalculateOrderDatesWithHttpInfo	(	Dictionary< string, CalculateOrderDatesRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The request containing the dates used for calculation
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of CalculateOrderDatesResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiSync.

◆ CalculateOrderDatesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CalculateOrderDatesResponse> > Lusid.Sdk.Api.TransferAgencyApi.CalculateOrderDatesWithHttpInfoAsync	(	Dictionary< string, CalculateOrderDatesRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CalculateOrderDates: Calculate the key dates associated with transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The request containing the dates used for calculation
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (CalculateOrderDatesResponse)

Implements Lusid.Sdk.Api.ITransferAgencyApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ UpsertTransferAgencyOrders()

TransferAgencyOrdersResponse Lusid.Sdk.Api.TransferAgencyApi.UpsertTransferAgencyOrders	(	Dictionary< string, UpsertTransferAgencyOrderRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The transfer agency orders to upsert, keyed by a unique request identifier.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: TransferAgencyOrdersResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiSync.

◆ UpsertTransferAgencyOrdersAsync()

async System.Threading.Tasks.Task<TransferAgencyOrdersResponse> Lusid.Sdk.Api.TransferAgencyApi.UpsertTransferAgencyOrdersAsync	(	Dictionary< string, UpsertTransferAgencyOrderRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The transfer agency orders to upsert, keyed by a unique request identifier.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of TransferAgencyOrdersResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiAsync.

◆ UpsertTransferAgencyOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransferAgencyOrdersResponse> Lusid.Sdk.Api.TransferAgencyApi.UpsertTransferAgencyOrdersWithHttpInfo	(	Dictionary< string, UpsertTransferAgencyOrderRequest >	requestBody,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The transfer agency orders to upsert, keyed by a unique request identifier.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of TransferAgencyOrdersResponse

Implements Lusid.Sdk.Api.ITransferAgencyApiSync.

◆ UpsertTransferAgencyOrdersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransferAgencyOrdersResponse> > Lusid.Sdk.Api.TransferAgencyApi.UpsertTransferAgencyOrdersWithHttpInfoAsync	(	Dictionary< string, UpsertTransferAgencyOrderRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertTransferAgencyOrders: Upsert transfer agency orders 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.

Exceptions

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

Parameters

requestBody	The transfer agency orders to upsert, keyed by a unique request identifier.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (TransferAgencyOrdersResponse)

Implements Lusid.Sdk.Api.ITransferAgencyApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.TransferAgencyApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.TransferAgencyApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.TransferAgencyApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.TransferAgencyApi.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/TransferAgencyApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TransferAgencyApi() [1/4]

◆ TransferAgencyApi() [2/4]

◆ TransferAgencyApi() [3/4]

◆ TransferAgencyApi() [4/4]

Member Function Documentation

◆ CalculateOrderDates()

◆ CalculateOrderDatesAsync()

◆ CalculateOrderDatesWithHttpInfo()

◆ CalculateOrderDatesWithHttpInfoAsync()

◆ GetBasePath()

◆ UpsertTransferAgencyOrders()

◆ UpsertTransferAgencyOrdersAsync()

◆ UpsertTransferAgencyOrdersWithHttpInfo()

◆ UpsertTransferAgencyOrdersWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory