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

Class AccountCashInterestEvent

java.lang.Object
markets.alpaca.client.openapi.broker.model.AccountCashInterestEvent
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AccountCashInterestEvent extends Object implements Serializable
This property is included when the account's cash interest program had changed due to an enrollment, APR tier change, or unenrollment. The from and to status or APR tier name will be included in the event, depending on the change.
See Also:

  • Field Details

  • Constructor Details

    • AccountCashInterestEvent

      public AccountCashInterestEvent()

  • Method Details

    • aprTierNameFrom

      public AccountCashInterestEvent aprTierNameFrom(@Nullable String aprTierNameFrom)

    • getAprTierNameFrom

      @Nullable public String getAprTierNameFrom()
      The APR tier name before the change
      Returns:
      aprTierNameFrom

    • setAprTierNameFrom

      public void setAprTierNameFrom(@Nullable String aprTierNameFrom)

    • aprTierNameTo

      public AccountCashInterestEvent aprTierNameTo(@Nullable String aprTierNameTo)

    • getAprTierNameTo

      @Nullable public String getAprTierNameTo()
      The APR tier name after the change
      Returns:
      aprTierNameTo

    • setAprTierNameTo

      public void setAprTierNameTo(@Nullable String aprTierNameTo)

    • currency

      public AccountCashInterestEvent currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The currency of the cash interest program that changed.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • statusFrom

      public AccountCashInterestEvent statusFrom(@Nullable String statusFrom)

    • getStatusFrom

      @Nullable public String getStatusFrom()
      The cash_interest program status of the account before the change
      Returns:
      statusFrom

    • setStatusFrom

      public void setStatusFrom(@Nullable String statusFrom)

    • statusTo

      public AccountCashInterestEvent statusTo(@Nullable String statusTo)

    • getStatusTo

      @Nullable public String getStatusTo()
      The cash_interest program status of the account after the change
      Returns:
      statusTo

    • setStatusTo

      public void setStatusTo(@Nullable String statusTo)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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