# 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.model_property import ModelProperty
[docs]
class ValuationPointOverview(BaseModel):
"""
ValuationPointOverview
"""
href: Optional[StrictStr] = Field(None,alias="href", description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
diary_entry_code: StrictStr = Field(...,alias="diaryEntryCode", description="The code for the Valuation Point.")
diary_entry_variant: Optional[StrictStr] = Field(None,alias="diaryEntryVariant", description="The Variant for the Valuation Point. Together with the valuation point code marks the unique branch for the NavType.")
effective_from: datetime = Field(description="The effective time of the last Valuation Point.", alias="effectiveFrom")
effective_to: datetime = Field(description="The effective time of the current Valuation Point.", alias="effectiveTo")
query_as_at: Optional[datetime] = Field(default=None, description="The query time of the Valuation Point. Defaults to latest.", alias="queryAsAt")
type: StrictStr = Field(...,alias="type", description="The type of the diary entry. This is 'ValuationPoint'. Available values: PeriodBoundary, ValuationPoint, Other.")
status: StrictStr = Field(...,alias="status", description="The status of the Valuation Point. Available values: Undefined, Estimate, Final, Candidate, Unofficial, Rejected.")
gav: Union[StrictFloat, StrictInt] = Field(description="The Gross Asset Value of the Fund or Share Class at the Valuation Point. This is effectively a summation of all Trial balance entries linked to accounts of types 'Asset' and 'Liabilities'.")
nav: Union[StrictFloat, StrictInt] = Field(description="The Net Asset Value of the Fund or Share Class at the Valuation Point. This represents the GAV with any fees applied in the period.")
holdings_as_at_override: Optional[datetime] = Field(default=None, description="The optional AsAt Override to use for building holdings in the Valuation Point. Defaults to QueryAsAt.", alias="holdingsAsAtOverride")
valuations_as_at_override: Optional[datetime] = Field(default=None, description="The optional AsAt Override to use for performing valuations in the Valuation Point. Defaults to QueryAsAt.", alias="valuationsAsAtOverride")
properties: Optional[Dict[str, ModelProperty]] = Field(default=None, description="The Fee properties. These will be from the 'Fee' domain.")
links: Optional[List[Link]] = None
__properties = ["href", "diaryEntryCode", "diaryEntryVariant", "effectiveFrom", "effectiveTo", "queryAsAt", "type", "status", "gav", "nav", "holdingsAsAtOverride", "valuationsAsAtOverride", "properties", "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) -> ValuationPointOverview:
"""Create an instance of ValuationPointOverview 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 properties (dict)
_field_dict = {}
if self.properties:
for _key in self.properties:
if self.properties[_key]:
_field_dict[_key] = self.properties[_key].to_dict()
_dict['properties'] = _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 diary_entry_variant (nullable) is None
# and __fields_set__ contains the field
if self.diary_entry_variant is None and "diary_entry_variant" in self.__fields_set__:
_dict['diaryEntryVariant'] = None
# set to None if holdings_as_at_override (nullable) is None
# and __fields_set__ contains the field
if self.holdings_as_at_override is None and "holdings_as_at_override" in self.__fields_set__:
_dict['holdingsAsAtOverride'] = None
# set to None if valuations_as_at_override (nullable) is None
# and __fields_set__ contains the field
if self.valuations_as_at_override is None and "valuations_as_at_override" in self.__fields_set__:
_dict['valuationsAsAtOverride'] = None
# set to None if properties (nullable) is None
# and __fields_set__ contains the field
if self.properties is None and "properties" in self.__fields_set__:
_dict['properties'] = 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) -> ValuationPointOverview:
"""Create an instance of ValuationPointOverview from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return ValuationPointOverview.parse_obj(obj)
_obj = ValuationPointOverview.parse_obj({
"href": obj.get("href"),
"diary_entry_code": obj.get("diaryEntryCode"),
"diary_entry_variant": obj.get("diaryEntryVariant"),
"effective_from": obj.get("effectiveFrom"),
"effective_to": obj.get("effectiveTo"),
"query_as_at": obj.get("queryAsAt"),
"type": obj.get("type"),
"status": obj.get("status"),
"gav": obj.get("gav"),
"nav": obj.get("nav"),
"holdings_as_at_override": obj.get("holdingsAsAtOverride"),
"valuations_as_at_override": obj.get("valuationsAsAtOverride"),
"properties": dict(
(_k, ModelProperty.from_dict(_v))
for _k, _v in obj.get("properties").items()
)
if obj.get("properties") 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
ValuationPointOverview.update_forward_refs()