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

Representation of a repurchase offer corporate action. Represents an offer by the issuer to repurchase its own shares from a shareholder at a given price. More...

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

Public Member Functions

 RepurchaseOfferEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset marketDeadlineDate=default(DateTimeOffset), decimal repurchaseQuantity=default(decimal), List< CashOfferElection > cashOfferElections=default(List< CashOfferElection >), List< LapseElection > lapseElections=default(List< LapseElection >), List< TenderOfferElection > tenderOfferElections=default(List< TenderOfferElection >), decimal prorationRate=(decimal) 1D, DateTimeOffset? responseDeadlineDate=default(DateTimeOffset?), DateTimeOffset? earlyResponseDeadline=default(DateTimeOffset?), decimal? minPieceSize=default(decimal?), decimal? minIncrement=default(decimal?), decimal? accruedInterestPerUnit=default(decimal?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the RepurchaseOfferEvent 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 (RepurchaseOfferEvent input)
 Returns true if RepurchaseOfferEvent 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

 RepurchaseOfferEvent ()
 Initializes a new instance of the RepurchaseOfferEvent 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]
 Payment date of the event. More...
 
DateTimeOffset MarketDeadlineDate [get, set]
 Date set by the issuer or by an agent of the issuer as the latest date to respond to the offer. Must be before or equal to the PaymentDate. More...
 
decimal RepurchaseQuantity [get, set]
 Quantity of the security to be repurchased. More...
 
List< CashOfferElectionCashOfferElections [get, set]
 List of possible CashOfferElections for this event. Only 1 should be provided. More...
 
List< LapseElectionLapseElections [get, set]
 List of possible LapseElections for this event. Only 1 should be provided. Allows the user to opt out of the offer. More...
 
List< TenderOfferElectionTenderOfferElections [get, set]
 List of possible TenderOfferElections for this event. Only 1 should be provided. More...
 
decimal ProrationRate [get, set]
 The fraction used to calculate a proportional adjustment for RepurchaseQuantity when a full period is not used. Defaults to 1 if not set. Must be greater than 0 and less than or equal to 1. More...
 
DateTimeOffset? ResponseDeadlineDate [get, set]
 Date set by the account servicer as the latest date to respond to the offer. Optional. If set, must be before or equal to MarketDeadlineDate. Defaults to MarketDeadlineDate if not set. More...
 
DateTimeOffset? EarlyResponseDeadline [get, set]
 Optional CTEN early-tender deadline. If set, must be on or before ResponseDeadlineDate. Used for bond tender offers where early tenders attract a premium. More...
 
decimal? MinPieceSize [get, set]
 Bond-specific minimum instructable face amount. Optional. Must be strictly positive when set. More...
 
decimal? MinIncrement [get, set]
 Bond-specific increment above MinPieceSize. Optional. When set, MinPieceSize must also be set. Must be strictly positive. More...
 
decimal? AccruedInterestPerUnit [get, set]
 Optional per-unit accrued interest on the accepted face amount, from the last coupon date up to (but excluding) PaymentDate. Bond-like instruments only. If left empty, resolves it internally at event time from the bond&#39;s coupon schedule and market data. 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

Representation of a repurchase offer corporate action. Represents an offer by the issuer to repurchase its own shares from a shareholder at a given price.

Constructor & Destructor Documentation

◆ RepurchaseOfferEvent() [1/2]

Lusid.Sdk.Model.RepurchaseOfferEvent.RepurchaseOfferEvent ( )
inlineprotected

Initializes a new instance of the RepurchaseOfferEvent class.

◆ RepurchaseOfferEvent() [2/2]

