lusid-sdk 1.1.131__py3-none-any.whl → 2.1.683__py3-none-any.whl

lusid/models/market_data_type.py

@@ -0,0 +1,50 @@
+# 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.
+"""
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class MarketDataType(str, Enum):
+    """
+    The format of the complex market data stored. Complex market data is used to store any  data which requires more context than just a simple single point as is the case with a  quote.  Examples of such complex market data are Discount Curve and Volatility Surfaces.
+    """
+
+    """
+    allowed enum values
+    """
+    DISCOUNTFACTORCURVEDATA = 'DiscountFactorCurveData'
+    EQUITYVOLSURFACEDATA = 'EquityVolSurfaceData'
+    FXVOLSURFACEDATA = 'FxVolSurfaceData'
+    IRVOLCUBEDATA = 'IrVolCubeData'
+    OPAQUEMARKETDATA = 'OpaqueMarketData'
+    YIELDCURVEDATA = 'YieldCurveData'
+    FXFORWARDCURVEDATA = 'FxForwardCurveData'
+    FXFORWARDPIPSCURVEDATA = 'FxForwardPipsCurveData'
+    FXFORWARDTENORCURVEDATA = 'FxForwardTenorCurveData'
+    FXFORWARDTENORPIPSCURVEDATA = 'FxForwardTenorPipsCurveData'
+    FXFORWARDCURVEBYQUOTEREFERENCE = 'FxForwardCurveByQuoteReference'
+    CREDITSPREADCURVEDATA = 'CreditSpreadCurveData'
+    EQUITYCURVEBYPRICESDATA = 'EquityCurveByPricesData'
+    CONSTANTVOLATILITYSURFACE = 'ConstantVolatilitySurface'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> MarketDataType:
+        """Create an instance of MarketDataType from a JSON string"""
+        return MarketDataType(json.loads(json_str))

lusid/models/market_observable_type.py

@@ -0,0 +1,41 @@
+# 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.
+"""
+
+
+import json
+import pprint
+import re  # noqa: F401
+from aenum import Enum, no_arg
+
+
+
+
+
+class MarketObservableType(str, Enum):
+    """
+    MarketObservableType
+    """
+
+    """
+    allowed enum values
+    """
+    FORWARDPOINTS = 'ForwardPoints'
+    FORWARDRATE = 'ForwardRate'
+    RATESCURVE = 'RatesCurve'
+    FXFORWARDCURVE = 'FxForwardCurve'
+    INVALID = 'Invalid'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> MarketObservableType:
+        """Create an instance of MarketObservableType from a JSON string"""
+        return MarketObservableType(json.loads(json_str))

lusid/models/market_options.py

