sdk.lusid.api.system_configuration_api.SystemConfigurationApi
- class SystemConfigurationApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type # noqa: E501
[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type # noqa: E501
[EXPERIMENTAL] CreateSideDefinition: Create side definition # noqa: E501
[EXPERIMENTAL] CreateSideDefinition: Create side definition # noqa: E501
[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
- create_configuration_transaction_type(transaction_configuration_data_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type # noqa: E501
Create a new transaction type by specifying a definition and mappings to movements. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_configuration_transaction_type(transaction_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_configuration_data_request (TransactionConfigurationDataRequest) – A transaction type definition.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_configuration_transaction_type_with_http_info(transaction_configuration_data_request=None, **kwargs)[source]
[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type # noqa: E501
Create a new transaction type by specifying a definition and mappings to movements. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_configuration_transaction_type_with_http_info(transaction_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_configuration_data_request (TransactionConfigurationDataRequest) – A transaction type definition.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))
- create_side_definition(side_configuration_data_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateSideDefinition: Create side definition # noqa: E501
Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_side_definition(side_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
side_configuration_data_request (SideConfigurationDataRequest) – The definition of the side.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_side_definition_with_http_info(side_configuration_data_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateSideDefinition: Create side definition # noqa: E501
Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_side_definition_with_http_info(side_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
side_configuration_data_request (SideConfigurationDataRequest) – The definition of the side.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))
- delete_transaction_configuration_source(source, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
/// 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transaction_configuration_source(source, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to delete transaction configurations for (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_transaction_configuration_source_with_http_info(source, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source # noqa: E501
/// 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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_transaction_configuration_source_with_http_info(source, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to delete transaction configurations for (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
- get_transaction_configuration_source(source, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
Returns failure if requested source is not found # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transaction_configuration_source(source, as_at, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source for which to retrieve transaction configurations (required)
as_at (datetime) – The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_transaction_configuration_source_with_http_info(source, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source # noqa: E501
Returns failure if requested source is not found # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transaction_configuration_source_with_http_info(source, as_at, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source for which to retrieve transaction configurations (required)
as_at (datetime) – The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))
- list_configuration_transaction_types(as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
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/. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_configuration_transaction_types(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_configuration_transaction_types_with_http_info(as_at=None, **kwargs)[source]
[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types # noqa: E501
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/. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_configuration_transaction_types_with_http_info(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))
- set_configuration_transaction_types(transaction_set_configuration_data_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_configuration_transaction_types(transaction_set_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_set_configuration_data_request (TransactionSetConfigurationDataRequest) – The complete set of transaction type definitions.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- set_configuration_transaction_types_with_http_info(transaction_set_configuration_data_request=None, **kwargs)[source]
[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_configuration_transaction_types_with_http_info(transaction_set_configuration_data_request, async_req=True) >>> result = thread.get()
- Parameters:
transaction_set_configuration_data_request (TransactionSetConfigurationDataRequest) – The complete set of transaction type definitions.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))
- set_transaction_configuration_source(source, set_transaction_configuration_source_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_transaction_configuration_source(source, set_transaction_configuration_source_request, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction configurations for (required)
set_transaction_configuration_source_request (List[SetTransactionConfigurationSourceRequest]) – The set of transaction configurations (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- set_transaction_configuration_source_with_http_info(source, set_transaction_configuration_source_request, **kwargs)[source]
[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source # noqa: E501
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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_transaction_configuration_source_with_http_info(source, set_transaction_configuration_source_request, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction configurations for (required)
set_transaction_configuration_source_request (List[SetTransactionConfigurationSourceRequest]) – The set of transaction configurations (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(TransactionSetConfigurationData, status_code(int), headers(HTTPHeaderDict))