Package markets.alpaca.client.openapi.data.model

Class CaEventEquityPartialCall

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventEquityPartialCall
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventEquityPartialCall extends Object implements Serializable
Partial redemption of an equity issue where the issuer calls back only a fraction of outstanding shares -- typically allocated to holders via a lottery. Delivered when `event_type == equity_partial_call_corporateaction_event`. Corresponds to `partial_calls` on the REST [`GET /v1/corporate-actions`](#operation/CorporateActions) response, but every decimal field is emitted as a JSON string to preserve precision on the wire.
See Also:

  • Field Details

  • Constructor Details

    • CaEventEquityPartialCall

      public CaEventEquityPartialCall()

  • Method Details

    • id

      public CaEventEquityPartialCall id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The internal Alpaca identifier of the corporate action.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • processDate

      public CaEventEquityPartialCall processDate(@Nonnull LocalDate processDate)

    • getProcessDate

      @Nonnull public LocalDate getProcessDate()
      The date when the corporate action is processed by Alpaca.
      Returns:
      processDate

    • setProcessDate

      public void setProcessDate(@Nonnull LocalDate processDate)

    • currency

      public CaEventEquityPartialCall currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The ISO 4217 currency code associated with the corporate action. Empty value can mean USD, non-applicable (e.g. for name changes) or unknown (can change later to a valid currency).
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • cusip

      public CaEventEquityPartialCall cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      CUSIP of the security.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • dividendRate

      public CaEventEquityPartialCall dividendRate(@Nullable String dividendRate)

    • getDividendRate

      @Nullable public String getDividendRate()
      Dividend rate associated with the called shares, as a decimal string.
      Returns:
      dividendRate

    • setDividendRate

      public void setDividendRate(@Nullable String dividendRate)

    • isin

      public CaEventEquityPartialCall isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      International Securities Identification Number (ISIN) as defined by ISO 6166. May be empty for US corporate actions.
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • lotteryDate

      public CaEventEquityPartialCall lotteryDate(@Nullable LocalDate lotteryDate)

    • getLotteryDate

      @Nullable public LocalDate getLotteryDate()
      When the lottery drawing happens.
      Returns:
      lotteryDate

    • setLotteryDate

      public void setLotteryDate(@Nullable LocalDate lotteryDate)

    • lotteryType

      public CaEventEquityPartialCall lotteryType(@Nullable CaEventEquityPartialCall.LotteryTypeEnum lotteryType)

    • getLotteryType

      @Nullable public CaEventEquityPartialCall.LotteryTypeEnum getLotteryType()
      How called shares were allocated among holders.
      Returns:
      lotteryType

    • setLotteryType

      public void setLotteryType(@Nullable CaEventEquityPartialCall.LotteryTypeEnum lotteryType)

    • payableDate

      public CaEventEquityPartialCall payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

      @Nullable public LocalDate getPayableDate()
      The date when the corporate action benefit is paid or distributed.
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • price

      public CaEventEquityPartialCall price(@Nullable String price)

    • getPrice

      @Nullable public String getPrice()
      Price paid per called share, as a decimal string.
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable String price)

    • recordDate

      public CaEventEquityPartialCall recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The date shareholders must own shares to receive the benefit.
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • resultsPublicationDate

      public CaEventEquityPartialCall resultsPublicationDate(@Nullable LocalDate resultsPublicationDate)

    • getResultsPublicationDate

      @Nullable public LocalDate getResultsPublicationDate()
      When the lottery results are published.
      Returns:
      resultsPublicationDate

    • setResultsPublicationDate

      public void setResultsPublicationDate(@Nullable LocalDate resultsPublicationDate)

    • symbol

      public CaEventEquityPartialCall symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Ticker being partially called.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

      public CaEventEquityPartialCall putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the CaEventEquityPartialCall instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to CaEventEquityPartialCall

    • fromJson

      public static CaEventEquityPartialCall fromJson(String jsonString) throws IOException
      Create an instance of CaEventEquityPartialCall given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of CaEventEquityPartialCall
      Throws:
      IOException - if the JSON string is invalid with respect to CaEventEquityPartialCall

    • toJson

      public String toJson()
      Convert an instance of CaEventEquityPartialCall to an JSON string
      Returns:
      JSON string