lusid-sdk 2.1.887__py3-none-any.whl → 2.1.889__py3-none-any.whl

lusid/api/custom_data_models_api.py

@@ -71,7 +71,7 @@ class CustomDataModelsApi:
 
     @validate_arguments
     def batch_amend(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], async_req: Optional[bool]=None, **kwargs) -> Union[BatchAmendCustomDataModelMembershipResponse, Awaitable[BatchAmendCustomDataModelMembershipResponse]]:  # noqa: E501
-        """[INTERNAL] BatchAmend: Batch amend Custom Data Models  # noqa: E501
+        """[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership.  # noqa: E501
 
         Add/Remove entities to/from a Custom Data Model in a single operation.                Each amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.  It serves only as a way to easily identify each amendment in the response.                Note: If using partial failure modes, then it is important to check the response body for failures as any  failures will still return a 200 status code.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -104,7 +104,7 @@ class CustomDataModelsApi:
 
     @validate_arguments
     def batch_amend_with_http_info(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], **kwargs) -> ApiResponse:  # noqa: E501
-        """[INTERNAL] BatchAmend: Batch amend Custom Data Models  # noqa: E501
+        """[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership.  # noqa: E501
 
         Add/Remove entities to/from a Custom Data Model in a single operation.                Each amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.  It serves only as a way to easily identify each amendment in the response.                Note: If using partial failure modes, then it is important to check the response body for failures as any  failures will still return a 200 status code.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an

lusid/api/funds_api.py

@@ -4369,7 +4369,7 @@ class FundsApi:
     def patch_fund(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], async_req: Optional[bool]=None, **kwargs) -> Union[Fund, Awaitable[Fund]]:  # noqa: E501
         """[EXPERIMENTAL] PatchFund: Patch a Fund.  # noqa: E501
 
-        Update fields on a Fund.  The behaviour is defined by the JSON Patch specification.    Currently supported fields are: DisplayName, Description, FundConfigurationId, AborId, ShareClassInstrumentScopes, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, YearEndDate.  # noqa: E501
+        Update fields on a Fund.  The behaviour is defined by the JSON Patch specification.    Currently supported fields are: DisplayName, Description, BaseCurrency, PortfolioIds, FundConfigurationId, ShareClassInstrumentScopes, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, PrimaryNavType, AdditionalNavTypes, AborId, YearEndDate.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -4404,7 +4404,7 @@ class FundsApi:
     def patch_fund_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Fund.")], code : Annotated[StrictStr, Field(..., description="The code of the Fund. Together with the scope this uniquely identifies the Fund.")], operation : Annotated[conlist(Operation), Field(..., description="The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902.")], **kwargs) -> ApiResponse:  # noqa: E501
         """[EXPERIMENTAL] PatchFund: Patch a Fund.  # noqa: E501
 
-        Update fields on a Fund.  The behaviour is defined by the JSON Patch specification.    Currently supported fields are: DisplayName, Description, FundConfigurationId, AborId, ShareClassInstrumentScopes, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, YearEndDate.  # noqa: E501
+        Update fields on a Fund.  The behaviour is defined by the JSON Patch specification.    Currently supported fields are: DisplayName, Description, BaseCurrency, PortfolioIds, FundConfigurationId, ShareClassInstrumentScopes, ShareClassInstruments, Type, InceptionDate, DecimalPlaces, PrimaryNavType, AdditionalNavTypes, AborId, YearEndDate.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

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.8098\n"\
+               "Version of the API: 0.11.8106\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/__init__.py

@@ -171,6 +171,10 @@ from lusid.models.change_item import ChangeItem
 from lusid.models.chart_of_accounts import ChartOfAccounts
 from lusid.models.chart_of_accounts_properties import ChartOfAccountsProperties
 from lusid.models.chart_of_accounts_request import ChartOfAccountsRequest
+from lusid.models.check_definition import CheckDefinition
+from lusid.models.check_definition_dataset_schema import CheckDefinitionDatasetSchema
+from lusid.models.check_definition_rule import CheckDefinitionRule
+from lusid.models.check_definition_rule_set import CheckDefinitionRuleSet
 from lusid.models.check_step import CheckStep
 from lusid.models.check_step_request import CheckStepRequest
 from lusid.models.cleardown_module_details import CleardownModuleDetails
@@ -247,6 +251,7 @@ from lusid.models.counterparty_signatory import CounterpartySignatory
 from lusid.models.create_address_key_definition_request import CreateAddressKeyDefinitionRequest
 from lusid.models.create_amortisation_rule_set_request import CreateAmortisationRuleSetRequest
 from lusid.models.create_calendar_request import CreateCalendarRequest
+from lusid.models.create_check_definition_request import CreateCheckDefinitionRequest
 from lusid.models.create_closed_period_request import CreateClosedPeriodRequest
 from lusid.models.create_compliance_template_request import CreateComplianceTemplateRequest
 from lusid.models.create_corporate_action_source_request import CreateCorporateActionSourceRequest
@@ -717,6 +722,7 @@ from lusid.models.paged_resource_list_of_amortisation_rule_set import PagedResou
 from lusid.models.paged_resource_list_of_block import PagedResourceListOfBlock
 from lusid.models.paged_resource_list_of_calendar import PagedResourceListOfCalendar
 from lusid.models.paged_resource_list_of_chart_of_accounts import PagedResourceListOfChartOfAccounts
+from lusid.models.paged_resource_list_of_check_definition import PagedResourceListOfCheckDefinition
 from lusid.models.paged_resource_list_of_cleardown_module_response import PagedResourceListOfCleardownModuleResponse
 from lusid.models.paged_resource_list_of_cleardown_module_rule import PagedResourceListOfCleardownModuleRule
 from lusid.models.paged_resource_list_of_closed_period import PagedResourceListOfClosedPeriod
@@ -1159,6 +1165,7 @@ from lusid.models.units_ratio import UnitsRatio
 from lusid.models.unmatched_holding_method import UnmatchedHoldingMethod
 from lusid.models.update_amortisation_rule_set_details_request import UpdateAmortisationRuleSetDetailsRequest
 from lusid.models.update_calendar_request import UpdateCalendarRequest
+from lusid.models.update_check_definition_request import UpdateCheckDefinitionRequest
 from lusid.models.update_compliance_template_request import UpdateComplianceTemplateRequest
 from lusid.models.update_custom_data_model_request import UpdateCustomDataModelRequest
 from lusid.models.update_custom_entity_definition_request import UpdateCustomEntityDefinitionRequest
