sdk.lusid.api.transaction_fee_types_api.TransactionFeeTypesApi
- class TransactionFeeTypesApi(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
[EXPERIMENTAL] CreateTransactionFeeType: Create a transaction fee type # noqa: E501
[EXPERIMENTAL] CreateTransactionFeeType: Create a transaction fee type # noqa: E501
[EXPERIMENTAL] DeleteTransactionFeeType: Delete a transaction fee type # noqa: E501
[EXPERIMENTAL] DeleteTransactionFeeType: Delete a transaction fee type # noqa: E501
[EXPERIMENTAL] GetTransactionFeeType: Get a transaction fee type # noqa: E501
[EXPERIMENTAL] GetTransactionFeeType: Get a transaction fee type # noqa: E501
[EXPERIMENTAL] ListTransactionFeeTypes: List transaction fee types # noqa: E501
[EXPERIMENTAL] ListTransactionFeeTypes: List transaction fee types # noqa: E501
[EXPERIMENTAL] UpdateTransactionFeeType: Update a transaction fee type # noqa: E501
[EXPERIMENTAL] UpdateTransactionFeeType: Update a transaction fee type # noqa: E501
- create_transaction_fee_type(scope, code, create_transaction_fee_type_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateTransactionFeeType: Create a transaction fee type # noqa: E501
Create a transaction fee type for the specified scope and code. # 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_transaction_fee_type(scope, code, create_transaction_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
create_transaction_fee_type_request (CreateTransactionFeeTypeRequest) – The contents of the transaction fee type. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_transaction_fee_type_with_http_info(scope, code, create_transaction_fee_type_request, **kwargs)[source]
[EXPERIMENTAL] CreateTransactionFeeType: Create a transaction fee type # noqa: E501
Create a transaction fee type for the specified scope and code. # 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_transaction_fee_type_with_http_info(scope, code, create_transaction_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
create_transaction_fee_type_request (CreateTransactionFeeTypeRequest) – The contents of the transaction fee type. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(TransactionFeeType, status_code(int), headers(HTTPHeaderDict))
- delete_transaction_fee_type(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionFeeType: Delete a transaction fee type # noqa: E501
Delete a transaction fee type for the specified scope and code. To note, this will be a monotemporal delete, meaning that the transaction fee type will be deleted for all effective time (including past and future versions of the transaction fee type). # 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_fee_type(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_transaction_fee_type_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionFeeType: Delete a transaction fee type # noqa: E501
Delete a transaction fee type for the specified scope and code. To note, this will be a monotemporal delete, meaning that the transaction fee type will be deleted for all effective time (including past and future versions of the transaction fee type). # 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_fee_type_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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_fee_type(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionFeeType: Get a transaction fee type # noqa: E501
Get the transaction fee type for the specified scope and code. # 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_fee_type(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
effective_at (str) – The effective datetime at which to retrieve the transaction fee type properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified.
property_keys (List[str]) – The collection of `PropertyKey`s that we want to decorate on the transaction fee type.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_transaction_fee_type_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionFeeType: Get a transaction fee type # noqa: E501
Get the transaction fee type for the specified scope and code. # 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_fee_type_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
effective_at (str) – The effective datetime at which to retrieve the transaction fee type properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified.
property_keys (List[str]) – The collection of `PropertyKey`s that we want to decorate on the transaction fee type.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(TransactionFeeType, status_code(int), headers(HTTPHeaderDict))
- list_transaction_fee_types(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionFeeTypes: List transaction fee types # noqa: E501
List transaction fee types that match the specified criteria. # 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_fee_types(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime at which to retrieve transaction fee type properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified.
page (str) – The pagination token to use to continue listing transaction fee types from a previous call to list transaction fee types. This value is returned from the previous call. If a pagination token is provided the filter, sortBy, effectiveAt and asAt field must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘ExampleScope’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
property_keys (List[str]) – The collection of `PropertyKey`s to filter on
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_transaction_fee_types_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionFeeTypes: List transaction fee types # noqa: E501
List transaction fee types that match the specified criteria. # 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_fee_types_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime at which to retrieve transaction fee type properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the transaction fee types. Defaults to latest if not specified.
page (str) – The pagination token to use to continue listing transaction fee types from a previous call to list transaction fee types. This value is returned from the previous call. If a pagination token is provided the filter, sortBy, effectiveAt and asAt field must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Scope, use “scope eq ‘ExampleScope’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
property_keys (List[str]) – The collection of `PropertyKey`s to filter on
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(ResourceListOfTransactionFeeType, status_code(int), headers(HTTPHeaderDict))
- update_transaction_fee_type(scope, code, update_transaction_fee_type_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateTransactionFeeType: Update a transaction fee type # noqa: E501
Update a transaction fee type by providing the new contents of the transaction fee type. The displayName field cannot be updated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_transaction_fee_type(scope, code, update_transaction_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
update_transaction_fee_type_request (UpdateTransactionFeeTypeRequest) – The updated contents of the transaction fee type. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- update_transaction_fee_type_with_http_info(scope, code, update_transaction_fee_type_request, **kwargs)[source]
[EXPERIMENTAL] UpdateTransactionFeeType: Update a transaction fee type # noqa: E501
Update a transaction fee type by providing the new contents of the transaction fee type. The displayName field cannot be updated. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_transaction_fee_type_with_http_info(scope, code, update_transaction_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the transaction fee type. (required)
code (str) – The code of the specified transaction fee type. Together with the scope this uniquely identifies the transaction fee type. (required)
update_transaction_fee_type_request (UpdateTransactionFeeTypeRequest) – The updated contents of the transaction fee type. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(TransactionFeeType, status_code(int), headers(HTTPHeaderDict))