sdk.lusid.api.address_key_definition_api.AddressKeyDefinitionApi
- class AddressKeyDefinitionApi(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
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
- create_address_key_definition(create_address_key_definition_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. # noqa: E501
Create the given address key definition. # 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_address_key_definition(create_address_key_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_address_key_definition_request (CreateAddressKeyDefinitionRequest) – The request used to create the address key definition. (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_address_key_definition_with_http_info(create_address_key_definition_request, **kwargs)[source]
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. # noqa: E501
Create the given address key definition. # 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_address_key_definition_with_http_info(create_address_key_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_address_key_definition_request (CreateAddressKeyDefinitionRequest) – The request used to create the address key definition. (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(AddressKeyDefinition, status_code(int), headers(HTTPHeaderDict))
- get_address_key_definition(key, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. # noqa: E501
Get the address key definition with the given address key at the specific asAt 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.get_address_key_definition(key, as_at, async_req=True) >>> result = thread.get()
- Parameters:
key (str) – The address key of the address key definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition 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_address_key_definition_with_http_info(key, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. # noqa: E501
Get the address key definition with the given address key at the specific asAt 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.get_address_key_definition_with_http_info(key, as_at, async_req=True) >>> result = thread.get()
- Parameters:
key (str) – The address key of the address key definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition 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(AddressKeyDefinition, status_code(int), headers(HTTPHeaderDict))
- list_address_key_definitions(as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. # noqa: E501
Fetch the last pre-AsAt date version of each address key definition. # 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_address_key_definitions(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.
page (str) – The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
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_address_key_definitions_with_http_info(as_at=None, page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. # noqa: E501
Fetch the last pre-AsAt date version of each address key definition. # 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_address_key_definitions_with_http_info(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified.
page (str) – The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
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(PagedResourceListOfAddressKeyDefinition, status_code(int), headers(HTTPHeaderDict))