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

lusid/models/instrument_definition.py

@@ -5,294 +5,107 @@
 
     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 InstrumentDefinition(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, List, Optional
+from pydantic import BaseModel, Field, conlist, constr
+from lusid.models.instrument_id_value import InstrumentIdValue
+from lusid.models.lusid_instrument import LusidInstrument
+from lusid.models.model_property import ModelProperty
+from lusid.models.resource_id import ResourceId
 
+class InstrumentDefinition(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'.
+    InstrumentDefinition
     """
-    openapi_types = {
-        'name': 'str',
-        'identifiers': 'dict(str, InstrumentIdValue)',
-        'properties': 'list[ModelProperty]',
-        'look_through_portfolio_id': 'ResourceId',
-        'definition': 'LusidInstrument',
-        'settlement_cycle': 'SettlementCycle'
-    }
-
-    attribute_map = {
-        'name': 'name',
-        'identifiers': 'identifiers',
-        'properties': 'properties',
-        'look_through_portfolio_id': 'lookThroughPortfolioId',
-        'definition': 'definition',
-        'settlement_cycle': 'settlementCycle'
-    }
-
-    required_map = {
-        'name': 'required',
-        'identifiers': 'required',
-        'properties': 'optional',
-        'look_through_portfolio_id': 'optional',
-        'definition': 'optional',
-        'settlement_cycle': 'optional'
-    }
-
-    def __init__(self, name=None, identifiers=None, properties=None, look_through_portfolio_id=None, definition=None, settlement_cycle=None, local_vars_configuration=None):  # noqa: E501
-        """InstrumentDefinition - a model defined in OpenAPI"
-        
-        :param name:  The name of the instrument. (required)
-        :type name: str
-        :param identifiers:  A set of identifiers that can be used to identify the instrument. At least one of these must be configured to be a unique identifier. (required)
-        :type identifiers: dict[str, lusid.InstrumentIdValue]
-        :param properties:  Set of unique instrument properties and associated values to store with the instrument. Each property must be from the 'Instrument' domain.
-        :type properties: list[lusid.ModelProperty]
-        :param look_through_portfolio_id: 
-        :type look_through_portfolio_id: lusid.ResourceId
-        :param definition: 
-        :type definition: lusid.LusidInstrument
-        :param settlement_cycle: 
-        :type settlement_cycle: lusid.SettlementCycle
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._name = None
-        self._identifiers = None
-        self._properties = None
-        self._look_through_portfolio_id = None
-        self._definition = None
-        self._settlement_cycle = None
-        self.discriminator = None
-
-        self.name = name
-        self.identifiers = identifiers
-        self.properties = properties
-        if look_through_portfolio_id is not None:
-            self.look_through_portfolio_id = look_through_portfolio_id
-        if definition is not None:
-            self.definition = definition
-        if settlement_cycle is not None:
-            self.settlement_cycle = settlement_cycle
-
-    @property
-    def name(self):
-        """Gets the name of this InstrumentDefinition.  # noqa: E501
-
-        The name of the instrument.  # noqa: E501
-
-        :return: The name of this InstrumentDefinition.  # noqa: E501
-        :rtype: str
-        """
-        return self._name
-
-    @name.setter
-    def name(self, name):
-        """Sets the name of this InstrumentDefinition.
-
-        The name of the instrument.  # noqa: E501
-
-        :param name: The name of this InstrumentDefinition.  # 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 InstrumentDefinition.  # noqa: E501
-
-        A set of identifiers that can be used to identify the instrument. At least one of these must be configured to be a unique identifier.  # noqa: E501
-
-        :return: The identifiers of this InstrumentDefinition.  # noqa: E501
-        :rtype: dict[str, lusid.InstrumentIdValue]
-        """
-        return self._identifiers
-
-    @identifiers.setter
-    def identifiers(self, identifiers):
-        """Sets the identifiers of this InstrumentDefinition.
-
-        A set of identifiers that can be used to identify the instrument. At least one of these must be configured to be a unique identifier.  # noqa: E501
-
-        :param identifiers: The identifiers of this InstrumentDefinition.  # noqa: E501
-        :type identifiers: dict[str, lusid.InstrumentIdValue]
-        """
-        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 InstrumentDefinition.  # noqa: E501
-
-        Set of unique instrument properties and associated values to store with the instrument. Each property must be from the 'Instrument' domain.  # noqa: E501
-
-        :return: The properties of this InstrumentDefinition.  # noqa: E501
-        :rtype: list[lusid.ModelProperty]
-        """
-        return self._properties
-
-    @properties.setter
-    def properties(self, properties):
-        """Sets the properties of this InstrumentDefinition.
-
-        Set of unique instrument properties and associated values to store with the instrument. Each property must be from the 'Instrument' domain.  # noqa: E501
-
-        :param properties: The properties of this InstrumentDefinition.  # noqa: E501
-        :type properties: list[lusid.ModelProperty]
-        """
-
-        self._properties = properties
-
-    @property
-    def look_through_portfolio_id(self):
-        """Gets the look_through_portfolio_id of this InstrumentDefinition.  # noqa: E501
-
-
-        :return: The look_through_portfolio_id of this InstrumentDefinition.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._look_through_portfolio_id
-
-    @look_through_portfolio_id.setter
-    def look_through_portfolio_id(self, look_through_portfolio_id):
-        """Sets the look_through_portfolio_id of this InstrumentDefinition.
-
-
-        :param look_through_portfolio_id: The look_through_portfolio_id of this InstrumentDefinition.  # noqa: E501
-        :type look_through_portfolio_id: lusid.ResourceId
-        """
-
-        self._look_through_portfolio_id = look_through_portfolio_id
-
-    @property
-    def definition(self):
-        """Gets the definition of this InstrumentDefinition.  # noqa: E501
-
-
-        :return: The definition of this InstrumentDefinition.  # noqa: E501
-        :rtype: lusid.LusidInstrument
-        """
-        return self._definition
-
-    @definition.setter
-    def definition(self, definition):
-        """Sets the definition of this InstrumentDefinition.
-
-
-        :param definition: The definition of this InstrumentDefinition.  # noqa: E501
-        :type definition: lusid.LusidInstrument
-        """
-
-        self._definition = definition
-
-    @property
-    def settlement_cycle(self):
-        """Gets the settlement_cycle of this InstrumentDefinition.  # noqa: E501
-
-
-        :return: The settlement_cycle of this InstrumentDefinition.  # noqa: E501
-        :rtype: lusid.SettlementCycle
-        """
-        return self._settlement_cycle
-
-    @settlement_cycle.setter
-    def settlement_cycle(self, settlement_cycle):
-        """Sets the settlement_cycle of this InstrumentDefinition.
-
-
-        :param settlement_cycle: The settlement_cycle of this InstrumentDefinition.  # noqa: E501
-        :type settlement_cycle: lusid.SettlementCycle
-        """
-
-        self._settlement_cycle = settlement_cycle
-
-    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, InstrumentDefinition):
-            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, InstrumentDefinition):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    name: constr(strict=True, min_length=1) = Field(..., description="The name of the instrument.")
+    identifiers: Dict[str, InstrumentIdValue] = Field(..., description="A set of identifiers that can be used to identify the instrument. At least one of these must be configured to be a unique identifier.")
+    properties: Optional[conlist(ModelProperty)] = Field(None, description="Set of unique instrument properties and associated values to store with the instrument. Each property must be from the 'Instrument' domain.")
+    look_through_portfolio_id: Optional[ResourceId] = Field(None, alias="lookThroughPortfolioId")
+    definition: Optional[LusidInstrument] = None
+    __properties = ["name", "identifiers", "properties", "lookThroughPortfolioId", "definition"]
+
+    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) -> InstrumentDefinition:
+        """Create an instance of InstrumentDefinition from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in identifiers (dict)
+        _field_dict = {}
+        if self.identifiers:
+            for _key in self.identifiers:
+                if self.identifiers[_key]:
+                    _field_dict[_key] = self.identifiers[_key].to_dict()
+            _dict['identifiers'] = _field_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 look_through_portfolio_id
+        if self.look_through_portfolio_id:
+            _dict['lookThroughPortfolioId'] = self.look_through_portfolio_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of definition
+        if self.definition:
+            _dict['definition'] = self.definition.to_dict()
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> InstrumentDefinition:
+        """Create an instance of InstrumentDefinition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return InstrumentDefinition.parse_obj(obj)
+
+        _obj = InstrumentDefinition.parse_obj({
+            "name": obj.get("name"),
+            "identifiers": dict(
+                (_k, InstrumentIdValue.from_dict(_v))
+                for _k, _v in obj.get("identifiers").items()
+            )
+            if obj.get("identifiers") is not None
+            else None,
+            "properties": [ModelProperty.from_dict(_item) for _item in obj.get("properties")] if obj.get("properties") is not None else None,
+            "look_through_portfolio_id": ResourceId.from_dict(obj.get("lookThroughPortfolioId")) if obj.get("lookThroughPortfolioId") is not None else None,
+            "definition": LusidInstrument.from_dict(obj.get("definition")) if obj.get("definition") is not None else None
+        })
+        return _obj

