sdk.lusid.api.fee_types_api.FeeTypesApi
- class FeeTypesApi(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] CreateFeeType: Create a FeeType.
[EXPERIMENTAL] CreateFeeType: Create a FeeType.
[EXPERIMENTAL] DeleteFeeType: Delete a FeeType.
[EXPERIMENTAL] DeleteFeeType: Delete a FeeType.
[EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType.
[EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType.
[EXPERIMENTAL] GetFeeType: Get a FeeType # noqa: E501
[EXPERIMENTAL] GetFeeType: Get a FeeType # noqa: E501
[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
[EXPERIMENTAL] UpdateFeeType: Update a FeeType.
[EXPERIMENTAL] UpdateFeeType: Update a FeeType.
- create_fee_type(scope, fee_type_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateFeeType: Create a FeeType. # noqa: E501
Create a FeeType that contains templates used to create fee transactions. # 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_fee_type(scope, fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
fee_type_request (FeeTypeRequest) – The contents of the FeeType. (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_fee_type_with_http_info(scope, fee_type_request, **kwargs)[source]
[EXPERIMENTAL] CreateFeeType: Create a FeeType. # noqa: E501
Create a FeeType that contains templates used to create fee transactions. # 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_fee_type_with_http_info(scope, fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
fee_type_request (FeeTypeRequest) – The contents of the FeeType. (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:
- delete_fee_type(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteFeeType: Delete a FeeType. # noqa: E501
Delete a FeeType that contains templates used to create fee transactions. # 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_fee_type(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
code (str) – The code of the 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_fee_type_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteFeeType: Delete a FeeType. # noqa: E501
Delete a FeeType that contains templates used to create fee transactions. # 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_fee_type_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
code (str) – The code of the 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_fee_template_specifications(async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType. # noqa: E501
Get FeeTemplateSpecifications used in the FeeType. # 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_fee_template_specifications(async_req=True) >>> result = thread.get()
- Parameters:
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_fee_template_specifications_with_http_info(**kwargs)[source]
[EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType. # noqa: E501
Get FeeTemplateSpecifications used in the FeeType. # 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_fee_template_specifications_with_http_info(async_req=True) >>> result = thread.get()
- Parameters:
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(FeeTransactionTemplateSpecification, status_code(int), headers(HTTPHeaderDict))
- get_fee_type(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetFeeType: Get a FeeType # noqa: E501
Get a FeeType that contains templates used to create fee transactions. # 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_fee_type(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType (required)
code (str) – The code of the FeeType (required)
as_at (datetime) – The asAt datetime at which to retrieve the FeeType. Defaults to returning the latest version of the FeeType, if not specified.
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_fee_type_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetFeeType: Get a FeeType # noqa: E501
Get a FeeType that contains templates used to create fee transactions. # 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_fee_type_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType (required)
code (str) – The code of the FeeType (required)
as_at (datetime) – The asAt datetime at which to retrieve the FeeType. Defaults to returning the latest version of the FeeType, 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. 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:
- list_fee_types(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
List FeeTypes that contain templates used to create fee transactions. # 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_fee_types(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.
page (str) – The pagination token to use to continue listing FeeTypes; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the Code of the FeeType type, specify “id.Code eq ‘FeeType1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”
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_fee_types_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListFeeTypes: List FeeTypes # noqa: E501
List FeeTypes that contain templates used to create fee transactions. # 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_fee_types_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the FeeTypes. Defaults to returning the latest version of each FeeType if not specified.
page (str) – The pagination token to use to continue listing FeeTypes; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the Code of the FeeType type, specify “id.Code eq ‘FeeType1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”
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(PagedResourceListOfFeeType, status_code(int), headers(HTTPHeaderDict))
- update_fee_type(scope, code, update_fee_type_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateFeeType: Update a FeeType. # noqa: E501
Update a FeeType that contains templates used to create fee transactions. # 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_fee_type(scope, code, update_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
code (str) – The code of the fee type (required)
update_fee_type_request (UpdateFeeTypeRequest) – The contents of the FeeType. (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_fee_type_with_http_info(scope, code, update_fee_type_request, **kwargs)[source]
[EXPERIMENTAL] UpdateFeeType: Update a FeeType. # noqa: E501
Update a FeeType that contains templates used to create fee transactions. # 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_fee_type_with_http_info(scope, code, update_fee_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the FeeType. (required)
code (str) – The code of the fee type (required)
update_fee_type_request (UpdateFeeTypeRequest) – The contents of the FeeType. (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: