# 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.model_property import ModelProperty
[docs]
class CreateClosedPeriodRequest(BaseModel):
"""
CreateClosedPeriodRequest
"""
closed_period_id: StrictStr = Field(...,alias="closedPeriodId", description="The unique Id of the Closed Period. The ClosedPeriodId, together with the Timeline Scope and Code, uniquely identifies a Closed Period")
effective_end: Optional[datetime] = Field(default=None, description="The effective end of the Closed Period", alias="effectiveEnd")
properties: Optional[Dict[str, ModelProperty]] = Field(default=None, description="The Closed Periods properties. These will be from the 'ClosedPeriod' domain.")
as_at_closed: Optional[datetime] = Field(default=None, description="The asAt closed datetime for the Closed Period", alias="asAtClosed")
display_name: Optional[StrictStr] = Field(None,alias="displayName", description="The name of the Closed Period.")
description: Optional[StrictStr] = Field(None,alias="description", description="A description for the Closed Period.")
holdings_as_at_closed_override: Optional[datetime] = Field(default=None, description="The optional AsAtClosed Override to use for building holdings in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.", alias="holdingsAsAtClosedOverride")
valuation_as_at_closed_override: Optional[datetime] = Field(default=None, description="The optional AsAtClosed Override to use for performing valuations in the Closed Period.If not specified, the AsAtClosed on the Closed Period will be used.", alias="valuationAsAtClosedOverride")
__properties = ["closedPeriodId", "effectiveEnd", "properties", "asAtClosed", "displayName", "description", "holdingsAsAtClosedOverride", "valuationAsAtClosedOverride"]
[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) -> CreateClosedPeriodRequest:
"""Create an instance of CreateClosedPeriodRequest 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 value in properties (dict)
_field_dict = {}
if self.properties:
for _key in self.properties:
if self.properties[_key]:
_field_dict[_key] = self.properties[_key].to_dict()
_dict['properties'] = _field_dict
# set to None if properties (nullable) is None
# and __fields_set__ contains the field
if self.properties is None and "properties" in self.__fields_set__:
_dict['properties'] = None
# set to None if as_at_closed (nullable) is None
# and __fields_set__ contains the field
if self.as_at_closed is None and "as_at_closed" in self.__fields_set__:
_dict['asAtClosed'] = 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
# set to None if holdings_as_at_closed_override (nullable) is None
# and __fields_set__ contains the field
if self.holdings_as_at_closed_override is None and "holdings_as_at_closed_override" in self.__fields_set__:
_dict['holdingsAsAtClosedOverride'] = None
# set to None if valuation_as_at_closed_override (nullable) is None
# and __fields_set__ contains the field
if self.valuation_as_at_closed_override is None and "valuation_as_at_closed_override" in self.__fields_set__:
_dict['valuationAsAtClosedOverride'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> CreateClosedPeriodRequest:
"""Create an instance of CreateClosedPeriodRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return CreateClosedPeriodRequest.parse_obj(obj)
_obj = CreateClosedPeriodRequest.parse_obj({
"closed_period_id": obj.get("closedPeriodId"),
"effective_end": obj.get("effectiveEnd"),
"properties": dict(
(_k, ModelProperty.from_dict(_v))
for _k, _v in obj.get("properties").items()
)
if obj.get("properties") is not None
else None,
"as_at_closed": obj.get("asAtClosed"),
"display_name": obj.get("displayName"),
"description": obj.get("description"),
"holdings_as_at_closed_override": obj.get("holdingsAsAtClosedOverride"),
"valuation_as_at_closed_override": obj.get("valuationAsAtClosedOverride")
})
return _obj
CreateClosedPeriodRequest.update_forward_refs()