# 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 AddressKeyAlias(BaseModel):
"""
An address key alias that maps a short alias key to a real key with options. # noqa: E501
"""
scope: StrictStr = Field(...,alias="scope", description="The scope of the alias")
code: StrictStr = Field(...,alias="code", description="The code of the alias")
alias_key: StrictStr = Field(...,alias="aliasKey", description="The alias address key, must start with \"Alias/\" prefix (e.g., \"Alias/DailyNZPnL\")")
real_key: StrictStr = Field(...,alias="realKey", description="The real address key this alias resolves to (e.g., \"ProfitAndLoss/Total\"). Must NOT start with \"Alias/\".")
options: Optional[Dict[str, Optional[StrictStr]]] = Field(default=None, description="Options to apply when resolving the alias (e.g., {\"Window\":\"Daily\",\"TimeZone\":\"NZ\"})")
display_name: Optional[StrictStr] = Field(None,alias="displayName", description="Human-readable display name")
description: Optional[StrictStr] = Field(None,alias="description", description="Description of the alias")
__properties = ["scope", "code", "aliasKey", "realKey", "options", "displayName", "description"]
[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) -> AddressKeyAlias:
"""Create an instance of AddressKeyAlias 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 options (nullable) is None
# and __fields_set__ contains the field
if self.options is None and "options" in self.__fields_set__:
_dict['options'] = None
# set to None if display_name (nullable) is None
# and __fields_set__ contains the field
if self.display_name is None and "display_name" in self.__fields_set__:
_dict['displayName'] = 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
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> AddressKeyAlias:
"""Create an instance of AddressKeyAlias from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return AddressKeyAlias.parse_obj(obj)
_obj = AddressKeyAlias.parse_obj({
"scope": obj.get("scope"),
"code": obj.get("code"),
"alias_key": obj.get("aliasKey"),
"real_key": obj.get("realKey"),
"options": obj.get("options"),
"display_name": obj.get("displayName"),
"description": obj.get("description")
})
return _obj
AddressKeyAlias.update_forward_refs()