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

lusid/models/configuration_recipe.py

@@ -5,376 +5,137 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.131
     Contact: info@finbourne.com
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """
 
 
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import six
-
-from lusid.configuration import Configuration
+import json
 
 
-class ConfigurationRecipe(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, conlist, 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
 
+class ConfigurationRecipe(BaseModel):
     """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-      required_map (dict): The key is attribute name
-                           and the value is whether it is 'required' or 'optional'.
+    The Configuration or Calculation Recipe controls how LUSID processes a given request.  This can be used to change where market data used in pricing is loaded from and in what order, or which model is used to  price a given instrument as well as how aggregation will process the produced results.  # noqa: E501
     """
-    openapi_types = {
-        'scope': 'str',
-        'code': 'str',
-        'market': 'MarketContext',
-        'pricing': 'PricingContext',
-        'aggregation': 'AggregationContext',
-        'description': 'str',
-        'holding': 'HoldingContext',
-        'translation': 'TranslationContext'
-    }
-
-    attribute_map = {
-        'scope': 'scope',
-        'code': 'code',
-        'market': 'market',
-        'pricing': 'pricing',
-        'aggregation': 'aggregation',
-        'description': 'description',
-        'holding': 'holding',
-        'translation': 'translation'
-    }
-
-    required_map = {
-        'scope': 'required',
-        'code': 'required',
-        'market': 'optional',
-        'pricing': 'optional',
-        'aggregation': 'optional',
-        'description': 'optional',
-        'holding': 'optional',
-        'translation': 'optional'
-    }
-
-    def __init__(self, scope=None, code=None, market=None, pricing=None, aggregation=None, description=None, holding=None, translation=None, local_vars_configuration=None):  # noqa: E501
-        """ConfigurationRecipe - a model defined in OpenAPI"
-        
-        :param scope:  The scope used when updating or inserting the Configuration Recipe. (required)
-        :type scope: str
-        :param code:  User given string name (code) to identify the recipe. (required)
-        :type code: str
-        :param market: 
-        :type market: lusid.MarketContext
-        :param pricing: 
-        :type pricing: lusid.PricingContext
-        :param aggregation: 
-        :type aggregation: lusid.AggregationContext
-        :param description:  User can assign a description to understand more humanly the recipe.
-        :type description: str
-        :param holding: 
-        :type holding: lusid.HoldingContext
-        :param translation: 
-        :type translation: lusid.TranslationContext
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._scope = None
-        self._code = None
-        self._market = None
-        self._pricing = None
-        self._aggregation = None
-        self._description = None
-        self._holding = None
-        self._translation = None
-        self.discriminator = None
-
-        self.scope = scope
-        self.code = code
-        if market is not None:
-            self.market = market
-        if pricing is not None:
-            self.pricing = pricing
-        if aggregation is not None:
-            self.aggregation = aggregation
-        self.description = description
-        if holding is not None:
-            self.holding = holding
-        if translation is not None:
-            self.translation = translation
-
-    @property
-    def scope(self):
-        """Gets the scope of this ConfigurationRecipe.  # noqa: E501
-
-        The scope used when updating or inserting the Configuration Recipe.  # noqa: E501
-
-        :return: The scope of this ConfigurationRecipe.  # noqa: E501
-        :rtype: str
-        """
-        return self._scope
-
-    @scope.setter
-    def scope(self, scope):
-        """Sets the scope of this ConfigurationRecipe.
-
-        The scope used when updating or inserting the Configuration Recipe.  # noqa: E501
-
-        :param scope: The scope of this ConfigurationRecipe.  # noqa: E501
-        :type scope: str
-        """
-        if self.local_vars_configuration.client_side_validation and scope is None:  # noqa: E501
-            raise ValueError("Invalid value for `scope`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                scope is not None and len(scope) > 64):
-            raise ValueError("Invalid value for `scope`, length must be less than or equal to `64`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                scope is not None and len(scope) < 1):
-            raise ValueError("Invalid value for `scope`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                scope is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', scope)):  # noqa: E501
-            raise ValueError(r"Invalid value for `scope`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._scope = scope
-
-    @property
-    def code(self):
-        """Gets the code of this ConfigurationRecipe.  # noqa: E501
-
-        User given string name (code) to identify the recipe.  # noqa: E501
-
-        :return: The code of this ConfigurationRecipe.  # noqa: E501
-        :rtype: str
-        """
-        return self._code
-
-    @code.setter
-    def code(self, code):
-        """Sets the code of this ConfigurationRecipe.
-
-        User given string name (code) to identify the recipe.  # noqa: E501
-
-        :param code: The code of this ConfigurationRecipe.  # noqa: E501
-        :type code: str
-        """
-        if self.local_vars_configuration.client_side_validation and code is None:  # noqa: E501
-            raise ValueError("Invalid value for `code`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                code is not None and len(code) > 64):
-            raise ValueError("Invalid value for `code`, length must be less than or equal to `64`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                code is not None and len(code) < 1):
-            raise ValueError("Invalid value for `code`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                code is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', code)):  # noqa: E501
-            raise ValueError(r"Invalid value for `code`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._code = code
-
-    @property
-    def market(self):
-        """Gets the market of this ConfigurationRecipe.  # noqa: E501
-
-
-        :return: The market of this ConfigurationRecipe.  # noqa: E501
-        :rtype: lusid.MarketContext
-        """
-        return self._market
-
-    @market.setter
-    def market(self, market):
-        """Sets the market of this ConfigurationRecipe.
-
-
-        :param market: The market of this ConfigurationRecipe.  # noqa: E501
-        :type market: lusid.MarketContext
-        """
-
-        self._market = market
-
-    @property
-    def pricing(self):
-        """Gets the pricing of this ConfigurationRecipe.  # noqa: E501
-
-
-        :return: The pricing of this ConfigurationRecipe.  # noqa: E501
-        :rtype: lusid.PricingContext
-        """
-        return self._pricing
-
-    @pricing.setter
-    def pricing(self, pricing):
-        """Sets the pricing of this ConfigurationRecipe.
-
-
-        :param pricing: The pricing of this ConfigurationRecipe.  # noqa: E501
-        :type pricing: lusid.PricingContext
-        """
-
-        self._pricing = pricing
-
-    @property
-    def aggregation(self):
-        """Gets the aggregation of this ConfigurationRecipe.  # noqa: E501
-
-
-        :return: The aggregation of this ConfigurationRecipe.  # noqa: E501
-        :rtype: lusid.AggregationContext
-        """
-        return self._aggregation
-
-    @aggregation.setter
-    def aggregation(self, aggregation):
-        """Sets the aggregation of this ConfigurationRecipe.
-
-
-        :param aggregation: The aggregation of this ConfigurationRecipe.  # noqa: E501
-        :type aggregation: lusid.AggregationContext
-        """
-
-        self._aggregation = aggregation
-
-    @property
-    def description(self):
-        """Gets the description of this ConfigurationRecipe.  # noqa: E501
-
-        User can assign a description to understand more humanly the recipe.  # noqa: E501
-
-        :return: The description of this ConfigurationRecipe.  # noqa: E501
-        :rtype: str
-        """
-        return self._description
-
-    @description.setter
-    def description(self, description):
-        """Sets the description of this ConfigurationRecipe.
-
-        User can assign a description to understand more humanly the recipe.  # noqa: E501
-
-        :param description: The description of this ConfigurationRecipe.  # noqa: E501
-        :type description: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                description is not None and len(description) > 1024):
-            raise ValueError("Invalid value for `description`, length must be less than or equal to `1024`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                description is not None and len(description) < 0):
-            raise ValueError("Invalid value for `description`, length must be greater than or equal to `0`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                description is not None and not re.search(r'^[\s\S]*$', description)):  # noqa: E501
-            raise ValueError(r"Invalid value for `description`, must be a follow pattern or equal to `/^[\s\S]*$/`")  # noqa: E501
-
-        self._description = description
-
-    @property
-    def holding(self):
-        """Gets the holding of this ConfigurationRecipe.  # noqa: E501
-
-
-        :return: The holding of this ConfigurationRecipe.  # noqa: E501
-        :rtype: lusid.HoldingContext
-        """
-        return self._holding
-
-    @holding.setter
-    def holding(self, holding):
-        """Sets the holding of this ConfigurationRecipe.
-
-
-        :param holding: The holding of this ConfigurationRecipe.  # noqa: E501
-        :type holding: lusid.HoldingContext
-        """
-
-        self._holding = holding
-
-    @property
-    def translation(self):
-        """Gets the translation of this ConfigurationRecipe.  # noqa: E501
-
-
-        :return: The translation of this ConfigurationRecipe.  # noqa: E501
-        :rtype: lusid.TranslationContext
-        """
-        return self._translation
-
-    @translation.setter
-    def translation(self, translation):
-        """Sets the translation of this ConfigurationRecipe.
-
-
-        :param translation: The translation of this ConfigurationRecipe.  # noqa: E501
-        :type translation: lusid.TranslationContext
-        """
-
-        self._translation = translation
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, ConfigurationRecipe):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, ConfigurationRecipe):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    scope: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The scope used when updating or inserting the Configuration Recipe.")
+    code: constr(strict=True, max_length=64, min_length=1) = Field(..., description="User given string name (code) to identify the recipe.")
+    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"]
+
+    @validator('scope')
+    def scope_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('code')
+    def code_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('description')
+    def description_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    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) -> ConfigurationRecipe:
+        """Create an instance of ConfigurationRecipe 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 market
+        if self.market:
+            _dict['market'] = self.market.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pricing
+        if self.pricing:
+            _dict['pricing'] = self.pricing.to_dict()
+        # 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
+
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ConfigurationRecipe:
+        """Create an instance of ConfigurationRecipe from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ConfigurationRecipe.parse_obj(obj)
+
+        _obj = ConfigurationRecipe.parse_obj({
+            "scope": obj.get("scope"),
+            "code": obj.get("code"),
+            "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
+        })
+        return _obj