LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.SystemConfigurationApi Class Reference

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

Inheritance diagram for Lusid.Sdk.Api.SystemConfigurationApi:
Inheritance graph
[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?), int operationIndex=0)
 [EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...
 
Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationDataCreateConfigurationTransactionTypeWithHttpInfo (TransactionConfigurationDataRequest? transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest?), int operationIndex=0)
 [EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...
 
async System.Threading.Tasks.Task< TransactionSetConfigurationDataCreateConfigurationTransactionTypeAsync (TransactionConfigurationDataRequest? transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateConfigurationTransactionType: 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type Create a new transaction type by specifying a definition and mappings to movements. More...
 
TransactionSetConfigurationData CreateSideDefinition (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0)
 [EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. More...
 
Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationDataCreateSideDefinitionWithHttpInfo (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0)
 [EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. More...
 
async System.Threading.Tasks.Task< TransactionSetConfigurationDataCreateSideDefinitionAsync (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > > CreateSideDefinitionWithHttpInfoAsync (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. More...
 
DeletedEntityResponse DeleteTransactionConfigurationSource (string source, int operationIndex=0)
 [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteTransactionConfigurationSourceWithHttpInfo (string source, int operationIndex=0)
 [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteTransactionConfigurationSourceAsync (string source, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteTransactionConfigurationSourceWithHttpInfoAsync (string source, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
TransactionSetConfigurationData GetTransactionConfigurationSource (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found More...
 
Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationDataGetTransactionConfigurationSourceWithHttpInfo (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found More...
 
async System.Threading.Tasks.Task< TransactionSetConfigurationDataGetTransactionConfigurationSourceAsync (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > > GetTransactionConfigurationSourceWithHttpInfoAsync (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found More...
 
TransactionSetConfigurationData ListConfigurationTransactionTypes (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] ListConfigurationTransactionTypes: 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< TransactionSetConfigurationDataListConfigurationTransactionTypesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] ListConfigurationTransactionTypes: 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< TransactionSetConfigurationDataListConfigurationTransactionTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListConfigurationTransactionTypes: 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListConfigurationTransactionTypes: 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...
 
TransactionSetConfigurationData SetConfigurationTransactionTypes (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0)
 [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationDataSetConfigurationTransactionTypesWithHttpInfo (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0)
 [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< TransactionSetConfigurationDataSetConfigurationTransactionTypesAsync (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > > SetConfigurationTransactionTypesWithHttpInfoAsync (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
TransactionSetConfigurationData SetTransactionConfigurationSource (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0)
 [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationDataSetTransactionConfigurationSourceWithHttpInfo (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0)
 [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< TransactionSetConfigurationDataSetTransactionConfigurationSourceAsync (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TransactionSetConfigurationData > > SetTransactionConfigurationSourceWithHttpInfoAsync (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change. 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
configurationAn 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
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateConfigurationTransactionType()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionType ( TransactionConfigurationDataRequest transactionConfigurationDataRequest = default(TransactionConfigurationDataRequest?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionConfigurationDataRequestA transaction type definition. (optional)
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ CreateConfigurationTransactionTypeAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.CreateConfigurationTransactionTypeAsync ( TransactionConfigurationDataRequest transactionConfigurationDataRequest = default(TransactionConfigurationDataRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionConfigurationDataRequestA transaction type definition. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionConfigurationDataRequestA transaction type definition. (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionConfigurationDataRequestA transaction type definition. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ CreateSideDefinition()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.CreateSideDefinition ( SideConfigurationDataRequest sideConfigurationDataRequest = default(SideConfigurationDataRequest?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sideConfigurationDataRequestThe definition of the side. (optional)
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ CreateSideDefinitionAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.CreateSideDefinitionAsync ( SideConfigurationDataRequest sideConfigurationDataRequest = default(SideConfigurationDataRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sideConfigurationDataRequestThe definition of the side. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ CreateSideDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.CreateSideDefinitionWithHttpInfo ( SideConfigurationDataRequest sideConfigurationDataRequest = default(SideConfigurationDataRequest?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sideConfigurationDataRequestThe definition of the side. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ CreateSideDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.CreateSideDefinitionWithHttpInfoAsync ( SideConfigurationDataRequest sideConfigurationDataRequest = default(SideConfigurationDataRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] CreateSideDefinition: Create side definition Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sideConfigurationDataRequestThe definition of the side. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ DeleteTransactionConfigurationSource()

DeletedEntityResponse Lusid.Sdk.Api.SystemConfigurationApi.DeleteTransactionConfigurationSource ( string  source,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to delete transaction configurations for
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ DeleteTransactionConfigurationSourceAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.SystemConfigurationApi.DeleteTransactionConfigurationSourceAsync ( string  source,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to delete transaction configurations for
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ DeleteTransactionConfigurationSourceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.SystemConfigurationApi.DeleteTransactionConfigurationSourceWithHttpInfo ( string  source,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to delete transaction configurations for
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ DeleteTransactionConfigurationSourceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.SystemConfigurationApi.DeleteTransactionConfigurationSourceWithHttpInfoAsync ( string  source,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source /// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to delete transaction configurations for
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

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.

◆ GetTransactionConfigurationSource()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.GetTransactionConfigurationSource ( string  source,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source for which to retrieve transaction configurations
asAtThe asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ GetTransactionConfigurationSourceAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.GetTransactionConfigurationSourceAsync ( string  source,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source for which to retrieve transaction configurations
asAtThe asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ GetTransactionConfigurationSourceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.GetTransactionConfigurationSourceWithHttpInfo ( string  source,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source for which to retrieve transaction configurations
asAtThe asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ GetTransactionConfigurationSourceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.GetTransactionConfigurationSourceWithHttpInfoAsync ( string  source,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source Returns failure if requested source is not found

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source for which to retrieve transaction configurations
asAtThe asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ ListConfigurationTransactionTypes()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.ListConfigurationTransactionTypes ( DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListConfigurationTransactionTypes: 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ ListConfigurationTransactionTypesAsync()

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

[EARLY ACCESS] ListConfigurationTransactionTypes: 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListConfigurationTransactionTypes: 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndexIndex associated with the operation.
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?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListConfigurationTransactionTypes: 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ SetConfigurationTransactionTypes()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.SetConfigurationTransactionTypes ( TransactionSetConfigurationDataRequest transactionSetConfigurationDataRequest = default(TransactionSetConfigurationDataRequest?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionSetConfigurationDataRequestThe complete set of transaction type definitions. (optional)
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ SetConfigurationTransactionTypesAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.SetConfigurationTransactionTypesAsync ( TransactionSetConfigurationDataRequest transactionSetConfigurationDataRequest = default(TransactionSetConfigurationDataRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionSetConfigurationDataRequestThe complete set of transaction type definitions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ SetConfigurationTransactionTypesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.SetConfigurationTransactionTypesWithHttpInfo ( TransactionSetConfigurationDataRequest transactionSetConfigurationDataRequest = default(TransactionSetConfigurationDataRequest?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionSetConfigurationDataRequestThe complete set of transaction type definitions. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ SetConfigurationTransactionTypesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.SetConfigurationTransactionTypesWithHttpInfoAsync ( TransactionSetConfigurationDataRequest transactionSetConfigurationDataRequest = default(TransactionSetConfigurationDataRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
transactionSetConfigurationDataRequestThe complete set of transaction type definitions. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (TransactionSetConfigurationData)

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ SetTransactionConfigurationSource()

TransactionSetConfigurationData Lusid.Sdk.Api.SystemConfigurationApi.SetTransactionConfigurationSource ( string  source,
List< SetTransactionConfigurationSourceRequest setTransactionConfigurationSourceRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to set the transaction configurations for
setTransactionConfigurationSourceRequestThe set of transaction configurations
operationIndexIndex associated with the operation.
Returns
TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ SetTransactionConfigurationSourceAsync()

async System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.SetTransactionConfigurationSourceAsync ( string  source,
List< SetTransactionConfigurationSourceRequest setTransactionConfigurationSourceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to set the transaction configurations for
setTransactionConfigurationSourceRequestThe set of transaction configurations
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiAsync.

◆ SetTransactionConfigurationSourceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> Lusid.Sdk.Api.SystemConfigurationApi.SetTransactionConfigurationSourceWithHttpInfo ( string  source,
List< SetTransactionConfigurationSourceRequest setTransactionConfigurationSourceRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to set the transaction configurations for
setTransactionConfigurationSourceRequestThe set of transaction configurations
operationIndexIndex associated with the operation.
Returns
ApiResponse of TransactionSetConfigurationData

Implements Lusid.Sdk.Api.ISystemConfigurationApiSync.

◆ SetTransactionConfigurationSourceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.SystemConfigurationApi.SetTransactionConfigurationSourceWithHttpInfoAsync ( string  source,
List< SetTransactionConfigurationSourceRequest setTransactionConfigurationSourceRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sourceThe source to set the transaction configurations for
setTransactionConfigurationSourceRequestThe set of transaction configurations
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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: