lusid-sdk 2.0.50b0__py3-none-any.whl → 2.0.470__py3-none-any.whl

lusid/models/compliance_rule_result_v2.py

@@ -0,0 +1,85 @@
+# 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
+from pydantic import BaseModel, Field, constr
+from lusid.models.compliance_summary_rule_result import ComplianceSummaryRuleResult
+from lusid.models.resource_id import ResourceId
+
+class ComplianceRuleResultV2(BaseModel):
+    """
+    ComplianceRuleResultV2
+    """
+    run_id: ResourceId = Field(..., alias="runId")
+    instigated_at: datetime = Field(..., alias="instigatedAt")
+    completed_at: datetime = Field(..., alias="completedAt")
+    schedule: constr(strict=True, min_length=1) = Field(...)
+    rule_result: ComplianceSummaryRuleResult = Field(..., alias="ruleResult")
+    __properties = ["runId", "instigatedAt", "completedAt", "schedule", "ruleResult"]
+
+    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) -> ComplianceRuleResultV2:
+        """Create an instance of ComplianceRuleResultV2 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 run_id
+        if self.run_id:
+            _dict['runId'] = self.run_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rule_result
+        if self.rule_result:
+            _dict['ruleResult'] = self.rule_result.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ComplianceRuleResultV2:
+        """Create an instance of ComplianceRuleResultV2 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ComplianceRuleResultV2.parse_obj(obj)
+
+        _obj = ComplianceRuleResultV2.parse_obj({
+            "run_id": ResourceId.from_dict(obj.get("runId")) if obj.get("runId") is not None else None,
+            "instigated_at": obj.get("instigatedAt"),
+            "completed_at": obj.get("completedAt"),
+            "schedule": obj.get("schedule"),
+            "rule_result": ComplianceSummaryRuleResult.from_dict(obj.get("ruleResult")) if obj.get("ruleResult") is not None else None
+        })
+        return _obj

lusid/models/compliance_step.py

@@ -0,0 +1,99 @@
+# 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, Union
+from pydantic import BaseModel, Field, StrictStr, validator
+import lusid.models
+
+class ComplianceStep(BaseModel):
+    """
+    ComplianceStep
+    """
+    compliance_step_type: StrictStr = Field(..., alias="complianceStepType", description=". The available values are: FilterStep, GroupByStep, GroupFilterStep, BranchStep, RecombineStep, CheckStep")
+    __properties = ["complianceStepType"]
+
+    @validator('compliance_step_type')
+    def compliance_step_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('FilterStep', 'GroupByStep', 'GroupFilterStep', 'BranchStep', 'RecombineStep', 'CheckStep'):
+            raise ValueError("must be one of enum values ('FilterStep', 'GroupByStep', 'GroupFilterStep', 'BranchStep', 'RecombineStep', 'CheckStep')")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    # JSON field name that stores the object type
+    __discriminator_property_name = 'complianceStepType'
+
+    # discriminator mappings
+    __discriminator_value_class_map = {
+        'BranchStep': 'BranchStep',
+        'CheckStep': 'CheckStep',
+        'FilterStep': 'FilterStep',
+        'GroupByStep': 'GroupByStep',
+        'GroupFilterStep': 'GroupFilterStep',
+        'IntermediateComplianceStep': 'IntermediateComplianceStep',
+        'RecombineStep': 'RecombineStep'
+    }
+
+    @classmethod
+    def get_discriminator_value(cls, obj: dict) -> str:
+        """Returns the discriminator value (object type) of the data"""
+        discriminator_value = obj[cls.__discriminator_property_name]
+        if discriminator_value:
+            return cls.__discriminator_value_class_map.get(discriminator_value)
+        else:
+            return None
+
+    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) -> Union(BranchStep, CheckStep, FilterStep, GroupByStep, GroupFilterStep, IntermediateComplianceStep, RecombineStep):
+        """Create an instance of ComplianceStep 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Union(BranchStep, CheckStep, FilterStep, GroupByStep, GroupFilterStep, IntermediateComplianceStep, RecombineStep):
+        """Create an instance of ComplianceStep from a dict"""
+        # look up the object type based on discriminator mapping
+        object_type = cls.get_discriminator_value(obj)
+        if object_type:
+            klass = getattr(lusid.models, object_type)
+            return klass.from_dict(obj)
+        else:
+            raise ValueError("ComplianceStep failed to lookup discriminator value from " +
+                             json.dumps(obj) + ". Discriminator property name: " + cls.__discriminator_property_name +
+                             ", mapping: " + json.dumps(cls.__discriminator_value_class_map))

lusid/models/compliance_step_type.py

@@ -0,0 +1,42 @@
+# 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.
+"""
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class ComplianceStepType(str, Enum):
+    """
+    ComplianceStepType
+    """
+
+    """
+    allowed enum values
+    """
+    FILTERSTEP = 'FilterStep'
+    GROUPBYSTEP = 'GroupByStep'
+    GROUPFILTERSTEP = 'GroupFilterStep'
+    BRANCHSTEP = 'BranchStep'
+    RECOMBINESTEP = 'RecombineStep'
+    CHECKSTEP = 'CheckStep'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ComplianceStepType:
+        """Create an instance of ComplianceStepType from a JSON string"""
+        return ComplianceStepType(json.loads(json_str))

