lusid-sdk 1.1.257__py3-none-any.whl → 2.0.430__py3-none-any.whl

lusid/models/instrument.py

@@ -5,611 +5,174 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.257
     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 Instrument(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist, constr, validator
+from lusid.models.link import Link
+from lusid.models.lusid_instrument import LusidInstrument
+from lusid.models.model_property import ModelProperty
+from lusid.models.relationship import Relationship
+from lusid.models.resource_id import ResourceId
+from lusid.models.version import Version
 
-    Do not edit the class manually.
+class Instrument(BaseModel):
     """
-
+    A list of instruments.  # noqa: E501
     """
-    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'.
-    """
-    openapi_types = {
-        'href': 'str',
-        'scope': 'str',
-        'lusid_instrument_id': 'str',
-        'version': 'Version',
-        'staged_modifications': 'StagedModificationsInfo',
-        'name': 'str',
-        'identifiers': 'dict(str, str)',
-        'properties': 'list[ModelProperty]',
-        'lookthrough_portfolio': 'ResourceId',
-        'instrument_definition': 'LusidInstrument',
-        'state': 'str',
-        'asset_class': 'str',
-        'dom_ccy': 'str',
-        'relationships': 'list[Relationship]',
-        'settlement_cycle': 'SettlementCycle',
-        'links': 'list[Link]'
-    }
-
-    attribute_map = {
-        'href': 'href',
-        'scope': 'scope',
-        'lusid_instrument_id': 'lusidInstrumentId',
-        'version': 'version',
-        'staged_modifications': 'stagedModifications',
-        'name': 'name',
-        'identifiers': 'identifiers',
-        'properties': 'properties',
-        'lookthrough_portfolio': 'lookthroughPortfolio',
-        'instrument_definition': 'instrumentDefinition',
-        'state': 'state',
-        'asset_class': 'assetClass',
-        'dom_ccy': 'domCcy',
-        'relationships': 'relationships',
-        'settlement_cycle': 'settlementCycle',
-        'links': 'links'
-    }
-
-    required_map = {
-        'href': 'optional',
-        'scope': 'optional',
-        'lusid_instrument_id': 'required',
-        'version': 'required',
-        'staged_modifications': 'optional',
-        'name': 'required',
-        'identifiers': 'required',
-        'properties': 'optional',
-        'lookthrough_portfolio': 'optional',
-        'instrument_definition': 'optional',
-        'state': 'required',
-        'asset_class': 'optional',
-        'dom_ccy': 'optional',
-        'relationships': 'optional',
-        'settlement_cycle': 'optional',
-        'links': 'optional'
-    }
-
-    def __init__(self, href=None, scope=None, lusid_instrument_id=None, version=None, staged_modifications=None, name=None, identifiers=None, properties=None, lookthrough_portfolio=None, instrument_definition=None, state=None, asset_class=None, dom_ccy=None, relationships=None, settlement_cycle=None, links=None, local_vars_configuration=None):  # noqa: E501
-        """Instrument - a model defined in OpenAPI"
-        
-        :param href:  The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.
-        :type href: str
-        :param scope:  The scope in which the instrument lies.
-        :type scope: str
-        :param lusid_instrument_id:  The unique LUSID Instrument Identifier (LUID) of the instrument. (required)
-        :type lusid_instrument_id: str
-        :param version:  (required)
-        :type version: lusid.Version
-        :param staged_modifications: 
-        :type staged_modifications: lusid.StagedModificationsInfo
-        :param name:  The name of the instrument. (required)
-        :type name: str
-        :param identifiers:  The set of identifiers that can be used to identify the instrument. (required)
-        :type identifiers: dict(str, str)
-        :param properties:  The requested instrument properties. These will be from the 'Instrument' domain.
-        :type properties: list[lusid.ModelProperty]
-        :param lookthrough_portfolio: 
-        :type lookthrough_portfolio: lusid.ResourceId
-        :param instrument_definition: 
-        :type instrument_definition: lusid.LusidInstrument
-        :param state:  The state of of the instrument at the asAt datetime of this version of the instrument definition. The available values are: Active, Inactive, Deleted (required)
-        :type state: str
-        :param asset_class:  The nominal asset class of the instrument, e.g. InterestRates, FX, Inflation, Equities, Credit, Commodities, etc. The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown
-        :type asset_class: str
-        :param dom_ccy:  The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD.
-        :type dom_ccy: str
-        :param relationships:  A set of relationships associated to the instrument.
-        :type relationships: list[lusid.Relationship]
-        :param settlement_cycle: 
-        :type settlement_cycle: lusid.SettlementCycle
-        :param links: 
-        :type links: list[lusid.Link]
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._href = None
-        self._scope = None
-        self._lusid_instrument_id = None
-        self._version = None
-        self._staged_modifications = None
-        self._name = None
-        self._identifiers = None
-        self._properties = None
-        self._lookthrough_portfolio = None
-        self._instrument_definition = None
-        self._state = None
-        self._asset_class = None
-        self._dom_ccy = None
-        self._relationships = None
-        self._settlement_cycle = None
-        self._links = None
-        self.discriminator = None
-
-        self.href = href
-        self.scope = scope
-        self.lusid_instrument_id = lusid_instrument_id
-        self.version = version
-        if staged_modifications is not None:
-            self.staged_modifications = staged_modifications
-        self.name = name
-        self.identifiers = identifiers
-        self.properties = properties
-        if lookthrough_portfolio is not None:
-            self.lookthrough_portfolio = lookthrough_portfolio
-        if instrument_definition is not None:
-            self.instrument_definition = instrument_definition
-        self.state = state
-        if asset_class is not None:
-            self.asset_class = asset_class
-        self.dom_ccy = dom_ccy
-        self.relationships = relationships
-        if settlement_cycle is not None:
-            self.settlement_cycle = settlement_cycle
-        self.links = links
-
-    @property
-    def href(self):
-        """Gets the href of this Instrument.  # noqa: E501
-
-        The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.  # noqa: E501
-
-        :return: The href of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._href
-
-    @href.setter
-    def href(self, href):
-        """Sets the href of this Instrument.
-
-        The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.  # noqa: E501
-
-        :param href: The href of this Instrument.  # noqa: E501
-        :type href: str
-        """
-
-        self._href = href
-
-    @property
-    def scope(self):
-        """Gets the scope of this Instrument.  # noqa: E501
-
-        The scope in which the instrument lies.  # noqa: E501
-
-        :return: The scope of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._scope
-
-    @scope.setter
-    def scope(self, scope):
-        """Sets the scope of this Instrument.
-
-        The scope in which the instrument lies.  # noqa: E501
-
-        :param scope: The scope of this Instrument.  # noqa: E501
-        :type scope: str
-        """
-
-        self._scope = scope
-
-    @property
-    def lusid_instrument_id(self):
-        """Gets the lusid_instrument_id of this Instrument.  # noqa: E501
-
-        The unique LUSID Instrument Identifier (LUID) of the instrument.  # noqa: E501
-
-        :return: The lusid_instrument_id of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._lusid_instrument_id
-
-    @lusid_instrument_id.setter
-    def lusid_instrument_id(self, lusid_instrument_id):
-        """Sets the lusid_instrument_id of this Instrument.
-
-        The unique LUSID Instrument Identifier (LUID) of the instrument.  # noqa: E501
-
-        :param lusid_instrument_id: The lusid_instrument_id of this Instrument.  # noqa: E501
-        :type lusid_instrument_id: str
-        """
-        if self.local_vars_configuration.client_side_validation and lusid_instrument_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `lusid_instrument_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                lusid_instrument_id is not None and len(lusid_instrument_id) < 1):
-            raise ValueError("Invalid value for `lusid_instrument_id`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._lusid_instrument_id = lusid_instrument_id
-
-    @property
-    def version(self):
-        """Gets the version of this Instrument.  # noqa: E501
-
-
-        :return: The version of this Instrument.  # noqa: E501
-        :rtype: lusid.Version
-        """
-        return self._version
-
-    @version.setter
-    def version(self, version):
-        """Sets the version of this Instrument.
-
-
-        :param version: The version of this Instrument.  # noqa: E501
-        :type version: lusid.Version
-        """
-        if self.local_vars_configuration.client_side_validation and version is None:  # noqa: E501
-            raise ValueError("Invalid value for `version`, must not be `None`")  # noqa: E501
-
-        self._version = version
-
-    @property
-    def staged_modifications(self):
-        """Gets the staged_modifications of this Instrument.  # noqa: E501
-
-
-        :return: The staged_modifications of this Instrument.  # noqa: E501
-        :rtype: lusid.StagedModificationsInfo
-        """
-        return self._staged_modifications
-
-    @staged_modifications.setter
-    def staged_modifications(self, staged_modifications):
-        """Sets the staged_modifications of this Instrument.
-
-
-        :param staged_modifications: The staged_modifications of this Instrument.  # noqa: E501
-        :type staged_modifications: lusid.StagedModificationsInfo
-        """
-
-        self._staged_modifications = staged_modifications
-
-    @property
-    def name(self):
-        """Gets the name of this Instrument.  # noqa: E501
-
-        The name of the instrument.  # noqa: E501
-
-        :return: The name of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._name
-
-    @name.setter
-    def name(self, name):
-        """Sets the name of this Instrument.
-
-        The name of the instrument.  # noqa: E501
-
-        :param name: The name of this Instrument.  # noqa: E501
-        :type name: str
-        """
-        if self.local_vars_configuration.client_side_validation and name is None:  # noqa: E501
-            raise ValueError("Invalid value for `name`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                name is not None and len(name) < 1):
-            raise ValueError("Invalid value for `name`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._name = name
-
-    @property
-    def identifiers(self):
-        """Gets the identifiers of this Instrument.  # noqa: E501
-
-        The set of identifiers that can be used to identify the instrument.  # noqa: E501
-
-        :return: The identifiers of this Instrument.  # noqa: E501
-        :rtype: dict(str, str)
-        """
-        return self._identifiers
-
-    @identifiers.setter
-    def identifiers(self, identifiers):
-        """Sets the identifiers of this Instrument.
-
-        The set of identifiers that can be used to identify the instrument.  # noqa: E501
-
-        :param identifiers: The identifiers of this Instrument.  # noqa: E501
-        :type identifiers: dict(str, str)
-        """
-        if self.local_vars_configuration.client_side_validation and identifiers is None:  # noqa: E501
-            raise ValueError("Invalid value for `identifiers`, must not be `None`")  # noqa: E501
-
-        self._identifiers = identifiers
-
-    @property
-    def properties(self):
-        """Gets the properties of this Instrument.  # noqa: E501
-
-        The requested instrument properties. These will be from the 'Instrument' domain.  # noqa: E501
-
-        :return: The properties of this Instrument.  # noqa: E501
-        :rtype: list[lusid.ModelProperty]
-        """
-        return self._properties
-
-    @properties.setter
-    def properties(self, properties):
-        """Sets the properties of this Instrument.
-
-        The requested instrument properties. These will be from the 'Instrument' domain.  # noqa: E501
-
-        :param properties: The properties of this Instrument.  # noqa: E501
-        :type properties: list[lusid.ModelProperty]
-        """
-
-        self._properties = properties
-
-    @property
-    def lookthrough_portfolio(self):
-        """Gets the lookthrough_portfolio of this Instrument.  # noqa: E501
-
-
-        :return: The lookthrough_portfolio of this Instrument.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._lookthrough_portfolio
-
-    @lookthrough_portfolio.setter
-    def lookthrough_portfolio(self, lookthrough_portfolio):
-        """Sets the lookthrough_portfolio of this Instrument.
-
-
-        :param lookthrough_portfolio: The lookthrough_portfolio of this Instrument.  # noqa: E501
-        :type lookthrough_portfolio: lusid.ResourceId
-        """
-
-        self._lookthrough_portfolio = lookthrough_portfolio
-
-    @property
-    def instrument_definition(self):
-        """Gets the instrument_definition of this Instrument.  # noqa: E501
-
-
-        :return: The instrument_definition of this Instrument.  # noqa: E501
-        :rtype: lusid.LusidInstrument
-        """
-        return self._instrument_definition
-
-    @instrument_definition.setter
-    def instrument_definition(self, instrument_definition):
-        """Sets the instrument_definition of this Instrument.
-
-
-        :param instrument_definition: The instrument_definition of this Instrument.  # noqa: E501
-        :type instrument_definition: lusid.LusidInstrument
-        """
-
-        self._instrument_definition = instrument_definition
-
-    @property
-    def state(self):
-        """Gets the state of this Instrument.  # noqa: E501
-
-        The state of of the instrument at the asAt datetime of this version of the instrument definition. The available values are: Active, Inactive, Deleted  # noqa: E501
-
-        :return: The state of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._state
-
-    @state.setter
-    def state(self, state):
-        """Sets the state of this Instrument.
-
-        The state of of the instrument at the asAt datetime of this version of the instrument definition. The available values are: Active, Inactive, Deleted  # noqa: E501
-
-        :param state: The state of this Instrument.  # noqa: E501
-        :type state: str
-        """
-        if self.local_vars_configuration.client_side_validation and state is None:  # noqa: E501
-            raise ValueError("Invalid value for `state`, must not be `None`")  # noqa: E501
-        allowed_values = ["Active", "Inactive", "Deleted"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and state not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `state` ({0}), must be one of {1}"  # noqa: E501
-                .format(state, allowed_values)
-            )
-
-        self._state = state
-
-    @property
-    def asset_class(self):
-        """Gets the asset_class of this Instrument.  # noqa: E501
-
-        The nominal asset class of the instrument, e.g. InterestRates, FX, Inflation, Equities, Credit, Commodities, etc. The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown  # noqa: E501
-
-        :return: The asset_class of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._asset_class
-
-    @asset_class.setter
-    def asset_class(self, asset_class):
-        """Sets the asset_class of this Instrument.
-
-        The nominal asset class of the instrument, e.g. InterestRates, FX, Inflation, Equities, Credit, Commodities, etc. The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown  # noqa: E501
-
-        :param asset_class: The asset_class of this Instrument.  # noqa: E501
-        :type asset_class: str
-        """
-        allowed_values = ["InterestRates", "FX", "Inflation", "Equities", "Credit", "Commodities", "Money", "Unknown"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and asset_class not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `asset_class` ({0}), must be one of {1}"  # noqa: E501
-                .format(asset_class, allowed_values)
-            )
-
-        self._asset_class = asset_class
-
-    @property
-    def dom_ccy(self):
-        """Gets the dom_ccy of this Instrument.  # noqa: E501
-
-        The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD.  # noqa: E501
-
-        :return: The dom_ccy of this Instrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._dom_ccy
-
-    @dom_ccy.setter
-    def dom_ccy(self, dom_ccy):
-        """Sets the dom_ccy of this Instrument.
-
-        The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD.  # noqa: E501
-
-        :param dom_ccy: The dom_ccy of this Instrument.  # noqa: E501
-        :type dom_ccy: str
-        """
-
-        self._dom_ccy = dom_ccy
-
-    @property
-    def relationships(self):
-        """Gets the relationships of this Instrument.  # noqa: E501
-
-        A set of relationships associated to the instrument.  # noqa: E501
-
-        :return: The relationships of this Instrument.  # noqa: E501
-        :rtype: list[lusid.Relationship]
-        """
-        return self._relationships
-
-    @relationships.setter
-    def relationships(self, relationships):
-        """Sets the relationships of this Instrument.
-
-        A set of relationships associated to the instrument.  # noqa: E501
-
-        :param relationships: The relationships of this Instrument.  # noqa: E501
-        :type relationships: list[lusid.Relationship]
-        """
-
-        self._relationships = relationships
-
-    @property
-    def settlement_cycle(self):
-        """Gets the settlement_cycle of this Instrument.  # noqa: E501
-
-
-        :return: The settlement_cycle of this Instrument.  # noqa: E501
-        :rtype: lusid.SettlementCycle
-        """
-        return self._settlement_cycle
-
-    @settlement_cycle.setter
-    def settlement_cycle(self, settlement_cycle):
-        """Sets the settlement_cycle of this Instrument.
-
-
-        :param settlement_cycle: The settlement_cycle of this Instrument.  # noqa: E501
-        :type settlement_cycle: lusid.SettlementCycle
-        """
-
-        self._settlement_cycle = settlement_cycle
-
-    @property
-    def links(self):
-        """Gets the links of this Instrument.  # noqa: E501
-
-
-        :return: The links of this Instrument.  # noqa: E501
-        :rtype: list[lusid.Link]
-        """
-        return self._links
-
-    @links.setter
-    def links(self, links):
-        """Sets the links of this Instrument.
-
-
-        :param links: The links of this Instrument.  # noqa: E501
-        :type links: list[lusid.Link]
-        """
-
-        self._links = links
-
-    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, Instrument):
-            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, Instrument):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    href: Optional[StrictStr] = Field(None, description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
+    scope: Optional[StrictStr] = Field(None, description="The scope in which the instrument lies.")
+    lusid_instrument_id: constr(strict=True, min_length=1) = Field(..., alias="lusidInstrumentId", description="The unique LUSID Instrument Identifier (LUID) of the instrument.")
+    version: Version = Field(...)
+    name: constr(strict=True, min_length=1) = Field(..., description="The name of the instrument.")
+    identifiers: Dict[str, StrictStr] = Field(..., description="The set of identifiers that can be used to identify the instrument.")
+    properties: Optional[conlist(ModelProperty)] = Field(None, description="The requested instrument properties. These will be from the 'Instrument' domain.")
+    lookthrough_portfolio: Optional[ResourceId] = Field(None, alias="lookthroughPortfolio")
+    instrument_definition: Optional[LusidInstrument] = Field(None, alias="instrumentDefinition")
+    state: StrictStr = Field(..., description="The state of of the instrument at the asAt datetime of this version of the instrument definition. The available values are: Active, Inactive, Deleted")
+    asset_class: Optional[StrictStr] = Field(None, alias="assetClass", description="The nominal asset class of the instrument, e.g. InterestRates, FX, Inflation, Equities, Credit, Commodities, etc. The available values are: InterestRates, FX, Inflation, Equities, Credit, Commodities, Money, Unknown")
+    dom_ccy: Optional[StrictStr] = Field(None, alias="domCcy", description="The domestic currency, meaning the currency in which the instrument would typically be expected to pay cashflows, e.g. a share in AAPL being USD.")
+    relationships: Optional[conlist(Relationship)] = Field(None, description="A set of relationships associated to the instrument.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["href", "scope", "lusidInstrumentId", "version", "name", "identifiers", "properties", "lookthroughPortfolio", "instrumentDefinition", "state", "assetClass", "domCcy", "relationships", "links"]
+
+    @validator('state')
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('Active', 'Inactive', 'Deleted'):
+            raise ValueError("must be one of enum values ('Active', 'Inactive', 'Deleted')")
+        return value
+
+    @validator('asset_class')
+    def asset_class_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in ('InterestRates', 'FX', 'Inflation', 'Equities', 'Credit', 'Commodities', 'Money', 'Unknown'):
+            raise ValueError("must be one of enum values ('InterestRates', 'FX', 'Inflation', 'Equities', 'Credit', 'Commodities', 'Money', 'Unknown')")
+        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) -> Instrument:
+        """Create an instance of Instrument 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 version
+        if self.version:
+            _dict['version'] = self.version.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in properties (list)
+        _items = []
+        if self.properties:
+            for _item in self.properties:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['properties'] = _items
+        # override the default output from pydantic by calling `to_dict()` of lookthrough_portfolio
+        if self.lookthrough_portfolio:
+            _dict['lookthroughPortfolio'] = self.lookthrough_portfolio.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of instrument_definition
+        if self.instrument_definition:
+            _dict['instrumentDefinition'] = self.instrument_definition.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in relationships (list)
+        _items = []
+        if self.relationships:
+            for _item in self.relationships:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['relationships'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.scope is None and "scope" in self.__fields_set__:
+            _dict['scope'] = None
+
+        # set to None if properties (nullable) is None
+        # and __fields_set__ contains the field
+        if self.properties is None and "properties" in self.__fields_set__:
+            _dict['properties'] = None
+
+        # set to None if dom_ccy (nullable) is None
+        # and __fields_set__ contains the field
+        if self.dom_ccy is None and "dom_ccy" in self.__fields_set__:
+            _dict['domCcy'] = None
+
+        # set to None if relationships (nullable) is None
+        # and __fields_set__ contains the field
+        if self.relationships is None and "relationships" in self.__fields_set__:
+            _dict['relationships'] = None
+
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Instrument:
+        """Create an instance of Instrument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return Instrument.parse_obj(obj)
+
+        _obj = Instrument.parse_obj({
+            "href": obj.get("href"),
+            "scope": obj.get("scope"),
+            "lusid_instrument_id": obj.get("lusidInstrumentId"),
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
+            "name": obj.get("name"),
+            "identifiers": obj.get("identifiers"),
+            "properties": [ModelProperty.from_dict(_item) for _item in obj.get("properties")] if obj.get("properties") is not None else None,
+            "lookthrough_portfolio": ResourceId.from_dict(obj.get("lookthroughPortfolio")) if obj.get("lookthroughPortfolio") is not None else None,
+            "instrument_definition": LusidInstrument.from_dict(obj.get("instrumentDefinition")) if obj.get("instrumentDefinition") is not None else None,
+            "state": obj.get("state"),
+            "asset_class": obj.get("assetClass"),
+            "dom_ccy": obj.get("domCcy"),
+            "relationships": [Relationship.from_dict(_item) for _item in obj.get("relationships")] if obj.get("relationships") is not None else None,
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj