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

lusid/models/quote.py

@@ -5,326 +5,100 @@
 
     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
 
+from datetime import datetime
+from typing import Any, Dict, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, constr
+from lusid.models.metric_value import MetricValue
+from lusid.models.quote_id import QuoteId
 
-class Quote(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class Quote(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 quote id, value and lineage of the quotes all keyed by a unique correlation id.  # noqa: E501
     """
-    openapi_types = {
-        'quote_id': 'QuoteId',
-        'metric_value': 'MetricValue',
-        'lineage': 'str',
-        'cut_label': 'str',
-        'uploaded_by': 'str',
-        'as_at': 'datetime',
-        'scale_factor': 'float'
-    }
-
-    attribute_map = {
-        'quote_id': 'quoteId',
-        'metric_value': 'metricValue',
-        'lineage': 'lineage',
-        'cut_label': 'cutLabel',
-        'uploaded_by': 'uploadedBy',
-        'as_at': 'asAt',
-        'scale_factor': 'scaleFactor'
-    }
-
-    required_map = {
-        'quote_id': 'required',
-        'metric_value': 'optional',
-        'lineage': 'optional',
-        'cut_label': 'optional',
-        'uploaded_by': 'required',
-        'as_at': 'required',
-        'scale_factor': 'optional'
-    }
-
-    def __init__(self, quote_id=None, metric_value=None, lineage=None, cut_label=None, uploaded_by=None, as_at=None, scale_factor=None, local_vars_configuration=None):  # noqa: E501
-        """Quote - a model defined in OpenAPI"
-        
-        :param quote_id:  (required)
-        :type quote_id: lusid.QuoteId
-        :param metric_value: 
-        :type metric_value: lusid.MetricValue
-        :param lineage:  Description of the quote's lineage e.g. 'FundAccountant_GreenQuality'.
-        :type lineage: str
-        :param cut_label:  The cut label that this quote was updated or inserted with.
-        :type cut_label: str
-        :param uploaded_by:  The unique id of the user that updated or inserted the quote. (required)
-        :type uploaded_by: str
-        :param as_at:  The asAt datetime at which the quote was committed to LUSID. (required)
-        :type as_at: datetime
-        :param scale_factor:  An optional scale factor for non-standard scaling of quotes against the instrument. For example, if you wish the quote's Value to be scaled down by a factor of 100, enter 100. If not supplied, the default ScaleFactor is 1.
-        :type scale_factor: float
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._quote_id = None
-        self._metric_value = None
-        self._lineage = None
-        self._cut_label = None
-        self._uploaded_by = None
-        self._as_at = None
-        self._scale_factor = None
-        self.discriminator = None
-
-        self.quote_id = quote_id
-        if metric_value is not None:
-            self.metric_value = metric_value
-        self.lineage = lineage
-        self.cut_label = cut_label
-        self.uploaded_by = uploaded_by
-        self.as_at = as_at
-        self.scale_factor = scale_factor
-
-    @property
-    def quote_id(self):
-        """Gets the quote_id of this Quote.  # noqa: E501
-
-
-        :return: The quote_id of this Quote.  # noqa: E501
-        :rtype: lusid.QuoteId
-        """
-        return self._quote_id
-
-    @quote_id.setter
-    def quote_id(self, quote_id):
-        """Sets the quote_id of this Quote.
-
-
-        :param quote_id: The quote_id of this Quote.  # noqa: E501
-        :type quote_id: lusid.QuoteId
-        """
-        if self.local_vars_configuration.client_side_validation and quote_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `quote_id`, must not be `None`")  # noqa: E501
-
-        self._quote_id = quote_id
-
-    @property
-    def metric_value(self):
-        """Gets the metric_value of this Quote.  # noqa: E501
-
-
-        :return: The metric_value of this Quote.  # noqa: E501
-        :rtype: lusid.MetricValue
-        """
-        return self._metric_value
-
-    @metric_value.setter
-    def metric_value(self, metric_value):
-        """Sets the metric_value of this Quote.
-
-
-        :param metric_value: The metric_value of this Quote.  # noqa: E501
-        :type metric_value: lusid.MetricValue
-        """
-
-        self._metric_value = metric_value
-
-    @property
-    def lineage(self):
-        """Gets the lineage of this Quote.  # noqa: E501
-
-        Description of the quote's lineage e.g. 'FundAccountant_GreenQuality'.  # noqa: E501
-
-        :return: The lineage of this Quote.  # noqa: E501
-        :rtype: str
-        """
-        return self._lineage
-
-    @lineage.setter
-    def lineage(self, lineage):
-        """Sets the lineage of this Quote.
-
-        Description of the quote's lineage e.g. 'FundAccountant_GreenQuality'.  # noqa: E501
-
-        :param lineage: The lineage of this Quote.  # noqa: E501
-        :type lineage: str
-        """
-
-        self._lineage = lineage
-
-    @property
-    def cut_label(self):
-        """Gets the cut_label of this Quote.  # noqa: E501
-
-        The cut label that this quote was updated or inserted with.  # noqa: E501
-
-        :return: The cut_label of this Quote.  # noqa: E501
-        :rtype: str
-        """
-        return self._cut_label
-
-    @cut_label.setter
-    def cut_label(self, cut_label):
-        """Sets the cut_label of this Quote.
-
-        The cut label that this quote was updated or inserted with.  # noqa: E501
-
-        :param cut_label: The cut_label of this Quote.  # noqa: E501
-        :type cut_label: str
-        """
-
-        self._cut_label = cut_label
-
-    @property
-    def uploaded_by(self):
-        """Gets the uploaded_by of this Quote.  # noqa: E501
-
-        The unique id of the user that updated or inserted the quote.  # noqa: E501
-
-        :return: The uploaded_by of this Quote.  # noqa: E501
-        :rtype: str
-        """
-        return self._uploaded_by
-
-    @uploaded_by.setter
-    def uploaded_by(self, uploaded_by):
-        """Sets the uploaded_by of this Quote.
-
-        The unique id of the user that updated or inserted the quote.  # noqa: E501
-
-        :param uploaded_by: The uploaded_by of this Quote.  # noqa: E501
-        :type uploaded_by: str
-        """
-        if self.local_vars_configuration.client_side_validation and uploaded_by is None:  # noqa: E501
-            raise ValueError("Invalid value for `uploaded_by`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                uploaded_by is not None and len(uploaded_by) < 1):
-            raise ValueError("Invalid value for `uploaded_by`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._uploaded_by = uploaded_by
-
-    @property
-    def as_at(self):
-        """Gets the as_at of this Quote.  # noqa: E501
-
-        The asAt datetime at which the quote was committed to LUSID.  # noqa: E501
-
-        :return: The as_at of this Quote.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._as_at
-
-    @as_at.setter
-    def as_at(self, as_at):
-        """Sets the as_at of this Quote.
-
-        The asAt datetime at which the quote was committed to LUSID.  # noqa: E501
-
-        :param as_at: The as_at of this Quote.  # noqa: E501
-        :type as_at: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and as_at is None:  # noqa: E501
-            raise ValueError("Invalid value for `as_at`, must not be `None`")  # noqa: E501
-
-        self._as_at = as_at
-
-    @property
-    def scale_factor(self):
-        """Gets the scale_factor of this Quote.  # noqa: E501
-
-        An optional scale factor for non-standard scaling of quotes against the instrument. For example, if you wish the quote's Value to be scaled down by a factor of 100, enter 100. If not supplied, the default ScaleFactor is 1.  # noqa: E501
-
-        :return: The scale_factor of this Quote.  # noqa: E501
-        :rtype: float
-        """
-        return self._scale_factor
-
-    @scale_factor.setter
-    def scale_factor(self, scale_factor):
-        """Sets the scale_factor of this Quote.
-
-        An optional scale factor for non-standard scaling of quotes against the instrument. For example, if you wish the quote's Value to be scaled down by a factor of 100, enter 100. If not supplied, the default ScaleFactor is 1.  # noqa: E501
-
-        :param scale_factor: The scale_factor of this Quote.  # noqa: E501
-        :type scale_factor: float
-        """
-
-        self._scale_factor = scale_factor
-
-    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, Quote):
-            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, Quote):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    quote_id: QuoteId = Field(..., alias="quoteId")
+    metric_value: Optional[MetricValue] = Field(None, alias="metricValue")
+    lineage: Optional[StrictStr] = Field(None, description="Description of the quote's lineage e.g. 'FundAccountant_GreenQuality'.")
+    cut_label: Optional[StrictStr] = Field(None, alias="cutLabel", description="The cut label that this quote was updated or inserted with.")
+    uploaded_by: constr(strict=True, min_length=1) = Field(..., alias="uploadedBy", description="The unique id of the user that updated or inserted the quote.")
+    as_at: datetime = Field(..., alias="asAt", description="The asAt datetime at which the quote was committed to LUSID.")
+    scale_factor: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="scaleFactor", description="An optional scale factor for non-standard scaling of quotes against the instrument. For example, if you wish the quote's Value to be scaled down by a factor of 100, enter 100. If not supplied, the default ScaleFactor is 1.")
+    __properties = ["quoteId", "metricValue", "lineage", "cutLabel", "uploadedBy", "asAt", "scaleFactor"]
+
+    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) -> Quote:
+        """Create an instance of Quote 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 quote_id
+        if self.quote_id:
+            _dict['quoteId'] = self.quote_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of metric_value
+        if self.metric_value:
+            _dict['metricValue'] = self.metric_value.to_dict()
+        # set to None if lineage (nullable) is None
+        # and __fields_set__ contains the field
+        if self.lineage is None and "lineage" in self.__fields_set__:
+            _dict['lineage'] = None
+
+        # set to None if cut_label (nullable) is None
+        # and __fields_set__ contains the field
+        if self.cut_label is None and "cut_label" in self.__fields_set__:
+            _dict['cutLabel'] = None
+
+        # set to None if scale_factor (nullable) is None
+        # and __fields_set__ contains the field
+        if self.scale_factor is None and "scale_factor" in self.__fields_set__:
+            _dict['scaleFactor'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Quote:
+        """Create an instance of Quote from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return Quote.parse_obj(obj)
+
+        _obj = Quote.parse_obj({
+            "quote_id": QuoteId.from_dict(obj.get("quoteId")) if obj.get("quoteId") is not None else None,
+            "metric_value": MetricValue.from_dict(obj.get("metricValue")) if obj.get("metricValue") is not None else None,
+            "lineage": obj.get("lineage"),
+            "cut_label": obj.get("cutLabel"),
+            "uploaded_by": obj.get("uploadedBy"),
+            "as_at": obj.get("asAt"),
+            "scale_factor": obj.get("scaleFactor")
+        })
+        return _obj

