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

lusid/models/aggregated_returns_request.py

@@ -5,417 +5,142 @@
 
     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 AggregatedReturnsRequest(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, StrictStr, conlist, constr
+from lusid.models.performance_returns_metric import PerformanceReturnsMetric
+from lusid.models.resource_id import ResourceId
 
+class AggregatedReturnsRequest(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 request used in the AggregatedReturns.  # noqa: E501
     """
-    openapi_types = {
-        'metrics': 'list[PerformanceReturnsMetric]',
-        'return_ids': 'list[ResourceId]',
-        'recipe_id': 'ResourceId',
-        'composite_method': 'str',
-        'period': 'str',
-        'output_frequency': 'str',
-        'alternative_inception_date': 'str',
-        'holiday_calendars': 'list[str]',
-        'currency': 'str',
-        'run_mode': 'str'
-    }
-
-    attribute_map = {
-        'metrics': 'metrics',
-        'return_ids': 'returnIds',
-        'recipe_id': 'recipeId',
-        'composite_method': 'compositeMethod',
-        'period': 'period',
-        'output_frequency': 'outputFrequency',
-        'alternative_inception_date': 'alternativeInceptionDate',
-        'holiday_calendars': 'holidayCalendars',
-        'currency': 'currency',
-        'run_mode': 'runMode'
-    }
-
-    required_map = {
-        'metrics': 'required',
-        'return_ids': 'optional',
-        'recipe_id': 'optional',
-        'composite_method': 'optional',
-        'period': 'optional',
-        'output_frequency': 'optional',
-        'alternative_inception_date': 'optional',
-        'holiday_calendars': 'optional',
-        'currency': 'optional',
-        'run_mode': 'optional'
-    }
-
-    def __init__(self, metrics=None, return_ids=None, recipe_id=None, composite_method=None, period=None, output_frequency=None, alternative_inception_date=None, holiday_calendars=None, currency=None, run_mode=None, local_vars_configuration=None):  # noqa: E501
-        """AggregatedReturnsRequest - a model defined in OpenAPI"
-        
-        :param metrics:  A list of metrics to calculate in the AggregatedReturns. (required)
-        :type metrics: list[lusid.PerformanceReturnsMetric]
-        :param return_ids:  The Scope and code of the returns.
-        :type return_ids: list[lusid.ResourceId]
-        :param recipe_id: 
-        :type recipe_id: lusid.ResourceId
-        :param composite_method:  The method used to calculate the Portfolio performance: Equal/Asset.
-        :type composite_method: str
-        :param period:  The type of the returns used to calculate the aggregation result: Daily/Monthly.
-        :type period: str
-        :param output_frequency:  The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.
-        :type output_frequency: str
-        :param alternative_inception_date:  Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request.
-        :type alternative_inception_date: str
-        :param holiday_calendars:  The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, 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 currency:  Optional - either a string or a property. If provided, the results will be converted to the specified currency
-        :type currency: str
-        :param run_mode:  The dates the AggregatedReturns output will be calculated: ReturnData/WeekDays/AllDays/MonthEnd. Defaults to ReturnData.
-        :type run_mode: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._metrics = None
-        self._return_ids = None
-        self._recipe_id = None
-        self._composite_method = None
-        self._period = None
-        self._output_frequency = None
-        self._alternative_inception_date = None
-        self._holiday_calendars = None
-        self._currency = None
-        self._run_mode = None
-        self.discriminator = None
-
-        self.metrics = metrics
-        self.return_ids = return_ids
-        if recipe_id is not None:
-            self.recipe_id = recipe_id
-        self.composite_method = composite_method
-        self.period = period
-        self.output_frequency = output_frequency
-        self.alternative_inception_date = alternative_inception_date
-        self.holiday_calendars = holiday_calendars
-        self.currency = currency
-        self.run_mode = run_mode
-
-    @property
-    def metrics(self):
-        """Gets the metrics of this AggregatedReturnsRequest.  # noqa: E501
-
-        A list of metrics to calculate in the AggregatedReturns.  # noqa: E501
-
-        :return: The metrics of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: list[lusid.PerformanceReturnsMetric]
-        """
-        return self._metrics
-
-    @metrics.setter
-    def metrics(self, metrics):
-        """Sets the metrics of this AggregatedReturnsRequest.
-
-        A list of metrics to calculate in the AggregatedReturns.  # noqa: E501
-
-        :param metrics: The metrics of this AggregatedReturnsRequest.  # noqa: E501
-        :type metrics: list[lusid.PerformanceReturnsMetric]
-        """
-        if self.local_vars_configuration.client_side_validation and metrics is None:  # noqa: E501
-            raise ValueError("Invalid value for `metrics`, must not be `None`")  # noqa: E501
-
-        self._metrics = metrics
-
-    @property
-    def return_ids(self):
-        """Gets the return_ids of this AggregatedReturnsRequest.  # noqa: E501
-
-        The Scope and code of the returns.  # noqa: E501
-
-        :return: The return_ids of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: list[lusid.ResourceId]
-        """
-        return self._return_ids
-
-    @return_ids.setter
-    def return_ids(self, return_ids):
-        """Sets the return_ids of this AggregatedReturnsRequest.
-
-        The Scope and code of the returns.  # noqa: E501
-
-        :param return_ids: The return_ids of this AggregatedReturnsRequest.  # noqa: E501
-        :type return_ids: list[lusid.ResourceId]
-        """
-
-        self._return_ids = return_ids
-
-    @property
-    def recipe_id(self):
-        """Gets the recipe_id of this AggregatedReturnsRequest.  # noqa: E501
-
-
-        :return: The recipe_id of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._recipe_id
-
-    @recipe_id.setter
-    def recipe_id(self, recipe_id):
-        """Sets the recipe_id of this AggregatedReturnsRequest.
-
-
-        :param recipe_id: The recipe_id of this AggregatedReturnsRequest.  # noqa: E501
-        :type recipe_id: lusid.ResourceId
-        """
-
-        self._recipe_id = recipe_id
-
-    @property
-    def composite_method(self):
-        """Gets the composite_method of this AggregatedReturnsRequest.  # noqa: E501
-
-        The method used to calculate the Portfolio performance: Equal/Asset.  # noqa: E501
-
-        :return: The composite_method of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._composite_method
-
-    @composite_method.setter
-    def composite_method(self, composite_method):
-        """Sets the composite_method of this AggregatedReturnsRequest.
-
-        The method used to calculate the Portfolio performance: Equal/Asset.  # noqa: E501
-
-        :param composite_method: The composite_method of this AggregatedReturnsRequest.  # noqa: E501
-        :type composite_method: str
-        """
-
-        self._composite_method = composite_method
-
-    @property
-    def period(self):
-        """Gets the period of this AggregatedReturnsRequest.  # noqa: E501
-
-        The type of the returns used to calculate the aggregation result: Daily/Monthly.  # noqa: E501
-
-        :return: The period of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._period
-
-    @period.setter
-    def period(self, period):
-        """Sets the period of this AggregatedReturnsRequest.
-
-        The type of the returns used to calculate the aggregation result: Daily/Monthly.  # noqa: E501
-
-        :param period: The period of this AggregatedReturnsRequest.  # noqa: E501
-        :type period: str
-        """
-
-        self._period = period
-
-    @property
-    def output_frequency(self):
-        """Gets the output_frequency of this AggregatedReturnsRequest.  # noqa: E501
-
-        The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.  # noqa: E501
-
-        :return: The output_frequency of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._output_frequency
-
-    @output_frequency.setter
-    def output_frequency(self, output_frequency):
-        """Sets the output_frequency of this AggregatedReturnsRequest.
-
-        The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.  # noqa: E501
-
-        :param output_frequency: The output_frequency of this AggregatedReturnsRequest.  # noqa: E501
-        :type output_frequency: str
-        """
-
-        self._output_frequency = output_frequency
-
-    @property
-    def alternative_inception_date(self):
-        """Gets the alternative_inception_date of this AggregatedReturnsRequest.  # noqa: E501
-
-        Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request.  # noqa: E501
-
-        :return: The alternative_inception_date of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._alternative_inception_date
-
-    @alternative_inception_date.setter
-    def alternative_inception_date(self, alternative_inception_date):
-        """Sets the alternative_inception_date of this AggregatedReturnsRequest.
-
-        Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request.  # noqa: E501
-
-        :param alternative_inception_date: The alternative_inception_date of this AggregatedReturnsRequest.  # noqa: E501
-        :type alternative_inception_date: str
-        """
-
-        self._alternative_inception_date = alternative_inception_date
-
-    @property
-    def holiday_calendars(self):
-        """Gets the holiday_calendars of this AggregatedReturnsRequest.  # noqa: E501
-
-        The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, 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 AggregatedReturnsRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._holiday_calendars
-
-    @holiday_calendars.setter
-    def holiday_calendars(self, holiday_calendars):
-        """Sets the holiday_calendars of this AggregatedReturnsRequest.
-
-        The holiday calendar(s) that should be used in determining the date schedule. Holiday calendar(s) are supplied by their codes, 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 AggregatedReturnsRequest.  # noqa: E501
-        :type holiday_calendars: list[str]
-        """
-
-        self._holiday_calendars = holiday_calendars
-
-    @property
-    def currency(self):
-        """Gets the currency of this AggregatedReturnsRequest.  # noqa: E501
-
-        Optional - either a string or a property. If provided, the results will be converted to the specified currency  # noqa: E501
-
-        :return: The currency of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._currency
-
-    @currency.setter
-    def currency(self, currency):
-        """Sets the currency of this AggregatedReturnsRequest.
-
-        Optional - either a string or a property. If provided, the results will be converted to the specified currency  # noqa: E501
-
-        :param currency: The currency of this AggregatedReturnsRequest.  # noqa: E501
-        :type currency: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                currency is not None and len(currency) > 6000):
-            raise ValueError("Invalid value for `currency`, length must be less than or equal to `6000`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                currency is not None and len(currency) < 0):
-            raise ValueError("Invalid value for `currency`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._currency = currency
-
-    @property
-    def run_mode(self):
-        """Gets the run_mode of this AggregatedReturnsRequest.  # noqa: E501
-
-        The dates the AggregatedReturns output will be calculated: ReturnData/WeekDays/AllDays/MonthEnd. Defaults to ReturnData.  # noqa: E501
-
-        :return: The run_mode of this AggregatedReturnsRequest.  # noqa: E501
-        :rtype: str
-        """
-        return self._run_mode
-
-    @run_mode.setter
-    def run_mode(self, run_mode):
-        """Sets the run_mode of this AggregatedReturnsRequest.
-
-        The dates the AggregatedReturns output will be calculated: ReturnData/WeekDays/AllDays/MonthEnd. Defaults to ReturnData.  # noqa: E501
-
-        :param run_mode: The run_mode of this AggregatedReturnsRequest.  # noqa: E501
-        :type run_mode: str
-        """
-
-        self._run_mode = run_mode
-
-    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, AggregatedReturnsRequest):
-            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, AggregatedReturnsRequest):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    metrics: conlist(PerformanceReturnsMetric) = Field(..., description="A list of metrics to calculate in the AggregatedReturns.")
+    return_ids: Optional[conlist(ResourceId)] = Field(None, alias="returnIds", description="The Scope and code of the returns.")
+    recipe_id: Optional[ResourceId] = Field(None, alias="recipeId")
+    composite_method: Optional[StrictStr] = Field(None, alias="compositeMethod", description="The method used to calculate the Portfolio performance: Equal/Asset.")
+    period: Optional[StrictStr] = Field(None, description="The type of the returns used to calculate the aggregation result: Daily/Monthly.")
+    output_frequency: Optional[StrictStr] = Field(None, alias="outputFrequency", description="The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly.")
+    alternative_inception_date: Optional[StrictStr] = Field(None, alias="alternativeInceptionDate", description="Optional - either a date, or the key for a portfolio property containing a date. If provided, the given date will override the inception date for this request.")
+    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 codes, 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.")
+    currency: Optional[constr(strict=True, max_length=6000, min_length=0)] = Field(None, description="Optional - either a string or a property. If provided, the results will be converted to the specified currency")
+    run_mode: Optional[StrictStr] = Field(None, alias="runMode", description="The dates the AggregatedReturns output will be calculated: ReturnData/WeekDays/AllDays/MonthEnd. Defaults to ReturnData.")
+    __properties = ["metrics", "returnIds", "recipeId", "compositeMethod", "period", "outputFrequency", "alternativeInceptionDate", "holidayCalendars", "currency", "runMode"]
+
+    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) -> AggregatedReturnsRequest:
+        """Create an instance of AggregatedReturnsRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item in self.metrics:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['metrics'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in return_ids (list)
+        _items = []
+        if self.return_ids:
+            for _item in self.return_ids:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['returnIds'] = _items
+        # override the default output from pydantic by calling `to_dict()` of recipe_id
+        if self.recipe_id:
+            _dict['recipeId'] = self.recipe_id.to_dict()
+        # set to None if return_ids (nullable) is None
+        # and __fields_set__ contains the field
+        if self.return_ids is None and "return_ids" in self.__fields_set__:
+            _dict['returnIds'] = None
+
+        # set to None if composite_method (nullable) is None
+        # and __fields_set__ contains the field
+        if self.composite_method is None and "composite_method" in self.__fields_set__:
+            _dict['compositeMethod'] = None
+
+        # set to None if period (nullable) is None
+        # and __fields_set__ contains the field
+        if self.period is None and "period" in self.__fields_set__:
+            _dict['period'] = None
+
+        # set to None if output_frequency (nullable) is None
+        # and __fields_set__ contains the field
+        if self.output_frequency is None and "output_frequency" in self.__fields_set__:
+            _dict['outputFrequency'] = None
+
+        # set to None if alternative_inception_date (nullable) is None
+        # and __fields_set__ contains the field
+        if self.alternative_inception_date is None and "alternative_inception_date" in self.__fields_set__:
+            _dict['alternativeInceptionDate'] = 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 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 run_mode (nullable) is None
+        # and __fields_set__ contains the field
+        if self.run_mode is None and "run_mode" in self.__fields_set__:
+            _dict['runMode'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AggregatedReturnsRequest:
+        """Create an instance of AggregatedReturnsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AggregatedReturnsRequest.parse_obj(obj)
+
+        _obj = AggregatedReturnsRequest.parse_obj({
+            "metrics": [PerformanceReturnsMetric.from_dict(_item) for _item in obj.get("metrics")] if obj.get("metrics") is not None else None,
+            "return_ids": [ResourceId.from_dict(_item) for _item in obj.get("returnIds")] if obj.get("returnIds") is not None else None,
+            "recipe_id": ResourceId.from_dict(obj.get("recipeId")) if obj.get("recipeId") is not None else None,
+            "composite_method": obj.get("compositeMethod"),
+            "period": obj.get("period"),
+            "output_frequency": obj.get("outputFrequency"),
+            "alternative_inception_date": obj.get("alternativeInceptionDate"),
+            "holiday_calendars": obj.get("holidayCalendars"),
+            "currency": obj.get("currency"),
+            "run_mode": obj.get("runMode")
+        })
+        return _obj