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

lusid/models/property_value.py

@@ -5,198 +5,82 @@
 
     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 PropertyValue(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
+from pydantic import BaseModel, Field, StrictStr
+from lusid.models.label_value_set import LabelValueSet
+from lusid.models.metric_value import MetricValue
 
+class PropertyValue(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 value of the property.  # noqa: E501
     """
-    openapi_types = {
-        'label_value': 'str',
-        'metric_value': 'MetricValue',
-        'label_value_set': 'LabelValueSet'
-    }
-
-    attribute_map = {
-        'label_value': 'labelValue',
-        'metric_value': 'metricValue',
-        'label_value_set': 'labelValueSet'
-    }
-
-    required_map = {
-        'label_value': 'optional',
-        'metric_value': 'optional',
-        'label_value_set': 'optional'
-    }
-
-    def __init__(self, label_value=None, metric_value=None, label_value_set=None, local_vars_configuration=None):  # noqa: E501
-        """PropertyValue - a model defined in OpenAPI"
-        
-        :param label_value:  The text value of a property defined as having the 'Label' type.
-        :type label_value: str
-        :param metric_value: 
-        :type metric_value: lusid.MetricValue
-        :param label_value_set: 
-        :type label_value_set: lusid.LabelValueSet
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._label_value = None
-        self._metric_value = None
-        self._label_value_set = None
-        self.discriminator = None
-
-        self.label_value = label_value
-        if metric_value is not None:
-            self.metric_value = metric_value
-        if label_value_set is not None:
-            self.label_value_set = label_value_set
-
-    @property
-    def label_value(self):
-        """Gets the label_value of this PropertyValue.  # noqa: E501
-
-        The text value of a property defined as having the 'Label' type.  # noqa: E501
-
-        :return: The label_value of this PropertyValue.  # noqa: E501
-        :rtype: str
-        """
-        return self._label_value
-
-    @label_value.setter
-    def label_value(self, label_value):
-        """Sets the label_value of this PropertyValue.
-
-        The text value of a property defined as having the 'Label' type.  # noqa: E501
-
-        :param label_value: The label_value of this PropertyValue.  # noqa: E501
-        :type label_value: str
-        """
-
-        self._label_value = label_value
-
-    @property
-    def metric_value(self):
-        """Gets the metric_value of this PropertyValue.  # noqa: E501
-
-
-        :return: The metric_value of this PropertyValue.  # noqa: E501
-        :rtype: lusid.MetricValue
-        """
-        return self._metric_value
-
-    @metric_value.setter
-    def metric_value(self, metric_value):
-        """Sets the metric_value of this PropertyValue.
-
-
-        :param metric_value: The metric_value of this PropertyValue.  # noqa: E501
-        :type metric_value: lusid.MetricValue
-        """
-
-        self._metric_value = metric_value
-
-    @property
-    def label_value_set(self):
-        """Gets the label_value_set of this PropertyValue.  # noqa: E501
-
-
-        :return: The label_value_set of this PropertyValue.  # noqa: E501
-        :rtype: lusid.LabelValueSet
-        """
-        return self._label_value_set
-
-    @label_value_set.setter
-    def label_value_set(self, label_value_set):
-        """Sets the label_value_set of this PropertyValue.
-
-
-        :param label_value_set: The label_value_set of this PropertyValue.  # noqa: E501
-        :type label_value_set: lusid.LabelValueSet
-        """
-
-        self._label_value_set = label_value_set
-
-    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, PropertyValue):
-            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, PropertyValue):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    label_value: Optional[StrictStr] = Field(None, alias="labelValue", description="The text value of a property defined as having the 'Label' type.")
+    metric_value: Optional[MetricValue] = Field(None, alias="metricValue")
+    label_value_set: Optional[LabelValueSet] = Field(None, alias="labelValueSet")
+    __properties = ["labelValue", "metricValue", "labelValueSet"]
+
+    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) -> PropertyValue:
+        """Create an instance of PropertyValue 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 metric_value
+        if self.metric_value:
+            _dict['metricValue'] = self.metric_value.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of label_value_set
+        if self.label_value_set:
+            _dict['labelValueSet'] = self.label_value_set.to_dict()
+        # set to None if label_value (nullable) is None
+        # and __fields_set__ contains the field
+        if self.label_value is None and "label_value" in self.__fields_set__:
+            _dict['labelValue'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PropertyValue:
+        """Create an instance of PropertyValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PropertyValue.parse_obj(obj)
+
+        _obj = PropertyValue.parse_obj({
+            "label_value": obj.get("labelValue"),
+            "metric_value": MetricValue.from_dict(obj.get("metricValue")) if obj.get("metricValue") is not None else None,
+            "label_value_set": LabelValueSet.from_dict(obj.get("labelValueSet")) if obj.get("labelValueSet") is not None else None
+        })
+        return _obj

