lusid-sdk 1.1.118__py3-none-any.whl → 2.0.50b0__py3-none-any.whl

lusid/models/reconciliation_transactions.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, Optional
+from pydantic import BaseModel, Field
+from lusid.models.date_range import DateRange
+from lusid.models.resource_id import ResourceId
+
+class ReconciliationTransactions(BaseModel):
+    """
+    Specification for the transactions of a scheduled reconciliation  # noqa: E501
+    """
+    transaction_window: Optional[DateRange] = Field(None, alias="transactionWindow")
+    mapping_id: Optional[ResourceId] = Field(None, alias="mappingId")
+    __properties = ["transactionWindow", "mappingId"]
+
+    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) -> ReconciliationTransactions:
+        """Create an instance of ReconciliationTransactions 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 transaction_window
+        if self.transaction_window:
+            _dict['transactionWindow'] = self.transaction_window.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of mapping_id
+        if self.mapping_id:
+            _dict['mappingId'] = self.mapping_id.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReconciliationTransactions:
+        """Create an instance of ReconciliationTransactions from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReconciliationTransactions.parse_obj(obj)
+
+        _obj = ReconciliationTransactions.parse_obj({
+            "transaction_window": DateRange.from_dict(obj.get("transactionWindow")) if obj.get("transactionWindow") is not None else None,
+            "mapping_id": ResourceId.from_dict(obj.get("mappingId")) if obj.get("mappingId") is not None else None
+        })
+        return _obj

lusid/models/reference_data.py

@@ -5,170 +5,83 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.118
     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
+import json
 
-from lusid.configuration import Configuration
 
+from typing import Any, Dict, List
+from pydantic import BaseModel, Field, conlist
+from lusid.models.field_definition import FieldDefinition
+from lusid.models.field_value import FieldValue
 
-class ReferenceData(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class ReferenceData(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'.
+    ReferenceData
     """
-    openapi_types = {
-        'field_definitions': 'list[FieldDefinition]',
-        'values': 'list[FieldValue]'
-    }
-
-    attribute_map = {
-        'field_definitions': 'fieldDefinitions',
-        'values': 'values'
-    }
-
-    required_map = {
-        'field_definitions': 'required',
-        'values': 'required'
-    }
-
-    def __init__(self, field_definitions=None, values=None, local_vars_configuration=None):  # noqa: E501
-        """ReferenceData - a model defined in OpenAPI"
-        
-        :param field_definitions:  (required)
-        :type field_definitions: list[lusid.FieldDefinition]
-        :param values:  (required)
-        :type values: list[lusid.FieldValue]
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._field_definitions = None
-        self._values = None
-        self.discriminator = None
-
-        self.field_definitions = field_definitions
-        self.values = values
-
-    @property
-    def field_definitions(self):
-        """Gets the field_definitions of this ReferenceData.  # noqa: E501
-
-
-        :return: The field_definitions of this ReferenceData.  # noqa: E501
-        :rtype: list[lusid.FieldDefinition]
-        """
-        return self._field_definitions
-
-    @field_definitions.setter
-    def field_definitions(self, field_definitions):
-        """Sets the field_definitions of this ReferenceData.
-
-
-        :param field_definitions: The field_definitions of this ReferenceData.  # noqa: E501
-        :type field_definitions: list[lusid.FieldDefinition]
-        """
-        if self.local_vars_configuration.client_side_validation and field_definitions is None:  # noqa: E501
-            raise ValueError("Invalid value for `field_definitions`, must not be `None`")  # noqa: E501
-
-        self._field_definitions = field_definitions
-
-    @property
-    def values(self):
-        """Gets the values of this ReferenceData.  # noqa: E501
-
-
-        :return: The values of this ReferenceData.  # noqa: E501
-        :rtype: list[lusid.FieldValue]
-        """
-        return self._values
-
-    @values.setter
-    def values(self, values):
-        """Sets the values of this ReferenceData.
-
-
-        :param values: The values of this ReferenceData.  # noqa: E501
-        :type values: list[lusid.FieldValue]
-        """
-        if self.local_vars_configuration.client_side_validation and values is None:  # noqa: E501
-            raise ValueError("Invalid value for `values`, must not be `None`")  # noqa: E501
-
-        self._values = values
-
-    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, ReferenceData):
-            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, ReferenceData):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    field_definitions: conlist(FieldDefinition) = Field(..., alias="fieldDefinitions")
+    values: conlist(FieldValue) = Field(...)
+    __properties = ["fieldDefinitions", "values"]
+
+    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) -> ReferenceData:
+        """Create an instance of ReferenceData 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 item in field_definitions (list)
+        _items = []
+        if self.field_definitions:
+            for _item in self.field_definitions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['fieldDefinitions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in values (list)
+        _items = []
+        if self.values:
+            for _item in self.values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['values'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReferenceData:
+        """Create an instance of ReferenceData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReferenceData.parse_obj(obj)
+
+        _obj = ReferenceData.parse_obj({
+            "field_definitions": [FieldDefinition.from_dict(_item) for _item in obj.get("fieldDefinitions")] if obj.get("fieldDefinitions") is not None else None,
+            "values": [FieldValue.from_dict(_item) for _item in obj.get("values")] if obj.get("values") is not None else None
+        })
+        return _obj