lusid/models/instrument_definition_format.py

@@ -5,215 +5,69 @@
 
     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 InstrumentDefinitionFormat(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
+from pydantic import BaseModel, Field, constr
 
+class InstrumentDefinitionFormat(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'.
+    What is the provenance of an instrument. This defines who creates/owns it, what format it is in (e.g. a proprietary format or a common and known one)              and what the version of that is.  # noqa: E501
     """
-    openapi_types = {
-        'source_system': 'str',
-        'vendor': 'str',
-        'version': 'str'
-    }
-
-    attribute_map = {
-        'source_system': 'sourceSystem',
-        'vendor': 'vendor',
-        'version': 'version'
-    }
-
-    required_map = {
-        'source_system': 'required',
-        'vendor': 'required',
-        'version': 'required'
-    }
-
-    def __init__(self, source_system=None, vendor=None, version=None, local_vars_configuration=None):  # noqa: E501
-        """InstrumentDefinitionFormat - a model defined in OpenAPI"
-        
-        :param source_system:  which source system does the format originate from (required)
-        :type source_system: str
-        :param vendor:  An instrument will potentially have been created by any number of different organisations. Some will be understood completely (e.g. LUSID's), some won't.              The provenance of an instrument indicates who \"owns\" the associated format. (required)
-        :type vendor: str
-        :param version:  Version of the document. Would be preferable to avoid the need, but LUSID will not control other organisations' trade formats. (required)
-        :type version: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._source_system = None
-        self._vendor = None
-        self._version = None
-        self.discriminator = None
-
-        self.source_system = source_system
-        self.vendor = vendor
-        self.version = version
-
-    @property
-    def source_system(self):
-        """Gets the source_system of this InstrumentDefinitionFormat.  # noqa: E501
-
-        which source system does the format originate from  # noqa: E501
-
-        :return: The source_system of this InstrumentDefinitionFormat.  # noqa: E501
-        :rtype: str
-        """
-        return self._source_system
-
-    @source_system.setter
-    def source_system(self, source_system):
-        """Sets the source_system of this InstrumentDefinitionFormat.
-
-        which source system does the format originate from  # noqa: E501
-
-        :param source_system: The source_system of this InstrumentDefinitionFormat.  # noqa: E501
-        :type source_system: str
-        """
-        if self.local_vars_configuration.client_side_validation and source_system is None:  # noqa: E501
-            raise ValueError("Invalid value for `source_system`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                source_system is not None and len(source_system) < 1):
-            raise ValueError("Invalid value for `source_system`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._source_system = source_system
-
-    @property
-    def vendor(self):
-        """Gets the vendor of this InstrumentDefinitionFormat.  # noqa: E501
-
-        An instrument will potentially have been created by any number of different organisations. Some will be understood completely (e.g. LUSID's), some won't.              The provenance of an instrument indicates who \"owns\" the associated format.  # noqa: E501
-
-        :return: The vendor of this InstrumentDefinitionFormat.  # noqa: E501
-        :rtype: str
-        """
-        return self._vendor
-
-    @vendor.setter
-    def vendor(self, vendor):
-        """Sets the vendor of this InstrumentDefinitionFormat.
-
-        An instrument will potentially have been created by any number of different organisations. Some will be understood completely (e.g. LUSID's), some won't.              The provenance of an instrument indicates who \"owns\" the associated format.  # noqa: E501
-
-        :param vendor: The vendor of this InstrumentDefinitionFormat.  # noqa: E501
-        :type vendor: str
-        """
-        if self.local_vars_configuration.client_side_validation and vendor is None:  # noqa: E501
-            raise ValueError("Invalid value for `vendor`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                vendor is not None and len(vendor) < 1):
-            raise ValueError("Invalid value for `vendor`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._vendor = vendor
-
-    @property
-    def version(self):
-        """Gets the version of this InstrumentDefinitionFormat.  # noqa: E501
-
-        Version of the document. Would be preferable to avoid the need, but LUSID will not control other organisations' trade formats.  # noqa: E501
-
-        :return: The version of this InstrumentDefinitionFormat.  # noqa: E501
-        :rtype: str
-        """
-        return self._version
-
-    @version.setter
-    def version(self, version):
-        """Sets the version of this InstrumentDefinitionFormat.
-
-        Version of the document. Would be preferable to avoid the need, but LUSID will not control other organisations' trade formats.  # noqa: E501
-
-        :param version: The version of this InstrumentDefinitionFormat.  # noqa: E501
-        :type version: str
-        """
-        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
-        if (self.local_vars_configuration.client_side_validation and
-                version is not None and len(version) < 1):
-            raise ValueError("Invalid value for `version`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._version = version
-
-    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, InstrumentDefinitionFormat):
-            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, InstrumentDefinitionFormat):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    source_system: constr(strict=True, min_length=1) = Field(..., alias="sourceSystem", description="which source system does the format originate from")
+    vendor: constr(strict=True, min_length=1) = Field(..., description="An instrument will potentially have been created by any number of different organisations. Some will be understood completely (e.g. LUSID's), some won't.              The provenance of an instrument indicates who \"owns\" the associated format.")
+    version: constr(strict=True, min_length=1) = Field(..., description="Version of the document. Would be preferable to avoid the need, but LUSID will not control other organisations' trade formats.")
+    __properties = ["sourceSystem", "vendor", "version"]
+
+    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) -> InstrumentDefinitionFormat:
+        """Create an instance of InstrumentDefinitionFormat 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)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> InstrumentDefinitionFormat:
+        """Create an instance of InstrumentDefinitionFormat from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return InstrumentDefinitionFormat.parse_obj(obj)
+
+        _obj = InstrumentDefinitionFormat.parse_obj({
+            "source_system": obj.get("sourceSystem"),
+            "vendor": obj.get("vendor"),
+            "version": obj.get("version")
+        })
+        return _obj