sdk.lusid.api.abor_configuration_api.AborConfigurationApi
- class AborConfigurationApi(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] CreateAborConfiguration: Create an AborConfiguration.
[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
- create_abor_configuration(scope, abor_configuration_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. # noqa: E501
Create the given AborConfiguration. # 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_abor_configuration(scope, abor_configuration_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration. (required)
abor_configuration_request (AborConfigurationRequest) – The definition of the AborConfiguration. (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_abor_configuration_with_http_info(scope, abor_configuration_request, **kwargs)[source]
[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. # noqa: E501
Create the given AborConfiguration. # 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_abor_configuration_with_http_info(scope, abor_configuration_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration. (required)
abor_configuration_request (AborConfigurationRequest) – The definition of the AborConfiguration. (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(AborConfiguration, status_code(int), headers(HTTPHeaderDict))
- delete_abor_configuration(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. # noqa: E501
Delete the given AborConfiguration. # 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_abor_configuration(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration to be deleted. (required)
code (str) – The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration. (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_abor_configuration_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. # noqa: E501
Delete the given AborConfiguration. # 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_abor_configuration_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration to be deleted. (required)
code (str) – The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration. (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_abor_configuration(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. # noqa: E501
Retrieve the definition of a particular AborConfiguration. # 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_abor_configuration(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration. (required)
code (str) – The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘AborConfiguration’ domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example ‘AborConfiguration/Manager/Id’. If no properties are specified, then no properties will be returned.
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_abor_configuration_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. # noqa: E501
Retrieve the definition of a particular AborConfiguration. # 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_abor_configuration_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration. (required)
code (str) – The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘AborConfiguration’ domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example ‘AborConfiguration/Manager/Id’. If no properties are specified, then no properties will be returned.
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(AborConfiguration, status_code(int), headers(HTTPHeaderDict))
- list_abor_configurations(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. # noqa: E501
List all the AborConfiguration matching particular 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_abor_configurations(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.
page (str) – The pagination token to use to continue listing AborConfiguration; 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 AborConfiguration type, specify “id.Code eq ‘AborConfiguration1’”. 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”.
property_keys (List[str]) – A list of property keys from the ‘AborConfiguration’ domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example ‘AborConfiguration/Manager/Id’.
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_abor_configurations_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. # noqa: E501
List all the AborConfiguration matching particular 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_abor_configurations_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 or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified.
page (str) – The pagination token to use to continue listing AborConfiguration; 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 AborConfiguration type, specify “id.Code eq ‘AborConfiguration1’”. 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”.
property_keys (List[str]) – A list of property keys from the ‘AborConfiguration’ domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example ‘AborConfiguration/Manager/Id’.
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(PagedResourceListOfAborConfiguration, status_code(int), headers(HTTPHeaderDict))
- upsert_abor_configuration_properties(scope, code, request_body=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘AborConfiguration’. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_abor_configuration_properties(scope, code, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration to update or insert the properties onto. (required)
code (str) – The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “AborConfiguration/Manager/Id”.
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:
- upsert_abor_configuration_properties_with_http_info(scope, code, request_body=None, **kwargs)[source]
[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties # noqa: E501
Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘AborConfiguration’. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_abor_configuration_properties_with_http_info(scope, code, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the AborConfiguration to update or insert the properties onto. (required)
code (str) – The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “AborConfiguration/Manager/Id”.
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(AborConfigurationProperties, status_code(int), headers(HTTPHeaderDict))