lusid/models/compliance_summary_rule_result.py

@@ -19,7 +19,7 @@ import json
 
 
 from typing import Any, Dict, List
-from pydantic import BaseModel, Field, conlist, constr
+from pydantic import BaseModel, Field, StrictStr, conlist, constr
 from lusid.models.compliance_rule_breakdown import ComplianceRuleBreakdown
 from lusid.models.resource_id import ResourceId
 
@@ -33,8 +33,9 @@ class ComplianceSummaryRuleResult(BaseModel):
     rule_status: constr(strict=True, min_length=1) = Field(..., alias="ruleStatus")
     affected_portfolios: conlist(ResourceId) = Field(..., alias="affectedPortfolios")
     affected_orders: conlist(ResourceId) = Field(..., alias="affectedOrders")
-    rule_breakdown: Dict[str, ComplianceRuleBreakdown] = Field(..., alias="ruleBreakdown")
-    __properties = ["ruleId", "templateId", "variation", "ruleStatus", "affectedPortfolios", "affectedOrders", "ruleBreakdown"]
+    parameters_used: Dict[str, StrictStr] = Field(..., alias="parametersUsed")
+    rule_breakdown: conlist(ComplianceRuleBreakdown) = Field(..., alias="ruleBreakdown")
+    __properties = ["ruleId", "templateId", "variation", "ruleStatus", "affectedPortfolios", "affectedOrders", "parametersUsed", "ruleBreakdown"]
 
     class Config:
         """Pydantic configuration"""
@@ -80,13 +81,13 @@ class ComplianceSummaryRuleResult(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['affectedOrders'] = _items
-        # override the default output from pydantic by calling `to_dict()` of each value in rule_breakdown (dict)
-        _field_dict = {}
+        # override the default output from pydantic by calling `to_dict()` of each item in rule_breakdown (list)
+        _items = []
         if self.rule_breakdown:
-            for _key in self.rule_breakdown:
-                if self.rule_breakdown[_key]:
-                    _field_dict[_key] = self.rule_breakdown[_key].to_dict()
-            _dict['ruleBreakdown'] = _field_dict
+            for _item in self.rule_breakdown:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['ruleBreakdown'] = _items
         return _dict
 
     @classmethod
@@ -105,11 +106,7 @@ class ComplianceSummaryRuleResult(BaseModel):
             "rule_status": obj.get("ruleStatus"),
             "affected_portfolios": [ResourceId.from_dict(_item) for _item in obj.get("affectedPortfolios")] if obj.get("affectedPortfolios") is not None else None,
             "affected_orders": [ResourceId.from_dict(_item) for _item in obj.get("affectedOrders")] if obj.get("affectedOrders") is not None else None,
-            "rule_breakdown": dict(
-                (_k, ComplianceRuleBreakdown.from_dict(_v))
-                for _k, _v in obj.get("ruleBreakdown").items()
-            )
-            if obj.get("ruleBreakdown") is not None
-            else None
+            "parameters_used": obj.get("parametersUsed"),
+            "rule_breakdown": [ComplianceRuleBreakdown.from_dict(_item) for _item in obj.get("ruleBreakdown")] if obj.get("ruleBreakdown") is not None else None
         })
         return _obj

