# 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_offer_election import CashOfferElection
from lusid.models.instrument_event import InstrumentEvent
from lusid.models.lapse_election import LapseElection
from lusid.models.tender_offer_election import TenderOfferElection
[docs]
class RepurchaseOfferEvent(InstrumentEvent):
"""
Representation of a repurchase offer corporate action. Represents an offer by the issuer to repurchase its own shares from a shareholder at a given price. # noqa: E501
"""
payment_date: Optional[datetime] = Field(default=None, description="Payment date of the event.", alias="paymentDate")
market_deadline_date: Optional[datetime] = Field(default=None, description="Date set by the issuer or by an agent of the issuer as the latest date to respond to the offer. Must be before or equal to the PaymentDate.", alias="marketDeadlineDate")
repurchase_quantity: Union[StrictFloat, StrictInt] = Field(description="Quantity of the security to be repurchased.", alias="repurchaseQuantity")
cash_offer_elections: List[CashOfferElection] = Field(description="List of possible CashOfferElections for this event. Only 1 should be provided.", alias="cashOfferElections")
lapse_elections: List[LapseElection] = Field(description="List of possible LapseElections for this event. Only 1 should be provided. Allows the user to opt out of the offer.", alias="lapseElections")
tender_offer_elections: List[TenderOfferElection] = Field(description="List of possible TenderOfferElections for this event. Only 1 should be provided.", alias="tenderOfferElections")
proration_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=1, description="The fraction used to calculate a proportional adjustment for RepurchaseQuantity when a full period is not used. 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="Date set by the account servicer as the latest date to respond to the offer. Optional. If set, must be before or equal to MarketDeadlineDate. Defaults to MarketDeadlineDate if not set.", alias="responseDeadlineDate")
early_response_deadline: Optional[datetime] = Field(default=None, description="Optional CTEN early-tender deadline. If set, must be on or before ResponseDeadlineDate. Used for bond tender offers where early tenders attract a premium.", alias="earlyResponseDeadline")
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")
accrued_interest_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Optional per-unit accrued interest on the accepted face amount, from the last coupon date up to (but excluding) PaymentDate. Bond-like instruments only. If left empty, resolves it internally at event time from the bond's coupon schedule and market data.", alias="accruedInterestPerUnit")
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.")
additional_properties: Dict[str, Any] = {}
__properties = ["instrumentEventType", "paymentDate", "marketDeadlineDate", "repurchaseQuantity", "cashOfferElections", "lapseElections", "tenderOfferElections", "prorationRate", "responseDeadlineDate", "earlyResponseDeadline", "minPieceSize", "minIncrement", "accruedInterestPerUnit"]
[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 'RepurchaseOfferEvent' 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']:
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')")
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) -> RepurchaseOfferEvent:
"""Create an instance of RepurchaseOfferEvent 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 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
# override the default output from pydantic by calling `to_dict()` of each item in lapse_elections (list)
_items = []
if self.lapse_elections:
for _item in self.lapse_elections:
if _item:
_items.append(_item.to_dict())
_dict['lapseElections'] = _items
# override the default output from pydantic by calling `to_dict()` of each item in tender_offer_elections (list)
_items = []
if self.tender_offer_elections:
for _item in self.tender_offer_elections:
if _item:
_items.append(_item.to_dict())
_dict['tenderOfferElections'] = _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 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 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
# 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 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
return _dict
[docs]
@classmethod
def from_dict(cls, obj: dict) -> RepurchaseOfferEvent:
"""Create an instance of RepurchaseOfferEvent from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return RepurchaseOfferEvent.parse_obj(obj)
_obj = RepurchaseOfferEvent.parse_obj({
"instrument_event_type": obj.get("instrumentEventType"),
"payment_date": obj.get("paymentDate"),
"market_deadline_date": obj.get("marketDeadlineDate"),
"repurchase_quantity": obj.get("repurchaseQuantity"),
"cash_offer_elections": [CashOfferElection.from_dict(_item) for _item in obj.get("cashOfferElections")] if obj.get("cashOfferElections") is not None else None,
"lapse_elections": [LapseElection.from_dict(_item) for _item in obj.get("lapseElections")] if obj.get("lapseElections") is not None else None,
"tender_offer_elections": [TenderOfferElection.from_dict(_item) for _item in obj.get("tenderOfferElections")] if obj.get("tenderOfferElections") is not None else None,
"proration_rate": obj.get("prorationRate") if obj.get("prorationRate") is not None else 1,
"response_deadline_date": obj.get("responseDeadlineDate"),
"early_response_deadline": obj.get("earlyResponseDeadline"),
"min_piece_size": obj.get("minPieceSize"),
"min_increment": obj.get("minIncrement"),
"accrued_interest_per_unit": obj.get("accruedInterestPerUnit")
})
# 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
RepurchaseOfferEvent.update_forward_refs()