sdk.lusid.api.blocks_api.BlocksApi
- class BlocksApi(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] DeleteBlock: Delete block # noqa: E501
[EARLY ACCESS] DeleteBlock: Delete block # noqa: E501
[EARLY ACCESS] GetBlock: Get Block # noqa: E501
[EARLY ACCESS] GetBlock: Get Block # noqa: E501
[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
[EARLY ACCESS] UpsertBlocks: Upsert Block # noqa: E501
[EARLY ACCESS] UpsertBlocks: Upsert Block # noqa: E501
- delete_block(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteBlock: Delete block # noqa: E501
Delete an block. Deletion will be valid from the block’s creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. # 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_block(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The block scope. (required)
code (str) – The block’s code. This, together with the scope uniquely identifies the block to delete. (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_block_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteBlock: Delete block # noqa: E501
Delete an block. Deletion will be valid from the block’s creation datetime. This means that the block will no longer exist at any effective datetime from the asAt datetime of deletion. # 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_block_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The block scope. (required)
code (str) – The block’s code. This, together with the scope uniquely identifies the block 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 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_block(scope, code, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetBlock: Get Block # noqa: E501
Fetch a Block that matches the specified 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_block(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the block belongs. (required)
code (str) – The block’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
property_keys (List[str]) – A list of property keys from the “Block” domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. “Block/system/Name”.
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_block_with_http_info(scope, code, as_at=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] GetBlock: Get Block # noqa: E501
Fetch a Block that matches the specified 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_block_with_http_info(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope to which the block belongs. (required)
code (str) – The block’s unique identifier. (required)
as_at (datetime) – The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
property_keys (List[str]) – A list of property keys from the “Block” domain to decorate onto the block. These take the format {domain}/{scope}/{code} e.g. “Block/system/Name”.
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:
- list_blocks(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). # 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_blocks(as_at, page, sort_by, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
page (str) – The pagination token to use to continue listing blocks from a previous call to list blocks. 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.
sort_by (List[str]) – A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Block” domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. “Block/system/Name”.
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_blocks_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] ListBlocks: List Blocks # noqa: E501
Fetch the last pre-AsAt date version of each block in scope (does not fetch the entire history). # 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_blocks_with_http_info(as_at, page, sort_by, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the block. Defaults to return the latest version of the block if not specified.
page (str) – The pagination token to use to continue listing blocks from a previous call to list blocks. 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.
sort_by (List[str]) – A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
property_keys (List[str]) – A list of property keys from the “Block” domain to decorate onto each block. These take the format {domain}/{scope}/{code} e.g. “Block/system/Name”.
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(PagedResourceListOfBlock, status_code(int), headers(HTTPHeaderDict))
- upsert_blocks(block_set_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertBlocks: Upsert Block # noqa: E501
Upsert; update existing blocks with given ids, or create new blocks otherwise. # 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_blocks(block_set_request, async_req=True) >>> result = thread.get()
- Parameters:
block_set_request (BlockSetRequest) – The collection of block requests.
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_blocks_with_http_info(block_set_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertBlocks: Upsert Block # noqa: E501
Upsert; update existing blocks with given ids, or create new blocks otherwise. # 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_blocks_with_http_info(block_set_request, async_req=True) >>> result = thread.get()
- Parameters:
block_set_request (BlockSetRequest) – The collection of block requests.
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(ResourceListOfBlock, status_code(int), headers(HTTPHeaderDict))