lusid/models/compliance_summary_rule_result_request.py

@@ -19,7 +19,7 @@ import json
 
 
 from typing import Any, Dict, List
-from pydantic import BaseModel, Field, conlist, constr
+from pydantic import BaseModel, Field, StrictStr, conlist, constr
 from lusid.models.compliance_rule_breakdown_request import ComplianceRuleBreakdownRequest
 from lusid.models.resource_id import ResourceId
 
@@ -33,8 +33,9 @@ class ComplianceSummaryRuleResultRequest(BaseModel):
     rule_status: constr(strict=True, max_length=6000, min_length=0) = Field(..., alias="ruleStatus")
     affected_portfolios: conlist(ResourceId) = Field(..., alias="affectedPortfolios")
     affected_orders: conlist(ResourceId) = Field(..., alias="affectedOrders")
-    rule_breakdown: Dict[str, ComplianceRuleBreakdownRequest] = Field(..., alias="ruleBreakdown")
-    __properties = ["ruleId", "templateId", "variation", "ruleStatus", "affectedPortfolios", "affectedOrders", "ruleBreakdown"]
+    parameters_used: Dict[str, StrictStr] = Field(..., alias="parametersUsed")
+    rule_breakdown: conlist(ComplianceRuleBreakdownRequest) = Field(..., alias="ruleBreakdown")
+    __properties = ["ruleId", "templateId", "variation", "ruleStatus", "affectedPortfolios", "affectedOrders", "parametersUsed", "ruleBreakdown"]
 
     class Config:
         """Pydantic configuration"""
@@ -80,13 +81,13 @@ class ComplianceSummaryRuleResultRequest(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['affectedOrders'] = _items
-        # override the default output from pydantic by calling `to_dict()` of each value in rule_breakdown (dict)
-        _field_dict = {}
+        # override the default output from pydantic by calling `to_dict()` of each item in rule_breakdown (list)
+        _items = []
         if self.rule_breakdown:
-            for _key in self.rule_breakdown:
-                if self.rule_breakdown[_key]:
-                    _field_dict[_key] = self.rule_breakdown[_key].to_dict()
-            _dict['ruleBreakdown'] = _field_dict
+            for _item in self.rule_breakdown:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['ruleBreakdown'] = _items
         return _dict
 
     @classmethod
@@ -105,11 +106,7 @@ class ComplianceSummaryRuleResultRequest(BaseModel):
             "rule_status": obj.get("ruleStatus"),
             "affected_portfolios": [ResourceId.from_dict(_item) for _item in obj.get("affectedPortfolios")] if obj.get("affectedPortfolios") is not None else None,
             "affected_orders": [ResourceId.from_dict(_item) for _item in obj.get("affectedOrders")] if obj.get("affectedOrders") is not None else None,
-            "rule_breakdown": dict(
-                (_k, ComplianceRuleBreakdownRequest.from_dict(_v))
-                for _k, _v in obj.get("ruleBreakdown").items()
-            )
-            if obj.get("ruleBreakdown") is not None
-            else None
+            "parameters_used": obj.get("parametersUsed"),
+            "rule_breakdown": [ComplianceRuleBreakdownRequest.from_dict(_item) for _item in obj.get("ruleBreakdown")] if obj.get("ruleBreakdown") is not None else None
         })
         return _obj