@@ -1438,6 +1445,10 @@ __all__ = [
     "ChartOfAccounts",
     "ChartOfAccountsProperties",
     "ChartOfAccountsRequest",
+    "CheckDefinition",
+    "CheckDefinitionDatasetSchema",
+    "CheckDefinitionRule",
+    "CheckDefinitionRuleSet",
     "CheckStep",
     "CheckStepRequest",
     "CleardownModuleDetails",
@@ -1514,6 +1525,7 @@ __all__ = [
     "CreateAddressKeyDefinitionRequest",
     "CreateAmortisationRuleSetRequest",
     "CreateCalendarRequest",
+    "CreateCheckDefinitionRequest",
     "CreateClosedPeriodRequest",
     "CreateComplianceTemplateRequest",
     "CreateCorporateActionSourceRequest",
@@ -1984,6 +1996,7 @@ __all__ = [
     "PagedResourceListOfBlock",
     "PagedResourceListOfCalendar",
     "PagedResourceListOfChartOfAccounts",
+    "PagedResourceListOfCheckDefinition",
     "PagedResourceListOfCleardownModuleResponse",
     "PagedResourceListOfCleardownModuleRule",
     "PagedResourceListOfClosedPeriod",
@@ -2426,6 +2439,7 @@ __all__ = [
     "UnmatchedHoldingMethod",
     "UpdateAmortisationRuleSetDetailsRequest",
     "UpdateCalendarRequest",
+    "UpdateCheckDefinitionRequest",
     "UpdateComplianceTemplateRequest",
     "UpdateCustomDataModelRequest",
     "UpdateCustomEntityDefinitionRequest",

lusid/models/check_definition.py

@@ -0,0 +1,164 @@
+# 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, List, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictStr, conlist, constr, validator 
+from lusid.models.check_definition_dataset_schema import CheckDefinitionDatasetSchema
+from lusid.models.check_definition_rule_set import CheckDefinitionRuleSet
+from lusid.models.link import Link
+from lusid.models.model_property import ModelProperty
+from lusid.models.resource_id import ResourceId
+from lusid.models.version import Version
+
+class CheckDefinition(BaseModel):
+    """
+    CheckDefinition
+    """
+    id: ResourceId = Field(...)
+    display_name:  Optional[StrictStr] = Field(None,alias="displayName", description="The name of the Check Definition.") 
+    description:  Optional[StrictStr] = Field(None,alias="description", description="A description for the Check Definition.") 
+    dataset_schema: Optional[CheckDefinitionDatasetSchema] = Field(None, alias="datasetSchema")
+    rule_sets: Optional[conlist(CheckDefinitionRuleSet)] = Field(None, alias="ruleSets", description="A collection of rule sets for the Check Definition.")
+    href:  Optional[StrictStr] = Field(None,alias="href", description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.") 
+    version: Optional[Version] = None
+    properties: Optional[Dict[str, ModelProperty]] = Field(None, description="A set of properties for the Check Definition.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["id", "displayName", "description", "datasetSchema", "ruleSets", "href", "version", "properties", "links"]
+
+    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) -> CheckDefinition:
+        """Create an instance of CheckDefinition 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 id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dataset_schema
+        if self.dataset_schema:
+            _dict['datasetSchema'] = self.dataset_schema.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in rule_sets (list)
+        _items = []
+        if self.rule_sets:
+            for _item in self.rule_sets:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['ruleSets'] = _items
+        # override the default output from pydantic by calling `to_dict()` of version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in properties (dict)
+        _field_dict = {}
+        if self.properties:
+            for _key in self.properties:
+                if self.properties[_key]:
+                    _field_dict[_key] = self.properties[_key].to_dict()
+            _dict['properties'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.display_name is None and "display_name" in self.__fields_set__:
+            _dict['displayName'] = None
+
+        # set to None if description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        # set to None if rule_sets (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_sets is None and "rule_sets" in self.__fields_set__:
+            _dict['ruleSets'] = None
+
+        # set to None if href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if properties (nullable) is None
+        # and __fields_set__ contains the field
+        if self.properties is None and "properties" in self.__fields_set__:
+            _dict['properties'] = None
+
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CheckDefinition:
+        """Create an instance of CheckDefinition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CheckDefinition.parse_obj(obj)
+
+        _obj = CheckDefinition.parse_obj({
+            "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description"),
+            "dataset_schema": CheckDefinitionDatasetSchema.from_dict(obj.get("datasetSchema")) if obj.get("datasetSchema") is not None else None,
+            "rule_sets": [CheckDefinitionRuleSet.from_dict(_item) for _item in obj.get("ruleSets")] if obj.get("ruleSets") is not None else None,
+            "href": obj.get("href"),
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
+            "properties": dict(
+                (_k, ModelProperty.from_dict(_v))
+                for _k, _v in obj.get("properties").items()
+            )
+            if obj.get("properties") is not None
+            else None,
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj

lusid/models/check_definition_dataset_schema.py

@@ -0,0 +1,89 @@
+# 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, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, constr 
+
+class CheckDefinitionDatasetSchema(BaseModel):
+    """
+    CheckDefinitionDatasetSchema
+    """
+    type:  Optional[StrictStr] = Field(None,alias="type", description="The type of dataset schema that the Check Definition applies to") 
+    entity_type:  Optional[StrictStr] = Field(None,alias="entityType", description="The type of entity that the dataset schema applies to, e.g. Instrument, Transaction, etc.") 
+    __properties = ["type", "entityType"]
+
+    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) -> CheckDefinitionDatasetSchema:
+        """Create an instance of CheckDefinitionDatasetSchema 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)
+        # set to None if type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.type is None and "type" in self.__fields_set__:
+            _dict['type'] = None
+
+        # set to None if entity_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.entity_type is None and "entity_type" in self.__fields_set__:
+            _dict['entityType'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CheckDefinitionDatasetSchema:
+        """Create an instance of CheckDefinitionDatasetSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CheckDefinitionDatasetSchema.parse_obj(obj)
+
+        _obj = CheckDefinitionDatasetSchema.parse_obj({
+            "type": obj.get("type"),
+            "entity_type": obj.get("entityType")
+        })
+        return _obj

lusid/models/check_definition_rule.py

@@ -0,0 +1,105 @@
+# 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, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictInt, constr, validator 
+
+class CheckDefinitionRule(BaseModel):
+    """
+    CheckDefinitionRule
+    """
+    rule_key:  Optional[StrictStr] = Field(None,alias="ruleKey", description="The key of the Rule.") 
+    display_name:  Optional[StrictStr] = Field(None,alias="displayName", description="The name of the Rule.") 
+    description:  Optional[StrictStr] = Field(None,alias="description", description="A description for the Rule.") 
+    rule_formula:  Optional[StrictStr] = Field(None,alias="ruleFormula", description="The formula for the rule.") 
+    severity: Optional[StrictInt] = Field(None, description="Severity of the rule if formaula is not satisfied.")
+    __properties = ["ruleKey", "displayName", "description", "ruleFormula", "severity"]
+
+    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) -> CheckDefinitionRule:
+        """Create an instance of CheckDefinitionRule 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)
+        # 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 display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.display_name is None and "display_name" in self.__fields_set__:
+            _dict['displayName'] = None
+
+        # set to None if description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CheckDefinitionRule:
+        """Create an instance of CheckDefinitionRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CheckDefinitionRule.parse_obj(obj)
+
+        _obj = CheckDefinitionRule.parse_obj({
+            "rule_key": obj.get("ruleKey"),
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description"),
+            "rule_formula": obj.get("ruleFormula"),
+            "severity": obj.get("severity")
+        })
+        return _obj

lusid/models/check_definition_rule_set.py

@@ -0,0 +1,118 @@
+# 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, List, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, conlist, constr, validator 
+from lusid.models.check_definition_rule import CheckDefinitionRule
+
+class CheckDefinitionRuleSet(BaseModel):
+    """
+    CheckDefinitionRuleSet
+    """
+    rule_set_key:  Optional[StrictStr] = Field(None,alias="ruleSetKey", description="The Key of the Rule Set.") 
+    display_name:  Optional[StrictStr] = Field(None,alias="displayName", description="The name of the Rule Set.") 
+    description:  Optional[StrictStr] = Field(None,alias="description", description="A description for the Rule Set.") 
+    rule_set_filter:  Optional[StrictStr] = Field(None,alias="ruleSetFilter", description="A filter for the Rule Set to filter entity instances the rule set applies to.") 
+    rules: Optional[conlist(CheckDefinitionRule)] = Field(None, description="A collection of rules for the Rule Set.")
+    __properties = ["ruleSetKey", "displayName", "description", "ruleSetFilter", "rules"]
+
+    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) -> CheckDefinitionRuleSet:
+        """Create an instance of CheckDefinitionRuleSet 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 each item in rules (list)
+        _items = []
+        if self.rules:
+            for _item in self.rules:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['rules'] = _items
+        # 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 display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.display_name is None and "display_name" in self.__fields_set__:
+            _dict['displayName'] = None
+
+        # set to None if description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        # set to None if rule_set_filter (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rule_set_filter is None and "rule_set_filter" in self.__fields_set__:
+            _dict['ruleSetFilter'] = None
+
+        # set to None if rules (nullable) is None
+        # and __fields_set__ contains the field
+        if self.rules is None and "rules" in self.__fields_set__:
+            _dict['rules'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> CheckDefinitionRuleSet:
+        """Create an instance of CheckDefinitionRuleSet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return CheckDefinitionRuleSet.parse_obj(obj)
+
+        _obj = CheckDefinitionRuleSet.parse_obj({
+            "rule_set_key": obj.get("ruleSetKey"),
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description"),
+            "rule_set_filter": obj.get("ruleSetFilter"),
+            "rules": [CheckDefinitionRule.from_dict(_item) for _item in obj.get("rules")] if obj.get("rules") is not None else None
+        })
+        return _obj