sdk.lusid.api.resource_record_api.ResourceRecordApi

class ResourceRecordApi(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

`delete_resource_record`	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record # noqa: E501
`delete_resource_record_with_http_info`	[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record # noqa: E501
`get_resource_record`	[EARLY ACCESS] GetResourceRecord: Get a Resource Record # noqa: E501
`get_resource_record_with_http_info`	[EARLY ACCESS] GetResourceRecord: Get a Resource Record # noqa: E501
`list_resource_record_codes`	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope # noqa: E501
`list_resource_record_codes_with_http_info`	[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope # noqa: E501
`list_resource_record_scopes`	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes # noqa: E501
`list_resource_record_scopes_with_http_info`	[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes # noqa: E501
`list_resource_records`	[EARLY ACCESS] ListResourceRecords: List Resource Records # noqa: E501
`list_resource_records_with_http_info`	[EARLY ACCESS] ListResourceRecords: List Resource Records # noqa: E501
`upsert_resource_record`	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record # noqa: E501
`upsert_resource_record_with_http_info`	[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record # noqa: E501

delete_resource_record(scope, code, resource_id, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record # noqa: E501

Delete a resource record. # 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_resource_record(scope, code, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
resource_id (str) – The resource identifier of the resource record. (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:

DeletedEntityResponse

delete_resource_record_with_http_info(scope, code, resource_id, **kwargs)[source]

[EARLY ACCESS] DeleteResourceRecord: Delete a Resource Record # noqa: E501

Delete a resource record. # 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_resource_record_with_http_info(scope, code, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
resource_id (str) – The resource identifier of the resource record. (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_resource_record(scope, code, resource_id, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetResourceRecord: Get a Resource Record # noqa: E501

Retrieve a resource record by its identifier. # 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_resource_record(scope, code, resource_id, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
resource_id (str) – The resource identifier of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. 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:

ResourceRecord

get_resource_record_with_http_info(scope, code, resource_id, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetResourceRecord: Get a Resource Record # noqa: E501

Retrieve a resource record by its identifier. # 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_resource_record_with_http_info(scope, code, resource_id, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
resource_id (str) – The resource identifier of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. 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(ResourceRecord, status_code(int), headers(HTTPHeaderDict))

list_resource_record_codes(scope, as_at=None, sort_order=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope # noqa: E501

List all resource records 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_resource_record_codes(scope, as_at, sort_order, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
sort_order (str) – Order of the sort - either “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:

ResourceListOfString

list_resource_record_codes_with_http_info(scope, as_at=None, sort_order=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecordCodes: List Resource Records Codes for Scope # noqa: E501

List all resource records 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_resource_record_codes_with_http_info(scope, as_at, sort_order, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
sort_order (str) – Order of the sort - either “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(ResourceListOfString, status_code(int), headers(HTTPHeaderDict))

list_resource_record_scopes(as_at=None, page=None, limit=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes # noqa: E501

List all resource records 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_resource_record_scopes(as_at, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing resource records from a previous call.
limit (int) – When paginating, limit the number of returned results to this many.
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:

ResourceListOfScopeDefinition

list_resource_record_scopes_with_http_info(as_at=None, page=None, limit=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecordScopes: List Resource Record Scopes # noqa: E501

List all resource records 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_resource_record_scopes_with_http_info(as_at, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing resource records from a previous call.
limit (int) – When paginating, limit the number of returned results to this many.
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(ResourceListOfScopeDefinition, status_code(int), headers(HTTPHeaderDict))

list_resource_records(scope, code, as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecords: List Resource Records # noqa: E501

List all resource records 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_resource_records(scope, code, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing resource records from a previous call.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set.
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:

PagedResourceListOfResourceRecord

list_resource_records_with_http_info(scope, code, as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]

[EARLY ACCESS] ListResourceRecords: List Resource Records # noqa: E501

List all resource records 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_resource_records_with_http_info(scope, code, as_at, page, sort_by, limit, filter, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the resource record. (required)
code (str) – The code of the resource record. (required)
as_at (datetime) – The asAt datetime at which to list the resource record. Defaults to return the latest version if not specified.
page (str) – The pagination token to use to continue listing resource records from a previous call.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set.
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(PagedResourceListOfResourceRecord, status_code(int), headers(HTTPHeaderDict))

upsert_resource_record(upsert_resource_record_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record # noqa: E501

Create or update a resource record. # 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_resource_record(upsert_resource_record_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_resource_record_request (UpsertResourceRecordRequest) – The resource record to upsert. (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:

ResourceRecord

upsert_resource_record_with_http_info(upsert_resource_record_request, **kwargs)[source]

[EARLY ACCESS] UpsertResourceRecord: Upsert a Resource Record # noqa: E501

Create or update a resource record. # 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_resource_record_with_http_info(upsert_resource_record_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_resource_record_request (UpsertResourceRecordRequest) – The resource record to upsert. (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(ResourceRecord, status_code(int), headers(HTTPHeaderDict))