lusid/models/compliance_template_variation.py

@@ -20,6 +20,7 @@ import json
 
 from typing import Any, Dict, List
 from pydantic import BaseModel, Field, conlist, constr
+from lusid.models.compliance_step import ComplianceStep
 from lusid.models.compliance_template_parameter import ComplianceTemplateParameter
 from lusid.models.perpetual_property import PerpetualProperty
 from lusid.models.resource_id import ResourceId
@@ -33,7 +34,8 @@ class ComplianceTemplateVariation(BaseModel):
     required_parameters: conlist(ComplianceTemplateParameter) = Field(..., alias="requiredParameters", description="A parameter required by a Compliance Template Variation")
     properties: Dict[str, PerpetualProperty] = Field(..., description="Properties associated with the Compliance Template Variation")
     accepted_address_keys: ResourceId = Field(..., alias="acceptedAddressKeys")
-    __properties = ["label", "description", "requiredParameters", "properties", "acceptedAddressKeys"]
+    steps: conlist(ComplianceStep) = Field(..., description="The steps expressed in this template, with their required parameters")
+    __properties = ["label", "description", "requiredParameters", "properties", "acceptedAddressKeys", "steps"]
 
     class Config:
         """Pydantic configuration"""
@@ -76,6 +78,13 @@ class ComplianceTemplateVariation(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of accepted_address_keys
         if self.accepted_address_keys:
             _dict['acceptedAddressKeys'] = self.accepted_address_keys.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in steps (list)
+        _items = []
+        if self.steps:
+            for _item in self.steps:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['steps'] = _items
         return _dict
 
     @classmethod
@@ -97,6 +106,7 @@ class ComplianceTemplateVariation(BaseModel):
             )
             if obj.get("properties") is not None
             else None,
-            "accepted_address_keys": ResourceId.from_dict(obj.get("acceptedAddressKeys")) if obj.get("acceptedAddressKeys") is not None else None
+            "accepted_address_keys": ResourceId.from_dict(obj.get("acceptedAddressKeys")) if obj.get("acceptedAddressKeys") is not None else None,
+            "steps": [ComplianceStep.from_dict(_item) for _item in obj.get("steps")] if obj.get("steps") is not None else None
         })
         return _obj

lusid/models/component_transaction.py

@@ -0,0 +1,92 @@
+# 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 import BaseModel, Field, conlist, constr
+from lusid.models.transaction_field_map import TransactionFieldMap
+from lusid.models.transaction_property_map import TransactionPropertyMap
+
+class ComponentTransaction(BaseModel):
+    """
+    ComponentTransaction
+    """
+    display_name: constr(strict=True, max_length=100, min_length=0) = Field(..., alias="displayName")
+    condition: Optional[constr(strict=True, max_length=1024, min_length=0)] = None
+    transaction_field_map: TransactionFieldMap = Field(..., alias="transactionFieldMap")
+    transaction_property_map: conlist(TransactionPropertyMap) = Field(..., alias="transactionPropertyMap")
+    __properties = ["displayName", "condition", "transactionFieldMap", "transactionPropertyMap"]
+
+    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) -> ComponentTransaction:
+        """Create an instance of ComponentTransaction 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 transaction_field_map
+        if self.transaction_field_map:
+            _dict['transactionFieldMap'] = self.transaction_field_map.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in transaction_property_map (list)
+        _items = []
+        if self.transaction_property_map:
+            for _item in self.transaction_property_map:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['transactionPropertyMap'] = _items
+        # set to None if condition (nullable) is None
+        # and __fields_set__ contains the field
+        if self.condition is None and "condition" in self.__fields_set__:
+            _dict['condition'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ComponentTransaction:
+        """Create an instance of ComponentTransaction from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ComponentTransaction.parse_obj(obj)
+
+        _obj = ComponentTransaction.parse_obj({
+            "display_name": obj.get("displayName"),
+            "condition": obj.get("condition"),
+            "transaction_field_map": TransactionFieldMap.from_dict(obj.get("transactionFieldMap")) if obj.get("transactionFieldMap") is not None else None,
+            "transaction_property_map": [TransactionPropertyMap.from_dict(_item) for _item in obj.get("transactionPropertyMap")] if obj.get("transactionPropertyMap") is not None else None
+        })
+        return _obj

