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

Class CaEventSpinOff

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventSpinOff
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventSpinOff extends Object implements Serializable
Spin-off payload delivered when `event_type == spin_off_corporateaction_event`. Corresponds to `spin_offs` 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

    • CaEventSpinOff

      public CaEventSpinOff()

  • Method Details

    • id

      public CaEventSpinOff 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 CaEventSpinOff 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 CaEventSpinOff 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)

    • dueBillRedemptionDate

      public CaEventSpinOff dueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • getDueBillRedemptionDate

      @Nullable public LocalDate getDueBillRedemptionDate()
      The date when due bill obligations are redeemed.
      Returns:
      dueBillRedemptionDate

    • setDueBillRedemptionDate

      public void setDueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • exDate

      public CaEventSpinOff exDate(@Nonnull LocalDate exDate)

    • getExDate

      @Nonnull public LocalDate getExDate()
      The ex-date marks the cutoff point for shareholders to be credited.
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nonnull LocalDate exDate)

    • newCusip

      public CaEventSpinOff newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the new spin-off company.
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newIsin

      public CaEventSpinOff newIsin(@Nullable String newIsin)

    • getNewIsin

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

    • setNewIsin

      public void setNewIsin(@Nullable String newIsin)

    • newRate

      public CaEventSpinOff newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      New-company shares distributed per `source_rate` parent shares, as a decimal string.
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • newSymbol

      public CaEventSpinOff newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Ticker of the new spin-off company.
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • payableDate

      public CaEventSpinOff 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)

    • recordDate

      public CaEventSpinOff 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)

    • sourceCusip

      public CaEventSpinOff sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      Parent CUSIP.
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourceIsin

      public CaEventSpinOff sourceIsin(@Nullable String sourceIsin)

    • getSourceIsin

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

    • setSourceIsin

      public void setSourceIsin(@Nullable String sourceIsin)

    • sourceRate

      public CaEventSpinOff sourceRate(@Nonnull String sourceRate)

    • getSourceRate

      @Nonnull public String getSourceRate()
      Parent shares required per ratio unit, as a decimal string.
      Returns:
      sourceRate

    • setSourceRate

      public void setSourceRate(@Nonnull String sourceRate)

    • sourceSymbol

      public CaEventSpinOff sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Parent company's ticker.
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • putAdditionalProperty

      public CaEventSpinOff 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 CaEventSpinOff 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 CaEventSpinOff

    • fromJson

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

    • toJson

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