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

Consent Event (CONS) — a voluntary corporate action where an issuer seeks approval from security holders to amend the terms of an outstanding instrument. More...

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

Public Member Functions

 ConsentEvent (string consentType=default(string), DateTimeOffset recordDate=default(DateTimeOffset), DateTimeOffset responseDeadline=default(DateTimeOffset), DateTimeOffset marketDeadline=default(DateTimeOffset), DateTimeOffset? earlyResponseDeadline=default(DateTimeOffset?), DateTimeOffset? paymentDate=default(DateTimeOffset?), List< CashOfferElection > cashOfferElections=default(List< CashOfferElection >), List< LapseElection > lapseElections=default(List< LapseElection >), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the ConsentEvent 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 (ConsentEvent input)
 Returns true if ConsentEvent 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

 ConsentEvent ()
 Initializes a new instance of the ConsentEvent 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

string ConsentType [get, set]
 The type of consent solicitation. Supported string (enumeration) values are: [ChangeInTerms, DueAndPayable]. Available values: ChangeInTerms, DueAndPayable. More...
 
DateTimeOffset RecordDate [get, set]
 The entitlement determination date. More...
 
DateTimeOffset ResponseDeadline [get, set]
 The last date to submit instructions. More...
 
DateTimeOffset MarketDeadline [get, set]
 The issuer-set outer deadline. Must be greater than or equal to ResponseDeadline. More...
 
DateTimeOffset? EarlyResponseDeadline [get, set]
 Deadline for early consent. Required when a CONY-early CashOfferElection is offered. Must be earlier than ResponseDeadline. More...
 
DateTimeOffset? PaymentDate [get, set]
 Date on which the consent fee is paid. Required when any CashOfferElection is offered. More...
 
List< CashOfferElectionCashOfferElections [get, set]
 List of possible cash offer elections for this event. Each tier (CONY-standard, CONY-early) is modelled as a separate entry; the election carries the per-unit fee rate and currency. More...
 
List< LapseElectionLapseElections [get, set]
 List of possible lapse elections for this event (NOAC, CONN, ABST). 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. 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
}
 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. More...
 

Detailed Description

Consent Event (CONS) — a voluntary corporate action where an issuer seeks approval from security holders to amend the terms of an outstanding instrument.

Constructor & Destructor Documentation

◆ ConsentEvent() [1/2]

Lusid.Sdk.Model.ConsentEvent.ConsentEvent ( )
inlineprotected

Initializes a new instance of the ConsentEvent class.

◆ ConsentEvent() [2/2]

Lusid.Sdk.Model.ConsentEvent.ConsentEvent ( string  consentType = default(string),
DateTimeOffset  recordDate = default(DateTimeOffset),
DateTimeOffset  responseDeadline = default(DateTimeOffset),
DateTimeOffset  marketDeadline = default(DateTimeOffset),
DateTimeOffset?  earlyResponseDeadline = default(DateTimeOffset?),
DateTimeOffset?  paymentDate = default(DateTimeOffset?),
List< CashOfferElection cashOfferElections = default(List<CashOfferElection>),
List< LapseElection lapseElections = default(List<LapseElection>),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the ConsentEvent class.

Parameters
consentTypeThe type of consent solicitation. Supported string (enumeration) values are: [ChangeInTerms, DueAndPayable]. Available values: ChangeInTerms, DueAndPayable. (required).
recordDateThe entitlement determination date..
responseDeadlineThe last date to submit instructions..
marketDeadlineThe issuer-set outer deadline. Must be greater than or equal to ResponseDeadline..
earlyResponseDeadlineDeadline for early consent. Required when a CONY-early CashOfferElection is offered. Must be earlier than ResponseDeadline..
paymentDateDate on which the consent fee is paid. Required when any CashOfferElection is offered..
cashOfferElectionsList of possible cash offer elections for this event. Each tier (CONY-standard, CONY-early) is modelled as a separate entry; the election carries the per-unit fee rate and currency..
lapseElectionsList of possible lapse elections for this event (NOAC, CONN, ABST)..
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. (required) (default to "ConsentEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if ConsentEvent instances are equal

Parameters
inputInstance of ConsentEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.ConsentEvent.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.ConsentEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CashOfferElections

List<CashOfferElection> Lusid.Sdk.Model.ConsentEvent.CashOfferElections
getset

List of possible cash offer elections for this event. Each tier (CONY-standard, CONY-early) is modelled as a separate entry; the election carries the per-unit fee rate and currency.

List of possible cash offer elections for this event. Each tier (CONY-standard, CONY-early) is modelled as a separate entry; the election carries the per-unit fee rate and currency.

◆ ConsentType

string Lusid.Sdk.Model.ConsentEvent.ConsentType
getset

The type of consent solicitation. Supported string (enumeration) values are: [ChangeInTerms, DueAndPayable]. Available values: ChangeInTerms, DueAndPayable.

The type of consent solicitation. Supported string (enumeration) values are: [ChangeInTerms, DueAndPayable]. Available values: ChangeInTerms, DueAndPayable.

◆ EarlyResponseDeadline

DateTimeOffset? Lusid.Sdk.Model.ConsentEvent.EarlyResponseDeadline
getset

Deadline for early consent. Required when a CONY-early CashOfferElection is offered. Must be earlier than ResponseDeadline.

Deadline for early consent. Required when a CONY-early CashOfferElection is offered. Must be earlier than ResponseDeadline.

◆ LapseElections

List<LapseElection> Lusid.Sdk.Model.ConsentEvent.LapseElections
getset

List of possible lapse elections for this event (NOAC, CONN, ABST).

List of possible lapse elections for this event (NOAC, CONN, ABST).

◆ MarketDeadline

DateTimeOffset Lusid.Sdk.Model.ConsentEvent.MarketDeadline
getset

The issuer-set outer deadline. Must be greater than or equal to ResponseDeadline.

The issuer-set outer deadline. Must be greater than or equal to ResponseDeadline.

◆ PaymentDate

DateTimeOffset? Lusid.Sdk.Model.ConsentEvent.PaymentDate
getset

Date on which the consent fee is paid. Required when any CashOfferElection is offered.

Date on which the consent fee is paid. Required when any CashOfferElection is offered.

◆ RecordDate

DateTimeOffset Lusid.Sdk.Model.ConsentEvent.RecordDate
getset

The entitlement determination date.

The entitlement determination date.

◆ ResponseDeadline

DateTimeOffset Lusid.Sdk.Model.ConsentEvent.ResponseDeadline
getset

The last date to submit instructions.

The last date to submit instructions.


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