sdk.lusid.api.transaction_configuration_api.TransactionConfigurationApi
- class TransactionConfigurationApi(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
DeleteSideDefinition: Delete the given side definition # noqa: E501
DeleteSideDefinition: Delete the given side definition # noqa: E501
DeleteTransactionType: Delete a transaction type # noqa: E501
DeleteTransactionTypeSource: Delete all transaction types for the given source and scope # noqa: E501
DeleteTransactionTypeSource: Delete all transaction types for the given source and scope # noqa: E501
DeleteTransactionType: Delete a transaction type # noqa: E501
GetSideDefinition: Get the side definition for a given side name( or label) # noqa: E501
GetSideDefinition: Get the side definition for a given side name( or label) # noqa: E501
GetTransactionType: Get a single transaction configuration type # noqa: E501
GetTransactionType: Get a single transaction configuration type # noqa: E501
ListSideDefinitions: List the side definitions # noqa: E501
ListSideDefinitions: List the side definitions # noqa: E501
ListTransactionTypes: List transaction types # noqa: E501
ListTransactionTypes: List transaction types # noqa: E501
SetSideDefinition: Set a side definition # noqa: E501
SetSideDefinition: Set a side definition # noqa: E501
SetSideDefinitions: Set the given side definitions # noqa: E501
SetSideDefinitions: Set the given side definitions # noqa: E501
SetTransactionType: Set a specific transaction type # noqa: E501
SetTransactionTypeSource: Set the transaction types for the given source and scope # noqa: E501
SetTransactionTypeSource: Set the transaction types for the given source and scope # noqa: E501
SetTransactionType: Set a specific transaction type # noqa: E501
- delete_side_definition(side, scope=None, async_req=None, **kwargs)[source]
DeleteSideDefinition: Delete the given side definition # noqa: E501
Delete the side which user specify in the request. # 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_side_definition(side, scope, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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_side_definition_with_http_info(side, scope=None, **kwargs)[source]
DeleteSideDefinition: Delete the given side definition # noqa: E501
Delete the side which user specify in the request. # 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_side_definition_with_http_info(side, scope, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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))
- delete_transaction_type(source, type, scope=None, async_req=None, **kwargs)[source]
DeleteTransactionType: Delete a transaction type # 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_type(source, type, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source that the type is in (required)
type (str) – One of the type’s aliases (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_type_source(source, scope=None, async_req=None, **kwargs)[source]
DeleteTransactionTypeSource: Delete all transaction types for the given source and scope # noqa: E501
Delete all the types for the given source and scope. # 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_type_source(source, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction types for. (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_type_source_with_http_info(source, scope=None, **kwargs)[source]
DeleteTransactionTypeSource: Delete all transaction types for the given source and scope # noqa: E501
Delete all the types for the given source and scope. # 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_type_source_with_http_info(source, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction types for. (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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))
- delete_transaction_type_with_http_info(source, type, scope=None, **kwargs)[source]
DeleteTransactionType: Delete a transaction type # 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_type_with_http_info(source, type, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source that the type is in (required)
type (str) – One of the type’s aliases (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_side_definition(side, scope=None, as_at=None, async_req=None, **kwargs)[source]
GetSideDefinition: Get the side definition for a given side name( or label) # noqa: E501
Get the side definition user requested. # 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_side_definition(side, scope, as_at, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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:
- get_side_definition_with_http_info(side, scope=None, as_at=None, **kwargs)[source]
GetSideDefinition: Get the side definition for a given side name( or label) # noqa: E501
Get the side definition user requested. # 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_side_definition_with_http_info(side, scope, as_at, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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(SideDefinition, status_code(int), headers(HTTPHeaderDict))
- get_transaction_type(source, type, as_at=None, scope=None, async_req=None, **kwargs)[source]
GetTransactionType: Get a single transaction configuration type # noqa: E501
Get a single transaction type. Returns failure if 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_type(source, type, as_at, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source that the type is in (required)
type (str) – One of the type’s aliases (required)
as_at (datetime) – The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_type_with_http_info(source, type, as_at=None, scope=None, **kwargs)[source]
GetTransactionType: Get a single transaction configuration type # noqa: E501
Get a single transaction type. Returns failure if 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_type_with_http_info(source, type, as_at, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source that the type is in (required)
type (str) – One of the type’s aliases (required)
as_at (datetime) – The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type if not specified
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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(TransactionType, status_code(int), headers(HTTPHeaderDict))
- list_side_definitions(as_at=None, scope=None, async_req=None, **kwargs)[source]
ListSideDefinitions: List the side definitions # noqa: E501
List all the side definitions in the given scope # 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_side_definitions(as_at, scope, 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.
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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_side_definitions_with_http_info(as_at=None, scope=None, **kwargs)[source]
ListSideDefinitions: List the side definitions # noqa: E501
List all the side definitions in the given scope # 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_side_definitions_with_http_info(as_at, scope, 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.
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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(ResourceListOfSideDefinition, status_code(int), headers(HTTPHeaderDict))
- list_transaction_types(as_at=None, scope=None, async_req=None, **kwargs)[source]
ListTransactionTypes: 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_transaction_types(as_at, scope, 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.
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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:
Dict[str, List[TransactionType]]
- list_transaction_types_with_http_info(as_at=None, scope=None, **kwargs)[source]
ListTransactionTypes: 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_transaction_types_with_http_info(as_at, scope, 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.
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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(Dict[str, List[TransactionType]], status_code(int), headers(HTTPHeaderDict))
- set_side_definition(side, side_definition_request, scope=None, async_req=None, **kwargs)[source]
SetSideDefinition: Set a side definition # noqa: E501
Set 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.set_side_definition(side, side_definition_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
side_definition_request (SideDefinitionRequest) – The side definition to create or replace. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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_side_definition_with_http_info(side, side_definition_request, scope=None, **kwargs)[source]
SetSideDefinition: Set a side definition # noqa: E501
Set 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.set_side_definition_with_http_info(side, side_definition_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
side (str) – The label to uniquely identify the side. (required)
side_definition_request (SideDefinitionRequest) – The side definition to create or replace. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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(SideDefinition, status_code(int), headers(HTTPHeaderDict))
- set_side_definitions(sides_definition_request, scope=None, async_req=None, **kwargs)[source]
SetSideDefinitions: Set the given side definitions # noqa: E501
Set 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.set_side_definitions(sides_definition_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
sides_definition_request (List[SidesDefinitionRequest]) – The list of side definitions to create, or replace. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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_side_definitions_with_http_info(sides_definition_request, scope=None, **kwargs)[source]
SetSideDefinitions: Set the given side definitions # noqa: E501
Set 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.set_side_definitions_with_http_info(sides_definition_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
sides_definition_request (List[SidesDefinitionRequest]) – The list of side definitions to create, or replace. (required)
scope (str) – The scope in which the side exists. When not supplied the scope is ‘default’.
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(ResourceListOfSideDefinition, status_code(int), headers(HTTPHeaderDict))
- set_transaction_type(source, type, transaction_type_request, scope=None, async_req=None, **kwargs)[source]
SetTransactionType: Set a specific transaction type # noqa: E501
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created 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_type(source, type, transaction_type_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction configuration for (required)
type (str) – One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type (required)
transaction_type_request (TransactionTypeRequest) – The transaction configuration to set (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_type_source(source, transaction_type_request, scope=None, async_req=None, **kwargs)[source]
SetTransactionTypeSource: Set the transaction types for the given source and scope # noqa: E501
The complete set of transaction types for the source. # 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_type_source(source, transaction_type_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction types for. (required)
transaction_type_request (List[TransactionTypeRequest]) – The set of transaction types. (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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_type_source_with_http_info(source, transaction_type_request, scope=None, **kwargs)[source]
SetTransactionTypeSource: Set the transaction types for the given source and scope # noqa: E501
The complete set of transaction types for the source. # 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_type_source_with_http_info(source, transaction_type_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction types for. (required)
transaction_type_request (List[TransactionTypeRequest]) – The set of transaction types. (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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(ResourceListOfTransactionType, status_code(int), headers(HTTPHeaderDict))
- set_transaction_type_with_http_info(source, type, transaction_type_request, scope=None, **kwargs)[source]
SetTransactionType: Set a specific transaction type # noqa: E501
Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created 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_type_with_http_info(source, type, transaction_type_request, scope, async_req=True) >>> result = thread.get()
- Parameters:
source (str) – The source to set the transaction configuration for (required)
type (str) – One of the transaction configuration alias types to uniquely identify the configuration. If this type does not exist, then a new transaction type is created using the body of the request in the given source, without including this type (required)
transaction_type_request (TransactionTypeRequest) – The transaction configuration to set (required)
scope (str) – The scope in which the transaction types exists. When not supplied the scope is ‘default’.
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(TransactionType, status_code(int), headers(HTTPHeaderDict))