lusid-sdk 1.1.250__py3-none-any.whl → 2.0.455__py3-none-any.whl

lusid/models/portfolio_return_breakdown.py

@@ -5,506 +5,123 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.250
     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 PortfolioReturnBreakdown(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, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr
+from lusid.models.resource_id import ResourceId
 
+class PortfolioReturnBreakdown(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'.
+    A list of Composite Breakdowns.  # noqa: E501
     """
-    openapi_types = {
-        'portfolio_id': 'ResourceId',
-        'rate_of_return': 'float',
-        'opening_market_value': 'float',
-        'closing_market_value': 'float',
-        'weight': 'float',
-        'constituents_in_the_composite': 'int',
-        'constituents_missing': 'int',
-        'currency': 'str',
-        'open_fx_rate': 'float',
-        'close_fx_rate': 'float',
-        'local_rate_of_return': 'float',
-        'local_opening_market_value': 'float',
-        'local_closing_market_value': 'float'
-    }
-
-    attribute_map = {
-        'portfolio_id': 'portfolioId',
-        'rate_of_return': 'rateOfReturn',
-        'opening_market_value': 'openingMarketValue',
-        'closing_market_value': 'closingMarketValue',
-        'weight': 'weight',
-        'constituents_in_the_composite': 'constituentsInTheComposite',
-        'constituents_missing': 'constituentsMissing',
-        'currency': 'currency',
-        'open_fx_rate': 'openFxRate',
-        'close_fx_rate': 'closeFxRate',
-        'local_rate_of_return': 'localRateOfReturn',
-        'local_opening_market_value': 'localOpeningMarketValue',
-        'local_closing_market_value': 'localClosingMarketValue'
-    }
-
-    required_map = {
-        'portfolio_id': 'required',
-        'rate_of_return': 'optional',
-        'opening_market_value': 'optional',
-        'closing_market_value': 'optional',
-        'weight': 'optional',
-        'constituents_in_the_composite': 'optional',
-        'constituents_missing': 'optional',
-        'currency': 'optional',
-        'open_fx_rate': 'optional',
-        'close_fx_rate': 'optional',
-        'local_rate_of_return': 'optional',
-        'local_opening_market_value': 'optional',
-        'local_closing_market_value': 'optional'
-    }
-
-    def __init__(self, portfolio_id=None, rate_of_return=None, opening_market_value=None, closing_market_value=None, weight=None, constituents_in_the_composite=None, constituents_missing=None, currency=None, open_fx_rate=None, close_fx_rate=None, local_rate_of_return=None, local_opening_market_value=None, local_closing_market_value=None, local_vars_configuration=None):  # noqa: E501
-        """PortfolioReturnBreakdown - a model defined in OpenAPI"
-        
-        :param portfolio_id:  (required)
-        :type portfolio_id: lusid.ResourceId
-        :param rate_of_return:  The return number.
-        :type rate_of_return: float
-        :param opening_market_value:  The opening market value.
-        :type opening_market_value: float
-        :param closing_market_value:  The closing market value.
-        :type closing_market_value: float
-        :param weight:  The weight of the constituent into the composite.
-        :type weight: float
-        :param constituents_in_the_composite:  The number of members in the Composite on the given day.
-        :type constituents_in_the_composite: int
-        :param constituents_missing:  The number of the constituents which have a missing return on that day.
-        :type constituents_missing: int
-        :param currency:  The currency of the portfolio.
-        :type currency: str
-        :param open_fx_rate:  The opening fxRate which is used in calculation.
-        :type open_fx_rate: float
-        :param close_fx_rate:  The closing fxRate which is used in calculation.
-        :type close_fx_rate: float
-        :param local_rate_of_return:  The rate of return in the local currency.
-        :type local_rate_of_return: float
-        :param local_opening_market_value:  The opening market value in the local currency.
-        :type local_opening_market_value: float
-        :param local_closing_market_value:  The closing market value in the local currency.
-        :type local_closing_market_value: float
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._portfolio_id = None
-        self._rate_of_return = None
-        self._opening_market_value = None
-        self._closing_market_value = None
-        self._weight = None
-        self._constituents_in_the_composite = None
-        self._constituents_missing = None
-        self._currency = None
-        self._open_fx_rate = None
-        self._close_fx_rate = None
-        self._local_rate_of_return = None
-        self._local_opening_market_value = None
-        self._local_closing_market_value = None
-        self.discriminator = None
-
-        self.portfolio_id = portfolio_id
-        if rate_of_return is not None:
-            self.rate_of_return = rate_of_return
-        self.opening_market_value = opening_market_value
-        self.closing_market_value = closing_market_value
-        if weight is not None:
-            self.weight = weight
-        if constituents_in_the_composite is not None:
-            self.constituents_in_the_composite = constituents_in_the_composite
-        if constituents_missing is not None:
-            self.constituents_missing = constituents_missing
-        self.currency = currency
-        if open_fx_rate is not None:
-            self.open_fx_rate = open_fx_rate
-        if close_fx_rate is not None:
-            self.close_fx_rate = close_fx_rate
-        self.local_rate_of_return = local_rate_of_return
-        self.local_opening_market_value = local_opening_market_value
-        self.local_closing_market_value = local_closing_market_value
-
-    @property
-    def portfolio_id(self):
-        """Gets the portfolio_id of this PortfolioReturnBreakdown.  # noqa: E501
-
-
-        :return: The portfolio_id of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._portfolio_id
-
-    @portfolio_id.setter
-    def portfolio_id(self, portfolio_id):
-        """Sets the portfolio_id of this PortfolioReturnBreakdown.
-
-
-        :param portfolio_id: The portfolio_id of this PortfolioReturnBreakdown.  # noqa: E501
-        :type portfolio_id: lusid.ResourceId
-        """
-        if self.local_vars_configuration.client_side_validation and portfolio_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `portfolio_id`, must not be `None`")  # noqa: E501
-
-        self._portfolio_id = portfolio_id
-
-    @property
-    def rate_of_return(self):
-        """Gets the rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The return number.  # noqa: E501
-
-        :return: The rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._rate_of_return
-
-    @rate_of_return.setter
-    def rate_of_return(self, rate_of_return):
-        """Sets the rate_of_return of this PortfolioReturnBreakdown.
-
-        The return number.  # noqa: E501
-
-        :param rate_of_return: The rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-        :type rate_of_return: float
-        """
-
-        self._rate_of_return = rate_of_return
-
-    @property
-    def opening_market_value(self):
-        """Gets the opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The opening market value.  # noqa: E501
-
-        :return: The opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._opening_market_value
-
-    @opening_market_value.setter
-    def opening_market_value(self, opening_market_value):
-        """Sets the opening_market_value of this PortfolioReturnBreakdown.
-
-        The opening market value.  # noqa: E501
-
-        :param opening_market_value: The opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :type opening_market_value: float
-        """
-
-        self._opening_market_value = opening_market_value
-
-    @property
-    def closing_market_value(self):
-        """Gets the closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The closing market value.  # noqa: E501
-
-        :return: The closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._closing_market_value
-
-    @closing_market_value.setter
-    def closing_market_value(self, closing_market_value):
-        """Sets the closing_market_value of this PortfolioReturnBreakdown.
-
-        The closing market value.  # noqa: E501
-
-        :param closing_market_value: The closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :type closing_market_value: float
-        """
-
-        self._closing_market_value = closing_market_value
-
-    @property
-    def weight(self):
-        """Gets the weight of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The weight of the constituent into the composite.  # noqa: E501
-
-        :return: The weight of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._weight
-
-    @weight.setter
-    def weight(self, weight):
-        """Sets the weight of this PortfolioReturnBreakdown.
-
-        The weight of the constituent into the composite.  # noqa: E501
-
-        :param weight: The weight of this PortfolioReturnBreakdown.  # noqa: E501
-        :type weight: float
-        """
-
-        self._weight = weight
-
-    @property
-    def constituents_in_the_composite(self):
-        """Gets the constituents_in_the_composite of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The number of members in the Composite on the given day.  # noqa: E501
-
-        :return: The constituents_in_the_composite of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: int
-        """
-        return self._constituents_in_the_composite
-
-    @constituents_in_the_composite.setter
-    def constituents_in_the_composite(self, constituents_in_the_composite):
-        """Sets the constituents_in_the_composite of this PortfolioReturnBreakdown.
-
-        The number of members in the Composite on the given day.  # noqa: E501
-
-        :param constituents_in_the_composite: The constituents_in_the_composite of this PortfolioReturnBreakdown.  # noqa: E501
-        :type constituents_in_the_composite: int
-        """
-
-        self._constituents_in_the_composite = constituents_in_the_composite
-
-    @property
-    def constituents_missing(self):
-        """Gets the constituents_missing of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The number of the constituents which have a missing return on that day.  # noqa: E501
-
-        :return: The constituents_missing of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: int
-        """
-        return self._constituents_missing
-
-    @constituents_missing.setter
-    def constituents_missing(self, constituents_missing):
-        """Sets the constituents_missing of this PortfolioReturnBreakdown.
-
-        The number of the constituents which have a missing return on that day.  # noqa: E501
-
-        :param constituents_missing: The constituents_missing of this PortfolioReturnBreakdown.  # noqa: E501
-        :type constituents_missing: int
-        """
-
-        self._constituents_missing = constituents_missing
-
-    @property
-    def currency(self):
-        """Gets the currency of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The currency of the portfolio.  # noqa: E501
-
-        :return: The currency of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: str
-        """
-        return self._currency
-
-    @currency.setter
-    def currency(self, currency):
-        """Sets the currency of this PortfolioReturnBreakdown.
-
-        The currency of the portfolio.  # noqa: E501
-
-        :param currency: The currency of this PortfolioReturnBreakdown.  # noqa: E501
-        :type currency: str
-        """
-
-        self._currency = currency
-
-    @property
-    def open_fx_rate(self):
-        """Gets the open_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The opening fxRate which is used in calculation.  # noqa: E501
-
-        :return: The open_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._open_fx_rate
-
-    @open_fx_rate.setter
-    def open_fx_rate(self, open_fx_rate):
-        """Sets the open_fx_rate of this PortfolioReturnBreakdown.
-
-        The opening fxRate which is used in calculation.  # noqa: E501
-
-        :param open_fx_rate: The open_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-        :type open_fx_rate: float
-        """
-
-        self._open_fx_rate = open_fx_rate
-
-    @property
-    def close_fx_rate(self):
-        """Gets the close_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The closing fxRate which is used in calculation.  # noqa: E501
-
-        :return: The close_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._close_fx_rate
-
-    @close_fx_rate.setter
-    def close_fx_rate(self, close_fx_rate):
-        """Sets the close_fx_rate of this PortfolioReturnBreakdown.
-
-        The closing fxRate which is used in calculation.  # noqa: E501
-
-        :param close_fx_rate: The close_fx_rate of this PortfolioReturnBreakdown.  # noqa: E501
-        :type close_fx_rate: float
-        """
-
-        self._close_fx_rate = close_fx_rate
-
-    @property
-    def local_rate_of_return(self):
-        """Gets the local_rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The rate of return in the local currency.  # noqa: E501
-
-        :return: The local_rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._local_rate_of_return
-
-    @local_rate_of_return.setter
-    def local_rate_of_return(self, local_rate_of_return):
-        """Sets the local_rate_of_return of this PortfolioReturnBreakdown.
-
-        The rate of return in the local currency.  # noqa: E501
-
-        :param local_rate_of_return: The local_rate_of_return of this PortfolioReturnBreakdown.  # noqa: E501
-        :type local_rate_of_return: float
-        """
-
-        self._local_rate_of_return = local_rate_of_return
-
-    @property
-    def local_opening_market_value(self):
-        """Gets the local_opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The opening market value in the local currency.  # noqa: E501
-
-        :return: The local_opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._local_opening_market_value
-
-    @local_opening_market_value.setter
-    def local_opening_market_value(self, local_opening_market_value):
-        """Sets the local_opening_market_value of this PortfolioReturnBreakdown.
-
-        The opening market value in the local currency.  # noqa: E501
-
-        :param local_opening_market_value: The local_opening_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :type local_opening_market_value: float
-        """
-
-        self._local_opening_market_value = local_opening_market_value
-
-    @property
-    def local_closing_market_value(self):
-        """Gets the local_closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-
-        The closing market value in the local currency.  # noqa: E501
-
-        :return: The local_closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :rtype: float
-        """
-        return self._local_closing_market_value
-
-    @local_closing_market_value.setter
-    def local_closing_market_value(self, local_closing_market_value):
-        """Sets the local_closing_market_value of this PortfolioReturnBreakdown.
-
-        The closing market value in the local currency.  # noqa: E501
-
-        :param local_closing_market_value: The local_closing_market_value of this PortfolioReturnBreakdown.  # noqa: E501
-        :type local_closing_market_value: float
-        """
-
-        self._local_closing_market_value = local_closing_market_value
-
-    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, PortfolioReturnBreakdown):
-            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, PortfolioReturnBreakdown):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    portfolio_id: ResourceId = Field(..., alias="portfolioId")
+    rate_of_return: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="rateOfReturn", description="The return number.")
+    opening_market_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="openingMarketValue", description="The opening market value.")
+    closing_market_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="closingMarketValue", description="The closing market value.")
+    weight: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The weight of the constituent into the composite.")
+    constituents_in_the_composite: Optional[StrictInt] = Field(None, alias="constituentsInTheComposite", description="The number of members in the Composite on the given day.")
+    constituents_missing: Optional[StrictInt] = Field(None, alias="constituentsMissing", description="The number of the constituents which have a missing return on that day.")
+    currency: Optional[StrictStr] = Field(None, description="The currency of the portfolio.")
+    open_fx_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="openFxRate", description="The opening fxRate which is used in calculation.")
+    close_fx_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="closeFxRate", description="The closing fxRate which is used in calculation.")
+    local_rate_of_return: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="localRateOfReturn", description="The rate of return in the local currency.")
+    local_opening_market_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="localOpeningMarketValue", description="The opening market value in the local currency.")
+    local_closing_market_value: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="localClosingMarketValue", description="The closing market value in the local currency.")
+    __properties = ["portfolioId", "rateOfReturn", "openingMarketValue", "closingMarketValue", "weight", "constituentsInTheComposite", "constituentsMissing", "currency", "openFxRate", "closeFxRate", "localRateOfReturn", "localOpeningMarketValue", "localClosingMarketValue"]
+
+    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) -> PortfolioReturnBreakdown:
+        """Create an instance of PortfolioReturnBreakdown 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 portfolio_id
+        if self.portfolio_id:
+            _dict['portfolioId'] = self.portfolio_id.to_dict()
+        # set to None if opening_market_value (nullable) is None
+        # and __fields_set__ contains the field
+        if self.opening_market_value is None and "opening_market_value" in self.__fields_set__:
+            _dict['openingMarketValue'] = None
+
+        # set to None if closing_market_value (nullable) is None
+        # and __fields_set__ contains the field
+        if self.closing_market_value is None and "closing_market_value" in self.__fields_set__:
+            _dict['closingMarketValue'] = None
+
+        # set to None if currency (nullable) is None
+        # and __fields_set__ contains the field
+        if self.currency is None and "currency" in self.__fields_set__:
+            _dict['currency'] = None
+
+        # set to None if local_rate_of_return (nullable) is None
+        # and __fields_set__ contains the field
+        if self.local_rate_of_return is None and "local_rate_of_return" in self.__fields_set__:
+            _dict['localRateOfReturn'] = None
+
+        # set to None if local_opening_market_value (nullable) is None
+        # and __fields_set__ contains the field
+        if self.local_opening_market_value is None and "local_opening_market_value" in self.__fields_set__:
+            _dict['localOpeningMarketValue'] = None
+
+        # set to None if local_closing_market_value (nullable) is None
+        # and __fields_set__ contains the field
+        if self.local_closing_market_value is None and "local_closing_market_value" in self.__fields_set__:
+            _dict['localClosingMarketValue'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PortfolioReturnBreakdown:
+        """Create an instance of PortfolioReturnBreakdown from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PortfolioReturnBreakdown.parse_obj(obj)
+
+        _obj = PortfolioReturnBreakdown.parse_obj({
+            "portfolio_id": ResourceId.from_dict(obj.get("portfolioId")) if obj.get("portfolioId") is not None else None,
+            "rate_of_return": obj.get("rateOfReturn"),
+            "opening_market_value": obj.get("openingMarketValue"),
+            "closing_market_value": obj.get("closingMarketValue"),
+            "weight": obj.get("weight"),
+            "constituents_in_the_composite": obj.get("constituentsInTheComposite"),
+            "constituents_missing": obj.get("constituentsMissing"),
+            "currency": obj.get("currency"),
+            "open_fx_rate": obj.get("openFxRate"),
+            "close_fx_rate": obj.get("closeFxRate"),
+            "local_rate_of_return": obj.get("localRateOfReturn"),
+            "local_opening_market_value": obj.get("localOpeningMarketValue"),
+            "local_closing_market_value": obj.get("localClosingMarketValue")
+        })
+        return _obj