# 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.resource_id import ResourceId
[docs]
class SubscriptionDefinition(BaseModel):
"""
SubscriptionDefinition
"""
scope: StrictStr = Field(...,alias="scope")
code: StrictStr = Field(...,alias="code")
display_name: Optional[StrictStr] = Field(None,alias="displayName")
description: Optional[StrictStr] = Field(None,alias="description")
portfolio_id: ResourceId = Field(alias="portfolioId")
timeline_id: Optional[ResourceId] = Field(default=None, alias="timelineId")
address_keys: Optional[List[StrictStr]] = Field(default=None, description="The set of addresses the subscriber wishes to receive.", alias="addressKeys")
by_tax_lots: Optional[StrictBool] = Field(default=None, alias="byTaxLots")
start_effective_at: Optional[datetime] = Field(default=None, alias="startEffectiveAt")
end_effective_at: Optional[datetime] = Field(default=None, alias="endEffectiveAt")
start_as_at: Optional[datetime] = Field(default=None, alias="startAsAt")
__properties = ["scope", "code", "displayName", "description", "portfolioId", "timelineId", "addressKeys", "byTaxLots", "startEffectiveAt", "endEffectiveAt", "startAsAt"]
[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) -> SubscriptionDefinition:
"""Create an instance of SubscriptionDefinition 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 portfolio_id
if self.portfolio_id:
_dict['portfolioId'] = self.portfolio_id.to_dict()
# override the default output from pydantic by calling `to_dict()` of timeline_id
if self.timeline_id:
_dict['timelineId'] = self.timeline_id.to_dict()
# 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 address_keys (nullable) is None
# and __fields_set__ contains the field
if self.address_keys is None and "address_keys" in self.__fields_set__:
_dict['addressKeys'] = None
# set to None if start_effective_at (nullable) is None
# and __fields_set__ contains the field
if self.start_effective_at is None and "start_effective_at" in self.__fields_set__:
_dict['startEffectiveAt'] = None
# set to None if end_effective_at (nullable) is None
# and __fields_set__ contains the field
if self.end_effective_at is None and "end_effective_at" in self.__fields_set__:
_dict['endEffectiveAt'] = None
# set to None if start_as_at (nullable) is None
# and __fields_set__ contains the field
if self.start_as_at is None and "start_as_at" in self.__fields_set__:
_dict['startAsAt'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> SubscriptionDefinition:
"""Create an instance of SubscriptionDefinition from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return SubscriptionDefinition.parse_obj(obj)
_obj = SubscriptionDefinition.parse_obj({
"scope": obj.get("scope"),
"code": obj.get("code"),
"display_name": obj.get("displayName"),
"description": obj.get("description"),
"portfolio_id": ResourceId.from_dict(obj.get("portfolioId")) if obj.get("portfolioId") is not None else None,
"timeline_id": ResourceId.from_dict(obj.get("timelineId")) if obj.get("timelineId") is not None else None,
"address_keys": obj.get("addressKeys"),
"by_tax_lots": obj.get("byTaxLots"),
"start_effective_at": obj.get("startEffectiveAt"),
"end_effective_at": obj.get("endEffectiveAt"),
"start_as_at": obj.get("startAsAt")
})
return _obj
SubscriptionDefinition.update_forward_refs()