lusid/models/composite_dispersion.py

@@ -27,11 +27,11 @@ class CompositeDispersion(BaseModel):
     A list of Dispersion calculations for the given years.  # noqa: E501
     """
     effective_at: datetime = Field(..., alias="effectiveAt", description="The date for which dipsersion calculation has been done. This should be 31 Dec for each given year.")
-    dispersion_calculation: Union[StrictFloat, StrictInt] = Field(..., alias="dispersionCalculation", description="The result for the dispersion calculation on the given effectiveAt.")
-    variance: Union[StrictFloat, StrictInt] = Field(..., description="The variance on the given effectiveAt.")
-    first_quartile: Union[StrictFloat, StrictInt] = Field(..., alias="firstQuartile", description="First Quartile (Q1) =  (lower quartile) = the middle of the bottom half of the returns.")
-    third_quartile: Union[StrictFloat, StrictInt] = Field(..., alias="thirdQuartile", description="Third Quartile (Q3) =  (higher quartile) = the middle of the top half of the returns.")
-    range: Union[StrictFloat, StrictInt] = Field(..., description="Highest return - Lowest return.")
+    dispersion_calculation: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="dispersionCalculation", description="The result for the dispersion calculation on the given effectiveAt.")
+    variance: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The variance on the given effectiveAt.")
+    first_quartile: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="firstQuartile", description="First Quartile (Q1) =  (lower quartile) = the middle of the bottom half of the returns.")
+    third_quartile: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="thirdQuartile", description="Third Quartile (Q3) =  (higher quartile) = the middle of the top half of the returns.")
+    range: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="Highest return - Lowest return.")
     constituents_in_scope: Optional[conlist(ResourceId)] = Field(None, alias="constituentsInScope", description="List containing Composite members which are part of the dispersion calcualtion.")
     constituents_excluded: Optional[conlist(ResourceId)] = Field(None, alias="constituentsExcluded", description="List containing the Composite members which are not part of the dispersion calculation")
     __properties = ["effectiveAt", "dispersionCalculation", "variance", "firstQuartile", "thirdQuartile", "range", "constituentsInScope", "constituentsExcluded"]
@@ -74,6 +74,31 @@ class CompositeDispersion(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['constituentsExcluded'] = _items
+        # set to None if dispersion_calculation (nullable) is None
+        # and __fields_set__ contains the field
+        if self.dispersion_calculation is None and "dispersion_calculation" in self.__fields_set__:
+            _dict['dispersionCalculation'] = None
+
+        # set to None if variance (nullable) is None
+        # and __fields_set__ contains the field
+        if self.variance is None and "variance" in self.__fields_set__:
+            _dict['variance'] = None
+
+        # set to None if first_quartile (nullable) is None
+        # and __fields_set__ contains the field
+        if self.first_quartile is None and "first_quartile" in self.__fields_set__:
+            _dict['firstQuartile'] = None
+
+        # set to None if third_quartile (nullable) is None
+        # and __fields_set__ contains the field
+        if self.third_quartile is None and "third_quartile" in self.__fields_set__:
+            _dict['thirdQuartile'] = None
+
+        # set to None if range (nullable) is None
+        # and __fields_set__ contains the field
+        if self.range is None and "range" in self.__fields_set__:
+            _dict['range'] = None
+
         # set to None if constituents_in_scope (nullable) is None
         # and __fields_set__ contains the field
         if self.constituents_in_scope is None and "constituents_in_scope" in self.__fields_set__:

lusid/models/compounding.py

@@ -25,12 +25,12 @@ class Compounding(BaseModel):
     """
     The compounding settings used on interest rate.  # noqa: E501
     """
-    averaging_method: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="averagingMethod", description="Defines whether a weighted or unweighted average is used when calculating the average rate.  It applies only when CompoundingMethod = ‘Average‘.    Supported string (enumeration) values are: [Unweighted, Weighted].")
+    averaging_method: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="averagingMethod", description="Defines whether a weighted or unweighted average is used when calculating the average rate.  It applies only when CompoundingMethod = ‘Averaging‘.    Supported string (enumeration) values are: [Unweighted, Weighted].")
     calculation_shift_method: Optional[StrictStr] = Field(None, alias="calculationShiftMethod", description="Defines which resets and day counts are used for the rate calculation    Supported string (enumeration) values are: [Lookback, NoShift, ObservationPeriodShift, Lockout].")
-    compounding_method: constr(strict=True, min_length=1) = Field(..., alias="compoundingMethod", description="If the interest rate is simple, compounded or using a pre-computed compounded index.    Supported string (enumeration) values are: [Average, Compounded, CompoundedIndex].")
-    reset_frequency: constr(strict=True, min_length=1) = Field(..., alias="resetFrequency", description="The interest payment frequency.")
+    compounding_method: constr(strict=True, min_length=1) = Field(..., alias="compoundingMethod", description="If the interest rate is simple, compounded or using a pre-computed compounded index.    Supported string (enumeration) values are: [Averaging, Compounding, CompoundedIndex].")
+    reset_frequency: constr(strict=True, min_length=1) = Field(..., alias="resetFrequency", description="The interest payment frequency.    For more information on tenors, see [knowledge base article KA-02097](https://support.lusid.com/knowledgebase/article/KA-02097)")
     shift: Optional[StrictInt] = Field(None, description="Defines the number of days to lockout or shift observation period by - should be a non-negative integer")
-    spread_compounding_method: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="spreadCompoundingMethod", description="Defines how the computed leg spread is applied to compounded rate.  It applies only when CompoundingMethod = ‘Compounded‘.    Available compounding methods:    | Method | Description |  | ------ | ----------- |  | Straight | Compounding rate in each compound period includes the spread. |  | Flat | Compounding rate does not include the spread, and the spread is used for simple interest in each compound period. |  | SpreadExclusive | Compounding rate does not include the spread, and the spread is used for simple interest for whole accrual period. |    The values \"IsdaCompounding\", \"NoCompounding\", \"IsdaFlatCompounding\", and \"None\" are accepted for compatibility  with existing instruments and their use is discouraged.    Supported string (enumeration) values are: [Straight, IsdaCompounding, NoCompounding, SpreadExclusive, IsdaFlatCompounding, Flat, None].")
+    spread_compounding_method: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="spreadCompoundingMethod", description="Defines how the computed leg spread is applied to compounded rate.  It applies only when CompoundingMethod = ‘Compounding‘ or ‘CompoundedIndex‘.    Available compounding methods:    | Method | Description |  | ------ | ----------- |  | Straight | Compounding rate in each compound period includes the spread. |  | Flat | Compounding rate does not include the spread, and the spread is used for simple interest in each compound period. |  | SpreadExclusive | Compounding rate does not include the spread, and the spread is used for simple interest for whole accrual period. |    The values \"IsdaCompounding\", \"NoCompounding\", \"IsdaFlatCompounding\", and \"None\" are accepted for compatibility  with existing instruments and their use is discouraged.    Supported string (enumeration) values are: [Straight, IsdaCompounding, NoCompounding, SpreadExclusive, IsdaFlatCompounding, Flat, None].")
     __properties = ["averagingMethod", "calculationShiftMethod", "compoundingMethod", "resetFrequency", "shift", "spreadCompoundingMethod"]
 
     class Config:

lusid/models/configuration_recipe.py

@@ -18,13 +18,13 @@ import re  # noqa: F401
 import json
 
 
-from typing import Any, Dict, List, Optional
-from pydantic import BaseModel, Field, conlist, constr, validator
+from typing import Any, Dict, Optional
+from pydantic import BaseModel, Field, constr, validator
 from lusid.models.aggregation_context import AggregationContext
 from lusid.models.holding_context import HoldingContext
 from lusid.models.market_context import MarketContext
 from lusid.models.pricing_context import PricingContext
-from lusid.models.resource_id import ResourceId
+from lusid.models.translation_context import TranslationContext
 
 class ConfigurationRecipe(BaseModel):
     """
