# 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.apportionment_member_factor import ApportionmentMemberFactor
[docs]
class ApportionmentBreakdown(BaseModel):
"""
The apportionment result for one level - the fund (apportioning the non-class-specific P&L across all share classes) or a single allocation group (apportioning its tagged P&L across its members) - with the per-member base values and factors the method produced. # noqa: E501
"""
apportionment_level: StrictStr = Field(...,alias="apportionmentLevel", description="Whether this result is the fund-level apportionment (across all share classes) or an allocation group's (across its share classes). Available values: Fund, AllocationGroup.")
allocation_group_code: Optional[StrictStr] = Field(None,alias="allocationGroupCode", description="The ShareClassShortCode identifying the allocation group this result is for, or null for the fund-level result.")
apportionment_method_property_key: StrictStr = Field(...,alias="apportionmentMethodPropertyKey", description="The apportionment method property key that produced the factors.")
factors: List[ApportionmentMemberFactor] = Field(description="The per-member base values and apportionment factors produced by the method.")
__properties = ["apportionmentLevel", "allocationGroupCode", "apportionmentMethodPropertyKey", "factors"]
[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) -> ApportionmentBreakdown:
"""Create an instance of ApportionmentBreakdown 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 factors (list)
_items = []
if self.factors:
for _item in self.factors:
if _item:
_items.append(_item.to_dict())
_dict['factors'] = _items
# set to None if allocation_group_code (nullable) is None
# and __fields_set__ contains the field
if self.allocation_group_code is None and "allocation_group_code" in self.__fields_set__:
_dict['allocationGroupCode'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> ApportionmentBreakdown:
"""Create an instance of ApportionmentBreakdown from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return ApportionmentBreakdown.parse_obj(obj)
_obj = ApportionmentBreakdown.parse_obj({
"apportionment_level": obj.get("apportionmentLevel"),
"allocation_group_code": obj.get("allocationGroupCode"),
"apportionment_method_property_key": obj.get("apportionmentMethodPropertyKey"),
"factors": [ApportionmentMemberFactor.from_dict(_item) for _item in obj.get("factors")] if obj.get("factors") is not None else None
})
return _obj
ApportionmentBreakdown.update_forward_refs()