Lusid.Sdk.Model.RepurchaseOfferEvent.RepurchaseOfferEvent ( DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset  marketDeadlineDate = default(DateTimeOffset),
decimal  repurchaseQuantity = default(decimal),
List< CashOfferElection cashOfferElections = default(List<CashOfferElection>),
List< LapseElection lapseElections = default(List<LapseElection>),
List< TenderOfferElection tenderOfferElections = default(List<TenderOfferElection>),
decimal  prorationRate = (decimal)1D,
DateTimeOffset?  responseDeadlineDate = default(DateTimeOffset?),
DateTimeOffset?  earlyResponseDeadline = default(DateTimeOffset?),
decimal?  minPieceSize = default(decimal?),
decimal?  minIncrement = default(decimal?),
decimal?  accruedInterestPerUnit = default(decimal?),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the RepurchaseOfferEvent class.

Parameters
paymentDatePayment date of the event..
marketDeadlineDateDate set by the issuer or by an agent of the issuer as the latest date to respond to the offer. Must be before or equal to the PaymentDate..
repurchaseQuantityQuantity of the security to be repurchased. (required).
cashOfferElectionsList of possible CashOfferElections for this event. Only 1 should be provided. (required).
lapseElectionsList of possible LapseElections for this event. Only 1 should be provided. Allows the user to opt out of the offer. (required).
tenderOfferElectionsList of possible TenderOfferElections for this event. Only 1 should be provided. (required).
prorationRateThe fraction used to calculate a proportional adjustment for RepurchaseQuantity when a full period is not used. Defaults to 1 if not set. Must be greater than 0 and less than or equal to 1. (default to 1D).
responseDeadlineDateDate set by the account servicer as the latest date to respond to the offer. Optional. If set, must be before or equal to MarketDeadlineDate. Defaults to MarketDeadlineDate if not set..
earlyResponseDeadlineOptional CTEN early-tender deadline. If set, must be on or before ResponseDeadlineDate. Used for bond tender offers where early tenders attract a premium..
minPieceSizeBond-specific minimum instructable face amount. Optional. Must be strictly positive when set..
minIncrementBond-specific increment above MinPieceSize. Optional. When set, MinPieceSize must also be set. Must be strictly positive..
accruedInterestPerUnitOptional per-unit accrued interest on the accepted face amount, from the last coupon date up to (but excluding) PaymentDate. Bond-like instruments only. If left empty, resolves it internally at event time from the bond&#39;s coupon schedule and market data..
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 "RepurchaseOfferEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if RepurchaseOfferEvent instances are equal

Parameters
inputInstance of RepurchaseOfferEvent to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccruedInterestPerUnit

decimal? Lusid.Sdk.Model.RepurchaseOfferEvent.AccruedInterestPerUnit
getset

Optional per-unit accrued interest on the accepted face amount, from the last coupon date up to (but excluding) PaymentDate. Bond-like instruments only. If left empty, resolves it internally at event time from the bond&#39;s coupon schedule and market data.

Optional per-unit accrued interest on the accepted face amount, from the last coupon date up to (but excluding) PaymentDate. Bond-like instruments only. If left empty, resolves it internally at event time from the bond&#39;s coupon schedule and market data.

◆ CashOfferElections

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

List of possible CashOfferElections for this event. Only 1 should be provided.

List of possible CashOfferElections for this event. Only 1 should be provided.

◆ EarlyResponseDeadline

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

Optional CTEN early-tender deadline. If set, must be on or before ResponseDeadlineDate. Used for bond tender offers where early tenders attract a premium.

Optional CTEN early-tender deadline. If set, must be on or before ResponseDeadlineDate. Used for bond tender offers where early tenders attract a premium.

◆ LapseElections

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

List of possible LapseElections for this event. Only 1 should be provided. Allows the user to opt out of the offer.

List of possible LapseElections for this event. Only 1 should be provided. Allows the user to opt out of the offer.

◆ MarketDeadlineDate

DateTimeOffset Lusid.Sdk.Model.RepurchaseOfferEvent.MarketDeadlineDate
getset

Date set by the issuer or by an agent of the issuer as the latest date to respond to the offer. Must be before or equal to the PaymentDate.

Date set by the issuer or by an agent of the issuer as the latest date to respond to the offer. Must be before or equal to the PaymentDate.

◆ MinIncrement

decimal? Lusid.Sdk.Model.RepurchaseOfferEvent.MinIncrement
getset

Bond-specific increment above MinPieceSize. Optional. When set, MinPieceSize must also be set. Must be strictly positive.

Bond-specific increment above MinPieceSize. Optional. When set, MinPieceSize must also be set. Must be strictly positive.

◆ MinPieceSize

decimal? Lusid.Sdk.Model.RepurchaseOfferEvent.MinPieceSize
getset

Bond-specific minimum instructable face amount. Optional. Must be strictly positive when set.

Bond-specific minimum instructable face amount. Optional. Must be strictly positive when set.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.RepurchaseOfferEvent.PaymentDate
getset

Payment date of the event.

Payment date of the event.

◆ ProrationRate

decimal Lusid.Sdk.Model.RepurchaseOfferEvent.ProrationRate
getset

The fraction used to calculate a proportional adjustment for RepurchaseQuantity when a full period is not used. Defaults to 1 if not set. Must be greater than 0 and less than or equal to 1.

The fraction used to calculate a proportional adjustment for RepurchaseQuantity when a full period is not used. Defaults to 1 if not set. Must be greater than 0 and less than or equal to 1.

◆ RepurchaseQuantity

decimal Lusid.Sdk.Model.RepurchaseOfferEvent.RepurchaseQuantity
getset

Quantity of the security to be repurchased.

Quantity of the security to be repurchased.

◆ ResponseDeadlineDate

DateTimeOffset? Lusid.Sdk.Model.RepurchaseOfferEvent.ResponseDeadlineDate
getset

Date set by the account servicer as the latest date to respond to the offer. Optional. If set, must be before or equal to MarketDeadlineDate. Defaults to MarketDeadlineDate if not set.

Date set by the account servicer as the latest date to respond to the offer. Optional. If set, must be before or equal to MarketDeadlineDate. Defaults to MarketDeadlineDate if not set.

◆ TenderOfferElections

List<TenderOfferElection> Lusid.Sdk.Model.RepurchaseOfferEvent.TenderOfferElections
getset

List of possible TenderOfferElections for this event. Only 1 should be provided.

List of possible TenderOfferElections for this event. Only 1 should be provided.


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