@@ -35,10 +35,10 @@ class ConfigurationRecipe(BaseModel):
     market: Optional[MarketContext] = None
     pricing: Optional[PricingContext] = None
     aggregation: Optional[AggregationContext] = None
-    inherited_recipes: Optional[conlist(ResourceId)] = Field(None, alias="inheritedRecipes", description="A list of parent recipes (scope,code) that can be used to share functionality between recipes. For instance one might use common recipes to set up  pricing for individual asset classes, e.g. rates or credit, and then combine them into a single recipe to be used by an exotics desk in conjunction with  some overrides that it requires for models or other pricing options.")
     description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="User can assign a description to understand more humanly the recipe.")
     holding: Optional[HoldingContext] = None
-    __properties = ["scope", "code", "market", "pricing", "aggregation", "inheritedRecipes", "description", "holding"]
+    translation: Optional[TranslationContext] = None
+    __properties = ["scope", "code", "market", "pricing", "aggregation", "description", "holding", "translation"]
 
     @validator('scope')
     def scope_validate_regular_expression(cls, value):
@@ -97,21 +97,12 @@ class ConfigurationRecipe(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of aggregation
         if self.aggregation:
             _dict['aggregation'] = self.aggregation.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of each item in inherited_recipes (list)
-        _items = []
-        if self.inherited_recipes:
-            for _item in self.inherited_recipes:
-                if _item:
-                    _items.append(_item.to_dict())
-            _dict['inheritedRecipes'] = _items
         # override the default output from pydantic by calling `to_dict()` of holding
         if self.holding:
             _dict['holding'] = self.holding.to_dict()
-        # set to None if inherited_recipes (nullable) is None
-        # and __fields_set__ contains the field
-        if self.inherited_recipes is None and "inherited_recipes" in self.__fields_set__:
-            _dict['inheritedRecipes'] = None
-
+        # override the default output from pydantic by calling `to_dict()` of translation
+        if self.translation:
+            _dict['translation'] = self.translation.to_dict()
         # 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__:
@@ -134,8 +125,8 @@ class ConfigurationRecipe(BaseModel):
             "market": MarketContext.from_dict(obj.get("market")) if obj.get("market") is not None else None,
             "pricing": PricingContext.from_dict(obj.get("pricing")) if obj.get("pricing") is not None else None,
             "aggregation": AggregationContext.from_dict(obj.get("aggregation")) if obj.get("aggregation") is not None else None,
-            "inherited_recipes": [ResourceId.from_dict(_item) for _item in obj.get("inheritedRecipes")] if obj.get("inheritedRecipes") is not None else None,
             "description": obj.get("description"),
-            "holding": HoldingContext.from_dict(obj.get("holding")) if obj.get("holding") is not None else None
+            "holding": HoldingContext.from_dict(obj.get("holding")) if obj.get("holding") is not None else None,
+            "translation": TranslationContext.from_dict(obj.get("translation")) if obj.get("translation") is not None else None
         })
         return _obj