# 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 List, Dict, Optional, Any, Union, TYPE_CHECKING
from typing_extensions import Annotated
from pydantic.v1 import BaseModel, StrictStr, StrictInt, StrictBool, StrictFloat, StrictBytes, Field, validator, ValidationError, conlist, constr
from datetime import datetime
from lusid.models.link import Link
from lusid.models.resource_id import ResourceId
[docs]
class InstrumentCashFlow(BaseModel):
"""
The details for the cashflow associated with an instrument from a given portfolio. # noqa: E501
"""
payment_date: datetime = Field(description="The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)", alias="paymentDate")
amount: Optional[Union[StrictFloat, StrictInt]] = Field(default=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(...,alias="currency", description="The payment currency of the cash flow.")
source_portfolio_id: ResourceId = Field(alias="sourcePortfolioId")
source_transaction_id: StrictStr = Field(...,alias="sourceTransactionId", description="The identifier for the parent transaction on the instrument that will pay/receive this cash flow.")
source_instrument_scope: StrictStr = Field(...,alias="sourceInstrumentScope", description="The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.")
source_instrument_id: StrictStr = Field(...,alias="sourceInstrumentId", description="The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.")
diagnostics: Dict[str, Optional[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[List[Link]] = None
__properties = ["paymentDate", "amount", "currency", "sourcePortfolioId", "sourceTransactionId", "sourceInstrumentScope", "sourceInstrumentId", "diagnostics", "links"]
[docs]
class Config:
"""Pydantic configuration"""
allow_population_by_field_name = True
validate_assignment = True
def __str__(self):
"""For `print` and `pprint`"""
return pprint.pformat(self.dict(by_alias=False))
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
[docs]
def to_str(self) -> str:
"""Returns the string representation of the model using alias"""
return pprint.pformat(self.dict(by_alias=True))
[docs]
def to_json(self) -> str:
"""Returns the JSON representation of the model using alias"""
return json.dumps(self.to_dict())
[docs]
@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))
[docs]
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
[docs]
@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
InstrumentCashFlow.update_forward_refs()