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

lusid/models/valuation_schedule.py

@@ -5,343 +5,100 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.118
     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 ValuationSchedule(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist, constr
 
-    Do not edit the class manually.
+class ValuationSchedule(BaseModel):
     """
-
+    Specification object for the valuation schedule, how do we determine which days we wish to perform a valuation upon.  # noqa: E501
     """
-    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'.
-    """
-    openapi_types = {
-        'effective_from': 'str',
-        'effective_at': 'str',
-        'tenor': 'str',
-        'roll_convention': 'str',
-        'holiday_calendars': 'list[str]',
-        'valuation_date_times': 'list[str]',
-        'business_day_convention': 'str'
-    }
-
-    attribute_map = {
-        'effective_from': 'effectiveFrom',
-        'effective_at': 'effectiveAt',
-        'tenor': 'tenor',
-        'roll_convention': 'rollConvention',
-        'holiday_calendars': 'holidayCalendars',
-        'valuation_date_times': 'valuationDateTimes',
-        'business_day_convention': 'businessDayConvention'
-    }
-
-    required_map = {
-        'effective_from': 'optional',
-        'effective_at': 'required',
-        'tenor': 'optional',
-        'roll_convention': 'optional',
-        'holiday_calendars': 'optional',
-        'valuation_date_times': 'optional',
-        'business_day_convention': 'optional'
-    }
-
-    def __init__(self, effective_from=None, effective_at=None, tenor=None, roll_convention=None, holiday_calendars=None, valuation_date_times=None, business_day_convention=None, local_vars_configuration=None):  # noqa: E501
-        """ValuationSchedule - a model defined in OpenAPI"
-        
-        :param effective_from:  If present, the EffectiveFrom and EffectiveAt dates are interpreted as a range of dates for which to perform a valuation.  In this case, valuation is calculated for the portfolio(s) for each business day in the given range.
-        :type effective_from: str
-        :param effective_at:  The market data time, i.e. the time to run the valuation request effective of. (required)
-        :type effective_at: str
-        :param tenor:  Tenor, e.g \"1D\", \"1M\" to be used in generating the date schedule when effectiveFrom and effectiveAt are both given and are not the same.
-        :type tenor: str
-        :param roll_convention:  When Tenor is given and is \"1M\" or longer, this specifies the rule which should be used to generate the date schedule.    For example, \"EndOfMonth\" to generate end of month dates, or \"1\" to specify the first day of the applicable month.
-        :type roll_convention: str
-        :param holiday_calendars:  The holiday calendar(s) that should be used in determining the date schedule.  Holiday calendar(s) are supplied by their names, for example, \"CoppClark\".   Note that when the calendars are not available (e.g. when the user has insufficient permissions),   a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.
-        :type holiday_calendars: list[str]
-        :param valuation_date_times:  If given, this is the exact set of dates on which to perform a valuation. This will replace/override all other specified values if given.
-        :type valuation_date_times: list[str]
-        :param business_day_convention:  When Tenor is given and is not equal to \"1D\", there may be cases where \"date + tenor\" land on non-business days around month end.  In that case, the BusinessDayConvention, e.g. modified following \"MF\" would be applied to determine the next GBD.
-        :type business_day_convention: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._effective_from = None
-        self._effective_at = None
-        self._tenor = None
-        self._roll_convention = None
-        self._holiday_calendars = None
-        self._valuation_date_times = None
-        self._business_day_convention = None
-        self.discriminator = None
-
-        self.effective_from = effective_from
-        self.effective_at = effective_at
-        self.tenor = tenor
-        self.roll_convention = roll_convention
-        self.holiday_calendars = holiday_calendars
-        self.valuation_date_times = valuation_date_times
-        self.business_day_convention = business_day_convention
-
-    @property
-    def effective_from(self):
-        """Gets the effective_from of this ValuationSchedule.  # noqa: E501
-
-        If present, the EffectiveFrom and EffectiveAt dates are interpreted as a range of dates for which to perform a valuation.  In this case, valuation is calculated for the portfolio(s) for each business day in the given range.  # noqa: E501
-
-        :return: The effective_from of this ValuationSchedule.  # noqa: E501
-        :rtype: str
-        """
-        return self._effective_from
-
-    @effective_from.setter
-    def effective_from(self, effective_from):
-        """Sets the effective_from of this ValuationSchedule.
-
-        If present, the EffectiveFrom and EffectiveAt dates are interpreted as a range of dates for which to perform a valuation.  In this case, valuation is calculated for the portfolio(s) for each business day in the given range.  # noqa: E501
-
-        :param effective_from: The effective_from of this ValuationSchedule.  # noqa: E501
-        :type effective_from: str
-        """
-
-        self._effective_from = effective_from
-
-    @property
-    def effective_at(self):
-        """Gets the effective_at of this ValuationSchedule.  # noqa: E501
-
-        The market data time, i.e. the time to run the valuation request effective of.  # noqa: E501
-
-        :return: The effective_at of this ValuationSchedule.  # noqa: E501
-        :rtype: str
-        """
-        return self._effective_at
-
-    @effective_at.setter
-    def effective_at(self, effective_at):
-        """Sets the effective_at of this ValuationSchedule.
-
-        The market data time, i.e. the time to run the valuation request effective of.  # noqa: E501
-
-        :param effective_at: The effective_at of this ValuationSchedule.  # noqa: E501
-        :type effective_at: str
-        """
-        if self.local_vars_configuration.client_side_validation and effective_at is None:  # noqa: E501
-            raise ValueError("Invalid value for `effective_at`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                effective_at is not None and len(effective_at) < 1):
-            raise ValueError("Invalid value for `effective_at`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._effective_at = effective_at
-
-    @property
-    def tenor(self):
-        """Gets the tenor of this ValuationSchedule.  # noqa: E501
-
-        Tenor, e.g \"1D\", \"1M\" to be used in generating the date schedule when effectiveFrom and effectiveAt are both given and are not the same.  # noqa: E501
-
-        :return: The tenor of this ValuationSchedule.  # noqa: E501
-        :rtype: str
-        """
-        return self._tenor
-
-    @tenor.setter
-    def tenor(self, tenor):
-        """Sets the tenor of this ValuationSchedule.
-
-        Tenor, e.g \"1D\", \"1M\" to be used in generating the date schedule when effectiveFrom and effectiveAt are both given and are not the same.  # noqa: E501
-
-        :param tenor: The tenor of this ValuationSchedule.  # noqa: E501
-        :type tenor: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                tenor is not None and len(tenor) > 16):
-            raise ValueError("Invalid value for `tenor`, length must be less than or equal to `16`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                tenor is not None and len(tenor) < 0):
-            raise ValueError("Invalid value for `tenor`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._tenor = tenor
-
-    @property
-    def roll_convention(self):
-        """Gets the roll_convention of this ValuationSchedule.  # noqa: E501
-
-        When Tenor is given and is \"1M\" or longer, this specifies the rule which should be used to generate the date schedule.    For example, \"EndOfMonth\" to generate end of month dates, or \"1\" to specify the first day of the applicable month.  # noqa: E501
-
-        :return: The roll_convention of this ValuationSchedule.  # noqa: E501
-        :rtype: str
-        """
-        return self._roll_convention
-
-    @roll_convention.setter
-    def roll_convention(self, roll_convention):
-        """Sets the roll_convention of this ValuationSchedule.
-
-        When Tenor is given and is \"1M\" or longer, this specifies the rule which should be used to generate the date schedule.    For example, \"EndOfMonth\" to generate end of month dates, or \"1\" to specify the first day of the applicable month.  # noqa: E501
-
-        :param roll_convention: The roll_convention of this ValuationSchedule.  # noqa: E501
-        :type roll_convention: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                roll_convention is not None and len(roll_convention) > 50):
-            raise ValueError("Invalid value for `roll_convention`, length must be less than or equal to `50`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                roll_convention is not None and len(roll_convention) < 0):
-            raise ValueError("Invalid value for `roll_convention`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._roll_convention = roll_convention
-
-    @property
-    def holiday_calendars(self):
-        """Gets the holiday_calendars of this ValuationSchedule.  # noqa: E501
-
-        The holiday calendar(s) that should be used in determining the date schedule.  Holiday calendar(s) are supplied by their names, for example, \"CoppClark\".   Note that when the calendars are not available (e.g. when the user has insufficient permissions),   a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.  # noqa: E501
-
-        :return: The holiday_calendars of this ValuationSchedule.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._holiday_calendars
-
-    @holiday_calendars.setter
-    def holiday_calendars(self, holiday_calendars):
-        """Sets the holiday_calendars of this ValuationSchedule.
-
-        The holiday calendar(s) that should be used in determining the date schedule.  Holiday calendar(s) are supplied by their names, for example, \"CoppClark\".   Note that when the calendars are not available (e.g. when the user has insufficient permissions),   a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.  # noqa: E501
-
-        :param holiday_calendars: The holiday_calendars of this ValuationSchedule.  # noqa: E501
-        :type holiday_calendars: list[str]
-        """
-
-        self._holiday_calendars = holiday_calendars
-
-    @property
-    def valuation_date_times(self):
-        """Gets the valuation_date_times of this ValuationSchedule.  # noqa: E501
-
-        If given, this is the exact set of dates on which to perform a valuation. This will replace/override all other specified values if given.  # noqa: E501
-
-        :return: The valuation_date_times of this ValuationSchedule.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._valuation_date_times
-
-    @valuation_date_times.setter
-    def valuation_date_times(self, valuation_date_times):
-        """Sets the valuation_date_times of this ValuationSchedule.
-
-        If given, this is the exact set of dates on which to perform a valuation. This will replace/override all other specified values if given.  # noqa: E501
-
-        :param valuation_date_times: The valuation_date_times of this ValuationSchedule.  # noqa: E501
-        :type valuation_date_times: list[str]
-        """
-
-        self._valuation_date_times = valuation_date_times
-
-    @property
-    def business_day_convention(self):
-        """Gets the business_day_convention of this ValuationSchedule.  # noqa: E501
-
-        When Tenor is given and is not equal to \"1D\", there may be cases where \"date + tenor\" land on non-business days around month end.  In that case, the BusinessDayConvention, e.g. modified following \"MF\" would be applied to determine the next GBD.  # noqa: E501
-
-        :return: The business_day_convention of this ValuationSchedule.  # noqa: E501
-        :rtype: str
-        """
-        return self._business_day_convention
-
-    @business_day_convention.setter
-    def business_day_convention(self, business_day_convention):
-        """Sets the business_day_convention of this ValuationSchedule.
-
-        When Tenor is given and is not equal to \"1D\", there may be cases where \"date + tenor\" land on non-business days around month end.  In that case, the BusinessDayConvention, e.g. modified following \"MF\" would be applied to determine the next GBD.  # noqa: E501
-
-        :param business_day_convention: The business_day_convention of this ValuationSchedule.  # noqa: E501
-        :type business_day_convention: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                business_day_convention is not None and len(business_day_convention) > 50):
-            raise ValueError("Invalid value for `business_day_convention`, length must be less than or equal to `50`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                business_day_convention is not None and len(business_day_convention) < 0):
-            raise ValueError("Invalid value for `business_day_convention`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._business_day_convention = business_day_convention
-
-    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, ValuationSchedule):
-            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, ValuationSchedule):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    effective_from: Optional[StrictStr] = Field(None, alias="effectiveFrom", description="If present, the EffectiveFrom and EffectiveAt dates are interpreted as a range of dates for which to perform a valuation.  In this case, valuation is calculated for the portfolio(s) for each business day in the given range.")
+    effective_at: constr(strict=True, min_length=1) = Field(..., alias="effectiveAt", description="The market data time, i.e. the time to run the valuation request effective of.")
+    tenor: Optional[constr(strict=True, max_length=16, min_length=0)] = Field(None, description="Tenor, e.g \"1D\", \"1M\" to be used in generating the date schedule when effectiveFrom and effectiveAt are both given and are not the same.")
+    roll_convention: Optional[constr(strict=True, max_length=50, min_length=0)] = Field(None, alias="rollConvention", description="When Tenor is given and is not equal to \"1D\", there may be cases where \"date + tenor\" land on non-business days around month end.  In that case, the RollConvention, e.g. modified following \"MF\" would be applied to determine the next GBD.")
+    holiday_calendars: Optional[conlist(StrictStr)] = Field(None, alias="holidayCalendars", description="The holiday calendar(s) that should be used in determining the date schedule.  Holiday calendar(s) are supplied by their names, for example, \"CoppClark\".   Note that when the calendars are not available (e.g. when the user has insufficient permissions),   a recipe setting will be used to determine whether the whole batch should then fail or whether the calendar not being available should simply be ignored.")
+    valuation_date_times: Optional[conlist(StrictStr)] = Field(None, alias="valuationDateTimes", description="If given, this is the exact set of dates on which to perform a valuation. This will replace/override all other specified values if given.")
+    __properties = ["effectiveFrom", "effectiveAt", "tenor", "rollConvention", "holidayCalendars", "valuationDateTimes"]
+
+    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) -> ValuationSchedule:
+        """Create an instance of ValuationSchedule 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 effective_from (nullable) is None
+        # and __fields_set__ contains the field
+        if self.effective_from is None and "effective_from" in self.__fields_set__:
+            _dict['effectiveFrom'] = None
+
+        # set to None if tenor (nullable) is None
+        # and __fields_set__ contains the field
+        if self.tenor is None and "tenor" in self.__fields_set__:
+            _dict['tenor'] = None
+
+        # set to None if roll_convention (nullable) is None
+        # and __fields_set__ contains the field
+        if self.roll_convention is None and "roll_convention" in self.__fields_set__:
+            _dict['rollConvention'] = None
+
+        # set to None if holiday_calendars (nullable) is None
+        # and __fields_set__ contains the field
+        if self.holiday_calendars is None and "holiday_calendars" in self.__fields_set__:
+            _dict['holidayCalendars'] = None
+
+        # set to None if valuation_date_times (nullable) is None
+        # and __fields_set__ contains the field
+        if self.valuation_date_times is None and "valuation_date_times" in self.__fields_set__:
+            _dict['valuationDateTimes'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ValuationSchedule:
+        """Create an instance of ValuationSchedule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ValuationSchedule.parse_obj(obj)
+
+        _obj = ValuationSchedule.parse_obj({
+            "effective_from": obj.get("effectiveFrom"),
+            "effective_at": obj.get("effectiveAt"),
+            "tenor": obj.get("tenor"),
+            "roll_convention": obj.get("rollConvention"),
+            "holiday_calendars": obj.get("holidayCalendars"),
+            "valuation_date_times": obj.get("valuationDateTimes")
+        })
+        return _obj