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

lusid/models/instrument_capabilities.py

@@ -0,0 +1,133 @@
+# 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, List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist
+from lusid.models.described_address_key import DescribedAddressKey
+from lusid.models.economic_dependency import EconomicDependency
+from lusid.models.link import Link
+
+class InstrumentCapabilities(BaseModel):
+    """
+    Instrument capabilities containing useful information about the instrument and the model. This includes  - features corresponding to the instrument i.e. Optionality:American, Other:InflationLinked  - supported addresses (if model provided) i.e. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued  - economic dependencies (if model provided) i.e. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS  # noqa: E501
+    """
+    instrument_id: Optional[StrictStr] = Field(None, alias="instrumentId", description="The Lusid instrument id for the instrument e.g. 'LUID_00003D4X'.")
+    model: Optional[StrictStr] = Field(None, description="The pricing model e.g. 'Discounting'.")
+    features: Optional[Dict[str, StrictStr]] = Field(None, description="Features of the instrument describing its optionality, payoff type and more e.g. 'Instrument/Features/Exercise: American', 'Instrument/Features/Product: Option'")
+    supported_addresses: Optional[conlist(DescribedAddressKey)] = Field(None, alias="supportedAddresses", description="Queryable addresses supported by the model, e.g. 'Valuation/Pv', 'Valuation/Accrued'.")
+    economic_dependencies: Optional[conlist(EconomicDependency)] = Field(None, alias="economicDependencies", description="Economic dependencies for the model, e.g. 'Fx:GBP.USD', 'Cash:GBP', 'Rates:GBP.GBPOIS'.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["instrumentId", "model", "features", "supportedAddresses", "economicDependencies", "links"]
+
+    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) -> InstrumentCapabilities:
+        """Create an instance of InstrumentCapabilities 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 supported_addresses (list)
+        _items = []
+        if self.supported_addresses:
+            for _item in self.supported_addresses:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['supportedAddresses'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in economic_dependencies (list)
+        _items = []
+        if self.economic_dependencies:
+            for _item in self.economic_dependencies:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['economicDependencies'] = _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 instrument_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.instrument_id is None and "instrument_id" in self.__fields_set__:
+            _dict['instrumentId'] = None
+
+        # set to None if model (nullable) is None
+        # and __fields_set__ contains the field
+        if self.model is None and "model" in self.__fields_set__:
+            _dict['model'] = None
+
+        # set to None if features (nullable) is None
+        # and __fields_set__ contains the field
+        if self.features is None and "features" in self.__fields_set__:
+            _dict['features'] = None
+
+        # set to None if supported_addresses (nullable) is None
+        # and __fields_set__ contains the field
+        if self.supported_addresses is None and "supported_addresses" in self.__fields_set__:
+            _dict['supportedAddresses'] = None
+
+        # set to None if economic_dependencies (nullable) is None
+        # and __fields_set__ contains the field
+        if self.economic_dependencies is None and "economic_dependencies" in self.__fields_set__:
+            _dict['economicDependencies'] = 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) -> InstrumentCapabilities:
+        """Create an instance of InstrumentCapabilities from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return InstrumentCapabilities.parse_obj(obj)
+
+        _obj = InstrumentCapabilities.parse_obj({
+            "instrument_id": obj.get("instrumentId"),
+            "model": obj.get("model"),
+            "features": obj.get("features"),
+            "supported_addresses": [DescribedAddressKey.from_dict(_item) for _item in obj.get("supportedAddresses")] if obj.get("supportedAddresses") is not None else None,
+            "economic_dependencies": [EconomicDependency.from_dict(_item) for _item in obj.get("economicDependencies")] if obj.get("economicDependencies") 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

lusid/models/instrument_cash_flow.py

@@ -5,399 +5,103 @@
 
     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
 
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist, constr
+from lusid.models.link import Link
+from lusid.models.resource_id import ResourceId
 
-class InstrumentCashFlow(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class InstrumentCashFlow(BaseModel):
     """
-
+    The details for the cashflow associated with an instrument from a given portfolio.  # 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 = {
-        'payment_date': 'datetime',
-        'amount': 'float',
-        'currency': 'str',
-        'source_portfolio_id': 'ResourceId',
-        'source_transaction_id': 'str',
-        'source_instrument_scope': 'str',
-        'source_instrument_id': 'str',
-        'diagnostics': 'dict(str, str)',
-        'links': 'list[Link]'
-    }
-
-    attribute_map = {
-        'payment_date': 'paymentDate',
-        'amount': 'amount',
-        'currency': 'currency',
-        'source_portfolio_id': 'sourcePortfolioId',
-        'source_transaction_id': 'sourceTransactionId',
-        'source_instrument_scope': 'sourceInstrumentScope',
-        'source_instrument_id': 'sourceInstrumentId',
-        'diagnostics': 'diagnostics',
-        'links': 'links'
-    }
-
-    required_map = {
-        'payment_date': 'required',
-        'amount': 'optional',
-        'currency': 'required',
-        'source_portfolio_id': 'required',
-        'source_transaction_id': 'required',
-        'source_instrument_scope': 'required',
-        'source_instrument_id': 'required',
-        'diagnostics': 'required',
-        'links': 'optional'
-    }
-
-    def __init__(self, payment_date=None, amount=None, currency=None, source_portfolio_id=None, source_transaction_id=None, source_instrument_scope=None, source_instrument_id=None, diagnostics=None, links=None, local_vars_configuration=None):  # noqa: E501
-        """InstrumentCashFlow - a model defined in OpenAPI"
-        
-        :param payment_date:  The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.) (required)
-        :type payment_date: datetime
-        :param amount:  The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.
-        :type amount: float
-        :param currency:  The payment currency of the cash flow. (required)
-        :type currency: str
-        :param source_portfolio_id:  (required)
-        :type source_portfolio_id: lusid.ResourceId
-        :param source_transaction_id:  The identifier for the parent transaction on the instrument that will pay/receive this cash flow. (required)
-        :type source_transaction_id: str
-        :param source_instrument_scope:  The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required)
-        :type source_instrument_scope: str
-        :param source_instrument_id:  The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required)
-        :type source_instrument_id: str
-        :param diagnostics:  Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data. (required)
-        :type diagnostics: dict(str, str)
-        :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._payment_date = None
-        self._amount = None
-        self._currency = None
-        self._source_portfolio_id = None
-        self._source_transaction_id = None
-        self._source_instrument_scope = None
-        self._source_instrument_id = None
-        self._diagnostics = None
-        self._links = None
-        self.discriminator = None
-
-        self.payment_date = payment_date
-        self.amount = amount
-        self.currency = currency
-        self.source_portfolio_id = source_portfolio_id
-        self.source_transaction_id = source_transaction_id
-        self.source_instrument_scope = source_instrument_scope
-        self.source_instrument_id = source_instrument_id
-        self.diagnostics = diagnostics
-        self.links = links
-
-    @property
-    def payment_date(self):
-        """Gets the payment_date of this InstrumentCashFlow.  # noqa: E501
-
-        The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)  # noqa: E501
-
-        :return: The payment_date of this InstrumentCashFlow.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._payment_date
-
-    @payment_date.setter
-    def payment_date(self, payment_date):
-        """Sets the payment_date of this InstrumentCashFlow.
-
-        The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)  # noqa: E501
-
-        :param payment_date: The payment_date of this InstrumentCashFlow.  # noqa: E501
-        :type payment_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and payment_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `payment_date`, must not be `None`")  # noqa: E501
-
-        self._payment_date = payment_date
-
-    @property
-    def amount(self):
-        """Gets the amount of this InstrumentCashFlow.  # noqa: E501
-
-        The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.  # noqa: E501
-
-        :return: The amount of this InstrumentCashFlow.  # noqa: E501
-        :rtype: float
-        """
-        return self._amount
-
-    @amount.setter
-    def amount(self, amount):
-        """Sets the amount of this InstrumentCashFlow.
-
-        The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.  # noqa: E501
-
-        :param amount: The amount of this InstrumentCashFlow.  # noqa: E501
-        :type amount: float
-        """
-
-        self._amount = amount
-
-    @property
-    def currency(self):
-        """Gets the currency of this InstrumentCashFlow.  # noqa: E501
-
-        The payment currency of the cash flow.  # noqa: E501
-
-        :return: The currency of this InstrumentCashFlow.  # noqa: E501
-        :rtype: str
-        """
-        return self._currency
-
-    @currency.setter
-    def currency(self, currency):
-        """Sets the currency of this InstrumentCashFlow.
-
-        The payment currency of the cash flow.  # noqa: E501
-
-        :param currency: The currency of this InstrumentCashFlow.  # noqa: E501
-        :type currency: str
-        """
-        if self.local_vars_configuration.client_side_validation and currency is None:  # noqa: E501
-            raise ValueError("Invalid value for `currency`, must not be `None`")  # noqa: E501
-
-        self._currency = currency
-
-    @property
-    def source_portfolio_id(self):
-        """Gets the source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
-
-
-        :return: The source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._source_portfolio_id
-
-    @source_portfolio_id.setter
-    def source_portfolio_id(self, source_portfolio_id):
-        """Sets the source_portfolio_id of this InstrumentCashFlow.
-
-
-        :param source_portfolio_id: The source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
-        :type source_portfolio_id: lusid.ResourceId
-        """
-        if self.local_vars_configuration.client_side_validation and source_portfolio_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `source_portfolio_id`, must not be `None`")  # noqa: E501
-
-        self._source_portfolio_id = source_portfolio_id
-
-    @property
-    def source_transaction_id(self):
-        """Gets the source_transaction_id of this InstrumentCashFlow.  # noqa: E501
-
-        The identifier for the parent transaction on the instrument that will pay/receive this cash flow.  # noqa: E501
-
-        :return: The source_transaction_id of this InstrumentCashFlow.  # noqa: E501
-        :rtype: str
-        """
-        return self._source_transaction_id
-
-    @source_transaction_id.setter
-    def source_transaction_id(self, source_transaction_id):
-        """Sets the source_transaction_id of this InstrumentCashFlow.
-
-        The identifier for the parent transaction on the instrument that will pay/receive this cash flow.  # noqa: E501
-
-        :param source_transaction_id: The source_transaction_id of this InstrumentCashFlow.  # noqa: E501
-        :type source_transaction_id: str
-        """
-        if self.local_vars_configuration.client_side_validation and source_transaction_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `source_transaction_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                source_transaction_id is not None and len(source_transaction_id) < 1):
-            raise ValueError("Invalid value for `source_transaction_id`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._source_transaction_id = source_transaction_id
-
-    @property
-    def source_instrument_scope(self):
-        """Gets the source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :return: The source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
-        :rtype: str
-        """
-        return self._source_instrument_scope
-
-    @source_instrument_scope.setter
-    def source_instrument_scope(self, source_instrument_scope):
-        """Sets the source_instrument_scope of this InstrumentCashFlow.
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :param source_instrument_scope: The source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
-        :type source_instrument_scope: str
-        """
-        if self.local_vars_configuration.client_side_validation and source_instrument_scope is None:  # noqa: E501
-            raise ValueError("Invalid value for `source_instrument_scope`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                source_instrument_scope is not None and len(source_instrument_scope) < 1):
-            raise ValueError("Invalid value for `source_instrument_scope`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._source_instrument_scope = source_instrument_scope
-
-    @property
-    def source_instrument_id(self):
-        """Gets the source_instrument_id of this InstrumentCashFlow.  # noqa: E501
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :return: The source_instrument_id of this InstrumentCashFlow.  # noqa: E501
-        :rtype: str
-        """
-        return self._source_instrument_id
-
-    @source_instrument_id.setter
-    def source_instrument_id(self, source_instrument_id):
-        """Sets the source_instrument_id of this InstrumentCashFlow.
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :param source_instrument_id: The source_instrument_id of this InstrumentCashFlow.  # noqa: E501
-        :type source_instrument_id: str
-        """
-        if self.local_vars_configuration.client_side_validation and source_instrument_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `source_instrument_id`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                source_instrument_id is not None and len(source_instrument_id) < 1):
-            raise ValueError("Invalid value for `source_instrument_id`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._source_instrument_id = source_instrument_id
-
-    @property
-    def diagnostics(self):
-        """Gets the diagnostics of this InstrumentCashFlow.  # noqa: E501
-
-        Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.  # noqa: E501
-
-        :return: The diagnostics of this InstrumentCashFlow.  # noqa: E501
-        :rtype: dict(str, str)
-        """
-        return self._diagnostics
-
-    @diagnostics.setter
-    def diagnostics(self, diagnostics):
-        """Sets the diagnostics of this InstrumentCashFlow.
-
-        Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.  # noqa: E501
-
-        :param diagnostics: The diagnostics of this InstrumentCashFlow.  # noqa: E501
-        :type diagnostics: dict(str, str)
-        """
-        if self.local_vars_configuration.client_side_validation and diagnostics is None:  # noqa: E501
-            raise ValueError("Invalid value for `diagnostics`, must not be `None`")  # noqa: E501
-
-        self._diagnostics = diagnostics
-
-    @property
-    def links(self):
-        """Gets the links of this InstrumentCashFlow.  # noqa: E501
-
-
-        :return: The links of this InstrumentCashFlow.  # noqa: E501
-        :rtype: list[lusid.Link]
-        """
-        return self._links
-
-    @links.setter
-    def links(self, links):
-        """Sets the links of this InstrumentCashFlow.
-
-
-        :param links: The links of this InstrumentCashFlow.  # 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, InstrumentCashFlow):
-            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, InstrumentCashFlow):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    payment_date: datetime = Field(..., alias="paymentDate", description="The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)")
+    amount: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.")
+    currency: StrictStr = Field(..., description="The payment currency of the cash flow.")
+    source_portfolio_id: ResourceId = Field(..., alias="sourcePortfolioId")
+    source_transaction_id: constr(strict=True, min_length=1) = Field(..., alias="sourceTransactionId", description="The identifier for the parent transaction on the instrument that will pay/receive this cash flow.")
+    source_instrument_scope: constr(strict=True, min_length=1) = Field(..., alias="sourceInstrumentScope", description="The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.")
+    source_instrument_id: constr(strict=True, min_length=1) = Field(..., alias="sourceInstrumentId", description="The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.")
+    diagnostics: Dict[str, StrictStr] = Field(..., description="Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["paymentDate", "amount", "currency", "sourcePortfolioId", "sourceTransactionId", "sourceInstrumentScope", "sourceInstrumentId", "diagnostics", "links"]
+
+    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) -> InstrumentCashFlow:
+        """Create an instance of InstrumentCashFlow 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 source_portfolio_id
+        if self.source_portfolio_id:
+            _dict['sourcePortfolioId'] = self.source_portfolio_id.to_dict()
+        # 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 amount (nullable) is None
+        # and __fields_set__ contains the field
+        if self.amount is None and "amount" in self.__fields_set__:
+            _dict['amount'] = 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) -> InstrumentCashFlow:
+        """Create an instance of InstrumentCashFlow from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return InstrumentCashFlow.parse_obj(obj)
+
+        _obj = InstrumentCashFlow.parse_obj({
+            "payment_date": obj.get("paymentDate"),
+            "amount": obj.get("amount"),
+            "currency": obj.get("currency"),
+            "source_portfolio_id": ResourceId.from_dict(obj.get("sourcePortfolioId")) if obj.get("sourcePortfolioId") is not None else None,
+            "source_transaction_id": obj.get("sourceTransactionId"),
+            "source_instrument_scope": obj.get("sourceInstrumentScope"),
+            "source_instrument_id": obj.get("sourceInstrumentId"),
+            "diagnostics": obj.get("diagnostics"),
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj