# 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.election_specification import ElectionSpecification
from lusid.models.eligibility_calculation import EligibilityCalculation
from lusid.models.template_field import TemplateField
[docs]
class TransactionTemplateSpecification(BaseModel):
"""
TransactionTemplateSpecification
"""
instrument_event_type: StrictStr = Field(...,alias="instrumentEventType", description="Available values: Internal, TransitionEvent, CouponEvent, OpenEvent, CloseEvent, BondDefaultEvent, CashDividendEvent, StockSplitEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, Unknown, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent.")
supported_instrument_types: List[StrictStr] = Field(alias="supportedInstrumentTypes")
supported_participation_types: List[StrictStr] = Field(alias="supportedParticipationTypes")
supported_election_types: List[ElectionSpecification] = Field(alias="supportedElectionTypes")
supported_template_fields: List[TemplateField] = Field(alias="supportedTemplateFields")
eligibility_calculation: EligibilityCalculation = Field(alias="eligibilityCalculation")
__properties = ["instrumentEventType", "supportedInstrumentTypes", "supportedParticipationTypes", "supportedElectionTypes", "supportedTemplateFields", "eligibilityCalculation"]
[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) -> TransactionTemplateSpecification:
"""Create an instance of TransactionTemplateSpecification 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 item in supported_election_types (list)
_items = []
if self.supported_election_types:
for _item in self.supported_election_types:
if _item:
_items.append(_item.to_dict())
_dict['supportedElectionTypes'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in supported_template_fields (list)
_items = []
if self.supported_template_fields:
for _item in self.supported_template_fields:
if _item:
_items.append(_item.to_dict())
_dict['supportedTemplateFields'] = _items
# override the default output from pydantic by calling `to_dict()` of eligibility_calculation
if self.eligibility_calculation:
_dict['eligibilityCalculation'] = self.eligibility_calculation.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> TransactionTemplateSpecification:
"""Create an instance of TransactionTemplateSpecification from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return TransactionTemplateSpecification.parse_obj(obj)
_obj = TransactionTemplateSpecification.parse_obj({
"instrument_event_type": obj.get("instrumentEventType"),
"supported_instrument_types": obj.get("supportedInstrumentTypes"),
"supported_participation_types": obj.get("supportedParticipationTypes"),
"supported_election_types": [ElectionSpecification.from_dict(_item) for _item in obj.get("supportedElectionTypes")] if obj.get("supportedElectionTypes") is not None else None,
"supported_template_fields": [TemplateField.from_dict(_item) for _item in obj.get("supportedTemplateFields")] if obj.get("supportedTemplateFields") is not None else None,
"eligibility_calculation": EligibilityCalculation.from_dict(obj.get("eligibilityCalculation")) if obj.get("eligibilityCalculation") is not None else None
})
return _obj
TransactionTemplateSpecification.update_forward_refs()