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

lusid/models/market_data_key_rule.py

@@ -5,475 +5,137 @@
 
     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
 
+from datetime import datetime
+from typing import Any, Dict, Optional
+from pydantic.v1 import BaseModel, Field, StrictBool, StrictStr, constr, validator
 
-class MarketDataKeyRule(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
+class MarketDataKeyRule(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'.
+    When performing analytics, instruments and models have dependencies on market data.  A market data key rule essentially tells lusid to \"resolve dependencies matching the pattern 'X' using data of the form 'Y'\".  The parameter 'X' is defined by the key of the key rule, and might specify \"all USD rates curves\" or \"all RIC-based prices\".  The parameter 'Y' is defined by the remaining fields of the key rule, and allows the user to configure things such as  where to look for data, what sort of data should be looked for (e.g. bid/mid/ask), and how old the data is allowed to be.  # noqa: E501
     """
-    openapi_types = {
-        'key': 'str',
-        'supplier': 'str',
-        'data_scope': 'str',
-        'quote_type': 'str',
-        'field': 'str',
-        'quote_interval': 'str',
-        'as_at': 'datetime',
-        'price_source': 'str',
-        'mask': 'str',
-        'source_system': 'str'
-    }
-
-    attribute_map = {
-        'key': 'key',
-        'supplier': 'supplier',
-        'data_scope': 'dataScope',
-        'quote_type': 'quoteType',
-        'field': 'field',
-        'quote_interval': 'quoteInterval',
-        'as_at': 'asAt',
-        'price_source': 'priceSource',
-        'mask': 'mask',
-        'source_system': 'sourceSystem'
-    }
-
-    required_map = {
-        'key': 'required',
-        'supplier': 'required',
-        'data_scope': 'required',
-        'quote_type': 'required',
-        'field': 'optional',
-        'quote_interval': 'optional',
-        'as_at': 'optional',
-        'price_source': 'optional',
-        'mask': 'optional',
-        'source_system': 'optional'
-    }
-
-    def __init__(self, key=None, supplier=None, data_scope=None, quote_type=None, field=None, quote_interval=None, as_at=None, price_source=None, mask=None, source_system=None, local_vars_configuration=None):  # noqa: E501
-        """MarketDataKeyRule - a model defined in OpenAPI"
-        
-        :param key:  A dot-separated string that defines a pattern for matching market data dependencies.  The form of the string depends on the type of the dependency; see below for basic types and the Knowledge Base for further info.  Quote lookup: \"Quote.{CodeType}.*\" e.g. \"Quote.RIC.*\" refers to 'any RIC quote'  Fx rates: \"Fx.CurrencyPair.*\", which refers to 'any FX rate'  Discounting curves: \"Rates.{Currency}.{Currency}OIS e.g. \"Rates.USD.USDOIS\" refers to the OIS USD discounting curve                For non-fx and non-quote rules, trailing parameters can be replaced by the wildcard character '*'.  e.g. \"Rates.*.*\" matches any dependency on a discounting curve. (required)
-        :type key: str
-        :param supplier:  The market data supplier (where the data comes from) (required)
-        :type supplier: str
-        :param data_scope:  The scope in which the data should be found when using this rule. (required)
-        :type data_scope: str
-        :param quote_type:  The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice (required)
-        :type quote_type: str
-        :param field:  The conceptual qualification for the field, typically 'bid', 'mid' (default), or 'ask', but can also be 'open', 'close', etc.  When resolving quotes from LUSID's database, only quotes whose Field is identical to the Field specified here  will be accepted as market data.  When resolving data from an external supplier, the Field must be one of a defined set for the given supplier.                Note: Applies to the retrieval of quotes only. Has no impact on the resolution of complex market data.
-        :type field: str
-        :param quote_interval:  Shorthand for the time interval used to select market data. This must be a dot-separated string              nominating a start and end date, for example '5D.0D' to look back 5 days from today (0 days ago). The syntax              is <i>int</i><i>char</i>.<i>int</i><i>char</i>, where <i>char</i> is one of              D(ay), Bd(business day), W(eek), M(onth) or Y(ear).              Business days are calculated using the calendars specified on the Valuation Request.              If no calendar is provided in the request, then it will default to only skipping weekends.              For example, if the valuation date is a Monday, then a quote interval of \"1Bd\" would behave as \"3D\",              looking back to the Friday. Data with effectiveAt on the weekend will still be found in that window.
-        :type quote_interval: str
-        :param as_at:  The AsAt predicate specification.
-        :type as_at: datetime
-        :param price_source:  The source of the quote. For a given provider/supplier of market data there may be an additional qualifier, e.g. the exchange or bank that provided the quote
-        :type price_source: str
-        :param mask:  Allows for partial or complete override of the market asset resolved for a dependency  Either a named override or a dot separated string (A.B.C.D.*).  e.g. for Rates curve 'EUR.*' will replace the resolve MarketAsset 'GBP/12M', 'GBP/3M' with the EUR equivalent, if there  are no wildcards in the mask, the mask is taken as the MarketAsset for any dependency matching the rule.
-        :type mask: str
-        :param source_system:  If set, this parameter will seek an external source of market data.  Optional and, if omitted, will default to \"Lusid\".  This means that data will be retrieved from the LUSID Quote Store and LUSID Complex Market Data Store.                This can be set to \"MarketDataOverrides\" if Supplier is set to \"Client\".
-        :type source_system: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._key = None
-        self._supplier = None
-        self._data_scope = None
-        self._quote_type = None
-        self._field = None
-        self._quote_interval = None
-        self._as_at = None
-        self._price_source = None
-        self._mask = None
-        self._source_system = None
-        self.discriminator = None
-
-        self.key = key
-        self.supplier = supplier
-        self.data_scope = data_scope
-        self.quote_type = quote_type
-        self.field = field
-        self.quote_interval = quote_interval
-        self.as_at = as_at
-        self.price_source = price_source
-        self.mask = mask
-        self.source_system = source_system
-
-    @property
-    def key(self):
-        """Gets the key of this MarketDataKeyRule.  # noqa: E501
-
-        A dot-separated string that defines a pattern for matching market data dependencies.  The form of the string depends on the type of the dependency; see below for basic types and the Knowledge Base for further info.  Quote lookup: \"Quote.{CodeType}.*\" e.g. \"Quote.RIC.*\" refers to 'any RIC quote'  Fx rates: \"Fx.CurrencyPair.*\", which refers to 'any FX rate'  Discounting curves: \"Rates.{Currency}.{Currency}OIS e.g. \"Rates.USD.USDOIS\" refers to the OIS USD discounting curve                For non-fx and non-quote rules, trailing parameters can be replaced by the wildcard character '*'.  e.g. \"Rates.*.*\" matches any dependency on a discounting curve.  # noqa: E501
-
-        :return: The key of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._key
-
-    @key.setter
-    def key(self, key):
-        """Sets the key of this MarketDataKeyRule.
-
-        A dot-separated string that defines a pattern for matching market data dependencies.  The form of the string depends on the type of the dependency; see below for basic types and the Knowledge Base for further info.  Quote lookup: \"Quote.{CodeType}.*\" e.g. \"Quote.RIC.*\" refers to 'any RIC quote'  Fx rates: \"Fx.CurrencyPair.*\", which refers to 'any FX rate'  Discounting curves: \"Rates.{Currency}.{Currency}OIS e.g. \"Rates.USD.USDOIS\" refers to the OIS USD discounting curve                For non-fx and non-quote rules, trailing parameters can be replaced by the wildcard character '*'.  e.g. \"Rates.*.*\" matches any dependency on a discounting curve.  # noqa: E501
-
-        :param key: The key of this MarketDataKeyRule.  # noqa: E501
-        :type key: str
-        """
-        if self.local_vars_configuration.client_side_validation and key is None:  # noqa: E501
-            raise ValueError("Invalid value for `key`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                key is not None and len(key) > 128):
-            raise ValueError("Invalid value for `key`, length must be less than or equal to `128`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                key is not None and len(key) < 0):
-            raise ValueError("Invalid value for `key`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._key = key
-
-    @property
-    def supplier(self):
-        """Gets the supplier of this MarketDataKeyRule.  # noqa: E501
-
-        The market data supplier (where the data comes from)  # noqa: E501
-
-        :return: The supplier of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._supplier
-
-    @supplier.setter
-    def supplier(self, supplier):
-        """Sets the supplier of this MarketDataKeyRule.
-
-        The market data supplier (where the data comes from)  # noqa: E501
-
-        :param supplier: The supplier of this MarketDataKeyRule.  # noqa: E501
-        :type supplier: str
-        """
-        if self.local_vars_configuration.client_side_validation and supplier is None:  # noqa: E501
-            raise ValueError("Invalid value for `supplier`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                supplier is not None and len(supplier) > 32):
-            raise ValueError("Invalid value for `supplier`, length must be less than or equal to `32`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                supplier is not None and len(supplier) < 0):
-            raise ValueError("Invalid value for `supplier`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._supplier = supplier
-
-    @property
-    def data_scope(self):
-        """Gets the data_scope of this MarketDataKeyRule.  # noqa: E501
-
-        The scope in which the data should be found when using this rule.  # noqa: E501
-
-        :return: The data_scope of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._data_scope
-
-    @data_scope.setter
-    def data_scope(self, data_scope):
-        """Sets the data_scope of this MarketDataKeyRule.
-
-        The scope in which the data should be found when using this rule.  # noqa: E501
-
-        :param data_scope: The data_scope of this MarketDataKeyRule.  # noqa: E501
-        :type data_scope: str
-        """
-        if self.local_vars_configuration.client_side_validation and data_scope is None:  # noqa: E501
-            raise ValueError("Invalid value for `data_scope`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                data_scope is not None and len(data_scope) > 256):
-            raise ValueError("Invalid value for `data_scope`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                data_scope is not None and len(data_scope) < 1):
-            raise ValueError("Invalid value for `data_scope`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                data_scope is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', data_scope)):  # noqa: E501
-            raise ValueError(r"Invalid value for `data_scope`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._data_scope = data_scope
-
-    @property
-    def quote_type(self):
-        """Gets the quote_type of this MarketDataKeyRule.  # noqa: E501
-
-        The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice  # noqa: E501
-
-        :return: The quote_type of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._quote_type
-
-    @quote_type.setter
-    def quote_type(self, quote_type):
-        """Sets the quote_type of this MarketDataKeyRule.
-
-        The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice  # noqa: E501
-
-        :param quote_type: The quote_type of this MarketDataKeyRule.  # noqa: E501
-        :type quote_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and quote_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `quote_type`, must not be `None`")  # noqa: E501
-        allowed_values = ["Price", "Spread", "Rate", "LogNormalVol", "NormalVol", "ParSpread", "IsdaSpread", "Upfront", "Index", "Ratio", "Delta", "PoolFactor", "InflationAssumption", "DirtyPrice"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and quote_type not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `quote_type` ({0}), must be one of {1}"  # noqa: E501
-                .format(quote_type, allowed_values)
-            )
-
-        self._quote_type = quote_type
-
-    @property
-    def field(self):
-        """Gets the field of this MarketDataKeyRule.  # noqa: E501
-
-        The conceptual qualification for the field, typically 'bid', 'mid' (default), or 'ask', but can also be 'open', 'close', etc.  When resolving quotes from LUSID's database, only quotes whose Field is identical to the Field specified here  will be accepted as market data.  When resolving data from an external supplier, the Field must be one of a defined set for the given supplier.                Note: Applies to the retrieval of quotes only. Has no impact on the resolution of complex market data.  # noqa: E501
-
-        :return: The field of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._field
-
-    @field.setter
-    def field(self, field):
-        """Sets the field of this MarketDataKeyRule.
-
-        The conceptual qualification for the field, typically 'bid', 'mid' (default), or 'ask', but can also be 'open', 'close', etc.  When resolving quotes from LUSID's database, only quotes whose Field is identical to the Field specified here  will be accepted as market data.  When resolving data from an external supplier, the Field must be one of a defined set for the given supplier.                Note: Applies to the retrieval of quotes only. Has no impact on the resolution of complex market data.  # noqa: E501
-
-        :param field: The field of this MarketDataKeyRule.  # noqa: E501
-        :type field: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                field is not None and len(field) > 32):
-            raise ValueError("Invalid value for `field`, length must be less than or equal to `32`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                field is not None and len(field) < 0):
-            raise ValueError("Invalid value for `field`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._field = field
-
-    @property
-    def quote_interval(self):
-        """Gets the quote_interval of this MarketDataKeyRule.  # noqa: E501
-
-        Shorthand for the time interval used to select market data. This must be a dot-separated string              nominating a start and end date, for example '5D.0D' to look back 5 days from today (0 days ago). The syntax              is <i>int</i><i>char</i>.<i>int</i><i>char</i>, where <i>char</i> is one of              D(ay), Bd(business day), W(eek), M(onth) or Y(ear).              Business days are calculated using the calendars specified on the Valuation Request.              If no calendar is provided in the request, then it will default to only skipping weekends.              For example, if the valuation date is a Monday, then a quote interval of \"1Bd\" would behave as \"3D\",              looking back to the Friday. Data with effectiveAt on the weekend will still be found in that window.  # noqa: E501
-
-        :return: The quote_interval of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._quote_interval
-
-    @quote_interval.setter
-    def quote_interval(self, quote_interval):
-        """Sets the quote_interval of this MarketDataKeyRule.
-
-        Shorthand for the time interval used to select market data. This must be a dot-separated string              nominating a start and end date, for example '5D.0D' to look back 5 days from today (0 days ago). The syntax              is <i>int</i><i>char</i>.<i>int</i><i>char</i>, where <i>char</i> is one of              D(ay), Bd(business day), W(eek), M(onth) or Y(ear).              Business days are calculated using the calendars specified on the Valuation Request.              If no calendar is provided in the request, then it will default to only skipping weekends.              For example, if the valuation date is a Monday, then a quote interval of \"1Bd\" would behave as \"3D\",              looking back to the Friday. Data with effectiveAt on the weekend will still be found in that window.  # noqa: E501
-
-        :param quote_interval: The quote_interval of this MarketDataKeyRule.  # noqa: E501
-        :type quote_interval: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                quote_interval is not None and len(quote_interval) > 16):
-            raise ValueError("Invalid value for `quote_interval`, length must be less than or equal to `16`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                quote_interval is not None and len(quote_interval) < 0):
-            raise ValueError("Invalid value for `quote_interval`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._quote_interval = quote_interval
-
-    @property
-    def as_at(self):
-        """Gets the as_at of this MarketDataKeyRule.  # noqa: E501
-
-        The AsAt predicate specification.  # noqa: E501
-
-        :return: The as_at of this MarketDataKeyRule.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._as_at
-
-    @as_at.setter
-    def as_at(self, as_at):
-        """Sets the as_at of this MarketDataKeyRule.
-
-        The AsAt predicate specification.  # noqa: E501
-
-        :param as_at: The as_at of this MarketDataKeyRule.  # noqa: E501
-        :type as_at: datetime
-        """
-
-        self._as_at = as_at
-
-    @property
-    def price_source(self):
-        """Gets the price_source of this MarketDataKeyRule.  # noqa: E501
-
-        The source of the quote. For a given provider/supplier of market data there may be an additional qualifier, e.g. the exchange or bank that provided the quote  # noqa: E501
-
-        :return: The price_source of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._price_source
-
-    @price_source.setter
-    def price_source(self, price_source):
-        """Sets the price_source of this MarketDataKeyRule.
-
-        The source of the quote. For a given provider/supplier of market data there may be an additional qualifier, e.g. the exchange or bank that provided the quote  # noqa: E501
-
-        :param price_source: The price_source of this MarketDataKeyRule.  # noqa: E501
-        :type price_source: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                price_source is not None and len(price_source) > 256):
-            raise ValueError("Invalid value for `price_source`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                price_source is not None and len(price_source) < 0):
-            raise ValueError("Invalid value for `price_source`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._price_source = price_source
-
-    @property
-    def mask(self):
-        """Gets the mask of this MarketDataKeyRule.  # noqa: E501
-
-        Allows for partial or complete override of the market asset resolved for a dependency  Either a named override or a dot separated string (A.B.C.D.*).  e.g. for Rates curve 'EUR.*' will replace the resolve MarketAsset 'GBP/12M', 'GBP/3M' with the EUR equivalent, if there  are no wildcards in the mask, the mask is taken as the MarketAsset for any dependency matching the rule.  # noqa: E501
-
-        :return: The mask of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._mask
-
-    @mask.setter
-    def mask(self, mask):
-        """Sets the mask of this MarketDataKeyRule.
-
-        Allows for partial or complete override of the market asset resolved for a dependency  Either a named override or a dot separated string (A.B.C.D.*).  e.g. for Rates curve 'EUR.*' will replace the resolve MarketAsset 'GBP/12M', 'GBP/3M' with the EUR equivalent, if there  are no wildcards in the mask, the mask is taken as the MarketAsset for any dependency matching the rule.  # noqa: E501
-
-        :param mask: The mask of this MarketDataKeyRule.  # noqa: E501
-        :type mask: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                mask is not None and len(mask) > 256):
-            raise ValueError("Invalid value for `mask`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                mask is not None and len(mask) < 0):
-            raise ValueError("Invalid value for `mask`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._mask = mask
-
-    @property
-    def source_system(self):
-        """Gets the source_system of this MarketDataKeyRule.  # noqa: E501
-
-        If set, this parameter will seek an external source of market data.  Optional and, if omitted, will default to \"Lusid\".  This means that data will be retrieved from the LUSID Quote Store and LUSID Complex Market Data Store.                This can be set to \"MarketDataOverrides\" if Supplier is set to \"Client\".  # noqa: E501
-
-        :return: The source_system of this MarketDataKeyRule.  # noqa: E501
-        :rtype: str
-        """
-        return self._source_system
-
-    @source_system.setter
-    def source_system(self, source_system):
-        """Sets the source_system of this MarketDataKeyRule.
-
-        If set, this parameter will seek an external source of market data.  Optional and, if omitted, will default to \"Lusid\".  This means that data will be retrieved from the LUSID Quote Store and LUSID Complex Market Data Store.                This can be set to \"MarketDataOverrides\" if Supplier is set to \"Client\".  # noqa: E501
-
-        :param source_system: The source_system of this MarketDataKeyRule.  # noqa: E501
-        :type source_system: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                source_system is not None and len(source_system) > 256):
-            raise ValueError("Invalid value for `source_system`, length must be less than or equal to `256`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                source_system is not None and len(source_system) < 0):
-            raise ValueError("Invalid value for `source_system`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._source_system = source_system
-
-    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())
+    key: constr(strict=True, max_length=128, min_length=0) = Field(..., description="A dot-separated string that defines a pattern for matching market data dependencies.  The form of the string depends on the type of the dependency; see below for basic types and the Knowledge Base for further info.  Quote lookup: \"Quote.{CodeType}.*\" e.g. \"Quote.RIC.*\" refers to 'any RIC quote'  Fx rates: \"Fx.CurrencyPair.*\", which refers to 'any FX rate'  Discounting curves: \"Rates.{Currency}.{Currency}OIS e.g. \"Rates.USD.USDOIS\" refers to the OIS USD discounting curve                For non-fx and non-quote rules, trailing parameters can be replaced by the wildcard character '*'.  e.g. \"Rates.*.*\" matches any dependency on a discounting curve.")
+    supplier: constr(strict=True, max_length=32, min_length=0) = Field(..., description="The market data supplier (where the data comes from)")
+    data_scope: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="dataScope", description="The scope in which the data should be found when using this rule.")
+    quote_type: StrictStr = Field(..., alias="quoteType", description="The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice, PrincipalWriteOff, InterestDeferred, InterestShortfall")
+    field: Optional[constr(strict=True, max_length=32, min_length=0)] = Field(None, description="The conceptual qualification for the field, typically 'bid', 'mid' (default), or 'ask', but can also be 'open', 'close', etc.  When resolving quotes from LUSID's database, only quotes whose Field is identical to the Field specified here  will be accepted as market data.  When resolving data from an external supplier, the Field must be one of a defined set for the given supplier.                Note: Applies to the retrieval of quotes only. Has no impact on the resolution of complex market data.")
+    quote_interval: Optional[constr(strict=True, max_length=16, min_length=0)] = Field(None, alias="quoteInterval", description="Shorthand for the time interval used to select market data. This must be a dot-separated string              nominating a start and end date, for example '5D.0D' to look back 5 days from today (0 days ago). The syntax              is <i>int</i><i>char</i>.<i>int</i><i>char</i>, where <i>char</i> is one of              D(ay), Bd(business day), W(eek), M(onth) or Y(ear).              Business days are calculated using the calendars specified on the Valuation Request.              If no calendar is provided in the request, then it will default to only skipping weekends.              For example, if the valuation date is a Monday, then a quote interval of \"1Bd\" would behave as \"3D\",              looking back to the Friday. Data with effectiveAt on the weekend will still be found in that window.")
+    as_at: Optional[datetime] = Field(None, alias="asAt", description="Deprecated field which no longer has any effect on market data resolution.")
+    price_source: Optional[constr(strict=True, max_length=256, min_length=0)] = Field(None, alias="priceSource", description="The source of the quote. For a given provider/supplier of market data there may be an additional qualifier, e.g. the exchange or bank that provided the quote")
+    mask: Optional[constr(strict=True, max_length=256, min_length=0)] = Field(None, description="Allows for partial or complete override of the market asset resolved for a dependency  Either a named override or a dot separated string (A.B.C.D.*).  e.g. for Rates curve 'EUR.*' will replace the resolve MarketAsset 'GBP/12M', 'GBP/3M' with the EUR equivalent, if there  are no wildcards in the mask, the mask is taken as the MarketAsset for any dependency matching the rule.")
+    source_system: Optional[constr(strict=True, max_length=256, min_length=0)] = Field(None, alias="sourceSystem", description="If set, this parameter will seek an external source of market data.  Optional and, if omitted, will default to \"Lusid\".  This means that data will be retrieved from the LUSID Quote Store and LUSID Complex Market Data Store.                This can be set to \"MarketDataOverrides\" if Supplier is set to \"Client\".")
+    fall_through_on_access_denied: Optional[StrictBool] = Field(None, alias="fallThroughOnAccessDenied", description="When a user attempts to use a rule to access data to which they are not entitled,  the rule will fail to resolve any market data.  By default, such an access denied failure will stop any further attempts to resolve market data.  This is so that differently entitled users always receive the same market data from market data resolution,  if they have sufficient entitlements to retrieve the required data.  If set to true, then an access denied failure will not stop further market data resolution,  and resolution will continue with the next specified MarketDataKeyRule.  Optional, and defaults to false.")
+    __properties = ["key", "supplier", "dataScope", "quoteType", "field", "quoteInterval", "asAt", "priceSource", "mask", "sourceSystem", "fallThroughOnAccessDenied"]
+
+    @validator('data_scope')
+    def data_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('quote_type')
+    def quote_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice', 'PrincipalWriteOff', 'InterestDeferred', 'InterestShortfall'):
+            raise ValueError("must be one of enum values ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice', 'PrincipalWriteOff', 'InterestDeferred', 'InterestShortfall')")
+        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, MarketDataKeyRule):
-            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, MarketDataKeyRule):
-            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) -> MarketDataKeyRule:
+        """Create an instance of MarketDataKeyRule 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 field (nullable) is None
+        # and __fields_set__ contains the field
+        if self.field is None and "field" in self.__fields_set__:
+            _dict['field'] = None
+
+        # set to None if quote_interval (nullable) is None
+        # and __fields_set__ contains the field
+        if self.quote_interval is None and "quote_interval" in self.__fields_set__:
+            _dict['quoteInterval'] = None
+
+        # 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 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 mask (nullable) is None
+        # and __fields_set__ contains the field
+        if self.mask is None and "mask" in self.__fields_set__:
+            _dict['mask'] = None
+
+        # set to None if source_system (nullable) is None
+        # and __fields_set__ contains the field
+        if self.source_system is None and "source_system" in self.__fields_set__:
+            _dict['sourceSystem'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> MarketDataKeyRule:
+        """Create an instance of MarketDataKeyRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return MarketDataKeyRule.parse_obj(obj)
+
+        _obj = MarketDataKeyRule.parse_obj({
+            "key": obj.get("key"),
+            "supplier": obj.get("supplier"),
+            "data_scope": obj.get("dataScope"),
+            "quote_type": obj.get("quoteType"),
+            "field": obj.get("field"),
+            "quote_interval": obj.get("quoteInterval"),
+            "as_at": obj.get("asAt"),
+            "price_source": obj.get("priceSource"),
+            "mask": obj.get("mask"),
+            "source_system": obj.get("sourceSystem"),
+            "fall_through_on_access_denied": obj.get("fallThroughOnAccessDenied")
+        })
+        return _obj