@@ -5,332 +5,130 @@
 
     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 MarketOptions(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.v1 import BaseModel, Field, StrictBool, constr, validator
 
+class MarketOptions(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 set of options that control miscellaneous and default market resolution behaviour.  These are aimed at a 'crude' level of control for those who do not wish to fine tune the way that data is resolved.  For clients who wish to simply match instruments to prices this is quite possibly sufficient. For those wishing to control market data sources  according to requirements based on accuracy or timeliness it is not. In more advanced cases the options should largely be ignored and rules specified  per source. Be aware that where no specified rule matches the final fallback is on to the logic implied here.  # noqa: E501
     """
-    openapi_types = {
-        'default_supplier': 'str',
-        'default_instrument_code_type': 'str',
-        'default_scope': 'str',
-        'attempt_to_infer_missing_fx': 'bool',
-        'calendar_scope': 'str',
-        'convention_scope': 'str'
-    }
-
-    attribute_map = {
-        'default_supplier': 'defaultSupplier',
-        'default_instrument_code_type': 'defaultInstrumentCodeType',
-        'default_scope': 'defaultScope',
-        'attempt_to_infer_missing_fx': 'attemptToInferMissingFx',
-        'calendar_scope': 'calendarScope',
-        'convention_scope': 'conventionScope'
-    }
-
-    required_map = {
-        'default_supplier': 'optional',
-        'default_instrument_code_type': 'optional',
-        'default_scope': 'required',
-        'attempt_to_infer_missing_fx': 'optional',
-        'calendar_scope': 'optional',
-        'convention_scope': 'optional'
-    }
-
-    def __init__(self, default_supplier=None, default_instrument_code_type=None, default_scope=None, attempt_to_infer_missing_fx=None, calendar_scope=None, convention_scope=None, local_vars_configuration=None):  # noqa: E501
-        """MarketOptions - a model defined in OpenAPI"
-        
-        :param default_supplier:  The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId
-        :type default_supplier: str
-        :param default_instrument_code_type:  When instrument quotes are searched for, what identifier should be used by default
-        :type default_instrument_code_type: str
-        :param default_scope:  For default rules, which scope should data be searched for in (required)
-        :type default_scope: str
-        :param attempt_to_infer_missing_fx:  if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD
-        :type attempt_to_infer_missing_fx: bool
-        :param calendar_scope:  The scope in which holiday calendars stored
-        :type calendar_scope: str
-        :param convention_scope:  The scope in which conventions stored
-        :type convention_scope: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._default_supplier = None
-        self._default_instrument_code_type = None
-        self._default_scope = None
-        self._attempt_to_infer_missing_fx = None
-        self._calendar_scope = None
-        self._convention_scope = None
-        self.discriminator = None
-
-        self.default_supplier = default_supplier
-        self.default_instrument_code_type = default_instrument_code_type
-        self.default_scope = default_scope
-        if attempt_to_infer_missing_fx is not None:
-            self.attempt_to_infer_missing_fx = attempt_to_infer_missing_fx
-        self.calendar_scope = calendar_scope
-        self.convention_scope = convention_scope
-
-    @property
-    def default_supplier(self):
-        """Gets the default_supplier of this MarketOptions.  # noqa: E501
-
-        The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId  # noqa: E501
-
-        :return: The default_supplier of this MarketOptions.  # noqa: E501
-        :rtype: str
-        """
-        return self._default_supplier
-
-    @default_supplier.setter
-    def default_supplier(self, default_supplier):
-        """Sets the default_supplier of this MarketOptions.
-
-        The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId  # noqa: E501
-
-        :param default_supplier: The default_supplier of this MarketOptions.  # noqa: E501
-        :type default_supplier: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                default_supplier is not None and len(default_supplier) > 32):
-            raise ValueError("Invalid value for `default_supplier`, length must be less than or equal to `32`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                default_supplier is not None and len(default_supplier) < 0):
-            raise ValueError("Invalid value for `default_supplier`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._default_supplier = default_supplier
-
-    @property
-    def default_instrument_code_type(self):
-        """Gets the default_instrument_code_type of this MarketOptions.  # noqa: E501
-
-        When instrument quotes are searched for, what identifier should be used by default  # noqa: E501
-
-        :return: The default_instrument_code_type of this MarketOptions.  # noqa: E501
-        :rtype: str
-        """
-        return self._default_instrument_code_type
-
-    @default_instrument_code_type.setter
-    def default_instrument_code_type(self, default_instrument_code_type):
-        """Sets the default_instrument_code_type of this MarketOptions.
-
-        When instrument quotes are searched for, what identifier should be used by default  # noqa: E501
-
-        :param default_instrument_code_type: The default_instrument_code_type of this MarketOptions.  # noqa: E501
-        :type default_instrument_code_type: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                default_instrument_code_type is not None and len(default_instrument_code_type) > 32):
-            raise ValueError("Invalid value for `default_instrument_code_type`, length must be less than or equal to `32`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                default_instrument_code_type is not None and len(default_instrument_code_type) < 0):
-            raise ValueError("Invalid value for `default_instrument_code_type`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._default_instrument_code_type = default_instrument_code_type
-
-    @property
-    def default_scope(self):
-        """Gets the default_scope of this MarketOptions.  # noqa: E501
-
-        For default rules, which scope should data be searched for in  # noqa: E501
-
-        :return: The default_scope of this MarketOptions.  # noqa: E501
-        :rtype: str
-        """
-        return self._default_scope
-
-    @default_scope.setter
-    def default_scope(self, default_scope):
-        """Sets the default_scope of this MarketOptions.
-
-        For default rules, which scope should data be searched for in  # noqa: E501
-
-        :param default_scope: The default_scope of this MarketOptions.  # noqa: E501
-        :type default_scope: str
-        """
-        if self.local_vars_configuration.client_side_validation and default_scope is None:  # noqa: E501
-            raise ValueError("Invalid value for `default_scope`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                default_scope is not None and len(default_scope) > 256):
-            raise ValueError("Invalid value for `default_scope`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                default_scope is not None and len(default_scope) < 1):
-            raise ValueError("Invalid value for `default_scope`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                default_scope is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', default_scope)):  # noqa: E501
-            raise ValueError(r"Invalid value for `default_scope`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._default_scope = default_scope
-
-    @property
-    def attempt_to_infer_missing_fx(self):
-        """Gets the attempt_to_infer_missing_fx of this MarketOptions.  # noqa: E501
-
-        if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD  # noqa: E501
-
-        :return: The attempt_to_infer_missing_fx of this MarketOptions.  # noqa: E501
-        :rtype: bool
-        """
-        return self._attempt_to_infer_missing_fx
-
-    @attempt_to_infer_missing_fx.setter
-    def attempt_to_infer_missing_fx(self, attempt_to_infer_missing_fx):
-        """Sets the attempt_to_infer_missing_fx of this MarketOptions.
-
-        if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD  # noqa: E501
-
-        :param attempt_to_infer_missing_fx: The attempt_to_infer_missing_fx of this MarketOptions.  # noqa: E501
-        :type attempt_to_infer_missing_fx: bool
-        """
-
-        self._attempt_to_infer_missing_fx = attempt_to_infer_missing_fx
-
-    @property
-    def calendar_scope(self):
-        """Gets the calendar_scope of this MarketOptions.  # noqa: E501
-
-        The scope in which holiday calendars stored  # noqa: E501
-
-        :return: The calendar_scope of this MarketOptions.  # noqa: E501
-        :rtype: str
-        """
-        return self._calendar_scope
-
-    @calendar_scope.setter
-    def calendar_scope(self, calendar_scope):
-        """Sets the calendar_scope of this MarketOptions.
-
-        The scope in which holiday calendars stored  # noqa: E501
-
-        :param calendar_scope: The calendar_scope of this MarketOptions.  # noqa: E501
-        :type calendar_scope: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                calendar_scope is not None and len(calendar_scope) > 256):
-            raise ValueError("Invalid value for `calendar_scope`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                calendar_scope is not None and len(calendar_scope) < 1):
-            raise ValueError("Invalid value for `calendar_scope`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                calendar_scope is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', calendar_scope)):  # noqa: E501
-            raise ValueError(r"Invalid value for `calendar_scope`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._calendar_scope = calendar_scope
-
-    @property
-    def convention_scope(self):
-        """Gets the convention_scope of this MarketOptions.  # noqa: E501
-
-        The scope in which conventions stored  # noqa: E501
-
-        :return: The convention_scope of this MarketOptions.  # noqa: E501
-        :rtype: str
-        """
-        return self._convention_scope
-
-    @convention_scope.setter
-    def convention_scope(self, convention_scope):
-        """Sets the convention_scope of this MarketOptions.
-
-        The scope in which conventions stored  # noqa: E501
-
-        :param convention_scope: The convention_scope of this MarketOptions.  # noqa: E501
-        :type convention_scope: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                convention_scope is not None and len(convention_scope) > 256):
-            raise ValueError("Invalid value for `convention_scope`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                convention_scope is not None and len(convention_scope) < 1):
-            raise ValueError("Invalid value for `convention_scope`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                convention_scope is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', convention_scope)):  # noqa: E501
-            raise ValueError(r"Invalid value for `convention_scope`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._convention_scope = convention_scope
-
-    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())
+    default_supplier: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="defaultSupplier", description="The default supplier of data. This controls which 'dialect' is used to find particular market data. e.g. one supplier might address data by RIC, another by PermId")
+    default_instrument_code_type: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, alias="defaultInstrumentCodeType", description="When instrument quotes are searched for, what identifier should be used by default")
+    default_scope: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="defaultScope", description="For default rules, which scope should data be searched for in")
+    attempt_to_infer_missing_fx: Optional[StrictBool] = Field(None, alias="attemptToInferMissingFx", description="if true will calculate a missing Fx pair (e.g. THBJPY) from the inverse JPYTHB or from standardised pairs against USD, e.g. THBUSD and JPYUSD")
+    calendar_scope: Optional[constr(strict=True, max_length=256, min_length=1)] = Field(None, alias="calendarScope", description="The scope in which holiday calendars stored")
+    convention_scope: Optional[constr(strict=True, max_length=256, min_length=1)] = Field(None, alias="conventionScope", description="The scope in which conventions stored")
+    __properties = ["defaultSupplier", "defaultInstrumentCodeType", "defaultScope", "attemptToInferMissingFx", "calendarScope", "conventionScope"]
+
+    @validator('default_scope')
+    def default_scope_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('calendar_scope')
+    def calendar_scope_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('convention_scope')
+    def convention_scope_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
 
     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, MarketOptions):
-            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, MarketOptions):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    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) -> MarketOptions:
+        """Create an instance of MarketOptions 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 default_supplier (nullable) is None
+        # and __fields_set__ contains the field
+        if self.default_supplier is None and "default_supplier" in self.__fields_set__:
+            _dict['defaultSupplier'] = None
+
+        # set to None if default_instrument_code_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.default_instrument_code_type is None and "default_instrument_code_type" in self.__fields_set__:
+            _dict['defaultInstrumentCodeType'] = None
+
+        # set to None if calendar_scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.calendar_scope is None and "calendar_scope" in self.__fields_set__:
+            _dict['calendarScope'] = None
+
+        # set to None if convention_scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.convention_scope is None and "convention_scope" in self.__fields_set__:
+            _dict['conventionScope'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MarketOptions:
+        """Create an instance of MarketOptions from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MarketOptions.parse_obj(obj)
+
+        _obj = MarketOptions.parse_obj({
+            "default_supplier": obj.get("defaultSupplier"),
+            "default_instrument_code_type": obj.get("defaultInstrumentCodeType"),
+            "default_scope": obj.get("defaultScope"),
+            "attempt_to_infer_missing_fx": obj.get("attemptToInferMissingFx"),
+            "calendar_scope": obj.get("calendarScope"),
+            "convention_scope": obj.get("conventionScope")
+        })
+        return _obj