lusid/models/reference_instrument.py

@@ -5,253 +5,91 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.118
     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
+import json
 
-from lusid.configuration import Configuration
 
+from typing import Any, Dict
+from pydantic import Field, StrictStr, constr, validator
+from lusid.models.lusid_instrument import LusidInstrument
 
-class ReferenceInstrument(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class ReferenceInstrument(LusidInstrument):
     """
-
-    """
-    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'.
+    LUSID representation of a reference to another instrument that has already been loaded (e.g. a lookthrough to a portfolio).  # noqa: E501
     """
-    openapi_types = {
-        'instrument_id': 'str',
-        'instrument_id_type': 'str',
-        'scope': 'str',
-        'instrument_type': 'str'
-    }
-
-    attribute_map = {
-        'instrument_id': 'instrumentId',
-        'instrument_id_type': 'instrumentIdType',
-        'scope': 'scope',
-        'instrument_type': 'instrumentType'
-    }
-
-    required_map = {
-        'instrument_id': 'required',
-        'instrument_id_type': 'required',
-        'scope': 'required',
-        'instrument_type': 'required'
-    }
-
-    def __init__(self, instrument_id=None, instrument_id_type=None, scope=None, instrument_type=None, local_vars_configuration=None):  # noqa: E501
-        """ReferenceInstrument - a model defined in OpenAPI"
-        
-        :param instrument_id:  The Identifier code (required)
-        :type instrument_id: str
-        :param instrument_id_type:  The type of the instrument id e.g. LusidInstrument Id (required)
-        :type instrument_id_type: str
-        :param scope:  Scope for the instrument (optional) (required)
-        :type scope: str
-        :param instrument_type:  The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan (required)
-        :type instrument_type: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._instrument_id = None
-        self._instrument_id_type = None
-        self._scope = None
-        self._instrument_type = None
-        self.discriminator = None
-
-        self.instrument_id = instrument_id
-        self.instrument_id_type = instrument_id_type
-        self.scope = scope
-        self.instrument_type = instrument_type
-
-    @property
-    def instrument_id(self):
-        """Gets the instrument_id of this ReferenceInstrument.  # noqa: E501
-
-        The Identifier code  # noqa: E501
-
-        :return: The instrument_id of this ReferenceInstrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_id
-
-    @instrument_id.setter
-    def instrument_id(self, instrument_id):
-        """Sets the instrument_id of this ReferenceInstrument.
-
-        The Identifier code  # noqa: E501
-
-        :param instrument_id: The instrument_id of this ReferenceInstrument.  # noqa: E501
-        :type instrument_id: str
-        """
-        if self.local_vars_configuration.client_side_validation and instrument_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `instrument_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                instrument_id is not None and len(instrument_id) < 1):
-            raise ValueError("Invalid value for `instrument_id`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._instrument_id = instrument_id
-
-    @property
-    def instrument_id_type(self):
-        """Gets the instrument_id_type of this ReferenceInstrument.  # noqa: E501
-
-        The type of the instrument id e.g. LusidInstrument Id  # noqa: E501
-
-        :return: The instrument_id_type of this ReferenceInstrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_id_type
-
-    @instrument_id_type.setter
-    def instrument_id_type(self, instrument_id_type):
-        """Sets the instrument_id_type of this ReferenceInstrument.
-
-        The type of the instrument id e.g. LusidInstrument Id  # noqa: E501
-
-        :param instrument_id_type: The instrument_id_type of this ReferenceInstrument.  # noqa: E501
-        :type instrument_id_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and instrument_id_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `instrument_id_type`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                instrument_id_type is not None and len(instrument_id_type) < 1):
-            raise ValueError("Invalid value for `instrument_id_type`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._instrument_id_type = instrument_id_type
-
-    @property
-    def scope(self):
-        """Gets the scope of this ReferenceInstrument.  # noqa: E501
-
-        Scope for the instrument (optional)  # noqa: E501
-
-        :return: The scope of this ReferenceInstrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._scope
-
-    @scope.setter
-    def scope(self, scope):
-        """Sets the scope of this ReferenceInstrument.
-
-        Scope for the instrument (optional)  # noqa: E501
-
-        :param scope: The scope of this ReferenceInstrument.  # noqa: E501
-        :type scope: str
-        """
-        if self.local_vars_configuration.client_side_validation and scope is None:  # noqa: E501
-            raise ValueError("Invalid value for `scope`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                scope is not None and len(scope) < 1):
-            raise ValueError("Invalid value for `scope`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._scope = scope
-
-    @property
-    def instrument_type(self):
-        """Gets the instrument_type of this ReferenceInstrument.  # noqa: E501
-
-        The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan  # noqa: E501
-
-        :return: The instrument_type of this ReferenceInstrument.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_type
-
-    @instrument_type.setter
-    def instrument_type(self, instrument_type):
-        """Sets the instrument_type of this ReferenceInstrument.
-
-        The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan  # noqa: E501
-
-        :param instrument_type: The instrument_type of this ReferenceInstrument.  # noqa: E501
-        :type instrument_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and instrument_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `instrument_type`, must not be `None`")  # noqa: E501
-        allowed_values = ["QuotedSecurity", "InterestRateSwap", "FxForward", "Future", "ExoticInstrument", "FxOption", "CreditDefaultSwap", "InterestRateSwaption", "Bond", "EquityOption", "FixedLeg", "FloatingLeg", "BespokeCashFlowsLeg", "Unknown", "TermDeposit", "ContractForDifference", "EquitySwap", "CashPerpetual", "CapFloor", "CashSettled", "CdsIndex", "Basket", "FundingLeg", "FxSwap", "ForwardRateAgreement", "SimpleInstrument", "Repo", "Equity", "ExchangeTradedOption", "ReferenceInstrument", "ComplexBond", "InflationLinkedBond", "InflationSwap", "SimpleCashFlowLoan", "TotalReturnSwap", "InflationLeg", "FundShareClass", "FlexibleLoan"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and instrument_type not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `instrument_type` ({0}), must be one of {1}"  # noqa: E501
-                .format(instrument_type, allowed_values)
-            )
-
-        self._instrument_type = instrument_type
-
-    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, ReferenceInstrument):
-            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, ReferenceInstrument):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    instrument_id: constr(strict=True, min_length=1) = Field(..., alias="instrumentId", description="The Identifier code")
+    instrument_id_type: constr(strict=True, min_length=1) = Field(..., alias="instrumentIdType", description="The type of the instrument id e.g. LusidInstrument Id")
+    scope: constr(strict=True, min_length=1) = Field(..., description="Scope for the instrument (optional)")
+    instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg")
+    additional_properties: Dict[str, Any] = {}
+    __properties = ["instrumentType", "instrumentId", "instrumentIdType", "scope"]
+
+    @validator('instrument_type')
+    def instrument_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('QuotedSecurity', 'InterestRateSwap', 'FxForward', 'Future', 'ExoticInstrument', 'FxOption', 'CreditDefaultSwap', 'InterestRateSwaption', 'Bond', 'EquityOption', 'FixedLeg', 'FloatingLeg', 'BespokeCashFlowsLeg', 'Unknown', 'TermDeposit', 'ContractForDifference', 'EquitySwap', 'CashPerpetual', 'CapFloor', 'CashSettled', 'CdsIndex', 'Basket', 'FundingLeg', 'FxSwap', 'ForwardRateAgreement', 'SimpleInstrument', 'Repo', 'Equity', 'ExchangeTradedOption', 'ReferenceInstrument', 'ComplexBond', 'InflationLinkedBond', 'InflationSwap', 'SimpleCashFlowLoan', 'TotalReturnSwap', 'InflationLeg'):
+            raise ValueError("must be one of enum values ('QuotedSecurity', 'InterestRateSwap', 'FxForward', 'Future', 'ExoticInstrument', 'FxOption', 'CreditDefaultSwap', 'InterestRateSwaption', 'Bond', 'EquityOption', 'FixedLeg', 'FloatingLeg', 'BespokeCashFlowsLeg', 'Unknown', 'TermDeposit', 'ContractForDifference', 'EquitySwap', 'CashPerpetual', 'CapFloor', 'CashSettled', 'CdsIndex', 'Basket', 'FundingLeg', 'FxSwap', 'ForwardRateAgreement', 'SimpleInstrument', 'Repo', 'Equity', 'ExchangeTradedOption', 'ReferenceInstrument', 'ComplexBond', 'InflationLinkedBond', 'InflationSwap', 'SimpleCashFlowLoan', 'TotalReturnSwap', 'InflationLeg')")
+        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) -> ReferenceInstrument:
+        """Create an instance of ReferenceInstrument 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={
+                            "additional_properties"
+                          },
+                          exclude_none=True)
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReferenceInstrument:
+        """Create an instance of ReferenceInstrument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReferenceInstrument.parse_obj(obj)
+
+        _obj = ReferenceInstrument.parse_obj({
+            "instrument_type": obj.get("instrumentType"),
+            "instrument_id": obj.get("instrumentId"),
+            "instrument_id_type": obj.get("instrumentIdType"),
+            "scope": obj.get("scope")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj