sdk.lusid.api.address_key_alias_api.AddressKeyAliasApi
- class AddressKeyAliasApi(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] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present.
[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present.
[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias # noqa: E501
[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias # noqa: E501
[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases # noqa: E501
[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases # noqa: E501
[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias.
[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias.
- delete_address_key_alias(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. # noqa: E501
Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. # 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_address_key_alias(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Address Key Alias to delete. (required)
code (str) – The Address Key Alias to delete. (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_address_key_alias_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteAddressKeyAlias: Delete an Address Key Alias, assuming that it is present. # noqa: E501
Delete the specified Address Key Alias from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. # 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_address_key_alias_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Address Key Alias to delete. (required)
code (str) – The Address Key Alias to delete. (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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- get_address_key_alias(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias # noqa: E501
Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. # 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_alias(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Address Key Alias to retrieve. (required)
code (str) – The code of the alias to retrieve. (required)
as_at (datetime) – The asAt datetime at which to retrieve the alias. Defaults to return the latest version 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_address_key_alias_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetAddressKeyAlias: Get Address Key Alias # noqa: E501
Get an Address Key Alias from a single scope. The response will return either the alias that has been stored, or a failure explaining why the request was unsuccessful. # 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_alias_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Address Key Alias to retrieve. (required)
code (str) – The code of the alias to retrieve. (required)
as_at (datetime) – The asAt datetime at which to retrieve the alias. Defaults to return 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. 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(GetAddressKeyAliasResponse, status_code(int), headers(HTTPHeaderDict))
- list_address_key_aliases(scope, as_at=None, filter=None, limit=None, page=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases # noqa: E501
List the set of address key aliases at the specified date/time and scope. # 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_aliases(scope, as_at, filter, limit, page, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to list aliases for. (required)
as_at (datetime) – The asAt datetime at which to list the aliases. Defaults to latest if not specified.
filter (str) – Expression to filter the result set.
limit (int) – Maximum number of results to return. Defaults to 100.
page (str) – Pagination token from a previous result to fetch the next page.
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_address_key_aliases_with_http_info(scope, as_at=None, filter=None, limit=None, page=None, **kwargs)[source]
[EXPERIMENTAL] ListAddressKeyAliases: List the set of Address Key Aliases # noqa: E501
List the set of address key aliases at the specified date/time and scope. # 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_aliases_with_http_info(scope, as_at, filter, limit, page, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to list aliases for. (required)
as_at (datetime) – The asAt datetime at which to list the aliases. Defaults to latest if not specified.
filter (str) – Expression to filter the result set.
limit (int) – Maximum number of results to return. Defaults to 100.
page (str) – Pagination token from a previous result to fetch the next page.
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(PagedResourceListOfGetAddressKeyAliasResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_address_key_alias(upsert_address_key_alias_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. # noqa: E501
Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. # 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_address_key_alias(upsert_address_key_alias_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_address_key_alias_request (UpsertAddressKeyAliasRequest) – The Address Key Alias to update or insert (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:
- upsert_address_key_alias_with_http_info(upsert_address_key_alias_request, **kwargs)[source]
[EXPERIMENTAL] UpsertAddressKeyAlias: Upsert an Address Key Alias. This creates or updates the alias in LUSID. # noqa: E501
Update or insert one Address Key Alias. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted alias or failure message if unsuccessful. # 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_address_key_alias_with_http_info(upsert_address_key_alias_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_address_key_alias_request (UpsertAddressKeyAliasRequest) – The Address Key Alias to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))