lusid-sdk 2.1.286__tar.gz → 2.1.308__tar.gz

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.286
+Version: 2.1.308
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -29,8 +29,8 @@ FINBOURNE Technology
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.11.6719
-- Package version: 2.1.286
+- API version: 0.11.6739
+- Package version: 2.1.308
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
 
@@ -318,6 +318,7 @@ Class | Method | HTTP request | Description
 *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
 *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
 *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
+*ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
 *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
 *ComplianceApi* | [**upsert_compliance_rule**](docs/ComplianceApi.md#upsert_compliance_rule) | **POST** /api/compliance/rules | [EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
 *ComplianceApi* | [**upsert_compliance_run_summary**](docs/ComplianceApi.md#upsert_compliance_run_summary) | **POST** /api/compliance/runs/summary | [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
@@ -906,6 +907,7 @@ Class | Method | HTTP request | Description
  - [ComplianceRuleTemplate](docs/ComplianceRuleTemplate.md)
  - [ComplianceRuleUpsertRequest](docs/ComplianceRuleUpsertRequest.md)
  - [ComplianceRuleUpsertResponse](docs/ComplianceRuleUpsertResponse.md)
+ - [ComplianceRunConfiguration](docs/ComplianceRunConfiguration.md)
  - [ComplianceRunInfo](docs/ComplianceRunInfo.md)
  - [ComplianceRunInfoV2](docs/ComplianceRunInfoV2.md)
  - [ComplianceStep](docs/ComplianceStep.md)
@@ -1403,6 +1405,7 @@ Class | Method | HTTP request | Description
  - [PostingModuleResponse](docs/PostingModuleResponse.md)
  - [PostingModuleRule](docs/PostingModuleRule.md)
  - [PostingModuleRulesUpdatedResponse](docs/PostingModuleRulesUpdatedResponse.md)
+ - [PreTradeConfiguration](docs/PreTradeConfiguration.md)
  - [Premium](docs/Premium.md)
  - [PreviousFundValuationPointData](docs/PreviousFundValuationPointData.md)
  - [PreviousNAV](docs/PreviousNAV.md)

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/README.md

@@ -3,8 +3,8 @@ FINBOURNE Technology
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.11.6719
-- Package version: 2.1.286
+- API version: 0.11.6739
+- Package version: 2.1.308
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
 
@@ -292,6 +292,7 @@ Class | Method | HTTP request | Description
 *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
 *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
 *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
+*ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
 *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
 *ComplianceApi* | [**upsert_compliance_rule**](docs/ComplianceApi.md#upsert_compliance_rule) | **POST** /api/compliance/rules | [EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
 *ComplianceApi* | [**upsert_compliance_run_summary**](docs/ComplianceApi.md#upsert_compliance_run_summary) | **POST** /api/compliance/runs/summary | [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
@@ -880,6 +881,7 @@ Class | Method | HTTP request | Description
  - [ComplianceRuleTemplate](docs/ComplianceRuleTemplate.md)
  - [ComplianceRuleUpsertRequest](docs/ComplianceRuleUpsertRequest.md)
  - [ComplianceRuleUpsertResponse](docs/ComplianceRuleUpsertResponse.md)
+ - [ComplianceRunConfiguration](docs/ComplianceRunConfiguration.md)
  - [ComplianceRunInfo](docs/ComplianceRunInfo.md)
  - [ComplianceRunInfoV2](docs/ComplianceRunInfoV2.md)
  - [ComplianceStep](docs/ComplianceStep.md)
@@ -1377,6 +1379,7 @@ Class | Method | HTTP request | Description
  - [PostingModuleResponse](docs/PostingModuleResponse.md)
  - [PostingModuleRule](docs/PostingModuleRule.md)
  - [PostingModuleRulesUpdatedResponse](docs/PostingModuleRulesUpdatedResponse.md)
+ - [PreTradeConfiguration](docs/PreTradeConfiguration.md)
  - [Premium](docs/Premium.md)
  - [PreviousFundValuationPointData](docs/PreviousFundValuationPointData.md)
  - [PreviousNAV](docs/PreviousNAV.md)

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/__init__.py

@@ -241,6 +241,7 @@ from lusid.models.compliance_rule_result_v2 import ComplianceRuleResultV2
 from lusid.models.compliance_rule_template import ComplianceRuleTemplate
 from lusid.models.compliance_rule_upsert_request import ComplianceRuleUpsertRequest
 from lusid.models.compliance_rule_upsert_response import ComplianceRuleUpsertResponse
+from lusid.models.compliance_run_configuration import ComplianceRunConfiguration
 from lusid.models.compliance_run_info import ComplianceRunInfo
 from lusid.models.compliance_run_info_v2 import ComplianceRunInfoV2
 from lusid.models.compliance_step import ComplianceStep
@@ -738,6 +739,7 @@ from lusid.models.posting_module_request import PostingModuleRequest
 from lusid.models.posting_module_response import PostingModuleResponse
 from lusid.models.posting_module_rule import PostingModuleRule
 from lusid.models.posting_module_rules_updated_response import PostingModuleRulesUpdatedResponse
+from lusid.models.pre_trade_configuration import PreTradeConfiguration
 from lusid.models.premium import Premium
 from lusid.models.previous_fund_valuation_point_data import PreviousFundValuationPointData
 from lusid.models.previous_nav import PreviousNAV
@@ -1344,6 +1346,7 @@ __all__ = [
     "ComplianceRuleTemplate",
     "ComplianceRuleUpsertRequest",
     "ComplianceRuleUpsertResponse",
+    "ComplianceRunConfiguration",
     "ComplianceRunInfo",
     "ComplianceRunInfoV2",
     "ComplianceStep",
@@ -1841,6 +1844,7 @@ __all__ = [
     "PostingModuleResponse",
     "PostingModuleRule",
     "PostingModuleRulesUpdatedResponse",
+    "PreTradeConfiguration",
     "Premium",
     "PreviousFundValuationPointData",
     "PreviousNAV",

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/api/compliance_api.py

@@ -29,6 +29,7 @@ from typing import Optional
 from lusid.models.compliance_rule_response import ComplianceRuleResponse
 from lusid.models.compliance_rule_result_v2 import ComplianceRuleResultV2
 from lusid.models.compliance_rule_template import ComplianceRuleTemplate
+from lusid.models.compliance_run_configuration import ComplianceRunConfiguration
 from lusid.models.compliance_run_info_v2 import ComplianceRunInfoV2
 from lusid.models.compliance_template import ComplianceTemplate
 from lusid.models.create_compliance_template_request import CreateComplianceTemplateRequest
@@ -1964,6 +1965,196 @@ class ComplianceApi:
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @overload
+    async def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, **kwargs) -> ComplianceRunInfoV2:  # noqa: E501
+        ...
+
+    @overload
+    def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, async_req: Optional[bool]=True, **kwargs) -> ComplianceRunInfoV2:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def run_compliance_preview(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ComplianceRunInfoV2, Awaitable[ComplianceRunInfoV2]]:  # noqa: E501
+        """[EARLY ACCESS] RunCompliancePreview: 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_preview(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, async_req=True)
+        >>> result = thread.get()
+
+        :param run_scope: Required: Scope to save the run results in. (required)
+        :type run_scope: str
+        :param rule_scope: Required: Scope from which to select rules to be run. (required)
+        :type rule_scope: str
+        :param recipe_id_scope: Required: the scope of the recipe to be used (required)
+        :type recipe_id_scope: str
+        :param recipe_id_code: Required: The code of the recipe to be used. If left blank, the default recipe will be used. (required)
+        :type recipe_id_code: str
+        :param compliance_run_configuration: Configuration options for the compliance run.
+        :type compliance_run_configuration: ComplianceRunConfiguration
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _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.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ComplianceRunInfoV2
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the run_compliance_preview_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        if async_req is not None:
+            kwargs['async_req'] = async_req
+        return self.run_compliance_preview_with_http_info(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def run_compliance_preview_with_http_info(self, run_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope to save the run results in.")], rule_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: Scope from which to select rules to be run.")], recipe_id_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: the scope of the recipe to be used")], recipe_id_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Required: The code of the recipe to be used. If left blank, the default recipe will be used.")], compliance_run_configuration : Annotated[Optional[ComplianceRunConfiguration], Field(description="Configuration options for the compliance run.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EARLY ACCESS] RunCompliancePreview: 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_preview_with_http_info(run_scope, rule_scope, recipe_id_scope, recipe_id_code, compliance_run_configuration, async_req=True)
+        >>> result = thread.get()
+
+        :param run_scope: Required: Scope to save the run results in. (required)
+        :type run_scope: str
+        :param rule_scope: Required: Scope from which to select rules to be run. (required)
+        :type rule_scope: str
+        :param recipe_id_scope: Required: the scope of the recipe to be used (required)
+        :type recipe_id_scope: str
+        :param recipe_id_code: Required: The code of the recipe to be used. If left blank, the default recipe will be used. (required)
+        :type recipe_id_code: str
+        :param compliance_run_configuration: Configuration options for the compliance run.
+        :type compliance_run_configuration: ComplianceRunConfiguration
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: 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.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _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.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(ComplianceRunInfoV2, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'run_scope',
+            'rule_scope',
+            'recipe_id_scope',
+            'recipe_id_code',
+            'compliance_run_configuration'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method run_compliance_preview" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('run_scope') is not None:  # noqa: E501
+            _query_params.append(('runScope', _params['run_scope']))
+
+        if _params.get('rule_scope') is not None:  # noqa: E501
+            _query_params.append(('ruleScope', _params['rule_scope']))
+
+        if _params.get('recipe_id_scope') is not None:  # noqa: E501
+            _query_params.append(('recipeIdScope', _params['recipe_id_scope']))
+
+        if _params.get('recipe_id_code') is not None:  # noqa: E501
+            _query_params.append(('recipeIdCode', _params['recipe_id_code']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params['compliance_run_configuration'] is not None:
+            _body_params = _params['compliance_run_configuration']
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get('_content_type',
+            self.api_client.select_header_content_type(
+                ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
+        if _content_types_list:
+                _header_params['Content-Type'] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '200': "ComplianceRunInfoV2",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/compliance/preview/runs', 'POST',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @overload
     async def update_compliance_template(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Compliance Rule Template.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Compliance Rule Template.")], update_compliance_template_request : Annotated[UpdateComplianceTemplateRequest, Field(..., description="Request to update a compliance rule template.")], **kwargs) -> ComplianceRuleTemplate:  # noqa: E501
         ...

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/api/scopes_api.py

@@ -20,7 +20,9 @@ from pydantic.v1 import validate_arguments, ValidationError
 from typing import overload, Optional, Union, Awaitable
 
 from typing_extensions import Annotated
-from pydantic.v1 import Field, constr, validator
+from datetime import datetime
+
+from pydantic.v1 import Field, conint, constr, validator
 
 from typing import Optional
 
@@ -47,26 +49,32 @@ class ScopesApi:
         self.api_client = api_client
 
     @overload
-    async def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
+    async def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
         ...
 
     @overload
-    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
+    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfScopeDefinition:  # noqa: E501
         ...
 
     @validate_arguments
-    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]:  # noqa: E501
+    def list_entity_scopes(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfScopeDefinition, Awaitable[ResourceListOfScopeDefinition]]:  # noqa: E501
         """ListEntityScopes: List Entity Scopes  # noqa: E501
 
         List all the scopes for a given entity type that contain data.  # 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_entity_scopes(entity_type, async_req=True)
+        >>> thread = api.list_entity_scopes(entity_type, as_at, page, limit, async_req=True)
         >>> result = thread.get()
 
         :param entity_type: The entity type to list scopes for. (required)
         :type entity_type: str
+        :param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
+        :type as_at: datetime
+        :param page: The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
+        :type limit: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request.
@@ -84,21 +92,27 @@ class ScopesApi:
             raise ValueError(message)
         if async_req is not None:
             kwargs['async_req'] = async_req
-        return self.list_entity_scopes_with_http_info(entity_type, **kwargs)  # noqa: E501
+        return self.list_entity_scopes_with_http_info(entity_type, as_at, page, limit, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def list_entity_scopes_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def list_entity_scopes_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=100, min_length=0), Field(..., description="The entity type to list scopes for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """ListEntityScopes: List Entity Scopes  # noqa: E501
 
         List all the scopes for a given entity type that contain data.  # 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_entity_scopes_with_http_info(entity_type, async_req=True)
+        >>> thread = api.list_entity_scopes_with_http_info(entity_type, as_at, page, limit, async_req=True)
         >>> result = thread.get()
 
         :param entity_type: The entity type to list scopes for. (required)
         :type entity_type: str
+        :param as_at: The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified.
+        :type as_at: datetime
+        :param page: The pagination token to use to continue listing scopes from a previous call to list scopes.              This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields              must not have changed since the original request.
+        :type page: str
+        :param limit: When paginating, limit the number of returned results to this number. Defaults to 100 if not specified.
+        :type limit: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -127,7 +141,10 @@ class ScopesApi:
         _params = locals()
 
         _all_params = [
-            'entity_type'
+            'entity_type',
+            'as_at',
+            'page',
+            'limit'
         ]
         _all_params.extend(
             [
@@ -161,6 +178,18 @@ class ScopesApi:
 
         # process the query parameters
         _query_params = []
+        if _params.get('as_at') is not None:  # noqa: E501
+            if isinstance(_params['as_at'], datetime):
+                _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('asAt', _params['as_at']))
+
+        if _params.get('page') is not None:  # noqa: E501
+            _query_params.append(('page', _params['page']))
+
+        if _params.get('limit') is not None:  # noqa: E501
+            _query_params.append(('limit', _params['limit']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/configuration.py

@@ -373,7 +373,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6719\n"\
+               "Version of the API: 0.11.6739\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/models/__init__.py

@@ -162,6 +162,7 @@ from lusid.models.compliance_rule_result_v2 import ComplianceRuleResultV2
 from lusid.models.compliance_rule_template import ComplianceRuleTemplate
 from lusid.models.compliance_rule_upsert_request import ComplianceRuleUpsertRequest
 from lusid.models.compliance_rule_upsert_response import ComplianceRuleUpsertResponse
+from lusid.models.compliance_run_configuration import ComplianceRunConfiguration
 from lusid.models.compliance_run_info import ComplianceRunInfo
 from lusid.models.compliance_run_info_v2 import ComplianceRunInfoV2
 from lusid.models.compliance_step import ComplianceStep
@@ -659,6 +660,7 @@ from lusid.models.posting_module_request import PostingModuleRequest
 from lusid.models.posting_module_response import PostingModuleResponse
 from lusid.models.posting_module_rule import PostingModuleRule
 from lusid.models.posting_module_rules_updated_response import PostingModuleRulesUpdatedResponse
+from lusid.models.pre_trade_configuration import PreTradeConfiguration
 from lusid.models.premium import Premium
 from lusid.models.previous_fund_valuation_point_data import PreviousFundValuationPointData
 from lusid.models.previous_nav import PreviousNAV
@@ -1187,6 +1189,7 @@ __all__ = [
     "ComplianceRuleTemplate",
     "ComplianceRuleUpsertRequest",
     "ComplianceRuleUpsertResponse",
+    "ComplianceRunConfiguration",
     "ComplianceRunInfo",
     "ComplianceRunInfoV2",
     "ComplianceStep",
@@ -1684,6 +1687,7 @@ __all__ = [
     "PostingModuleResponse",
     "PostingModuleRule",
     "PostingModuleRulesUpdatedResponse",
+    "PreTradeConfiguration",
     "Premium",
     "PreviousFundValuationPointData",
     "PreviousNAV",

lusid_sdk-2.1.308/lusid/models/compliance_run_configuration.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict
+from pydantic.v1 import BaseModel, Field
+from lusid.models.pre_trade_configuration import PreTradeConfiguration
+
+class ComplianceRunConfiguration(BaseModel):
+    """
+    Specification object for the configuration parameters of a compliance run  # noqa: E501
+    """
+    pre_trade_configuration: PreTradeConfiguration = Field(..., alias="preTradeConfiguration")
+    __properties = ["preTradeConfiguration"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ComplianceRunConfiguration:
+        """Create an instance of ComplianceRunConfiguration from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of pre_trade_configuration
+        if self.pre_trade_configuration:
+            _dict['preTradeConfiguration'] = self.pre_trade_configuration.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ComplianceRunConfiguration:
+        """Create an instance of ComplianceRunConfiguration from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ComplianceRunConfiguration.parse_obj(obj)
+
+        _obj = ComplianceRunConfiguration.parse_obj({
+            "pre_trade_configuration": PreTradeConfiguration.from_dict(obj.get("preTradeConfiguration")) if obj.get("preTradeConfiguration") is not None else None
+        })
+        return _obj

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/models/fund_configuration.py

@@ -35,12 +35,12 @@ class FundConfiguration(BaseModel):
     display_name: Optional[StrictStr] = Field(None, alias="displayName", description="The name of the FundConfiguration.")
     description: Optional[StrictStr] = Field(None, description="A description for the FundConfiguration.")
     dealing_rule: Optional[ComponentRule] = Field(None, alias="dealingRule")
-    fund_pnl_exclusion_rule: Optional[ComponentRule] = Field(None, alias="fundPnlExclusionRule")
+    fund_pnl_rule: Optional[ComponentRule] = Field(None, alias="fundPnlRule")
     back_out_rule: Optional[ComponentRule] = Field(None, alias="backOutRule")
     properties: Optional[Dict[str, ModelProperty]] = Field(None, description="A set of properties for the Fund Configuration.")
     version: Optional[Version] = None
     links: Optional[conlist(Link)] = None
-    __properties = ["href", "id", "displayName", "description", "dealingRule", "fundPnlExclusionRule", "backOutRule", "properties", "version", "links"]
+    __properties = ["href", "id", "displayName", "description", "dealingRule", "fundPnlRule", "backOutRule", "properties", "version", "links"]
 
     class Config:
         """Pydantic configuration"""
@@ -72,9 +72,9 @@ class FundConfiguration(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of dealing_rule
         if self.dealing_rule:
             _dict['dealingRule'] = self.dealing_rule.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of fund_pnl_exclusion_rule
-        if self.fund_pnl_exclusion_rule:
-            _dict['fundPnlExclusionRule'] = self.fund_pnl_exclusion_rule.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of fund_pnl_rule
+        if self.fund_pnl_rule:
+            _dict['fundPnlRule'] = self.fund_pnl_rule.to_dict()
         # override the default output from pydantic by calling `to_dict()` of back_out_rule
         if self.back_out_rule:
             _dict['backOutRule'] = self.back_out_rule.to_dict()
@@ -137,7 +137,7 @@ class FundConfiguration(BaseModel):
             "display_name": obj.get("displayName"),
             "description": obj.get("description"),
             "dealing_rule": ComponentRule.from_dict(obj.get("dealingRule")) if obj.get("dealingRule") is not None else None,
-            "fund_pnl_exclusion_rule": ComponentRule.from_dict(obj.get("fundPnlExclusionRule")) if obj.get("fundPnlExclusionRule") is not None else None,
+            "fund_pnl_rule": ComponentRule.from_dict(obj.get("fundPnlRule")) if obj.get("fundPnlRule") is not None else None,
             "back_out_rule": ComponentRule.from_dict(obj.get("backOutRule")) if obj.get("backOutRule") is not None else None,
             "properties": dict(
                 (_k, ModelProperty.from_dict(_v))

{lusid_sdk-2.1.286 → lusid_sdk-2.1.308}/lusid/models/fund_configuration_request.py

@@ -31,10 +31,10 @@ class FundConfigurationRequest(BaseModel):
     display_name: Optional[constr(strict=True, max_length=256, min_length=1)] = Field(None, alias="displayName", description="The name of the Fund.")
     description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="A description for the Fund.")
     dealing_rule: ComponentRule = Field(..., alias="dealingRule")
-    fund_pnl_exclusion_rule: Optional[ComponentRule] = Field(None, alias="fundPnlExclusionRule")
+    fund_pnl_rule: ComponentRule = Field(..., alias="fundPnlRule")
     back_out_rule: ComponentRule = Field(..., alias="backOutRule")
     properties: Optional[Dict[str, ModelProperty]] = Field(None, description="A set of properties for the Fund Configuration.")
-    __properties = ["code", "displayName", "description", "dealingRule", "fundPnlExclusionRule", "backOutRule", "properties"]
+    __properties = ["code", "displayName", "description", "dealingRule", "fundPnlRule", "backOutRule", "properties"]
 
     @validator('code')
     def code_validate_regular_expression(cls, value):
@@ -80,9 +80,9 @@ class FundConfigurationRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of dealing_rule
         if self.dealing_rule:
             _dict['dealingRule'] = self.dealing_rule.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of fund_pnl_exclusion_rule
-        if self.fund_pnl_exclusion_rule:
-            _dict['fundPnlExclusionRule'] = self.fund_pnl_exclusion_rule.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of fund_pnl_rule
+        if self.fund_pnl_rule:
+            _dict['fundPnlRule'] = self.fund_pnl_rule.to_dict()
         # override the default output from pydantic by calling `to_dict()` of back_out_rule
         if self.back_out_rule:
             _dict['backOutRule'] = self.back_out_rule.to_dict()
@@ -124,7 +124,7 @@ class FundConfigurationRequest(BaseModel):
             "display_name": obj.get("displayName"),
             "description": obj.get("description"),
             "dealing_rule": ComponentRule.from_dict(obj.get("dealingRule")) if obj.get("dealingRule") is not None else None,
-            "fund_pnl_exclusion_rule": ComponentRule.from_dict(obj.get("fundPnlExclusionRule")) if obj.get("fundPnlExclusionRule") is not None else None,
+            "fund_pnl_rule": ComponentRule.from_dict(obj.get("fundPnlRule")) if obj.get("fundPnlRule") is not None else None,
             "back_out_rule": ComponentRule.from_dict(obj.get("backOutRule")) if obj.get("backOutRule") is not None else None,
             "properties": dict(
                 (_k, ModelProperty.from_dict(_v))