# 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.instrument_event_configuration import InstrumentEventConfiguration
from lusid.models.link import Link
from lusid.models.portfolio_settlement_configuration import PortfolioSettlementConfiguration
from lusid.models.resource_id import ResourceId
from lusid.models.staged_modifications_info import StagedModificationsInfo
from lusid.models.version import Version
[docs]
class PortfolioDetails(BaseModel):
"""
PortfolioDetails
"""
href: Optional[StrictStr] = Field(None,alias="href", description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
origin_portfolio_id: ResourceId = Field(alias="originPortfolioId")
version: Version
base_currency: StrictStr = Field(...,alias="baseCurrency", description="The base currency of the transaction portfolio.")
corporate_action_source_id: Optional[ResourceId] = Field(default=None, alias="corporateActionSourceId")
sub_holding_keys: Optional[List[StrictStr]] = Field(default=None, alias="subHoldingKeys")
instrument_scopes: Optional[List[StrictStr]] = Field(default=None, description="The resolution strategy used to resolve instruments of transactions/holdings upserted to the transaction portfolio.", alias="instrumentScopes")
accounting_method: Optional[StrictStr] = Field(None,alias="accountingMethod", description="The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.")
amortisation_method: Optional[StrictStr] = Field(None,alias="amortisationMethod", description="The amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate.")
transaction_type_scope: Optional[StrictStr] = Field(None,alias="transactionTypeScope", description="The scope of the transaction types.")
cash_gain_loss_calculation_date: Optional[StrictStr] = Field(None,alias="cashGainLossCalculationDate", description="The option when the Cash Gain Loss to be calulated. Default value: SettlementDate.")
instrument_event_configuration: Optional[InstrumentEventConfiguration] = Field(default=None, alias="instrumentEventConfiguration")
amortisation_rule_set_id: Optional[ResourceId] = Field(default=None, alias="amortisationRuleSetId")
tax_rule_set_scope: Optional[StrictStr] = Field(None,alias="taxRuleSetScope", description="The scope of the tax rule sets for this portfolio.")
settlement_configuration: Optional[PortfolioSettlementConfiguration] = Field(default=None, alias="settlementConfiguration")
staged_modifications: Optional[StagedModificationsInfo] = Field(default=None, alias="stagedModifications")
links: Optional[List[Link]] = None
__properties = ["href", "originPortfolioId", "version", "baseCurrency", "corporateActionSourceId", "subHoldingKeys", "instrumentScopes", "accountingMethod", "amortisationMethod", "transactionTypeScope", "cashGainLossCalculationDate", "instrumentEventConfiguration", "amortisationRuleSetId", "taxRuleSetScope", "settlementConfiguration", "stagedModifications", "links"]
[docs]
@validator('accounting_method')
def accounting_method_validate_enum(cls, value):
"""Validates the enum"""
# Finbourne have removed enum validation on all models, except for this use case:
# Workflow and notification application SDK use the property name 'type' as the discriminator on a number of classes.
# During instantiation, the value of 'type' is checked against the enum values,
# check it's a class that uses the 'type' property as a discriminator
# list of classes can be found by searching for 'actual_instance: Union[' in the generated code
if 'PortfolioDetails' not in [
# For notification application classes
'AmazonSqsNotificationType',
'AmazonSqsNotificationTypeResponse',
'AmazonSqsPrincipalAuthNotificationType',
'AmazonSqsPrincipalAuthNotificationTypeResponse',
'AzureServiceBusTypeResponse',
'AzureServiceBusNotificationType',
'EmailNotificationType',
'EmailNotificationTypeResponse',
'SmsNotificationType',
'SmsNotificationTypeResponse',
'WebhookNotificationType',
'WebhookNotificationTypeResponse',
# For workflow application classes
'CreateChildTasksAction',
'RunWorkerAction',
'TriggerParentTaskAction',
'CreateChildTasksActionResponse',
'RunWorkerActionResponse',
'TriggerChildTasksAction',
'TriggerChildTasksActionResponse',
'TriggerParentTaskActionResponse',
'CreateNewTaskActivity',
'UpdateMatchingTasksActivity',
'CreateNewTaskActivityResponse',
'UpdateMatchingTasksActivityResponse',
'Fail',
'GroupReconciliation',
'HealthCheck',
'LuminesceView',
'SchedulerJob',
'Sleep',
'FailResponse',
'GroupReconciliationResponse',
'HealthCheckResponse',
'LuminesceViewResponse',
'SchedulerJobResponse',
'SleepResponse',
'Library',
'LibraryResponse',
'DayRegularity',
'RelativeMonthRegularity',
'SpecificMonthRegularity',
'WeekRegularity',
'YearRegularity',
'LusidEntityDataQualityCheck',
'LusidEntityDataQualityCheckResponse',
'TriggerChildTasksActionResponse']:
return value
# Only validate the 'type' property of the class
if "accounting_method" != "type":
return value
if value is None:
return value
if value not in ['Default', 'AverageCost', 'FirstInFirstOut', 'LastInFirstOut', 'HighestCostFirst', 'LowestCostFirst', 'ProRateByUnits', 'ProRateByCost', 'ProRateByCostPortfolioCurrency', 'IntraDayThenFirstInFirstOut', 'LongTermHighestCostFirst', 'LongTermHighestCostFirstPortfolioCurrency', 'HighestCostFirstPortfolioCurrency', 'LowestCostFirstPortfolioCurrency', 'MaximumLossMinimumGain', 'MaximumLossMinimumGainPortfolioCurrency']:
raise ValueError("must be one of enum values ('Default', 'AverageCost', 'FirstInFirstOut', 'LastInFirstOut', 'HighestCostFirst', 'LowestCostFirst', 'ProRateByUnits', 'ProRateByCost', 'ProRateByCostPortfolioCurrency', 'IntraDayThenFirstInFirstOut', 'LongTermHighestCostFirst', 'LongTermHighestCostFirstPortfolioCurrency', 'HighestCostFirstPortfolioCurrency', 'LowestCostFirstPortfolioCurrency', 'MaximumLossMinimumGain', 'MaximumLossMinimumGainPortfolioCurrency')")
return value
[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) -> PortfolioDetails:
"""Create an instance of PortfolioDetails 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 origin_portfolio_id
if self.origin_portfolio_id:
_dict['originPortfolioId'] = self.origin_portfolio_id.to_dict()
# override the default output from pydantic by calling `to_dict()` of version
if self.version:
_dict['version'] = self.version.to_dict()
# override the default output from pydantic by calling `to_dict()` of corporate_action_source_id
if self.corporate_action_source_id:
_dict['corporateActionSourceId'] = self.corporate_action_source_id.to_dict()
# override the default output from pydantic by calling `to_dict()` of instrument_event_configuration
if self.instrument_event_configuration:
_dict['instrumentEventConfiguration'] = self.instrument_event_configuration.to_dict()
# override the default output from pydantic by calling `to_dict()` of amortisation_rule_set_id
if self.amortisation_rule_set_id:
_dict['amortisationRuleSetId'] = self.amortisation_rule_set_id.to_dict()
# override the default output from pydantic by calling `to_dict()` of settlement_configuration
if self.settlement_configuration:
_dict['settlementConfiguration'] = self.settlement_configuration.to_dict()
# override the default output from pydantic by calling `to_dict()` of staged_modifications
if self.staged_modifications:
_dict['stagedModifications'] = self.staged_modifications.to_dict()
# 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 sub_holding_keys (nullable) is None
# and __fields_set__ contains the field
if self.sub_holding_keys is None and "sub_holding_keys" in self.__fields_set__:
_dict['subHoldingKeys'] = None
# set to None if instrument_scopes (nullable) is None
# and __fields_set__ contains the field
if self.instrument_scopes is None and "instrument_scopes" in self.__fields_set__:
_dict['instrumentScopes'] = None
# set to None if amortisation_method (nullable) is None
# and __fields_set__ contains the field
if self.amortisation_method is None and "amortisation_method" in self.__fields_set__:
_dict['amortisationMethod'] = None
# set to None if transaction_type_scope (nullable) is None
# and __fields_set__ contains the field
if self.transaction_type_scope is None and "transaction_type_scope" in self.__fields_set__:
_dict['transactionTypeScope'] = None
# set to None if cash_gain_loss_calculation_date (nullable) is None
# and __fields_set__ contains the field
if self.cash_gain_loss_calculation_date is None and "cash_gain_loss_calculation_date" in self.__fields_set__:
_dict['cashGainLossCalculationDate'] = None
# set to None if tax_rule_set_scope (nullable) is None
# and __fields_set__ contains the field
if self.tax_rule_set_scope is None and "tax_rule_set_scope" in self.__fields_set__:
_dict['taxRuleSetScope'] = 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) -> PortfolioDetails:
"""Create an instance of PortfolioDetails from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return PortfolioDetails.parse_obj(obj)
_obj = PortfolioDetails.parse_obj({
"href": obj.get("href"),
"origin_portfolio_id": ResourceId.from_dict(obj.get("originPortfolioId")) if obj.get("originPortfolioId") is not None else None,
"version": Version.from_dict(obj.get("version")) if obj.get("version") is not None else None,
"base_currency": obj.get("baseCurrency"),
"corporate_action_source_id": ResourceId.from_dict(obj.get("corporateActionSourceId")) if obj.get("corporateActionSourceId") is not None else None,
"sub_holding_keys": obj.get("subHoldingKeys"),
"instrument_scopes": obj.get("instrumentScopes"),
"accounting_method": obj.get("accountingMethod"),
"amortisation_method": obj.get("amortisationMethod"),
"transaction_type_scope": obj.get("transactionTypeScope"),
"cash_gain_loss_calculation_date": obj.get("cashGainLossCalculationDate"),
"instrument_event_configuration": InstrumentEventConfiguration.from_dict(obj.get("instrumentEventConfiguration")) if obj.get("instrumentEventConfiguration") is not None else None,
"amortisation_rule_set_id": ResourceId.from_dict(obj.get("amortisationRuleSetId")) if obj.get("amortisationRuleSetId") is not None else None,
"tax_rule_set_scope": obj.get("taxRuleSetScope"),
"settlement_configuration": PortfolioSettlementConfiguration.from_dict(obj.get("settlementConfiguration")) if obj.get("settlementConfiguration") is not None else None,
"staged_modifications": StagedModificationsInfo.from_dict(obj.get("stagedModifications")) if obj.get("stagedModifications") 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
PortfolioDetails.update_forward_refs()