lusid-sdk 2.1.983__tar.gz → 2.1.984__tar.gz

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.983
+Version: 2.1.984
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -134,6 +134,7 @@ Class | Method | HTTP request | Description
 *CheckDefinitionsApi* | [**delete_check_definition**](docs/CheckDefinitionsApi.md#delete_check_definition) | **DELETE** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition
 *CheckDefinitionsApi* | [**get_check_definition**](docs/CheckDefinitionsApi.md#get_check_definition) | **GET** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.
 *CheckDefinitionsApi* | [**list_check_definitions**](docs/CheckDefinitionsApi.md#list_check_definitions) | **GET** /api/dataquality/checkdefinitions | [EXPERIMENTAL] ListCheckDefinitions: List Check Definitions
+*CheckDefinitionsApi* | [**run_check_definition**](docs/CheckDefinitionsApi.md#run_check_definition) | **PUT** /api/dataquality/checkdefinitions/{scope}/{code}/$run | [EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.
 *CheckDefinitionsApi* | [**update_check_definition**](docs/CheckDefinitionsApi.md#update_check_definition) | **PUT** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code
 *ComplexMarketDataApi* | [**delete_complex_market_data**](docs/ComplexMarketDataApi.md#delete_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$delete | DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present.
 *ComplexMarketDataApi* | [**get_complex_market_data**](docs/ComplexMarketDataApi.md#get_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$get | GetComplexMarketData: Get complex market data
@@ -1003,6 +1004,7 @@ Class | Method | HTTP request | Description
  - [DataMapping](docs/DataMapping.md)
  - [DataModelMembership](docs/DataModelMembership.md)
  - [DataModelSummary](docs/DataModelSummary.md)
+ - [DataQualityCheckResult](docs/DataQualityCheckResult.md)
  - [DataScope](docs/DataScope.md)
  - [DataType](docs/DataType.md)
  - [DataTypeEntity](docs/DataTypeEntity.md)
@@ -1305,6 +1307,8 @@ Class | Method | HTTP request | Description
  - [LoanPeriod](docs/LoanPeriod.md)
  - [LoanPrincipalRepaymentEvent](docs/LoanPrincipalRepaymentEvent.md)
  - [LockPeriodDiaryEntryRequest](docs/LockPeriodDiaryEntryRequest.md)
+ - [LusidEntityDataset](docs/LusidEntityDataset.md)
+ - [LusidEntityResult](docs/LusidEntityResult.md)
  - [LusidInstrument](docs/LusidInstrument.md)
  - [LusidProblemDetails](docs/LusidProblemDetails.md)
  - [LusidTradeTicket](docs/LusidTradeTicket.md)
@@ -1719,6 +1723,8 @@ Class | Method | HTTP request | Description
  - [RoundingConfigurationComponent](docs/RoundingConfigurationComponent.md)
  - [RoundingConvention](docs/RoundingConvention.md)
  - [RulesInterval](docs/RulesInterval.md)
+ - [RunCheckRequest](docs/RunCheckRequest.md)
+ - [RunCheckResponse](docs/RunCheckResponse.md)
  - [ScalingMethodology](docs/ScalingMethodology.md)
  - [Schedule](docs/Schedule.md)
  - [ScheduleType](docs/ScheduleType.md)

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/README.md

@@ -107,6 +107,7 @@ Class | Method | HTTP request | Description
 *CheckDefinitionsApi* | [**delete_check_definition**](docs/CheckDefinitionsApi.md#delete_check_definition) | **DELETE** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition
 *CheckDefinitionsApi* | [**get_check_definition**](docs/CheckDefinitionsApi.md#get_check_definition) | **GET** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.
 *CheckDefinitionsApi* | [**list_check_definitions**](docs/CheckDefinitionsApi.md#list_check_definitions) | **GET** /api/dataquality/checkdefinitions | [EXPERIMENTAL] ListCheckDefinitions: List Check Definitions
+*CheckDefinitionsApi* | [**run_check_definition**](docs/CheckDefinitionsApi.md#run_check_definition) | **PUT** /api/dataquality/checkdefinitions/{scope}/{code}/$run | [EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.
 *CheckDefinitionsApi* | [**update_check_definition**](docs/CheckDefinitionsApi.md#update_check_definition) | **PUT** /api/dataquality/checkdefinitions/{scope}/{code} | [EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code
 *ComplexMarketDataApi* | [**delete_complex_market_data**](docs/ComplexMarketDataApi.md#delete_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$delete | DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present.
 *ComplexMarketDataApi* | [**get_complex_market_data**](docs/ComplexMarketDataApi.md#get_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$get | GetComplexMarketData: Get complex market data
@@ -976,6 +977,7 @@ Class | Method | HTTP request | Description
  - [DataMapping](docs/DataMapping.md)
  - [DataModelMembership](docs/DataModelMembership.md)
  - [DataModelSummary](docs/DataModelSummary.md)
+ - [DataQualityCheckResult](docs/DataQualityCheckResult.md)
  - [DataScope](docs/DataScope.md)
  - [DataType](docs/DataType.md)
  - [DataTypeEntity](docs/DataTypeEntity.md)
@@ -1278,6 +1280,8 @@ Class | Method | HTTP request | Description
  - [LoanPeriod](docs/LoanPeriod.md)
  - [LoanPrincipalRepaymentEvent](docs/LoanPrincipalRepaymentEvent.md)
  - [LockPeriodDiaryEntryRequest](docs/LockPeriodDiaryEntryRequest.md)
+ - [LusidEntityDataset](docs/LusidEntityDataset.md)
+ - [LusidEntityResult](docs/LusidEntityResult.md)
  - [LusidInstrument](docs/LusidInstrument.md)
  - [LusidProblemDetails](docs/LusidProblemDetails.md)
  - [LusidTradeTicket](docs/LusidTradeTicket.md)
@@ -1692,6 +1696,8 @@ Class | Method | HTTP request | Description
  - [RoundingConfigurationComponent](docs/RoundingConfigurationComponent.md)
  - [RoundingConvention](docs/RoundingConvention.md)
  - [RulesInterval](docs/RulesInterval.md)
+ - [RunCheckRequest](docs/RunCheckRequest.md)
+ - [RunCheckResponse](docs/RunCheckResponse.md)
  - [ScalingMethodology](docs/ScalingMethodology.md)
  - [Schedule](docs/Schedule.md)
  - [ScheduleType](docs/ScheduleType.md)

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/lusid/__init__.py

@@ -413,6 +413,7 @@ from lusid.models.data_map_key import DataMapKey
 from lusid.models.data_mapping import DataMapping
 from lusid.models.data_model_membership import DataModelMembership
 from lusid.models.data_model_summary import DataModelSummary
+from lusid.models.data_quality_check_result import DataQualityCheckResult
 from lusid.models.data_scope import DataScope
 from lusid.models.data_type import DataType
 from lusid.models.data_type_entity import DataTypeEntity
@@ -715,6 +716,8 @@ from lusid.models.loan_interest_repayment_event import LoanInterestRepaymentEven
 from lusid.models.loan_period import LoanPeriod
 from lusid.models.loan_principal_repayment_event import LoanPrincipalRepaymentEvent
 from lusid.models.lock_period_diary_entry_request import LockPeriodDiaryEntryRequest
+from lusid.models.lusid_entity_dataset import LusidEntityDataset
+from lusid.models.lusid_entity_result import LusidEntityResult
 from lusid.models.lusid_instrument import LusidInstrument
 from lusid.models.lusid_problem_details import LusidProblemDetails
 from lusid.models.lusid_trade_ticket import LusidTradeTicket
@@ -1129,6 +1132,8 @@ from lusid.models.rounding_configuration import RoundingConfiguration
 from lusid.models.rounding_configuration_component import RoundingConfigurationComponent
 from lusid.models.rounding_convention import RoundingConvention
 from lusid.models.rules_interval import RulesInterval
+from lusid.models.run_check_request import RunCheckRequest
+from lusid.models.run_check_response import RunCheckResponse
 from lusid.models.scaling_methodology import ScalingMethodology
 from lusid.models.schedule import Schedule
 from lusid.models.schedule_type import ScheduleType
@@ -1803,6 +1808,7 @@ __all__ = [
     "DataMapping",
     "DataModelMembership",
     "DataModelSummary",
+    "DataQualityCheckResult",
     "DataScope",
     "DataType",
     "DataTypeEntity",
@@ -2105,6 +2111,8 @@ __all__ = [
     "LoanPeriod",
     "LoanPrincipalRepaymentEvent",
     "LockPeriodDiaryEntryRequest",
+    "LusidEntityDataset",
+    "LusidEntityResult",
     "LusidInstrument",
     "LusidProblemDetails",
     "LusidTradeTicket",
@@ -2519,6 +2527,8 @@ __all__ = [
     "RoundingConfigurationComponent",
     "RoundingConvention",
     "RulesInterval",
+    "RunCheckRequest",
+    "RunCheckResponse",
     "ScalingMethodology",
     "Schedule",
     "ScheduleType",

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/lusid/api/check_definitions_api.py

@@ -30,6 +30,8 @@ from lusid.models.check_definition import CheckDefinition
 from lusid.models.create_check_definition_request import CreateCheckDefinitionRequest
 from lusid.models.deleted_entity_response import DeletedEntityResponse
 from lusid.models.paged_resource_list_of_check_definition import PagedResourceListOfCheckDefinition
+from lusid.models.run_check_request import RunCheckRequest
+from lusid.models.run_check_response import RunCheckResponse
 from lusid.models.update_check_definition_request import UpdateCheckDefinitionRequest
 
 from lusid.api_client import ApiClient
@@ -770,6 +772,181 @@ class CheckDefinitionsApi:
             _request_auth=_params.get('_request_auth'))
 
 
+    @overload
+    async def run_check_definition(self, scope : Annotated[StrictStr, Field(..., description="Scope of the CheckDefinition to run.")], code : Annotated[StrictStr, Field(..., description="Code of the CheckDefinition to run.")], run_check_request : Annotated[Optional[RunCheckRequest], Field(description="Run request defining what dataset to run against.")] = None, **kwargs) -> RunCheckResponse:  # noqa: E501
+        ...
+
+    @overload
+    def run_check_definition(self, scope : Annotated[StrictStr, Field(..., description="Scope of the CheckDefinition to run.")], code : Annotated[StrictStr, Field(..., description="Code of the CheckDefinition to run.")], run_check_request : Annotated[Optional[RunCheckRequest], Field(description="Run request defining what dataset to run against.")] = None, async_req: Optional[bool]=True, **kwargs) -> RunCheckResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def run_check_definition(self, scope : Annotated[StrictStr, Field(..., description="Scope of the CheckDefinition to run.")], code : Annotated[StrictStr, Field(..., description="Code of the CheckDefinition to run.")], run_check_request : Annotated[Optional[RunCheckRequest], Field(description="Run request defining what dataset to run against.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[RunCheckResponse, Awaitable[RunCheckResponse]]:  # noqa: E501
+        """[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.  # noqa: E501
+
+        Runs a Check Definition against given dataset.  # 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_check_definition(scope, code, run_check_request, async_req=True)
+        >>> result = thread.get()
+
+        :param scope: Scope of the CheckDefinition to run. (required)
+        :type scope: str
+        :param code: Code of the CheckDefinition to run. (required)
+        :type code: str
+        :param run_check_request: Run request defining what dataset to run against.
+        :type run_check_request: RunCheckRequest
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: RunCheckResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the run_check_definition_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_check_definition_with_http_info(scope, code, run_check_request, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def run_check_definition_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="Scope of the CheckDefinition to run.")], code : Annotated[StrictStr, Field(..., description="Code of the CheckDefinition to run.")], run_check_request : Annotated[Optional[RunCheckRequest], Field(description="Run request defining what dataset to run against.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.  # noqa: E501
+
+        Runs a Check Definition against given dataset.  # 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_check_definition_with_http_info(scope, code, run_check_request, async_req=True)
+        >>> result = thread.get()
+
+        :param scope: Scope of the CheckDefinition to run. (required)
+        :type scope: str
+        :param code: Code of the CheckDefinition to run. (required)
+        :type code: str
+        :param run_check_request: Run request defining what dataset to run against.
+        :type run_check_request: RunCheckRequest
+        :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. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :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(RunCheckResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'scope',
+            'code',
+            'run_check_request'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers',
+                'opts'
+            ]
+        )
+
+        # 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_check_definition" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['scope']:
+            _path_params['scope'] = _params['scope']
+
+        if _params['code']:
+            _path_params['code'] = _params['code']
+
+
+        # process the query parameters
+        _query_params = []
+        # 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['run_check_request'] is not None:
+            _body_params = _params['run_check_request']
+
+        # 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': "RunCheckResponse",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/dataquality/checkdefinitions/{scope}/{code}/$run', 'PUT',
+            _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'),
+            opts=_params.get('opts'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
+
     @overload
     async def update_check_definition(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Check Definition.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition.")], update_check_definition_request : Annotated[Optional[UpdateCheckDefinitionRequest], Field(description="The request containing the updated details of the Check Definition")] = None, **kwargs) -> CheckDefinition:  # noqa: E501
         ...

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/lusid/configuration.py

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

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/lusid/models/__init__.py

@@ -322,6 +322,7 @@ from lusid.models.data_map_key import DataMapKey
 from lusid.models.data_mapping import DataMapping
 from lusid.models.data_model_membership import DataModelMembership
 from lusid.models.data_model_summary import DataModelSummary
+from lusid.models.data_quality_check_result import DataQualityCheckResult
 from lusid.models.data_scope import DataScope
 from lusid.models.data_type import DataType
 from lusid.models.data_type_entity import DataTypeEntity
@@ -624,6 +625,8 @@ from lusid.models.loan_interest_repayment_event import LoanInterestRepaymentEven
 from lusid.models.loan_period import LoanPeriod
 from lusid.models.loan_principal_repayment_event import LoanPrincipalRepaymentEvent
 from lusid.models.lock_period_diary_entry_request import LockPeriodDiaryEntryRequest
+from lusid.models.lusid_entity_dataset import LusidEntityDataset
+from lusid.models.lusid_entity_result import LusidEntityResult
 from lusid.models.lusid_instrument import LusidInstrument
 from lusid.models.lusid_problem_details import LusidProblemDetails
 from lusid.models.lusid_trade_ticket import LusidTradeTicket
@@ -1038,6 +1041,8 @@ from lusid.models.rounding_configuration import RoundingConfiguration
 from lusid.models.rounding_configuration_component import RoundingConfigurationComponent
 from lusid.models.rounding_convention import RoundingConvention
 from lusid.models.rules_interval import RulesInterval
+from lusid.models.run_check_request import RunCheckRequest
+from lusid.models.run_check_response import RunCheckResponse
 from lusid.models.scaling_methodology import ScalingMethodology
 from lusid.models.schedule import Schedule
 from lusid.models.schedule_type import ScheduleType
@@ -1622,6 +1627,7 @@ __all__ = [
     "DataMapping",
     "DataModelMembership",
     "DataModelSummary",
+    "DataQualityCheckResult",
     "DataScope",
     "DataType",
     "DataTypeEntity",
@@ -1924,6 +1930,8 @@ __all__ = [
     "LoanPeriod",
     "LoanPrincipalRepaymentEvent",
     "LockPeriodDiaryEntryRequest",
+    "LusidEntityDataset",
+    "LusidEntityResult",
     "LusidInstrument",
     "LusidProblemDetails",
     "LusidTradeTicket",
@@ -2338,6 +2346,8 @@ __all__ = [
     "RoundingConfigurationComponent",
     "RoundingConvention",
     "RulesInterval",
+    "RunCheckRequest",
+    "RunCheckResponse",
     "ScalingMethodology",
     "Schedule",
     "ScheduleType",

lusid_sdk-2.1.984/lusid/models/data_quality_check_result.py

@@ -0,0 +1,181 @@
+# 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 datetime import datetime
+from typing import Any, Dict, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictInt, StrictStr 
+from lusid.models.lusid_entity_result import LusidEntityResult
+
+class DataQualityCheckResult(BaseModel):
+    """
+    Represents the result of a data quality check operation  # noqa: E501
+    """
+    check_definition_scope:  Optional[StrictStr] = Field(None,alias="checkDefinitionScope", description="The scope of the check definition") 
+    check_definition_code:  Optional[StrictStr] = Field(None,alias="checkDefinitionCode", description="The code of the check definition") 
+    check_definition_display_name:  Optional[StrictStr] = Field(None,alias="checkDefinitionDisplayName", description="The display name of the check definition") 
+    check_run_as_at: Optional[datetime] = Field(None, alias="checkRunAsAt", description="The timestamp when the check was run")
+    result_type:  Optional[StrictStr] = Field(None,alias="resultType", description="The type of result from the check") 
+    rule_set_key:  Optional[StrictStr] = Field(None,alias="ruleSetKey", description="The key identifying the ruleset") 
+    rule_set_display_name:  Optional[StrictStr] = Field(None,alias="ruleSetDisplayName", description="The display name of the ruleset") 
+    rule_key:  Optional[StrictStr] = Field(None,alias="ruleKey", description="The key identifying the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)") 
+    rule_display_name:  Optional[StrictStr] = Field(None,alias="ruleDisplayName", description="The display name of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)") 
+    rule_description:  Optional[StrictStr] = Field(None,alias="ruleDescription", description="The description of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)") 
+    rule_formula:  Optional[StrictStr] = Field(None,alias="ruleFormula", description="The formula of the rule (for RuleInvalid, RuleBreached, RuleBreachesOverLimit)") 
+    severity: Optional[StrictInt] = Field(None, description="The severity level")
+    lusid_entity: Optional[LusidEntityResult] = Field(None, alias="lusidEntity")
+    count_rule_breaches: Optional[StrictInt] = Field(None, alias="countRuleBreaches", description="The count of rule breaches (1 for RuleBreached, multiple for RuleBreachesOverLimit)")
+    error_detail:  Optional[StrictStr] = Field(None,alias="errorDetail", description="Error details (for RulesetInvalid, RuleInvalid)") 
+    result_id:  Optional[StrictStr] = Field(None,alias="resultId", description="Unique identifier for the result in format: {{GUID of Check Definition}}-{{resultType}}-{{rulesetKey}}-{{ruleKey}}-{{entity GUID}}") 
+    __properties = ["checkDefinitionScope", "checkDefinitionCode", "checkDefinitionDisplayName", "checkRunAsAt", "resultType", "ruleSetKey", "ruleSetDisplayName", "ruleKey", "ruleDisplayName", "ruleDescription", "ruleFormula", "severity", "lusidEntity", "countRuleBreaches", "errorDetail", "resultId"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    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) -> DataQualityCheckResult:
+        """Create an instance of DataQualityCheckResult 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 lusid_entity
+        if self.lusid_entity:
+            _dict['lusidEntity'] = self.lusid_entity.to_dict()
+        # set to None if check_definition_scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.check_definition_scope is None and "check_definition_scope" in self.__fields_set__:
+            _dict['checkDefinitionScope'] = None
+
+        # set to None if check_definition_code (nullable) is None
+        # and __fields_set__ contains the field
+        if self.check_definition_code is None and "check_definition_code" in self.__fields_set__:
+            _dict['checkDefinitionCode'] = None
+
+        # set to None if check_definition_display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.check_definition_display_name is None and "check_definition_display_name" in self.__fields_set__:
+            _dict['checkDefinitionDisplayName'] = None
+
+        # set to None if result_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.result_type is None and "result_type" in self.__fields_set__:
+            _dict['resultType'] = None
+
+        # set to None if rule_set_key (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_set_key is None and "rule_set_key" in self.__fields_set__:
+            _dict['ruleSetKey'] = None
+
+        # set to None if rule_set_display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_set_display_name is None and "rule_set_display_name" in self.__fields_set__:
+            _dict['ruleSetDisplayName'] = None
+
+        # set to None if rule_key (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_key is None and "rule_key" in self.__fields_set__:
+            _dict['ruleKey'] = None
+
+        # set to None if rule_display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_display_name is None and "rule_display_name" in self.__fields_set__:
+            _dict['ruleDisplayName'] = None
+
+        # set to None if rule_description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_description is None and "rule_description" in self.__fields_set__:
+            _dict['ruleDescription'] = None
+
+        # set to None if rule_formula (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_formula is None and "rule_formula" in self.__fields_set__:
+            _dict['ruleFormula'] = None
+
+        # set to None if severity (nullable) is None
+        # and __fields_set__ contains the field
+        if self.severity is None and "severity" in self.__fields_set__:
+            _dict['severity'] = None
+
+        # set to None if count_rule_breaches (nullable) is None
+        # and __fields_set__ contains the field
+        if self.count_rule_breaches is None and "count_rule_breaches" in self.__fields_set__:
+            _dict['countRuleBreaches'] = None
+
+        # set to None if error_detail (nullable) is None
+        # and __fields_set__ contains the field
+        if self.error_detail is None and "error_detail" in self.__fields_set__:
+            _dict['errorDetail'] = None
+
+        # set to None if result_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.result_id is None and "result_id" in self.__fields_set__:
+            _dict['resultId'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> DataQualityCheckResult:
+        """Create an instance of DataQualityCheckResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return DataQualityCheckResult.parse_obj(obj)
+
+        _obj = DataQualityCheckResult.parse_obj({
+            "check_definition_scope": obj.get("checkDefinitionScope"),
+            "check_definition_code": obj.get("checkDefinitionCode"),
+            "check_definition_display_name": obj.get("checkDefinitionDisplayName"),
+            "check_run_as_at": obj.get("checkRunAsAt"),
+            "result_type": obj.get("resultType"),
+            "rule_set_key": obj.get("ruleSetKey"),
+            "rule_set_display_name": obj.get("ruleSetDisplayName"),
+            "rule_key": obj.get("ruleKey"),
+            "rule_display_name": obj.get("ruleDisplayName"),
+            "rule_description": obj.get("ruleDescription"),
+            "rule_formula": obj.get("ruleFormula"),
+            "severity": obj.get("severity"),
+            "lusid_entity": LusidEntityResult.from_dict(obj.get("lusidEntity")) if obj.get("lusidEntity") is not None else None,
+            "count_rule_breaches": obj.get("countRuleBreaches"),
+            "error_detail": obj.get("errorDetail"),
+            "result_id": obj.get("resultId")
+        })
+        return _obj

{lusid_sdk-2.1.983 → lusid_sdk-2.1.984}/lusid/models/derivation_formula_explain_request.py

@@ -26,11 +26,12 @@ class DerivationFormulaExplainRequest(BaseModel):
     DerivationFormulaExplainRequest
     """
     entity_type:  StrictStr = Field(...,alias="entityType", description="The type of the entity for which the derived property or partial formula is to be resolved against.") 
-    scope:  Optional[StrictStr] = Field(None,alias="scope", description="The scope that entity exists in. If no scope is provided, the default scope for the entity type will be used.") 
-    identifier: Optional[Dict[str, StrictStr]] = Field(None, description="An identifier key/value pair that uniquely identifies the entity to explain the derived property for. This can be either an instrument identifier, an identifier property, or a scope/code identifier which take the format {entityType}/default/code : {identifier}. If no identifiers are provided, the logical evaluation tree without resolved values is returned.")
-    property_key:  Optional[StrictStr] = Field(None,alias="propertyKey", description="The key of the derived property to explain. This takes the format {domain}/{scope}/{code}.") 
-    partial_formula:  Optional[StrictStr] = Field(None,alias="partialFormula", description="A partial derivation formula to explain. Can be provided in lieu of a property key.") 
-    __properties = ["entityType", "scope", "identifier", "propertyKey", "partialFormula"]
+    scope:  Optional[StrictStr] = Field(None,alias="scope", description="(Optional) The scope that entity exists in. If no scope is provided, the default scope for the entity type will be used.") 
+    code:  Optional[StrictStr] = Field(None,alias="code", description="(Optional) The code of the entity, to be provided for entities that support scope/code retrieval. If no code or identifier is provided, the logical evaluation tree without resolved values is returned.") 
+    identifier: Optional[Dict[str, StrictStr]] = Field(None, description="(Optional). An identifier key/value pair that uniquely identifies the entity to explain the derived property for. This can be either an instrument identifier, or an identifier property. If no code or identifier is provided, the logical evaluation tree without resolved values is returned.")
+    property_key:  Optional[StrictStr] = Field(None,alias="propertyKey", description="(Optional) The key of the derived property to get an explanation for. This takes the format {domain}/{scope}/{code}. One of either property key or partial formula must be provided.") 
+    partial_formula:  Optional[StrictStr] = Field(None,alias="partialFormula", description="(Optional) A partial derivation formula to get an explanation for. Can be provided in lieu of a property key. One of either property key or partial formula must be provided.") 
+    __properties = ["entityType", "scope", "code", "identifier", "propertyKey", "partialFormula"]
 
     class Config:
         """Pydantic configuration"""
@@ -69,6 +70,11 @@ class DerivationFormulaExplainRequest(BaseModel):
         if self.scope is None and "scope" in self.__fields_set__:
             _dict['scope'] = None
 
+        # set to None if code (nullable) is None
+        # and __fields_set__ contains the field
+        if self.code is None and "code" in self.__fields_set__:
+            _dict['code'] = None
+
         # set to None if identifier (nullable) is None
         # and __fields_set__ contains the field
         if self.identifier is None and "identifier" in self.__fields_set__:
@@ -98,6 +104,7 @@ class DerivationFormulaExplainRequest(BaseModel):
         _obj = DerivationFormulaExplainRequest.parse_obj({
             "entity_type": obj.get("entityType"),
             "scope": obj.get("scope"),
+            "code": obj.get("code"),
             "identifier": obj.get("identifier"),
             "property_key": obj.get("propertyKey"),
             "partial_formula": obj.get("partialFormula")