# 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 datetime import datetime
from typing import Any, Dict, List, Optional
from pydantic.v1 import BaseModel, Field, StrictBool, StrictStr, conlist, constr, validator
from lusid.models.link import Link
from lusid.models.model_property import ModelProperty
from lusid.models.resource_id import ResourceId
[docs]
class PortfolioSearchResult(BaseModel):
"""
A list of portfolios. # noqa: E501
"""
id: ResourceId = Field(...)
type: StrictStr = Field(..., description="The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction")
href: Optional[StrictStr] = Field(None, description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
description: Optional[StrictStr] = Field(None, description="The long form description of the portfolio.")
display_name: constr(strict=True, min_length=1) = Field(..., alias="displayName", description="The name of the portfolio.")
is_derived: Optional[StrictBool] = Field(None, alias="isDerived", description="Whether or not this is a derived portfolio.")
created: datetime = Field(..., description="The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date.")
parent_portfolio_id: Optional[ResourceId] = Field(None, alias="parentPortfolioId")
base_currency: Optional[StrictStr] = Field(None, alias="baseCurrency", description="The base currency of the portfolio.")
properties: Optional[conlist(ModelProperty)] = Field(None, description="The requested portfolio properties. These will be from the 'Portfolio' domain.")
links: Optional[conlist(Link)] = None
__properties = ["id", "type", "href", "description", "displayName", "isDerived", "created", "parentPortfolioId", "baseCurrency", "properties", "links"]
[docs]
@validator('type')
def type_validate_enum(cls, value):
"""Validates the enum"""
if value not in ('Transaction', 'Reference', 'DerivedTransaction'):
raise ValueError("must be one of enum values ('Transaction', 'Reference', 'DerivedTransaction')")
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) -> PortfolioSearchResult:
"""Create an instance of PortfolioSearchResult 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={
"is_derived",
},
exclude_none=True)
# override the default output from pydantic by calling `to_dict()` of id
if self.id:
_dict['id'] = self.id.to_dict()
# override the default output from pydantic by calling `to_dict()` of parent_portfolio_id
if self.parent_portfolio_id:
_dict['parentPortfolioId'] = self.parent_portfolio_id.to_dict()
# override the default output from pydantic by calling `to_dict()` of each item in properties (list)
_items = []
if self.properties:
for _item in self.properties:
if _item:
_items.append(_item.to_dict())
_dict['properties'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in links (list)
_items = []
if self.links:
for _item in self.links:
if _item:
_items.append(_item.to_dict())
_dict['links'] = _items
# set to None if href (nullable) is None
# and __fields_set__ contains the field
if self.href is None and "href" in self.__fields_set__:
_dict['href'] = 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 base_currency (nullable) is None
# and __fields_set__ contains the field
if self.base_currency is None and "base_currency" in self.__fields_set__:
_dict['baseCurrency'] = None
# 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 links (nullable) is None
# and __fields_set__ contains the field
if self.links is None and "links" in self.__fields_set__:
_dict['links'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> PortfolioSearchResult:
"""Create an instance of PortfolioSearchResult from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return PortfolioSearchResult.parse_obj(obj)
_obj = PortfolioSearchResult.parse_obj({
"id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
"type": obj.get("type"),
"href": obj.get("href"),
"description": obj.get("description"),
"display_name": obj.get("displayName"),
"is_derived": obj.get("isDerived"),
"created": obj.get("created"),
"parent_portfolio_id": ResourceId.from_dict(obj.get("parentPortfolioId")) if obj.get("parentPortfolioId") is not None else None,
"base_currency": obj.get("baseCurrency"),
"properties": [ModelProperty.from_dict(_item) for _item in obj.get("properties")] if obj.get("properties") is not None else None,
"links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
})
return _obj