# 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.v1 import BaseModel, Field, StrictStr, conlist
from lusid.models.cash_ladder_record import CashLadderRecord
from lusid.models.error_detail import ErrorDetail
from lusid.models.link import Link
from lusid.models.perpetual_property import PerpetualProperty
[docs]
class PortfolioCashLadder(BaseModel):
"""
PortfolioCashLadder
"""
currency: StrictStr = Field(..., description="The currency of the cash-flows.")
sub_holding_keys: Optional[Dict[str, PerpetualProperty]] = Field(None, alias="subHoldingKeys", description="The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.")
records: conlist(CashLadderRecord) = Field(..., description="A record of cash flows on a specific date.")
failed: Optional[Dict[str, ErrorDetail]] = Field(None, description="The records that could not be returned along with a reason for their failure.")
links: Optional[conlist(Link)] = None
__properties = ["currency", "subHoldingKeys", "records", "failed", "links"]
[docs]
class Config:
"""Pydantic configuration"""
allow_population_by_field_name = True
validate_assignment = True
[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) -> PortfolioCashLadder:
"""Create an instance of PortfolioCashLadder 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 each value in sub_holding_keys (dict)
_field_dict = {}
if self.sub_holding_keys:
for _key in self.sub_holding_keys:
if self.sub_holding_keys[_key]:
_field_dict[_key] = self.sub_holding_keys[_key].to_dict()
_dict['subHoldingKeys'] = _field_dict
# override the default output from pydantic by calling `to_dict()` of each item in records (list)
_items = []
if self.records:
for _item in self.records:
if _item:
_items.append(_item.to_dict())
_dict['records'] = _items
# override the default output from pydantic by calling `to_dict()` of each value in failed (dict)
_field_dict = {}
if self.failed:
for _key in self.failed:
if self.failed[_key]:
_field_dict[_key] = self.failed[_key].to_dict()
_dict['failed'] = _field_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 sub_holding_keys (nullable) is None
# and __fields_set__ contains the field
if self.sub_holding_keys is None and "sub_holding_keys" in self.__fields_set__:
_dict['subHoldingKeys'] = None
# set to None if failed (nullable) is None
# and __fields_set__ contains the field
if self.failed is None and "failed" in self.__fields_set__:
_dict['failed'] = 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) -> PortfolioCashLadder:
"""Create an instance of PortfolioCashLadder from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return PortfolioCashLadder.parse_obj(obj)
_obj = PortfolioCashLadder.parse_obj({
"currency": obj.get("currency"),
"sub_holding_keys": dict(
(_k, PerpetualProperty.from_dict(_v))
for _k, _v in obj.get("subHoldingKeys").items()
)
if obj.get("subHoldingKeys") is not None
else None,
"records": [CashLadderRecord.from_dict(_item) for _item in obj.get("records")] if obj.get("records") is not None else None,
"failed": dict(
(_k, ErrorDetail.from_dict(_v))
for _k, _v in obj.get("failed").items()
)
if obj.get("failed") 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