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

Class CaEventStockAndCashMerger

java.lang.Object
markets.alpaca.client.openapi.data.model.CaEventStockAndCashMerger
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CaEventStockAndCashMerger extends Object implements Serializable
Merger paying a mix of stock and cash. Delivered when `event_type == stock_and_cash_merger_corporateaction_event`. Corresponds to `stock_and_cash_mergers` 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

    • CaEventStockAndCashMerger

      public CaEventStockAndCashMerger()

  • Method Details

    • id

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

    • acquireeCusip

      public CaEventStockAndCashMerger acquireeCusip(@Nonnull String acquireeCusip)

    • getAcquireeCusip

      @Nonnull public String getAcquireeCusip()
      CUSIP of the company being bought.
      Returns:
      acquireeCusip

    • setAcquireeCusip

      public void setAcquireeCusip(@Nonnull String acquireeCusip)

    • acquireeIsin

      public CaEventStockAndCashMerger acquireeIsin(@Nullable String acquireeIsin)

    • getAcquireeIsin

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

    • setAcquireeIsin

      public void setAcquireeIsin(@Nullable String acquireeIsin)

    • acquireeRate

      public CaEventStockAndCashMerger acquireeRate(@Nonnull String acquireeRate)

    • getAcquireeRate

      @Nonnull public String getAcquireeRate()
      Bought-side ratio, as a decimal string.
      Returns:
      acquireeRate

    • setAcquireeRate

      public void setAcquireeRate(@Nonnull String acquireeRate)

    • acquireeSymbol

      public CaEventStockAndCashMerger acquireeSymbol(@Nonnull String acquireeSymbol)

    • getAcquireeSymbol

      @Nonnull public String getAcquireeSymbol()
      Ticker being bought (will disappear).
      Returns:
      acquireeSymbol

    • setAcquireeSymbol

      public void setAcquireeSymbol(@Nonnull String acquireeSymbol)

    • acquirerCusip

      public CaEventStockAndCashMerger acquirerCusip(@Nonnull String acquirerCusip)

    • getAcquirerCusip

      @Nonnull public String getAcquirerCusip()
      Buyer's CUSIP.
      Returns:
      acquirerCusip

    • setAcquirerCusip

      public void setAcquirerCusip(@Nonnull String acquirerCusip)

    • acquirerIsin

      public CaEventStockAndCashMerger acquirerIsin(@Nullable String acquirerIsin)

    • getAcquirerIsin

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

    • setAcquirerIsin

      public void setAcquirerIsin(@Nullable String acquirerIsin)

    • acquirerRate

      public CaEventStockAndCashMerger acquirerRate(@Nonnull String acquirerRate)

    • getAcquirerRate

      @Nonnull public String getAcquirerRate()
      Buyer shares given per unit ratio, as a decimal string.
      Returns:
      acquirerRate

    • setAcquirerRate

      public void setAcquirerRate(@Nonnull String acquirerRate)

    • acquirerSymbol

      public CaEventStockAndCashMerger acquirerSymbol(@Nonnull String acquirerSymbol)

    • getAcquirerSymbol

      @Nonnull public String getAcquirerSymbol()
      Buyer's ticker (the surviving company).
      Returns:
      acquirerSymbol

    • setAcquirerSymbol

      public void setAcquirerSymbol(@Nonnull String acquirerSymbol)

    • cashRate

      public CaEventStockAndCashMerger cashRate(@Nonnull String cashRate)

    • getCashRate

      @Nonnull public String getCashRate()
      Extra cash paid per share of the acquired company, as a decimal string.
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nonnull String cashRate)

    • currency

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

    • effectiveDate

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

    • payableDate

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

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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