sdk.lusid.models.instrument_event.InstrumentEvent
- class InstrumentEvent(**data)[source]
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
- classmethod from_dict(obj)[source]
Create an instance of InstrumentEvent from a dict
- Return type:
Union(AccumulationEvent, AmortisationEvent, BondCouponEvent, BondDefaultEvent, BondPrincipalEvent, CashDividendEvent, CashFlowEvent, CloseEvent, DividendOptionEvent, DividendReinvestmentEvent, ExerciseEvent, ExpiryEvent, FxForwardSettlementEvent, InformationalErrorEvent, InformationalEvent, MaturityEvent, OpenEvent, RawVendorEvent, ResetEvent, ReverseStockSplitEvent, ScripDividendEvent, StockDividendEvent, StockSplitEvent, TransitionEvent, TriggerEvent)
- classmethod from_json(json_str)[source]
Create an instance of InstrumentEvent from a JSON string
- Return type:
Union(AccumulationEvent, AmortisationEvent, BondCouponEvent, BondDefaultEvent, BondPrincipalEvent, CashDividendEvent, CashFlowEvent, CloseEvent, DividendOptionEvent, DividendReinvestmentEvent, ExerciseEvent, ExpiryEvent, FxForwardSettlementEvent, InformationalErrorEvent, InformationalEvent, MaturityEvent, OpenEvent, RawVendorEvent, ResetEvent, ReverseStockSplitEvent, ScripDividendEvent, StockDividendEvent, StockSplitEvent, TransitionEvent, TriggerEvent)