# 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.cash_and_security_offer_election import CashAndSecurityOfferElection
from lusid.models.cash_offer_election import CashOfferElection
from lusid.models.instrument_event import InstrumentEvent
from lusid.models.new_instrument import NewInstrument
from lusid.models.security_offer_election import SecurityOfferElection
[docs]
class TenderEvent(InstrumentEvent):
"""
Tender Event (TEND). # noqa: E501
"""
announcement_date: Optional[datetime] = Field(default=None, description="The date the tender is announced.", alias="announcementDate")
ex_date: Optional[datetime] = Field(default=None, description="The ex date (entitlement date) of the event.", alias="exDate")
record_date: Optional[datetime] = Field(default=None, description="Date you have to be the holder of record in order to participate in the tender.", alias="recordDate")
payment_date: Optional[datetime] = Field(default=None, description="The payment date of the event.", alias="paymentDate")
new_instrument: NewInstrument = Field(alias="newInstrument")
fractional_units_cash_price: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The cash price paid in lieu of fractionalUnits.", alias="fractionalUnitsCashPrice")
fractional_units_cash_currency: Optional[StrictStr] = Field(None,alias="fractionalUnitsCashCurrency", description="The currency of the cash paid in lieu of fractionalUnits.")
security_offer_elections: Optional[List[SecurityOfferElection]] = Field(default=None, description="List of possible SecurityOfferElections for this event.", alias="securityOfferElections")
cash_and_security_offer_elections: Optional[List[CashAndSecurityOfferElection]] = Field(default=None, description="List of possible CashAndSecurityOfferElections for this event.", alias="cashAndSecurityOfferElections")
cash_offer_elections: Optional[List[CashOfferElection]] = Field(default=None, description="List of possible CashOfferElections for this event.", alias="cashOfferElections")
offer_type: Optional[StrictStr] = Field(None,alias="offerType", description="Informational ISO 20022 OfferTp indicator (e.g. \"ACPR\"). Optional. No calculation impact.")
accrued_interest_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optional per-unit accrued interest on the tendered face, from the last coupon date up to (but excluding) PaymentDate. Bond instrument types only. If left empty, analytics-core resolves it at event time from the bond's coupon schedule and market data.", alias="accruedInterestPerUnit")
min_piece_size: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Bond-specific minimum instructable face amount. Optional. Must be strictly positive when set.", alias="minPieceSize")
min_increment: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Bond-specific increment above MinPieceSize. Optional. When set, MinPieceSize must also be set. Must be strictly positive.", alias="minIncrement")
proration_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=1, description="Proration applied when the offer is oversubscribed. Defaults to 1 if not set. Must be greater than 0 and less than or equal to 1.", alias="prorationRate")
response_deadline_date: Optional[datetime] = Field(default=None, description="Account-servicer SLA deadline for holder instruction. Optional at the DTO layer; required under Voluntary participation on bond instrument types.", alias="responseDeadlineDate")
market_deadline_date: Optional[datetime] = Field(default=None, description="Offeror's-agent deadline for holder instruction. Optional at the DTO layer; required under Voluntary participation on bond instrument types.", alias="marketDeadlineDate")
early_response_deadline: Optional[datetime] = Field(default=None, description="Optional early-tender deadline. When set, must be on or before ResponseDeadlineDate.", alias="earlyResponseDeadline")
instrument_event_type: StrictStr = Field(...,alias="instrumentEventType", description="The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, 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, 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, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent, BankruptcyEvent, LiquidationPaymentEvent, PartialDefeasanceEvent.")
additional_properties: Dict[str, Any] = {}
__properties = ["instrumentEventType", "announcementDate", "exDate", "recordDate", "paymentDate", "newInstrument", "fractionalUnitsCashPrice", "fractionalUnitsCashCurrency", "securityOfferElections", "cashAndSecurityOfferElections", "cashOfferElections", "offerType", "accruedInterestPerUnit", "minPieceSize", "minIncrement", "prorationRate", "responseDeadlineDate", "marketDeadlineDate", "earlyResponseDeadline"]
[docs]
@validator('instrument_event_type')
def instrument_event_type_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 'TenderEvent' 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 "instrument_event_type" != "type":
return value
if value not in ['TransitionEvent', 'InformationalEvent', 'OpenEvent', 'CloseEvent', 'StockSplitEvent', 'BondDefaultEvent', 'CashDividendEvent', 'AmortisationEvent', 'CashFlowEvent', 'ExerciseEvent', 'ResetEvent', 'TriggerEvent', 'RawVendorEvent', 'InformationalErrorEvent', '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', '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', 'PutRedemptionEvent', 'LoanFacilityDelayedCompensationPaymentEvent', 'InterestPaymentEvent', 'PriorityIssueEvent', 'ClassActionEvent', 'BankruptcyEvent', 'LiquidationPaymentEvent', 'PartialDefeasanceEvent']:
raise ValueError("must be one of enum values ('TransitionEvent', 'InformationalEvent', 'OpenEvent', 'CloseEvent', 'StockSplitEvent', 'BondDefaultEvent', 'CashDividendEvent', 'AmortisationEvent', 'CashFlowEvent', 'ExerciseEvent', 'ResetEvent', 'TriggerEvent', 'RawVendorEvent', 'InformationalErrorEvent', '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', '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', 'PutRedemptionEvent', 'LoanFacilityDelayedCompensationPaymentEvent', 'InterestPaymentEvent', 'PriorityIssueEvent', 'ClassActionEvent', 'BankruptcyEvent', 'LiquidationPaymentEvent', 'PartialDefeasanceEvent')")
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) -> TenderEvent:
"""Create an instance of TenderEvent 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={
"additional_properties"
},
exclude_none=True)
# override the default output from pydantic by calling `to_dict()` of new_instrument
if self.new_instrument:
_dict['newInstrument'] = self.new_instrument.to_dict()
# override the default output from pydantic by calling `to_dict()` of each item in security_offer_elections (list)
_items = []
if self.security_offer_elections:
for _item in self.security_offer_elections:
if _item:
_items.append(_item.to_dict())
_dict['securityOfferElections'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in cash_and_security_offer_elections (list)
_items = []
if self.cash_and_security_offer_elections:
for _item in self.cash_and_security_offer_elections:
if _item:
_items.append(_item.to_dict())
_dict['cashAndSecurityOfferElections'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in cash_offer_elections (list)
_items = []
if self.cash_offer_elections:
for _item in self.cash_offer_elections:
if _item:
_items.append(_item.to_dict())
_dict['cashOfferElections'] = _items
# puts key-value pairs in additional_properties in the top level
if self.additional_properties is not None:
for _key, _value in self.additional_properties.items():
_dict[_key] = _value
# set to None if announcement_date (nullable) is None
# and __fields_set__ contains the field
if self.announcement_date is None and "announcement_date" in self.__fields_set__:
_dict['announcementDate'] = None
# set to None if record_date (nullable) is None
# and __fields_set__ contains the field
if self.record_date is None and "record_date" in self.__fields_set__:
_dict['recordDate'] = None
# set to None if fractional_units_cash_price (nullable) is None
# and __fields_set__ contains the field
if self.fractional_units_cash_price is None and "fractional_units_cash_price" in self.__fields_set__:
_dict['fractionalUnitsCashPrice'] = None
# set to None if fractional_units_cash_currency (nullable) is None
# and __fields_set__ contains the field
if self.fractional_units_cash_currency is None and "fractional_units_cash_currency" in self.__fields_set__:
_dict['fractionalUnitsCashCurrency'] = None
# set to None if security_offer_elections (nullable) is None
# and __fields_set__ contains the field
if self.security_offer_elections is None and "security_offer_elections" in self.__fields_set__:
_dict['securityOfferElections'] = None
# set to None if cash_and_security_offer_elections (nullable) is None
# and __fields_set__ contains the field
if self.cash_and_security_offer_elections is None and "cash_and_security_offer_elections" in self.__fields_set__:
_dict['cashAndSecurityOfferElections'] = None
# set to None if cash_offer_elections (nullable) is None
# and __fields_set__ contains the field
if self.cash_offer_elections is None and "cash_offer_elections" in self.__fields_set__:
_dict['cashOfferElections'] = None
# set to None if offer_type (nullable) is None
# and __fields_set__ contains the field
if self.offer_type is None and "offer_type" in self.__fields_set__:
_dict['offerType'] = None
# set to None if accrued_interest_per_unit (nullable) is None
# and __fields_set__ contains the field
if self.accrued_interest_per_unit is None and "accrued_interest_per_unit" in self.__fields_set__:
_dict['accruedInterestPerUnit'] = None
# set to None if min_piece_size (nullable) is None
# and __fields_set__ contains the field
if self.min_piece_size is None and "min_piece_size" in self.__fields_set__:
_dict['minPieceSize'] = None
# set to None if min_increment (nullable) is None
# and __fields_set__ contains the field
if self.min_increment is None and "min_increment" in self.__fields_set__:
_dict['minIncrement'] = None
# set to None if response_deadline_date (nullable) is None
# and __fields_set__ contains the field
if self.response_deadline_date is None and "response_deadline_date" in self.__fields_set__:
_dict['responseDeadlineDate'] = None
# set to None if market_deadline_date (nullable) is None
# and __fields_set__ contains the field
if self.market_deadline_date is None and "market_deadline_date" in self.__fields_set__:
_dict['marketDeadlineDate'] = None
# set to None if early_response_deadline (nullable) is None
# and __fields_set__ contains the field
if self.early_response_deadline is None and "early_response_deadline" in self.__fields_set__:
_dict['earlyResponseDeadline'] = None
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> TenderEvent:
"""Create an instance of TenderEvent from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return TenderEvent.parse_obj(obj)
_obj = TenderEvent.parse_obj({
"instrument_event_type": obj.get("instrumentEventType"),
"announcement_date": obj.get("announcementDate"),
"ex_date": obj.get("exDate"),
"record_date": obj.get("recordDate"),
"payment_date": obj.get("paymentDate"),
"new_instrument": NewInstrument.from_dict(obj.get("newInstrument")) if obj.get("newInstrument") is not None else None,
"fractional_units_cash_price": obj.get("fractionalUnitsCashPrice"),
"fractional_units_cash_currency": obj.get("fractionalUnitsCashCurrency"),
"security_offer_elections": [SecurityOfferElection.from_dict(_item) for _item in obj.get("securityOfferElections")] if obj.get("securityOfferElections") is not None else None,
"cash_and_security_offer_elections": [CashAndSecurityOfferElection.from_dict(_item) for _item in obj.get("cashAndSecurityOfferElections")] if obj.get("cashAndSecurityOfferElections") is not None else None,
"cash_offer_elections": [CashOfferElection.from_dict(_item) for _item in obj.get("cashOfferElections")] if obj.get("cashOfferElections") is not None else None,
"offer_type": obj.get("offerType"),
"accrued_interest_per_unit": obj.get("accruedInterestPerUnit"),
"min_piece_size": obj.get("minPieceSize"),
"min_increment": obj.get("minIncrement"),
"proration_rate": obj.get("prorationRate") if obj.get("prorationRate") is not None else 1,
"response_deadline_date": obj.get("responseDeadlineDate"),
"market_deadline_date": obj.get("marketDeadlineDate"),
"early_response_deadline": obj.get("earlyResponseDeadline")
})
# store additional fields in additional_properties
for _key in obj.keys():
if _key not in cls.__properties:
_obj.additional_properties[_key] = obj.get(_key)
return _obj
TenderEvent.update_forward_refs()