sdk.lusid.api.cut_label_definitions_api.CutLabelDefinitionsApi
- class CutLabelDefinitionsApi(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
CreateCutLabelDefinition: Create a Cut Label # noqa: E501
CreateCutLabelDefinition: Create a Cut Label # noqa: E501
DeleteCutLabelDefinition: Delete a Cut Label # noqa: E501
DeleteCutLabelDefinition: Delete a Cut Label # noqa: E501
GetCutLabelDefinition: Get a Cut Label # noqa: E501
GetCutLabelDefinition: Get a Cut Label # noqa: E501
ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
UpdateCutLabelDefinition: Update a Cut Label # noqa: E501
UpdateCutLabelDefinition: Update a Cut Label # noqa: E501
- create_cut_label_definition(create_cut_label_definition_request=None, async_req=None, **kwargs)[source]
CreateCutLabelDefinition: Create a Cut Label # noqa: E501
Create a Cut Label valid in all scopes # 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_cut_label_definition(create_cut_label_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_cut_label_definition_request (CreateCutLabelDefinitionRequest) – The cut label definition
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_cut_label_definition_with_http_info(create_cut_label_definition_request=None, **kwargs)[source]
CreateCutLabelDefinition: Create a Cut Label # noqa: E501
Create a Cut Label valid in all scopes # 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_cut_label_definition_with_http_info(create_cut_label_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_cut_label_definition_request (CreateCutLabelDefinitionRequest) – The cut label definition
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(CutLabelDefinition, status_code(int), headers(HTTPHeaderDict))
- delete_cut_label_definition(code, async_req=None, **kwargs)[source]
DeleteCutLabelDefinition: Delete a Cut Label # noqa: E501
Delete a specified cut label # 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_cut_label_definition(code, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being Deleted (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:
datetime
- delete_cut_label_definition_with_http_info(code, **kwargs)[source]
DeleteCutLabelDefinition: Delete a Cut Label # noqa: E501
Delete a specified cut label # 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_cut_label_definition_with_http_info(code, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being Deleted (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:
- get_cut_label_definition(code, as_at=None, async_req=None, **kwargs)[source]
GetCutLabelDefinition: Get a Cut Label # noqa: E501
Get a specified cut label at a given 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_cut_label_definition(code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being queried (required)
as_at (datetime) – The time at which to get the Cut Label
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_cut_label_definition_with_http_info(code, as_at=None, **kwargs)[source]
GetCutLabelDefinition: Get a Cut Label # noqa: E501
Get a specified cut label at a given 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_cut_label_definition_with_http_info(code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being queried (required)
as_at (datetime) – The time at which to get the Cut Label
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(CutLabelDefinition, status_code(int), headers(HTTPHeaderDict))
- list_cut_label_definitions(as_at=None, sort_by=None, limit=None, filter=None, page=None, async_req=None, **kwargs)[source]
ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
List all the Cut Label Definitions that are valid at the given 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.list_cut_label_definitions(as_at, sort_by, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The As At time at which listed Cut Labels are valid
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on code, use “code eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
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_cut_label_definitions_with_http_info(as_at=None, sort_by=None, limit=None, filter=None, page=None, **kwargs)[source]
ListCutLabelDefinitions: List Existing Cut Labels # noqa: E501
List all the Cut Label Definitions that are valid at the given 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.list_cut_label_definitions_with_http_info(as_at, sort_by, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The As At time at which listed Cut Labels are valid
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on code, use “code eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
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(PagedResourceListOfCutLabelDefinition, status_code(int), headers(HTTPHeaderDict))
- update_cut_label_definition(code, update_cut_label_definition_request=None, async_req=None, **kwargs)[source]
UpdateCutLabelDefinition: Update a Cut Label # noqa: E501
Update a specified cut label # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_cut_label_definition(code, update_cut_label_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being updated (required)
update_cut_label_definition_request (UpdateCutLabelDefinitionRequest) – The cut label update definition
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:
- update_cut_label_definition_with_http_info(code, update_cut_label_definition_request=None, **kwargs)[source]
UpdateCutLabelDefinition: Update a Cut Label # noqa: E501
Update a specified cut label # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_cut_label_definition_with_http_info(code, update_cut_label_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
code (str) – The Code of the Cut Label that is being updated (required)
update_cut_label_definition_request (UpdateCutLabelDefinitionRequest) – The cut label update definition
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(CutLabelDefinition, status_code(int), headers(HTTPHeaderDict))