Package markets.alpaca.client.openapi.broker.model

Class OpcaSPINActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.OpcaSPINActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OpcaSPINActivityV2 extends Object implements Serializable
Options corporate action of spin-offs
See Also:

  • Field Details

  • Constructor Details

    • OpcaSPINActivityV2

      public OpcaSPINActivityV2()

  • Method Details

    • groupId

      public OpcaSPINActivityV2 groupId(@Nullable UUID groupId)

    • getGroupId

      @Nullable public UUID getGroupId()
      Optional group ID which can help grouping together related activities
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable UUID groupId)

    • systemDate

      public OpcaSPINActivityV2 systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      The date when the activity was booked
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • caId

      public OpcaSPINActivityV2 caId(@Nullable UUID caId)

    • getCaId

      @Nullable public UUID getCaId()
      The unique identifier for this corporate action
      Returns:
      caId

    • setCaId

      public void setCaId(@Nullable UUID caId)

    • positionDate

      public OpcaSPINActivityV2 positionDate(@Nonnull LocalDate positionDate)

    • getPositionDate

      @Nonnull public LocalDate getPositionDate()
      The position_date for this corporate action
      Returns:
      positionDate

    • setPositionDate

      public void setPositionDate(@Nonnull LocalDate positionDate)

    • reorgId

      public OpcaSPINActivityV2 reorgId(@Nullable String reorgId)

    • getReorgId

      @Nullable public String getReorgId()
      The reorg identifier, if present in the source corporate action definition
      Returns:
      reorgId

    • setReorgId

      public void setReorgId(@Nullable String reorgId)

    • newContractSymbol

      public OpcaSPINActivityV2 newContractSymbol(@Nonnull String newContractSymbol)

    • getNewContractSymbol

      @Nonnull public String getNewContractSymbol()
      The new contract symbol
      Returns:
      newContractSymbol

    • setNewContractSymbol

      public void setNewContractSymbol(@Nonnull String newContractSymbol)

    • newQty

      public OpcaSPINActivityV2 newQty(@Nullable String newQty)

    • getNewQty

      @Nullable public String getNewQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      newQty

    • setNewQty

      public void setNewQty(@Nullable String newQty)

    • oldContractSymbol

      public OpcaSPINActivityV2 oldContractSymbol(@Nonnull String oldContractSymbol)

    • getOldContractSymbol

      @Nonnull public String getOldContractSymbol()
      The old contract symbol
      Returns:
      oldContractSymbol

    • setOldContractSymbol

      public void setOldContractSymbol(@Nonnull String oldContractSymbol)

    • oldQty

      public OpcaSPINActivityV2 oldQty(@Nullable String oldQty)

    • getOldQty

      @Nullable public String getOldQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      oldQty

    • setOldQty

      public void setOldQty(@Nullable String oldQty)

    • qty

      public OpcaSPINActivityV2 qty(@Nullable String qty)

    • getQty

      @Nullable public String getQty()
      used when the old contract's quantity is equal to the new contract's quantity. Mutually exclusive with 'old_qty' and 'new_qty'
      Returns:
      qty

    • setQty

      public void setQty(@Nullable String qty)

    • dueBillRedemptionDate

      public OpcaSPINActivityV2 dueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • getDueBillRedemptionDate

      @Nullable public LocalDate getDueBillRedemptionDate()
      When due bills related to the spinoff are redeemed
      Returns:
      dueBillRedemptionDate

    • setDueBillRedemptionDate

      public void setDueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • exDate

      public OpcaSPINActivityV2 exDate(@Nullable LocalDate exDate)

    • getExDate

      @Nullable public LocalDate getExDate()
      The ex_date for this corporate action
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nullable LocalDate exDate)

    • newCusip

      public OpcaSPINActivityV2 newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the new security
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newPrice

      public OpcaSPINActivityV2 newPrice(@Nonnull String newPrice)

    • getNewPrice

      @Nonnull public String getNewPrice()
      Market price of new shares after the spinoff
      Returns:
      newPrice

    • setNewPrice

      public void setNewPrice(@Nonnull String newPrice)

    • newRate

      public OpcaSPINActivityV2 newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      Ratio of new shares received
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • newSymbol

      public OpcaSPINActivityV2 newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Symbol of the new security
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • payableDate

      public OpcaSPINActivityV2 payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

      @Nullable public LocalDate getPayableDate()
      The payable_date for this corporate action
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • recordDate

      public OpcaSPINActivityV2 recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The record_date for this corporate action
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • sourceCusip

      public OpcaSPINActivityV2 sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      CUSIP of the parent security
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourcePrice

      public OpcaSPINActivityV2 sourcePrice(@Nonnull String sourcePrice)

    • getSourcePrice

      @Nonnull public String getSourcePrice()
      Market price of parent shares before the spinoff
      Returns:
      sourcePrice

    • setSourcePrice

      public void setSourcePrice(@Nonnull String sourcePrice)

    • sourceRate

      public OpcaSPINActivityV2 sourceRate(@Nonnull String sourceRate)

    • getSourceRate

      @Nonnull public String getSourceRate()
      Ratio of parent shares
      Returns:
      sourceRate

    • setSourceRate

      public void setSourceRate(@Nonnull String sourceRate)

    • sourceSymbol

      public OpcaSPINActivityV2 sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Symbol of the parent security
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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