sdk.lusid.api.sequences_api.SequencesApi
- class SequencesApi(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] CreateSequence: Create a new sequence # noqa: E501
[EARLY ACCESS] CreateSequence: Create a new sequence # noqa: E501
[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
- create_sequence(scope, create_sequence_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateSequence: Create a new sequence # noqa: E501
Create a new sequence # 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_sequence(scope, create_sequence_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
create_sequence_request (CreateSequenceRequest) – Request to create sequence (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:
- create_sequence_with_http_info(scope, create_sequence_request, **kwargs)[source]
[EARLY ACCESS] CreateSequence: Create a new sequence # noqa: E501
Create a new sequence # 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_sequence_with_http_info(scope, create_sequence_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
create_sequence_request (CreateSequenceRequest) – Request to create sequence (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(SequenceDefinition, status_code(int), headers(HTTPHeaderDict))
- get_sequence(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
Return the details of a specified sequence # 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_sequence(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
code (str) – Code of the sequence. This together with stated scope uniquely identifies the sequence. (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:
- get_sequence_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] GetSequence: Get a specified sequence # noqa: E501
Return the details of a specified sequence # 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_sequence_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
code (str) – Code of the sequence. This together with stated scope uniquely identifies the sequence. (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(SequenceDefinition, status_code(int), headers(HTTPHeaderDict))
- list_sequences(page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
List sequences which satisfies filtering 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_sequences(page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
page (str) – The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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_sequences_with_http_info(page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] ListSequences: List Sequences # noqa: E501
List sequences which satisfies filtering 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_sequences_with_http_info(page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
page (str) – The pagination token to use to continue listing sequences from a previous call to list sequences. This value is returned from the previous call.
limit (int) – When paginating, limit the number of returned results to this many. Defaults to 500 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
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(PagedResourceListOfSequenceDefinition, status_code(int), headers(HTTPHeaderDict))
- next(scope, code, batch=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
Get the next set of values from a specified sequence # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.next(scope, code, batch, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
code (str) – Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
batch (int) – Number of sequences items to return for the specified sequence. Default to 1 if not specified.
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:
- next_with_http_info(scope, code, batch=None, **kwargs)[source]
[EARLY ACCESS] Next: Get next values from sequence # noqa: E501
Get the next set of values from a specified sequence # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.next_with_http_info(scope, code, batch, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of the sequence. (required)
code (str) – Code of the sequence. This together with stated scope uniquely identifies the sequence. (required)
batch (int) – Number of sequences items to return for the specified sequence. Default to 1 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 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(NextValueInSequenceResponse, status_code(int), headers(HTTPHeaderDict))