# 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.allocation_group import AllocationGroup
from lusid.models.fund import Fund
from lusid.models.fund_structure_edge import FundStructureEdge
from lusid.models.fund_structure_node import FundStructureNode
from lusid.models.link import Link
from lusid.models.model_property import ModelProperty
from lusid.models.resource_id import ResourceId
from lusid.models.version import Version
[docs]
class FundStructure(BaseModel):
"""
Definition of the structure of a fund # noqa: E501
"""
href: Optional[StrictStr] = Field(None,alias="href", description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
id: ResourceId
name: StrictStr = Field(...,alias="name", description="The display name of the Fund Structure.")
description: Optional[StrictStr] = Field(None,alias="description", description="An optional description for the Fund Structure.")
funds: Optional[List[Fund]] = Field(default=None, description="An optional list of existing funds to be incorporated as part of the structure.")
allocation_groups: Optional[List[AllocationGroup]] = Field(default=None, description="An optional list of Allocation Groups that can apply across a Fund Structure. Only classes and feeder funds linked to the master fund specified are allowed.", alias="allocationGroups")
nodes: List[FundStructureNode] = Field(description="The list of nodes that make up the Fund Structure, each referencing a Fund and defining its role.")
edges: List[FundStructureEdge] = Field(description="The list of edges that define the relationships between feeder and master nodes in the structure.")
version: Optional[Version] = None
properties: Optional[Dict[str, ModelProperty]] = Field(default=None, description="A set of properties to decorate onto the Fund Structure.")
links: Optional[List[Link]] = None
__properties = ["href", "id", "name", "description", "funds", "allocationGroups", "nodes", "edges", "version", "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) -> FundStructure:
"""Create an instance of FundStructure 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 id
if self.id:
_dict['id'] = self.id.to_dict()
# override the default output from pydantic by calling `to_dict()` of each item in funds (list)
_items = []
if self.funds:
for _item in self.funds:
if _item:
_items.append(_item.to_dict())
_dict['funds'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in allocation_groups (list)
_items = []
if self.allocation_groups:
for _item in self.allocation_groups:
if _item:
_items.append(_item.to_dict())
_dict['allocationGroups'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in nodes (list)
_items = []
if self.nodes:
for _item in self.nodes:
if _item:
_items.append(_item.to_dict())
_dict['nodes'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in edges (list)
_items = []
if self.edges:
for _item in self.edges:
if _item:
_items.append(_item.to_dict())
_dict['edges'] = _items
# override the default output from pydantic by calling `to_dict()` of version
if self.version:
_dict['version'] = self.version.to_dict()
# 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 description (nullable) is None
# and __fields_set__ contains the field
if self.description is None and "description" in self.__fields_set__:
_dict['description'] = None
# set to None if funds (nullable) is None
# and __fields_set__ contains the field
if self.funds is None and "funds" in self.__fields_set__:
_dict['funds'] = None
# set to None if allocation_groups (nullable) is None
# and __fields_set__ contains the field
if self.allocation_groups is None and "allocation_groups" in self.__fields_set__:
_dict['allocationGroups'] = 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) -> FundStructure:
"""Create an instance of FundStructure from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return FundStructure.parse_obj(obj)
_obj = FundStructure.parse_obj({
"href": obj.get("href"),
"id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
"name": obj.get("name"),
"description": obj.get("description"),
"funds": [Fund.from_dict(_item) for _item in obj.get("funds")] if obj.get("funds") is not None else None,
"allocation_groups": [AllocationGroup.from_dict(_item) for _item in obj.get("allocationGroups")] if obj.get("allocationGroups") is not None else None,
"nodes": [FundStructureNode.from_dict(_item) for _item in obj.get("nodes")] if obj.get("nodes") is not None else None,
"edges": [FundStructureEdge.from_dict(_item) for _item in obj.get("edges")] if obj.get("edges") is not None else None,
"version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
"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
FundStructure.update_forward_refs()