sdk.lusid.api.instrument_event_types_api.InstrumentEventTypesApi
- class InstrumentEventTypesApi(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] CreateTransactionTemplate: Create Transaction Template # noqa: E501
[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template # noqa: E501
[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template # noqa: E501
[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.
[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.
[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template # noqa: E501
[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.
[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.
[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates # noqa: E501
[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates # noqa: E501
[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
- create_transaction_template(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template # noqa: E501
Create a transaction template for a particular instrument event type in a scope. # 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_transaction_template(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. (required)
transaction_template_request (TransactionTemplateRequest) – A request defining a new transaction template to be created. (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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, transaction_template_request, **kwargs)[source]
[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template # noqa: E501
Create a transaction template for a particular instrument event type in a scope. # 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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. (required)
transaction_template_request (TransactionTemplateRequest) – A request defining a new transaction template to be created. (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(TransactionTemplate, status_code(int), headers(HTTPHeaderDict))
- delete_transaction_template(instrument_event_type, instrument_type, scope, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
Delete a transaction template for a particular instrument event type in a scope. # 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_transaction_template(instrument_event_type, instrument_type, scope, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope of the template. (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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, **kwargs)[source]
[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
Delete a transaction template for a particular instrument event type in a scope. # 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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope of the template. (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_transaction_template(instrument_event_type, instrument_type, scope, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template # noqa: E501
Gets the Transaction Template that for the instrument event type within the scope specified. # 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_transaction_template(instrument_event_type, instrument_type, scope, as_at, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The instrument event type of the transaction template (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. When not supplied the scope is ‘default’. (required)
as_at (datetime) – The AsAt time of the requested Transaction Template
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_transaction_template_specification(instrument_event_type, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
Retrieve the transaction template specification for a particular event type. # 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_transaction_template_specification(instrument_event_type, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The requested instrument event type. (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_transaction_template_specification_with_http_info(instrument_event_type, **kwargs)[source]
[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
Retrieve the transaction template specification for a particular event type. # 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_transaction_template_specification_with_http_info(instrument_event_type, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The requested instrument event type. (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(TransactionTemplateSpecification, status_code(int), headers(HTTPHeaderDict))
- get_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template # noqa: E501
Gets the Transaction Template that for the instrument event type within the scope specified. # 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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, as_at, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The instrument event type of the transaction template (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. When not supplied the scope is ‘default’. (required)
as_at (datetime) – The AsAt time of the requested Transaction Template
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(TransactionTemplate, status_code(int), headers(HTTPHeaderDict))
- list_transaction_template_specifications(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
Retrieves all transaction template specifications. # 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_transaction_template_specifications(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – AsAt of the request
page (str) – The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. 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.
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.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
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_transaction_template_specifications_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
Retrieves all transaction template specifications. # 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_transaction_template_specifications_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – AsAt of the request
page (str) – The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. 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.
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.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ 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 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(PagedResourceListOfTransactionTemplateSpecification, status_code(int), headers(HTTPHeaderDict))
- list_transaction_templates(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates # noqa: E501
Lists all Transaction Templates. # 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_transaction_templates(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The AsAt time at which to retrieve the Transaction Templates
page (str) – The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, and asAt fields must not have changed since the original request.
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.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
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_transaction_templates_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates # noqa: E501
Lists all Transaction Templates. # 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_transaction_templates_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The AsAt time at which to retrieve the Transaction Templates
page (str) – The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, and asAt fields must not have changed since the original request.
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.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ 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 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(PagedResourceListOfTransactionTemplate, status_code(int), headers(HTTPHeaderDict))
- update_transaction_template(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
Update a transaction template for a particular instrument event type in a scope. # 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_transaction_template(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. (required)
transaction_template_request (TransactionTemplateRequest) – A request defining the updated values for the transaction template. (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:
- update_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, transaction_template_request, **kwargs)[source]
[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
Update a transaction template for a particular instrument event type in a scope. # 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_transaction_template_with_http_info(instrument_event_type, instrument_type, scope, transaction_template_request, async_req=True) >>> result = thread.get()
- Parameters:
instrument_event_type (str) – The type of instrument events that the template is applied to. (required)
instrument_type (str) – The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template (required)
scope (str) – The scope in which the template lies. (required)
transaction_template_request (TransactionTemplateRequest) – A request defining the updated values for the transaction template. (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(TransactionTemplate, status_code(int), headers(HTTPHeaderDict))