# 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
[docs]
class ApportionmentMemberFactor(BaseModel):
"""
One member share class's outcome within an apportionment result: the base value the method produced for it and the resulting apportionment factor. # noqa: E501
"""
member_identifier: StrictStr = Field(...,alias="memberIdentifier", description="The member share class's short code.")
fund_scope: Optional[StrictStr] = Field(None,alias="fundScope", description="The scope of the fund the member share class belongs to.")
fund_code: Optional[StrictStr] = Field(None,alias="fundCode", description="The code of the fund the member share class belongs to.")
base_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The base value the method produced for the member, or null for the SetFactor method.", alias="baseValue")
apportionment_factor: Union[StrictFloat, StrictInt] = Field(description="The member's apportionment factor: its base value over the total across the group or fund.", alias="apportionmentFactor")
__properties = ["memberIdentifier", "fundScope", "fundCode", "baseValue", "apportionmentFactor"]
[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) -> ApportionmentMemberFactor:
"""Create an instance of ApportionmentMemberFactor 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)
# set to None if fund_scope (nullable) is None
# and __fields_set__ contains the field
if self.fund_scope is None and "fund_scope" in self.__fields_set__:
_dict['fundScope'] = None
# set to None if fund_code (nullable) is None
# and __fields_set__ contains the field
if self.fund_code is None and "fund_code" in self.__fields_set__:
_dict['fundCode'] = None
# set to None if base_value (nullable) is None
# and __fields_set__ contains the field
if self.base_value is None and "base_value" in self.__fields_set__:
_dict['baseValue'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> ApportionmentMemberFactor:
"""Create an instance of ApportionmentMemberFactor from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return ApportionmentMemberFactor.parse_obj(obj)
_obj = ApportionmentMemberFactor.parse_obj({
"member_identifier": obj.get("memberIdentifier"),
"fund_scope": obj.get("fundScope"),
"fund_code": obj.get("fundCode"),
"base_value": obj.get("baseValue"),
"apportionment_factor": obj.get("apportionmentFactor")
})
return _obj
ApportionmentMemberFactor.update_forward_refs()