sdk.lusid.api.aggregated_returns_api.AggregatedReturnsApi
- class AggregatedReturnsApi(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] DeleteReturnsEntity: Delete returns entity.
[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity.
[EXPERIMENTAL] GetReturnsEntity: Get returns entity.
[EXPERIMENTAL] GetReturnsEntity: Get returns entity.
[EXPERIMENTAL] ListReturnsEntities: List returns entities.
[EXPERIMENTAL] ListReturnsEntities: List returns entities.
[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity.
[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity.
- delete_returns_entity(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. # noqa: E501
Delete returns entity. # 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_returns_entity(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Returns entity scope. (required)
code (str) – Returns entity code. (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_returns_entity_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. # noqa: E501
Delete returns entity. # 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_returns_entity_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Returns entity scope. (required)
code (str) – Returns entity code. (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_returns_entity(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetReturnsEntity: Get returns entity. # noqa: E501
Get returns entity. # 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_returns_entity(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Returns entity scope. (required)
code (str) – Returns entity code. (required)
as_at (datetime) – The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition 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_returns_entity_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetReturnsEntity: Get returns entity. # noqa: E501
Get returns entity. # 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_returns_entity_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Returns entity scope. (required)
code (str) – Returns entity code. (required)
as_at (datetime) – The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the 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. 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(ReturnsEntity, status_code(int), headers(HTTPHeaderDict))
- list_returns_entities(as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListReturnsEntities: List returns entities. # noqa: E501
List returns entities. # 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_returns_entities(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition 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:
- list_returns_entities_with_http_info(as_at=None, **kwargs)[source]
[EXPERIMENTAL] ListReturnsEntities: List returns entities. # noqa: E501
List returns entities. # 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_returns_entities_with_http_info(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each 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. 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(ResourceListOfReturnsEntity, status_code(int), headers(HTTPHeaderDict))
- upsert_returns_entity(returns_entity, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. # noqa: E501
Upsert returns entity. # 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_returns_entity(returns_entity, async_req=True) >>> result = thread.get()
- Parameters:
returns_entity (ReturnsEntity) – Definition of the returns entity. (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_returns_entity_with_http_info(returns_entity, **kwargs)[source]
[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. # noqa: E501
Upsert returns entity. # 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_returns_entity_with_http_info(returns_entity, async_req=True) >>> result = thread.get()
- Parameters:
returns_entity (ReturnsEntity) – Definition of the returns entity. (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(ReturnsEntity, status_code(int), headers(HTTPHeaderDict))