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

Class CaEventReorganization

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventReorganization
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventReorganization extends Object implements Serializable
General-purpose corporate restructuring (e.g. Chapter 11 emergence) where existing holders receive a mix of cash and/or one or more replacement securities. Each entry in `stock_movements` describes a separate share-class distribution. Delivered when `event_type == reorganization_corporateaction_event`. Corresponds to `reorganizations` 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

    • CaEventReorganization

      public CaEventReorganization()

  • Method Details

    • id

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

    • cashRate

      public CaEventReorganization cashRate(@Nullable String cashRate)

    • getCashRate

      @Nullable public String getCashRate()
      Cash paid per source share, as a decimal string.
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nullable String cashRate)

    • currency

      public CaEventReorganization 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 CaEventReorganization cusip(@Nonnull String cusip)

    • getCusip

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

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • effectiveDate

      public CaEventReorganization effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      The effective date marks the cutoff point for shareholders to be credited.
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • isin

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

    • payableDate

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

    • stockMovements

      public CaEventReorganization stockMovements(@Nullable List<CaEventReorganizationStockMovement> stockMovements)

    • addStockMovementsItem

      public CaEventReorganization addStockMovementsItem(CaEventReorganizationStockMovement stockMovementsItem)

    • getStockMovements

      @Nullable public List<CaEventReorganizationStockMovement> getStockMovements()
      One entry per replacement security delivered to holders.
      Returns:
      stockMovements

    • setStockMovements

      public void setStockMovements(@Nullable List<CaEventReorganizationStockMovement> stockMovements)

    • symbol

      public CaEventReorganization symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Ticker undergoing the reorganization.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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