# 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_definition_request import FundDefinitionRequest
from lusid.models.fund_structure_edge import FundStructureEdge
from lusid.models.fund_structure_node import FundStructureNode
from lusid.models.resource_id import ResourceId
[docs]
class FundStructureRequest(BaseModel):
"""
The request used to create a Fund Structure. # noqa: E501
"""
code: StrictStr = Field(...,alias="code", description="The code of the Fund Structure.")
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.")
existing_funds: Optional[List[ResourceId]] = Field(default=None, description="An optional list of existing funds to be incorporated as part of the structure.", alias="existingFunds")
new_funds: Optional[List[FundDefinitionRequest]] = Field(default=None, description="An optional list of Fund definitions to be created inline as part of the structure.", alias="newFunds")
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.")
__properties = ["code", "name", "description", "existingFunds", "newFunds", "allocationGroups", "nodes", "edges"]
[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) -> FundStructureRequest:
"""Create an instance of FundStructureRequest 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 item in existing_funds (list)
_items = []
if self.existing_funds:
for _item in self.existing_funds:
if _item:
_items.append(_item.to_dict())
_dict['existingFunds'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in new_funds (list)
_items = []
if self.new_funds:
for _item in self.new_funds:
if _item:
_items.append(_item.to_dict())
_dict['newFunds'] = _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
# 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 existing_funds (nullable) is None
# and __fields_set__ contains the field
if self.existing_funds is None and "existing_funds" in self.__fields_set__:
_dict['existingFunds'] = None
# set to None if new_funds (nullable) is None
# and __fields_set__ contains the field
if self.new_funds is None and "new_funds" in self.__fields_set__:
_dict['newFunds'] = 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
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> FundStructureRequest:
"""Create an instance of FundStructureRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return FundStructureRequest.parse_obj(obj)
_obj = FundStructureRequest.parse_obj({
"code": obj.get("code"),
"name": obj.get("name"),
"description": obj.get("description"),
"existing_funds": [ResourceId.from_dict(_item) for _item in obj.get("existingFunds")] if obj.get("existingFunds") is not None else None,
"new_funds": [FundDefinitionRequest.from_dict(_item) for _item in obj.get("newFunds")] if obj.get("newFunds") 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
})
return _obj
FundStructureRequest.update_forward_refs()