lusid/models/quote_access_metadata_rule.py

@@ -0,0 +1,92 @@
+# 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 BaseModel, Field, conlist
+from lusid.models.access_metadata_value import AccessMetadataValue
+from lusid.models.quote_access_metadata_rule_id import QuoteAccessMetadataRuleId
+
+class QuoteAccessMetadataRule(BaseModel):
+    """
+    QuoteAccessMetadataRule
+    """
+    id: QuoteAccessMetadataRuleId = Field(...)
+    metadata: Dict[str, conlist(AccessMetadataValue)] = Field(..., description="The access control metadata to assign to quotes that match the identifier")
+    __properties = ["id", "metadata"]
+
+    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) -> QuoteAccessMetadataRule:
+        """Create an instance of QuoteAccessMetadataRule 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 id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict of array)
+        _field_dict_of_array = {}
+        if self.metadata:
+            for _key in self.metadata:
+                if self.metadata[_key]:
+                    _field_dict_of_array[_key] = [
+                        _item.to_dict() for _item in self.metadata[_key]
+                    ]
+            _dict['metadata'] = _field_dict_of_array
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> QuoteAccessMetadataRule:
+        """Create an instance of QuoteAccessMetadataRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return QuoteAccessMetadataRule.parse_obj(obj)
+
+        _obj = QuoteAccessMetadataRule.parse_obj({
+            "id": QuoteAccessMetadataRuleId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "metadata": dict(
+                (_k,
+                        [AccessMetadataValue.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("metadata").items()
+            )
+        })
+        return _obj

lusid/models/quote_access_metadata_rule_id.py

@@ -0,0 +1,129 @@
+# 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, Optional
+from pydantic import BaseModel, Field, constr, validator
+
+class QuoteAccessMetadataRuleId(BaseModel):
+    """
+    An identifier that uniquely identifies a set of Quote access control metadata.  # noqa: E501
+    """
+    provider: Optional[constr(strict=True, max_length=100, min_length=0)] = Field(None, description="The platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes")
+    price_source: Optional[constr(strict=True, max_length=256, min_length=0)] = Field(None, alias="priceSource", description="The source or originator of the quote, e.g. a bank or financial institution.")
+    instrument_id: Optional[constr(strict=True, max_length=256, min_length=0)] = Field(None, alias="instrumentId", description="The value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'.")
+    instrument_id_type: Optional[constr(strict=True, max_length=50, min_length=0)] = Field(None, alias="instrumentIdType", description="The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'.")
+    quote_type: Optional[constr(strict=True, max_length=50, min_length=0)] = Field(None, alias="quoteType", description="The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used.")
+    field: Optional[constr(strict=True, max_length=2048, min_length=0)] = Field(None, description="The field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : *Any value is accepted*; DataScope : 'bid', 'mid', 'ask'; Lusid : *Any value is accepted*; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last'")
+    __properties = ["provider", "priceSource", "instrumentId", "instrumentIdType", "quoteType", "field"]
+
+    @validator('instrument_id_type')
+    def instrument_id_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z]*$/")
+        return value
+
+    @validator('quote_type')
+    def quote_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z]*$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z]*$/")
+        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) -> QuoteAccessMetadataRuleId:
+        """Create an instance of QuoteAccessMetadataRuleId 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 provider (nullable) is None
+        # and __fields_set__ contains the field
+        if self.provider is None and "provider" in self.__fields_set__:
+            _dict['provider'] = None
+
+        # set to None if price_source (nullable) is None
+        # and __fields_set__ contains the field
+        if self.price_source is None and "price_source" in self.__fields_set__:
+            _dict['priceSource'] = None
+
+        # set to None if instrument_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.instrument_id is None and "instrument_id" in self.__fields_set__:
+            _dict['instrumentId'] = None
+
+        # set to None if instrument_id_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.instrument_id_type is None and "instrument_id_type" in self.__fields_set__:
+            _dict['instrumentIdType'] = None
+
+        # set to None if quote_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.quote_type is None and "quote_type" in self.__fields_set__:
+            _dict['quoteType'] = None
+
+        # set to None if field (nullable) is None
+        # and __fields_set__ contains the field
+        if self.field is None and "field" in self.__fields_set__:
+            _dict['field'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> QuoteAccessMetadataRuleId:
+        """Create an instance of QuoteAccessMetadataRuleId from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return QuoteAccessMetadataRuleId.parse_obj(obj)
+
+        _obj = QuoteAccessMetadataRuleId.parse_obj({
+            "provider": obj.get("provider"),
+            "price_source": obj.get("priceSource"),
+            "instrument_id": obj.get("instrumentId"),
+            "instrument_id_type": obj.get("instrumentIdType"),
+            "quote_type": obj.get("quoteType"),
+            "field": obj.get("field")
+        })
+        return _obj