sdk.lusid.api.amortisation_rule_sets_api.AmortisationRuleSetsApi
- class AmortisationRuleSetsApi(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] CreateAmortisationRuleSet: Create an amortisation rule set.
[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set.
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set.
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set.
[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets.
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets.
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set.
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set.
- create_amortisation_rule_set(scope, create_amortisation_rule_set_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. # noqa: E501
Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # 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_amortisation_rule_set(scope, create_amortisation_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the rule set. (required)
create_amortisation_rule_set_request (CreateAmortisationRuleSetRequest) – The contents of the rule set. (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:
- create_amortisation_rule_set_with_http_info(scope, create_amortisation_rule_set_request, **kwargs)[source]
[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. # noqa: E501
Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. # 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_amortisation_rule_set_with_http_info(scope, create_amortisation_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the rule set. (required)
create_amortisation_rule_set_request (CreateAmortisationRuleSetRequest) – The contents of the rule set. (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(AmortisationRuleSet, status_code(int), headers(HTTPHeaderDict))
- delete_amortisation_ruleset(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. # noqa: E501
<br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. # 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_amortisation_ruleset(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (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_amortisation_ruleset_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. # noqa: E501
<br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. # 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_amortisation_ruleset_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (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_amortisation_rule_set(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
Retrieves the amortisation rule set definition at the given effective and as at times. # 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_amortisation_rule_set(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version 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_amortisation_rule_set_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set # noqa: E501
Retrieves the amortisation rule set definition at the given effective and as at times. # 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_amortisation_rule_set_with_http_info(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version 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(AmortisationRuleSet, status_code(int), headers(HTTPHeaderDict))
- list_amortisation_rule_sets(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. # noqa: E501
Retrieves all amortisation rule sets at the given effective and as at times # 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_amortisation_rule_sets(effective_at, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing AmortisationRuleSets; 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 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 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_amortisation_rule_sets_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. # noqa: E501
Retrieves all amortisation rule sets at the given effective and as at times # 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_amortisation_rule_sets_with_http_info(effective_at, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing AmortisationRuleSets; 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 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 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(PagedResourceListOfAmortisationRuleSet, status_code(int), headers(HTTPHeaderDict))
- update_amortisation_rule_set_details(scope, code, update_amortisation_rule_set_details_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. # noqa: E501
Updates the amortisation rule set definition for all effective time. # 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_amortisation_rule_set_details(scope, code, update_amortisation_rule_set_details_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
update_amortisation_rule_set_details_request (UpdateAmortisationRuleSetDetailsRequest) – The contents of the rule set. (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:
- update_amortisation_rule_set_details_with_http_info(scope, code, update_amortisation_rule_set_details_request, **kwargs)[source]
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. # noqa: E501
Updates the amortisation rule set definition for all effective time. # 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_amortisation_rule_set_details_with_http_info(scope, code, update_amortisation_rule_set_details_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The rule set scope. (required)
code (str) – The rule set code. (required)
update_amortisation_rule_set_details_request (UpdateAmortisationRuleSetDetailsRequest) – The contents of the rule set. (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(AmortisationRuleSet, status_code(int), headers(HTTPHeaderDict))