lusid/models/property_value_equals.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict
+from pydantic import Field, StrictStr, constr, validator
+from lusid.models.match_criterion import MatchCriterion
+
+class PropertyValueEquals(MatchCriterion):
+    """
+    A criterion that checks whether a Property Value is equal to the given string value  # noqa: E501
+    """
+    property_key: StrictStr = Field(..., alias="propertyKey", description="The property key whose value will form the left-hand side of the operation")
+    value: constr(strict=True, max_length=1024, min_length=0) = Field(..., description="The value to be compared against")
+    criterion_type: StrictStr = Field(..., alias="criterionType", description="The available values are: PropertyValueEquals, PropertyValueIn, SubHoldingKeyValueEquals")
+    additional_properties: Dict[str, Any] = {}
+    __properties = ["criterionType", "propertyKey", "value"]
+
+    @validator('criterion_type')
+    def criterion_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('PropertyValueEquals', 'PropertyValueIn', 'SubHoldingKeyValueEquals'):
+            raise ValueError("must be one of enum values ('PropertyValueEquals', 'PropertyValueIn', 'SubHoldingKeyValueEquals')")
+        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) -> PropertyValueEquals:
+        """Create an instance of PropertyValueEquals 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={
+                            "additional_properties"
+                          },
+                          exclude_none=True)
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PropertyValueEquals:
+        """Create an instance of PropertyValueEquals from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PropertyValueEquals.parse_obj(obj)
+
+        _obj = PropertyValueEquals.parse_obj({
+            "criterion_type": obj.get("criterionType"),
+            "property_key": obj.get("propertyKey"),
+            "value": obj.get("value")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

lusid/models/property_value_in.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, List
+from pydantic import Field, StrictStr, conlist, validator
+from lusid.models.match_criterion import MatchCriterion
+
+class PropertyValueIn(MatchCriterion):
+    """
+    A criterion that checks whether a Property Value is equal to one of the given string values  # noqa: E501
+    """
+    property_key: StrictStr = Field(..., alias="propertyKey", description="The property key whose value will form the left-hand side of the operation")
+    value: conlist(StrictStr) = Field(..., description="The value to be compared against")
+    criterion_type: StrictStr = Field(..., alias="criterionType", description="The available values are: PropertyValueEquals, PropertyValueIn, SubHoldingKeyValueEquals")
+    additional_properties: Dict[str, Any] = {}
+    __properties = ["criterionType", "propertyKey", "value"]
+
+    @validator('criterion_type')
+    def criterion_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('PropertyValueEquals', 'PropertyValueIn', 'SubHoldingKeyValueEquals'):
+            raise ValueError("must be one of enum values ('PropertyValueEquals', 'PropertyValueIn', 'SubHoldingKeyValueEquals')")
+        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) -> PropertyValueIn:
+        """Create an instance of PropertyValueIn 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={
+                            "additional_properties"
+                          },
+                          exclude_none=True)
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PropertyValueIn:
+        """Create an instance of PropertyValueIn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PropertyValueIn.parse_obj(obj)
+
+        _obj = PropertyValueIn.parse_obj({
+            "criterion_type": obj.get("criterionType"),
+            "property_key": obj.get("propertyKey"),
+            "value": obj.get("value")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

lusid/models/query_bucketed_cash_flows_request.py

@@ -0,0 +1,162 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, constr, validator
+from lusid.models.bucketing_schedule import BucketingSchedule
+from lusid.models.portfolio_entity_id import PortfolioEntityId
+from lusid.models.resource_id import ResourceId
+
+class QueryBucketedCashFlowsRequest(BaseModel):
+    """
+    Query for bucketed cashflows from one or more portfolios.  # noqa: E501
+    """
+    as_at: Optional[datetime] = Field(None, alias="asAt", description="The time of the system at which to query for bucketed cashflows.")
+    window_start: datetime = Field(..., alias="windowStart", description="The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  There is no lower bound if this is not specified.")
+    window_end: datetime = Field(..., alias="windowEnd", description="The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows.  The upper bound defaults to 'today' if it is not specified")
+    portfolio_entity_ids: conlist(PortfolioEntityId) = Field(..., alias="portfolioEntityIds", description="The set of portfolios and portfolio groups to which the instrument events must belong.")
+    effective_at: datetime = Field(..., alias="effectiveAt", description="The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows.  This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up.  For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt  is before the start of the range they are forward looking and will be expectations assuming the model supports that.  There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.")
+    recipe_id: ResourceId = Field(..., alias="recipeId")
+    rounding_method: constr(strict=True, min_length=1) = Field(..., alias="roundingMethod", description="When bucketing, there is not a unique way to allocate the bucket points.  RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].")
+    bucketing_dates: Optional[conlist(datetime)] = Field(None, alias="bucketingDates", description="A list of dates to perform cashflow bucketing upon.  If this is provided, the list of tenors for bucketing should be empty.")
+    bucketing_tenors: Optional[conlist(StrictStr)] = Field(None, alias="bucketingTenors", description="A list of tenors to perform cashflow bucketing upon.  If this is provided, the list of dates for bucketing should be empty.")
+    report_currency: constr(strict=True, max_length=3, min_length=0) = Field(..., alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries.")
+    group_by: Optional[conlist(StrictStr)] = Field(None, alias="groupBy", description="The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping  that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.")
+    addresses: Optional[conlist(StrictStr)] = Field(None, description="The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones.")
+    equip_with_subtotals: Optional[StrictBool] = Field(None, alias="equipWithSubtotals", description="Flag directing the Valuation call to populate the results with subtotals of aggregates.")
+    exclude_unsettled_trades: Optional[StrictBool] = Field(None, alias="excludeUnsettledTrades", description="Flag directing the Valuation call to exclude cashflows from unsettled trades.  If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.")
+    cash_flow_type: Optional[StrictStr] = Field(None, alias="cashFlowType", description="Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this)  Options: [InstrumentCashFlow, PortfolioCashFlow]")
+    bucketing_schedule: Optional[BucketingSchedule] = Field(None, alias="bucketingSchedule")
+    filter: Optional[constr(strict=True, max_length=16384, min_length=0)] = None
+    __properties = ["asAt", "windowStart", "windowEnd", "portfolioEntityIds", "effectiveAt", "recipeId", "roundingMethod", "bucketingDates", "bucketingTenors", "reportCurrency", "groupBy", "addresses", "equipWithSubtotals", "excludeUnsettledTrades", "cashFlowType", "bucketingSchedule", "filter"]
+
+    @validator('filter')
+    def filter_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) -> QueryBucketedCashFlowsRequest:
+        """Create an instance of QueryBucketedCashFlowsRequest 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 portfolio_entity_ids (list)
+        _items = []
+        if self.portfolio_entity_ids:
+            for _item in self.portfolio_entity_ids:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['portfolioEntityIds'] = _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()
+        # override the default output from pydantic by calling `to_dict()` of bucketing_schedule
+        if self.bucketing_schedule:
+            _dict['bucketingSchedule'] = self.bucketing_schedule.to_dict()
+        # set to None if as_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.as_at is None and "as_at" in self.__fields_set__:
+            _dict['asAt'] = None
+
+        # set to None if bucketing_dates (nullable) is None
+        # and __fields_set__ contains the field
+        if self.bucketing_dates is None and "bucketing_dates" in self.__fields_set__:
+            _dict['bucketingDates'] = None
+
+        # set to None if bucketing_tenors (nullable) is None
+        # and __fields_set__ contains the field
+        if self.bucketing_tenors is None and "bucketing_tenors" in self.__fields_set__:
+            _dict['bucketingTenors'] = None
+
+        # set to None if group_by (nullable) is None
+        # and __fields_set__ contains the field
+        if self.group_by is None and "group_by" in self.__fields_set__:
+            _dict['groupBy'] = None
+
+        # set to None if addresses (nullable) is None
+        # and __fields_set__ contains the field
+        if self.addresses is None and "addresses" in self.__fields_set__:
+            _dict['addresses'] = None
+
+        # set to None if cash_flow_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.cash_flow_type is None and "cash_flow_type" in self.__fields_set__:
+            _dict['cashFlowType'] = None
+
+        # set to None if filter (nullable) is None
+        # and __fields_set__ contains the field
+        if self.filter is None and "filter" in self.__fields_set__:
+            _dict['filter'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> QueryBucketedCashFlowsRequest:
+        """Create an instance of QueryBucketedCashFlowsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return QueryBucketedCashFlowsRequest.parse_obj(obj)
+
+        _obj = QueryBucketedCashFlowsRequest.parse_obj({
+            "as_at": obj.get("asAt"),
+            "window_start": obj.get("windowStart"),
+            "window_end": obj.get("windowEnd"),
+            "portfolio_entity_ids": [PortfolioEntityId.from_dict(_item) for _item in obj.get("portfolioEntityIds")] if obj.get("portfolioEntityIds") is not None else None,
+            "effective_at": obj.get("effectiveAt"),
+            "recipe_id": ResourceId.from_dict(obj.get("recipeId")) if obj.get("recipeId") is not None else None,
+            "rounding_method": obj.get("roundingMethod"),
+            "bucketing_dates": obj.get("bucketingDates"),
+            "bucketing_tenors": obj.get("bucketingTenors"),
+            "report_currency": obj.get("reportCurrency"),
+            "group_by": obj.get("groupBy"),
+            "addresses": obj.get("addresses"),
+            "equip_with_subtotals": obj.get("equipWithSubtotals"),
+            "exclude_unsettled_trades": obj.get("excludeUnsettledTrades"),
+            "cash_flow_type": obj.get("cashFlowType"),
+            "bucketing_schedule": BucketingSchedule.from_dict(obj.get("bucketingSchedule")) if obj.get("bucketingSchedule") is not None else None,
+            "filter": obj.get("filter")
+        })
+        return _obj