sdk.lusid.api.compliance_api.ComplianceApi
- class ComplianceApi(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] DeleteComplianceRule: Delete compliance rule.
[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule.
[EARLY ACCESS] GetComplianceRule: Get compliance rule.
[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run.
[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run.
[EARLY ACCESS] GetComplianceRule: Get compliance rule.
[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template.
[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template.
[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run.
[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run.
[EARLY ACCESS] ListComplianceRules: List compliance rules.
[EARLY ACCESS] ListComplianceRules: List compliance rules.
[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
[EARLY ACCESS] ListComplianceTemplates: List compliance templates.
[EARLY ACCESS] ListComplianceTemplates: List compliance templates.
[EARLY ACCESS] RunCompliance: Run a compliance check.
[EARLY ACCESS] RunCompliance: Run a compliance check.
[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
- delete_compliance_rule(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. # noqa: E501
Use this endpoint to delete a compliance rule. The rule will be recoverable for asat times earlier than the delete time, but will otherwise appear to have never existed. # 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_compliance_rule(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The compliance rule’s scope. (required)
code (str) – The compliance rule’s code. (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_compliance_rule_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. # noqa: E501
Use this endpoint to delete a compliance rule. The rule will be recoverable for asat times earlier than the delete time, but will otherwise appear to have never existed. # 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_compliance_rule_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The compliance rule’s scope. (required)
code (str) – The compliance rule’s 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 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_compliance_rule(scope, code, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetComplianceRule: Get compliance rule. # noqa: E501
Use this endpoint to retrieve a single compliance rule. # 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_compliance_rule(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The compliance rule’s scope. (required)
code (str) – The compliance rule’s code. (required)
as_at (datetime) – Optional. Asat time for query.
property_keys (List[str]) – A list of property keys from the ‘Compliance’ domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example ‘Compliance/live/UCITS’.
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_compliance_rule_result(run_scope, run_code, rule_scope, rule_code, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. # noqa: E501
Specify a run scope and code from a previously run compliance check, and the scope and code of a rule within that run, to get detailed results for that rule. # 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_compliance_rule_result(run_scope, run_code, rule_scope, rule_code, async_req=True) >>> result = thread.get()
- Parameters:
run_scope (str) – Required: Run Scope. (required)
run_code (str) – Required: Run Code. (required)
rule_scope (str) – Required: Rule Scope. (required)
rule_code (str) – Required: Rule Code. (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_compliance_rule_result_with_http_info(run_scope, run_code, rule_scope, rule_code, **kwargs)[source]
[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. # noqa: E501
Specify a run scope and code from a previously run compliance check, and the scope and code of a rule within that run, to get detailed results for that rule. # 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_compliance_rule_result_with_http_info(run_scope, run_code, rule_scope, rule_code, async_req=True) >>> result = thread.get()
- Parameters:
run_scope (str) – Required: Run Scope. (required)
run_code (str) – Required: Run Code. (required)
rule_scope (str) – Required: Rule Scope. (required)
rule_code (str) – Required: Rule 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 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(ComplianceRuleResultV2, status_code(int), headers(HTTPHeaderDict))
- get_compliance_rule_with_http_info(scope, code, as_at=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] GetComplianceRule: Get compliance rule. # noqa: E501
Use this endpoint to retrieve a single compliance rule. # 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_compliance_rule_with_http_info(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The compliance rule’s scope. (required)
code (str) – The compliance rule’s code. (required)
as_at (datetime) – Optional. Asat time for query.
property_keys (List[str]) – A list of property keys from the ‘Compliance’ domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example ‘Compliance/live/UCITS’.
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(ComplianceRuleResponse, status_code(int), headers(HTTPHeaderDict))
- get_compliance_template(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. # noqa: E501
Use this endpoint to fetch a specific compliance template. # 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_compliance_template(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of TemplateID (required)
code (str) – Code of TemplateID (required)
as_at (datetime) – Optional. The time at which to get results from. Default : latest
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_compliance_template_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. # noqa: E501
Use this endpoint to fetch a specific compliance template. # 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_compliance_template_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Scope of TemplateID (required)
code (str) – Code of TemplateID (required)
as_at (datetime) – Optional. The time at which to get results from. Default : latest
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(ComplianceTemplate, status_code(int), headers(HTTPHeaderDict))
- get_decorated_compliance_run_summary(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. # noqa: E501
Specify a run scope and code from a previously run compliance check to get an overview of result details. # 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_decorated_compliance_run_summary(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Required: Run Scope. (required)
code (str) – Required: Run Code. (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_decorated_compliance_run_summary_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. # noqa: E501
Specify a run scope and code from a previously run compliance check to get an overview of result details. # 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_decorated_compliance_run_summary_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Required: Run Scope. (required)
code (str) – Required: Run 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 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(DecoratedComplianceRunSummary, status_code(int), headers(HTTPHeaderDict))
- list_compliance_rules(as_at=None, page=None, limit=None, filter=None, property_keys=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceRules: List compliance rules. # noqa: E501
Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. # 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_compliance_rules(as_at, page, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. Asat time.
page (str) – Optional. Pagination token.
limit (int) – Optional. Entries per page.
filter (str) – Optional. Filter.
property_keys (List[str]) – A list of property keys from the ‘Compliance’ domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example ‘Compliance/live/UCITS’. If not provided will return all the entitled properties for each rule.
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_compliance_rules_with_http_info(as_at=None, page=None, limit=None, filter=None, property_keys=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceRules: List compliance rules. # noqa: E501
Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. # 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_compliance_rules_with_http_info(as_at, page, limit, filter, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. Asat time.
page (str) – Optional. Pagination token.
limit (int) – Optional. Entries per page.
filter (str) – Optional. Filter.
property_keys (List[str]) – A list of property keys from the ‘Compliance’ domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example ‘Compliance/live/UCITS’. If not provided will return all the entitled properties for each rule.
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(PagedResourceListOfComplianceRuleResponse, status_code(int), headers(HTTPHeaderDict))
- list_compliance_runs(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. # noqa: E501
Lists RunIds of prior compliance runs, or a subset with a filter. # 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_compliance_runs(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The time at which to get results from. Default : latest
page (str) – Optional. The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. 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) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. 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]) – Optional. 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_compliance_runs_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. # noqa: E501
Lists RunIds of prior compliance runs, or a subset with a filter. # 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_compliance_runs_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The time at which to get results from. Default : latest
page (str) – Optional. The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. 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) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. 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]) – Optional. 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(PagedResourceListOfComplianceRunInfoV2, status_code(int), headers(HTTPHeaderDict))
- list_compliance_templates(as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceTemplates: List compliance templates. # noqa: E501
Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter. # 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_compliance_templates(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The time at which to get results from. Default : latest
page (str) – Optional. The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. 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) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. 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_compliance_templates_with_http_info(as_at=None, page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] ListComplianceTemplates: List compliance templates. # noqa: E501
Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter. # 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_compliance_templates_with_http_info(as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – Optional. The time at which to get results from. Default : latest
page (str) – Optional. The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. 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) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. 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(PagedResourceListOfComplianceTemplate, status_code(int), headers(HTTPHeaderDict))
- run_compliance(run_scope, rule_scope, is_pre_trade, recipe_id_scope, recipe_id_code, async_req=None, **kwargs)[source]
[EARLY ACCESS] RunCompliance: Run a compliance check. # noqa: E501
Use this endpoint to run a compliance check using rules from a specific 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.run_compliance(run_scope, rule_scope, is_pre_trade, recipe_id_scope, recipe_id_code, async_req=True) >>> result = thread.get()
- Parameters:
run_scope (str) – Required: Scope to save the run results in. (required)
rule_scope (str) – Required: Scope from which to select rules to be run. (required)
is_pre_trade (bool) – Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false (required)
recipe_id_scope (str) – Required: the scope of the recipe to be used (required)
recipe_id_code (str) – Required: The code of the recipe to be used. If left blank, the default recipe will be used. (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:
- run_compliance_with_http_info(run_scope, rule_scope, is_pre_trade, recipe_id_scope, recipe_id_code, **kwargs)[source]
[EARLY ACCESS] RunCompliance: Run a compliance check. # noqa: E501
Use this endpoint to run a compliance check using rules from a specific 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.run_compliance_with_http_info(run_scope, rule_scope, is_pre_trade, recipe_id_scope, recipe_id_code, async_req=True) >>> result = thread.get()
- Parameters:
run_scope (str) – Required: Scope to save the run results in. (required)
rule_scope (str) – Required: Scope from which to select rules to be run. (required)
is_pre_trade (bool) – Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false (required)
recipe_id_scope (str) – Required: the scope of the recipe to be used (required)
recipe_id_code (str) – Required: The code of the recipe to be used. If left blank, the default recipe will be used. (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(ComplianceRunInfoV2, status_code(int), headers(HTTPHeaderDict))
- upsert_compliance_rule(upsert_compliance_rule_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. # noqa: E501
Use this endpoint to upsert a single compliance rule. The template and variation specified must already exist, as must the portfolio group. The parameters passed must match those required by the template variation. # 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_compliance_rule(upsert_compliance_rule_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_compliance_rule_request (UpsertComplianceRuleRequest)
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_compliance_rule_with_http_info(upsert_compliance_rule_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. # noqa: E501
Use this endpoint to upsert a single compliance rule. The template and variation specified must already exist, as must the portfolio group. The parameters passed must match those required by the template variation. # 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_compliance_rule_with_http_info(upsert_compliance_rule_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_compliance_rule_request (UpsertComplianceRuleRequest)
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(ComplianceRuleResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_compliance_run_summary(upsert_compliance_run_summary_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. # noqa: E501
Use this endpoint to upsert a compliance run result summary. # 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_compliance_run_summary(upsert_compliance_run_summary_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_compliance_run_summary_request (UpsertComplianceRunSummaryRequest)
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_compliance_run_summary_with_http_info(upsert_compliance_run_summary_request=None, **kwargs)[source]
[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. # noqa: E501
Use this endpoint to upsert a compliance run result summary. # 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_compliance_run_summary_with_http_info(upsert_compliance_run_summary_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_compliance_run_summary_request (UpsertComplianceRunSummaryRequest)
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(UpsertComplianceRunSummaryResult, status_code(int), headers(HTTPHeaderDict))