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

Mandatory partial bond redemption (DRAW) where the issuer lottery-selects specific bonds for early redemption. The affected face amount (AFFB) is pre-determined externally from the vendor notification and supplied on the event. More...

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

Public Member Functions

 DrawingEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset effectiveDate=default(DateTimeOffset), decimal affectedAmount=default(decimal), decimal? pricePerUnit=default(decimal?), string currency=default(string), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the DrawingEvent 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 (DrawingEvent input)
 Returns true if DrawingEvent 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

 DrawingEvent ()
 Initializes a new instance of the DrawingEvent 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 PaymentDate [get, set]
 Date the cash actually flows for the drawn portion of the holding. More...
 
DateTimeOffset EffectiveDate [get, set]
 Lottery Date (&#x3D; Record Date). Holdings are snapshotted at the close of this date to determine the affected balance. More...
 
decimal AffectedAmount [get, set]
 Affected face amount (AFFB) — the lottery-selected portion of the holding that is redeemed. Must be strictly positive. More...
 
decimal? PricePerUnit [get, set]
 Redemption price per unit (OFFR / 100). Clean price convention. Optional: AFFB is typically known before the issuer publishes OFFR, so a null price is permitted on upsert. More...
 
string Currency [get, set]
 Settlement currency for the redemption. 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

Mandatory partial bond redemption (DRAW) where the issuer lottery-selects specific bonds for early redemption. The affected face amount (AFFB) is pre-determined externally from the vendor notification and supplied on the event.

Constructor & Destructor Documentation

◆ DrawingEvent() [1/2]

Lusid.Sdk.Model.DrawingEvent.DrawingEvent ( )
inlineprotected

Initializes a new instance of the DrawingEvent class.

◆ DrawingEvent() [2/2]

Lusid.Sdk.Model.DrawingEvent.DrawingEvent ( DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset  effectiveDate = default(DateTimeOffset),
decimal  affectedAmount = default(decimal),
decimal?  pricePerUnit = default(decimal?),
string  currency = default(string),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the DrawingEvent class.

Parameters
paymentDateDate the cash actually flows for the drawn portion of the holding..
effectiveDateLottery Date (&#x3D; Record Date). Holdings are snapshotted at the close of this date to determine the affected balance..
affectedAmountAffected face amount (AFFB) — the lottery-selected portion of the holding that is redeemed. Must be strictly positive. (required).
pricePerUnitRedemption price per unit (OFFR / 100). Clean price convention. Optional: AFFB is typically known before the issuer publishes OFFR, so a null price is permitted on upsert..
currencySettlement currency for the redemption. (required).
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 "DrawingEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if DrawingEvent instances are equal

Parameters
inputInstance of DrawingEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AffectedAmount

decimal Lusid.Sdk.Model.DrawingEvent.AffectedAmount
getset

Affected face amount (AFFB) — the lottery-selected portion of the holding that is redeemed. Must be strictly positive.

Affected face amount (AFFB) — the lottery-selected portion of the holding that is redeemed. Must be strictly positive.

◆ Currency

string Lusid.Sdk.Model.DrawingEvent.Currency
getset

Settlement currency for the redemption.

Settlement currency for the redemption.

◆ EffectiveDate

DateTimeOffset Lusid.Sdk.Model.DrawingEvent.EffectiveDate
getset

Lottery Date (&#x3D; Record Date). Holdings are snapshotted at the close of this date to determine the affected balance.

Lottery Date (&#x3D; Record Date). Holdings are snapshotted at the close of this date to determine the affected balance.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.DrawingEvent.PaymentDate
getset

Date the cash actually flows for the drawn portion of the holding.

Date the cash actually flows for the drawn portion of the holding.

◆ PricePerUnit

decimal? Lusid.Sdk.Model.DrawingEvent.PricePerUnit
getset

Redemption price per unit (OFFR / 100). Clean price convention. Optional: AFFB is typically known before the issuer publishes OFFR, so a null price is permitted on upsert.

Redemption price per unit (OFFR / 100). Clean price convention. Optional: AFFB is typically known before the issuer publishes OFFR, so a null price is permitted on upsert.


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