# 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 Any, Dict, Optional
from pydantic.v1 import BaseModel, Field, StrictBool, StrictStr, constr, validator
from lusid.models.resource_id import ResourceId
[docs]
class CreatePropertyDefinitionRequest(BaseModel):
"""
CreatePropertyDefinitionRequest
"""
domain: StrictStr = Field(..., description="The domain that the property exists in. The available values are: NotDefined, Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, CutLabelDefinition, Analytic, PortfolioGroup, Person, AccessMetadata, Order, UnitResult, MarketData, ConfigurationRecipe, Allocation, Calendar, LegalEntity, Placement, Execution, Block, Participation, Package, OrderInstruction, NextBestAction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, Abor, AborConfiguration, Fund, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation")
scope: StrictStr = Field(..., description="The scope that the property exists in.")
code: StrictStr = Field(..., description="The code of the property. Together with the domain and scope this uniquely identifies the property.")
value_required: Optional[StrictBool] = Field(None, alias="valueRequired", description="This field is not implemented and should be disregarded.")
display_name: constr(strict=True, min_length=1) = Field(..., alias="displayName", description="The display name of the property.")
data_type_id: ResourceId = Field(..., alias="dataTypeId")
life_time: Optional[StrictStr] = Field(None, alias="lifeTime", description="Describes how the property's values can change over time. The available values are: Perpetual, TimeVariant")
constraint_style: Optional[StrictStr] = Field(None, alias="constraintStyle", description="Describes the uniqueness and cardinality of the property for entity objects under the property domain specified in Key. Defaults to \"Property\" if not specified. Valid values for this field are: Property, Collection or Identifier.")
property_description: Optional[constr(strict=True, max_length=512)] = Field(None, alias="propertyDescription", description="Describes the property")
collection_type: Optional[StrictStr] = Field(None, alias="collectionType", description="Describes whether a collection property should behave as a set or as an array.")
__properties = ["domain", "scope", "code", "valueRequired", "displayName", "dataTypeId", "lifeTime", "constraintStyle", "propertyDescription", "collectionType"]
[docs]
@validator('domain')
def domain_validate_enum(cls, value):
"""Validates the enum"""
if value not in ('NotDefined', 'Transaction', 'Portfolio', 'Holding', 'ReferenceHolding', 'TransactionConfiguration', 'Instrument', 'CutLabelDefinition', 'Analytic', 'PortfolioGroup', 'Person', 'AccessMetadata', 'Order', 'UnitResult', 'MarketData', 'ConfigurationRecipe', 'Allocation', 'Calendar', 'LegalEntity', 'Placement', 'Execution', 'Block', 'Participation', 'Package', 'OrderInstruction', 'NextBestAction', 'CustomEntity', 'InstrumentEvent', 'Account', 'ChartOfAccounts', 'CustodianAccount', 'Abor', 'AborConfiguration', 'Fund', 'Fee', 'Reconciliation', 'PropertyDefinition', 'Compliance', 'DiaryEntry', 'Leg', 'DerivedValuation'):
raise ValueError("must be one of enum values ('NotDefined', 'Transaction', 'Portfolio', 'Holding', 'ReferenceHolding', 'TransactionConfiguration', 'Instrument', 'CutLabelDefinition', 'Analytic', 'PortfolioGroup', 'Person', 'AccessMetadata', 'Order', 'UnitResult', 'MarketData', 'ConfigurationRecipe', 'Allocation', 'Calendar', 'LegalEntity', 'Placement', 'Execution', 'Block', 'Participation', 'Package', 'OrderInstruction', 'NextBestAction', 'CustomEntity', 'InstrumentEvent', 'Account', 'ChartOfAccounts', 'CustodianAccount', 'Abor', 'AborConfiguration', 'Fund', 'Fee', 'Reconciliation', 'PropertyDefinition', 'Compliance', 'DiaryEntry', 'Leg', 'DerivedValuation')")
return value
[docs]
@validator('life_time')
def life_time_validate_enum(cls, value):
"""Validates the enum"""
if value is None:
return value
if value not in ('Perpetual', 'TimeVariant'):
raise ValueError("must be one of enum values ('Perpetual', 'TimeVariant')")
return value
[docs]
class Config:
"""Pydantic configuration"""
allow_population_by_field_name = True
validate_assignment = True
[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) -> CreatePropertyDefinitionRequest:
"""Create an instance of CreatePropertyDefinitionRequest 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 data_type_id
if self.data_type_id:
_dict['dataTypeId'] = self.data_type_id.to_dict()
# set to None if constraint_style (nullable) is None
# and __fields_set__ contains the field
if self.constraint_style is None and "constraint_style" in self.__fields_set__:
_dict['constraintStyle'] = None
# set to None if property_description (nullable) is None
# and __fields_set__ contains the field
if self.property_description is None and "property_description" in self.__fields_set__:
_dict['propertyDescription'] = None
# set to None if collection_type (nullable) is None
# and __fields_set__ contains the field
if self.collection_type is None and "collection_type" in self.__fields_set__:
_dict['collectionType'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> CreatePropertyDefinitionRequest:
"""Create an instance of CreatePropertyDefinitionRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return CreatePropertyDefinitionRequest.parse_obj(obj)
_obj = CreatePropertyDefinitionRequest.parse_obj({
"domain": obj.get("domain"),
"scope": obj.get("scope"),
"code": obj.get("code"),
"value_required": obj.get("valueRequired"),
"display_name": obj.get("displayName"),
"data_type_id": ResourceId.from_dict(obj.get("dataTypeId")) if obj.get("dataTypeId") is not None else None,
"life_time": obj.get("lifeTime"),
"constraint_style": obj.get("constraintStyle"),
"property_description": obj.get("propertyDescription"),
"collection_type": obj.get("collectionType")
})
return _obj