# 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.error_detail import ErrorDetail
from lusid.models.link import Link
from lusid.models.result_data_schema import ResultDataSchema
[docs]
class BucketedCashFlowResponse(BaseModel):
"""
BucketedCashFlowResponse
"""
href: Optional[StrictStr] = None
data: Optional[conlist(Dict[str, Any])] = Field(None, description="List of dictionary bucketed cash flow result set. Each dictionary represent a bucketed cashflow result set keyed by AddressKeys. e.g. dictionary[\"Valuation/CashFlowAmount\"] for the aggregated cash flow amount for the bucket. e.g. suppose \"RoundUp\" method, then dictionary[\"Valuation/CashFlowDate/RoundUp\"] returns the bucketed cashflow date.")
report_currency: Optional[StrictStr] = Field(None, alias="reportCurrency", description="Three letter ISO currency string indicating what currency to report in for ReportCcy denominated queries. If not present then the currency of the relevant portfolio will be used in its place where relevant.")
data_schema: Optional[ResultDataSchema] = Field(None, alias="dataSchema")
failed: Optional[Dict[str, ErrorDetail]] = Field(None, description="Information about where instruments have failed to return cashflows in so far as it is available. e.g., failure to retrieve a market quote for a floating rate instrument.")
links: Optional[conlist(Link)] = None
__properties = ["href", "data", "reportCurrency", "dataSchema", "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) -> BucketedCashFlowResponse:
"""Create an instance of BucketedCashFlowResponse 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 data_schema
if self.data_schema:
_dict['dataSchema'] = self.data_schema.to_dict()
# 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 href (nullable) is None
# and __fields_set__ contains the field
if self.href is None and "href" in self.__fields_set__:
_dict['href'] = None
# set to None if data (nullable) is None
# and __fields_set__ contains the field
if self.data is None and "data" in self.__fields_set__:
_dict['data'] = None
# set to None if report_currency (nullable) is None
# and __fields_set__ contains the field
if self.report_currency is None and "report_currency" in self.__fields_set__:
_dict['reportCurrency'] = 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) -> BucketedCashFlowResponse:
"""Create an instance of BucketedCashFlowResponse from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return BucketedCashFlowResponse.parse_obj(obj)
_obj = BucketedCashFlowResponse.parse_obj({
"href": obj.get("href"),
"data": obj.get("data"),
"report_currency": obj.get("reportCurrency"),
"data_schema": ResultDataSchema.from_dict(obj.get("dataSchema")) if obj.get("dataSchema") 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