LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.ChangeEvent Class Reference

Change event (CHAN) — a reorganisation in which an instrument's certificates, name, or terms are changed. Holders of record on the record date have their positions converted automatically to the new instrument at a fixed 1:1 ratio on the payment date. More...

Inheritance diagram for Lusid.Sdk.Model.ChangeEvent:
Inheritance graph
[legend]

Public Member Functions

 ChangeEvent (DateTimeOffset recordDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), NewInstrument newInstrument=default(NewInstrument), UnitsRatio unitsRatio=default(UnitsRatio), string changeType=default(string), string termTarget=default(string), string termTargetIdentifier=default(string), string additionalInformation=default(string), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the ChangeEvent class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (ChangeEvent input)
 Returns true if ChangeEvent instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
 InstrumentEvent (InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the InstrumentEvent class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (InstrumentEvent input)
 Returns true if InstrumentEvent instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 ChangeEvent ()
 Initializes a new instance of the ChangeEvent class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
 InstrumentEvent ()
 Initializes a new instance of the InstrumentEvent class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

DateTimeOffset RecordDate [get, set]
 The record date — the eligibility cutoff. Holders of record on this date enter the change. More...
 
DateTimeOffset PaymentDate [get, set]
 The payment date — the date the change fires and the paired StockMovement transactions land. More...
 
NewInstrument NewInstrument [get, set]
 Gets or Sets NewInstrument More...
 
UnitsRatio UnitsRatio [get, set]
 Gets or Sets UnitsRatio More...
 
string ChangeType [get, set]
 The nature of the change — one of &quot;Certificates&quot;, &quot;Name&quot;, or &quot;Terms&quot;. Available values: Certificates, Name, Terms. More...
 
string TermTarget [get, set]
 The target of a terms change — one of &quot;InstrumentDefinitionField&quot; or &quot;InstrumentProperty&quot;. Only applicable when ChangeType is &quot;Terms&quot;. Available values: InstrumentDefinitionField, InstrumentProperty. More...
 
string TermTargetIdentifier [get, set]
 The identifier of the term target being changed. Must be paired with TermTarget. More...
 
string AdditionalInformation [get, set]
 Free-text additional information describing the change. More...
 
- Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum InstrumentEventType [get, set]
 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, SecurityWriteOffEvent, WarrantsExerciseEvent, PariPassuEvent, ChangeEvent. More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.InstrumentEvent
enum class  InstrumentEventTypeEnum {
  TransitionEvent = 1 , InformationalEvent = 2 , OpenEvent = 3 , CloseEvent = 4 ,
  StockSplitEvent = 5 , BondDefaultEvent = 6 , CashDividendEvent = 7 , AmortisationEvent = 8 ,
  CashFlowEvent = 9 , ExerciseEvent = 10 , ResetEvent = 11 , TriggerEvent = 12 ,
  RawVendorEvent = 13 , InformationalErrorEvent = 14 , BondCouponEvent = 15 , DividendReinvestmentEvent = 16 ,
  AccumulationEvent = 17 , BondPrincipalEvent = 18 , DividendOptionEvent = 19 , MaturityEvent = 20 ,
  FxForwardSettlementEvent = 21 , ExpiryEvent = 22 , ScripDividendEvent = 23 , StockDividendEvent = 24 ,
  ReverseStockSplitEvent = 25 , CapitalDistributionEvent = 26 , SpinOffEvent = 27 , MergerEvent = 28 ,
  FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 ,
  CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 ,
  BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 ,
  TenderEvent = 41 , CallOnIntermediateSecuritiesEvent = 42 , IntermediateSecuritiesDistributionEvent = 43 , OptionExercisePhysicalEvent = 44 ,
  OptionExerciseCashEvent = 45 , ProtectionPayoutCashFlowEvent = 46 , TermDepositInterestEvent = 47 , TermDepositPrincipalEvent = 48 ,
  EarlyRedemptionEvent = 49 , FutureMarkToMarketEvent = 50 , AdjustGlobalCommitmentEvent = 51 , ContractInitialisationEvent = 52 ,
  DrawdownEvent = 53 , LoanInterestRepaymentEvent = 54 , UpdateDepositAmountEvent = 55 , LoanPrincipalRepaymentEvent = 56 ,
  DepositInterestPaymentEvent = 57 , DepositCloseEvent = 58 , LoanFacilityContractRolloverEvent = 59 , RepurchaseOfferEvent = 60 ,
  RepoPartialClosureEvent = 61 , RepoCashFlowEvent = 62 , FlexibleRepoInterestPaymentEvent = 63 , FlexibleRepoCashFlowEvent = 64 ,
  FlexibleRepoCollateralEvent = 65 , ConversionEvent = 66 , FlexibleRepoPartialClosureEvent = 67 , FlexibleRepoFullClosureEvent = 68 ,
  CapletFloorletCashFlowEvent = 69 , EarlyCloseOutEvent = 70 , DepositRollEvent = 71 , ConsentEvent = 72 ,
  DrawingEvent = 73 , CapitalGainsDistributionEvent = 74 , ExchangeOfferEvent = 75 , DutchAuctionEvent = 76 ,
  WorthlessEvent = 77 , PutRedemptionEvent = 78 , LoanFacilityDelayedCompensationPaymentEvent = 79 , InterestPaymentEvent = 80 ,
  PriorityIssueEvent = 81 , ClassActionEvent = 82 , BankruptcyEvent = 83 , LiquidationPaymentEvent = 84 ,
  PartialDefeasanceEvent = 85 , SecurityWriteOffEvent = 86 , WarrantsExerciseEvent = 87 , PariPassuEvent = 88 ,
  ChangeEvent = 89
}
 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, SecurityWriteOffEvent, WarrantsExerciseEvent, PariPassuEvent, ChangeEvent. More...
 

Detailed Description

Change event (CHAN) — a reorganisation in which an instrument&#39;s certificates, name, or terms are changed. Holders of record on the record date have their positions converted automatically to the new instrument at a fixed 1:1 ratio on the payment date.

Constructor & Destructor Documentation

◆ ChangeEvent() [1/2]

Lusid.Sdk.Model.ChangeEvent.ChangeEvent ( )
inlineprotected

Initializes a new instance of the ChangeEvent class.

◆ ChangeEvent() [2/2]

Lusid.Sdk.Model.ChangeEvent.ChangeEvent ( DateTimeOffset  recordDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
NewInstrument  newInstrument = default(NewInstrument),
UnitsRatio  unitsRatio = default(UnitsRatio),
string  changeType = default(string),
string  termTarget = default(string),
string  termTargetIdentifier = default(string),
string  additionalInformation = default(string),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the ChangeEvent class.

Parameters
recordDateThe record date — the eligibility cutoff. Holders of record on this date enter the change..
paymentDateThe payment date — the date the change fires and the paired StockMovement transactions land..
newInstrumentnewInstrument (required).
unitsRatiounitsRatio (required).
changeTypeThe nature of the change — one of &quot;Certificates&quot;, &quot;Name&quot;, or &quot;Terms&quot;. Available values: Certificates, Name, Terms. (required).
termTargetThe target of a terms change — one of &quot;InstrumentDefinitionField&quot; or &quot;InstrumentProperty&quot;. Only applicable when ChangeType is &quot;Terms&quot;. Available values: InstrumentDefinitionField, InstrumentProperty..
termTargetIdentifierThe identifier of the term target being changed. Must be paired with TermTarget..
additionalInformationFree-text additional information describing the change..
instrumentEventTypeThe 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, SecurityWriteOffEvent, WarrantsExerciseEvent, PariPassuEvent, ChangeEvent. (required) (default to "ChangeEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.ChangeEvent.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.ChangeEvent.Equals ( ChangeEvent  input)
inline

Returns true if ChangeEvent instances are equal

Parameters
inputInstance of ChangeEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.ChangeEvent.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.ChangeEvent.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.ChangeEvent.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.InstrumentEvent.

◆ ToString()

override string Lusid.Sdk.Model.ChangeEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AdditionalInformation

string Lusid.Sdk.Model.ChangeEvent.AdditionalInformation
getset

Free-text additional information describing the change.

Free-text additional information describing the change.

◆ ChangeType

string Lusid.Sdk.Model.ChangeEvent.ChangeType
getset

The nature of the change — one of &quot;Certificates&quot;, &quot;Name&quot;, or &quot;Terms&quot;. Available values: Certificates, Name, Terms.

The nature of the change — one of &quot;Certificates&quot;, &quot;Name&quot;, or &quot;Terms&quot;. Available values: Certificates, Name, Terms.

◆ NewInstrument

NewInstrument Lusid.Sdk.Model.ChangeEvent.NewInstrument
getset

Gets or Sets NewInstrument

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.ChangeEvent.PaymentDate
getset

The payment date — the date the change fires and the paired StockMovement transactions land.

The payment date — the date the change fires and the paired StockMovement transactions land.

◆ RecordDate

DateTimeOffset Lusid.Sdk.Model.ChangeEvent.RecordDate
getset

The record date — the eligibility cutoff. Holders of record on this date enter the change.

The record date — the eligibility cutoff. Holders of record on this date enter the change.

◆ TermTarget

string Lusid.Sdk.Model.ChangeEvent.TermTarget
getset

The target of a terms change — one of &quot;InstrumentDefinitionField&quot; or &quot;InstrumentProperty&quot;. Only applicable when ChangeType is &quot;Terms&quot;. Available values: InstrumentDefinitionField, InstrumentProperty.

The target of a terms change — one of &quot;InstrumentDefinitionField&quot; or &quot;InstrumentProperty&quot;. Only applicable when ChangeType is &quot;Terms&quot;. Available values: InstrumentDefinitionField, InstrumentProperty.

◆ TermTargetIdentifier

string Lusid.Sdk.Model.ChangeEvent.TermTargetIdentifier
getset

The identifier of the term target being changed. Must be paired with TermTarget.

The identifier of the term target being changed. Must be paired with TermTarget.

◆ UnitsRatio

UnitsRatio Lusid.Sdk.Model.ChangeEvent.UnitsRatio
getset

Gets or Sets UnitsRatio


The documentation for this class was generated from the following file: