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

Inheritance diagram for Lusid.Sdk.Api.SystemConfigurationApi:

[legend]

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

	SystemConfigurationApi (String basePath)
	Initializes a new instance of the SystemConfigurationApi class. More...

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

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

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

TransactionSetConfigurationData	CreateConfigurationTransactionType (TransactionConfigurationDataRequest transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest))
	[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...

Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData >	CreateConfigurationTransactionTypeWithHttpInfo (TransactionConfigurationDataRequest transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest))
	[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...

async System.Threading.Tasks.Task< TransactionSetConfigurationData >	CreateConfigurationTransactionTypeAsync (TransactionConfigurationDataRequest transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > >	CreateConfigurationTransactionTypeWithHttpInfoAsync (TransactionConfigurationDataRequest transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...

TransactionSetConfigurationData	ListConfigurationTransactionTypes (DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. More...

Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData >	ListConfigurationTransactionTypesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?))
	[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. More...

async System.Threading.Tasks.Task< TransactionSetConfigurationData >	ListConfigurationTransactionTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > >	ListConfigurationTransactionTypesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/. 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

◆ SystemConfigurationApi() [1/4]

Lusid.Sdk.Api.SystemConfigurationApi.SystemConfigurationApi ( )

inline

Initializes a new instance of the SystemConfigurationApi class.

Returns

◆ SystemConfigurationApi() [2/4]

Lusid.Sdk.Api.SystemConfigurationApi.SystemConfigurationApi ( String basePath )

inline

Initializes a new instance of the SystemConfigurationApi class.

Returns

◆ SystemConfigurationApi() [3/4]

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

inline

Initializes a new instance of the SystemConfigurationApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ SystemConfigurationApi() [4/4]

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

inline

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

◆ CreateConfigurationTransactionType()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionType ( TransactionConfigurationDataRequest transactionConfigurationDataRequest = default(TransactionConfigurationDataRequest) )

inline

[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest A transaction type definition. (optional)

Returns: TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ CreateConfigurationTransactionTypeAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionTypeAsync	(	TransactionConfigurationDataRequest	transactionConfigurationDataRequest = `default(TransactionConfigurationDataRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest	A transaction type definition. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ CreateConfigurationTransactionTypeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionTypeWithHttpInfo ( TransactionConfigurationDataRequest transactionConfigurationDataRequest = default(TransactionConfigurationDataRequest) )

inline

[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest A transaction type definition. (optional)

Returns: ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ CreateConfigurationTransactionTypeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionTypeWithHttpInfoAsync	(	TransactionConfigurationDataRequest	transactionConfigurationDataRequest = `default(TransactionConfigurationDataRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Create transaction type Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest	A transaction type definition. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ GetBasePath()

String Lusid.Sdk.Api.SystemConfigurationApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListConfigurationTransactionTypes()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.ListConfigurationTransactionTypes ( DateTimeOffset? asAt = default(DateTimeOffset?) )

inline

[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)

Returns: TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ ListConfigurationTransactionTypesAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.ListConfigurationTransactionTypesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ ListConfigurationTransactionTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.ListConfigurationTransactionTypesWithHttpInfo ( DateTimeOffset? asAt = default(DateTimeOffset?) )

inline

[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)

Returns: ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ ListConfigurationTransactionTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.ListConfigurationTransactionTypesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] List transaction types Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.SystemConfigurationApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.SystemConfigurationApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.SystemConfigurationApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SystemConfigurationApi() [1/4]

◆ SystemConfigurationApi() [2/4]

◆ SystemConfigurationApi() [3/4]

◆ SystemConfigurationApi() [4/4]

Member Function Documentation

◆ CreateConfigurationTransactionType()

◆ CreateConfigurationTransactionTypeAsync()

◆ CreateConfigurationTransactionTypeWithHttpInfo()

◆ CreateConfigurationTransactionTypeWithHttpInfoAsync()

◆ GetBasePath()

◆ ListConfigurationTransactionTypes()

◆ ListConfigurationTransactionTypesAsync()

◆ ListConfigurationTransactionTypesWithHttpInfo()

◆ ListConfigurationTransactionTypesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory