sdk.lusid.models.instrument_event.InstrumentEvent

class InstrumentEvent(**data)

Base class for representing instrument events in LUSID, such as dividends, stock splits, and option exercises. This base class should not be directly instantiated; each supported InstrumentEventType has a corresponding inherited class. # noqa: E501

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Attributes

This is a Pydantic class. For now, click on the green [source] link in the class signature above to see descriptions/allowed values for these attributes.

instrument_event_type

class Config

Pydantic configuration

classmethod from_dict(obj)

Create an instance of InstrumentEvent from a dict

Return type:

Union(AccumulationEvent, AdjustGlobalCommitmentEvent, AmortisationEvent, BondCouponEvent, BondDefaultEvent, BondPrincipalEvent, BonusIssueEvent, CallOnIntermediateSecuritiesEvent, CapitalDistributionEvent, CapitalGainsDistributionEvent, CapletFloorletCashFlowEvent, CashDividendEvent, CashFlowEvent, CdsCreditEvent, CdxCreditEvent, CloseEvent, ConsentEvent, ContractInitialisationEvent, ConversionEvent, CreditPremiumCashFlowEvent, DepositCloseEvent, DepositInterestPaymentEvent, DepositRollEvent, DividendOptionEvent, DividendReinvestmentEvent, DrawdownEvent, DrawingEvent, DutchAuctionEvent, EarlyCloseOutEvent, EarlyRedemptionEvent, ExchangeOfferEvent, ExerciseEvent, ExpiryEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, FlexibleRepoFullClosureEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoPartialClosureEvent, FutureExpiryEvent, FutureMarkToMarketEvent, FxForwardSettlementEvent, InformationalErrorEvent, InformationalEvent, IntermediateSecuritiesDistributionEvent, LoanFacilityContractRolloverEvent, LoanInterestRepaymentEvent, LoanPrincipalRepaymentEvent, MaturityEvent, MbsCouponEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, MbsPrincipalEvent, MbsPrincipalWriteOffEvent, MergerEvent, OpenEvent, OptionExerciseCashEvent, OptionExercisePhysicalEvent, ProtectionPayoutCashFlowEvent, RawVendorEvent, RepoCashFlowEvent, RepoPartialClosureEvent, RepurchaseOfferEvent, ResetEvent, ReverseStockSplitEvent, ScripDividendEvent, SpinOffEvent, StockDividendEvent, StockSplitEvent, SwapCashFlowEvent, SwapPrincipalEvent, TenderEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, TransitionEvent, TriggerEvent, UpdateDepositAmountEvent, WorthlessEvent)

classmethod from_json(json_str)

Create an instance of InstrumentEvent from a JSON string

Return type:

Union(AccumulationEvent, AdjustGlobalCommitmentEvent, AmortisationEvent, BondCouponEvent, BondDefaultEvent, BondPrincipalEvent, BonusIssueEvent, CallOnIntermediateSecuritiesEvent, CapitalDistributionEvent, CapitalGainsDistributionEvent, CapletFloorletCashFlowEvent, CashDividendEvent, CashFlowEvent, CdsCreditEvent, CdxCreditEvent, CloseEvent, ConsentEvent, ContractInitialisationEvent, ConversionEvent, CreditPremiumCashFlowEvent, DepositCloseEvent, DepositInterestPaymentEvent, DepositRollEvent, DividendOptionEvent, DividendReinvestmentEvent, DrawdownEvent, DrawingEvent, DutchAuctionEvent, EarlyCloseOutEvent, EarlyRedemptionEvent, ExchangeOfferEvent, ExerciseEvent, ExpiryEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, FlexibleRepoFullClosureEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoPartialClosureEvent, FutureExpiryEvent, FutureMarkToMarketEvent, FxForwardSettlementEvent, InformationalErrorEvent, InformationalEvent, IntermediateSecuritiesDistributionEvent, LoanFacilityContractRolloverEvent, LoanInterestRepaymentEvent, LoanPrincipalRepaymentEvent, MaturityEvent, MbsCouponEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, MbsPrincipalEvent, MbsPrincipalWriteOffEvent, MergerEvent, OpenEvent, OptionExerciseCashEvent, OptionExercisePhysicalEvent, ProtectionPayoutCashFlowEvent, RawVendorEvent, RepoCashFlowEvent, RepoPartialClosureEvent, RepurchaseOfferEvent, ResetEvent, ReverseStockSplitEvent, ScripDividendEvent, SpinOffEvent, StockDividendEvent, StockSplitEvent, SwapCashFlowEvent, SwapPrincipalEvent, TenderEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, TransitionEvent, TriggerEvent, UpdateDepositAmountEvent, WorthlessEvent)

classmethod get_discriminator_value(obj)

Returns the discriminator value (object type) of the data

Return type:

str

classmethod instrument_event_type_validate_enum(value)

Validates the enum

to_dict()

Returns the dictionary representation of the model using alias

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str