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

Class AccountCashInterestProgram

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

  • Field Details

  • Constructor Details

    • AccountCashInterestProgram

      public AccountCashInterestProgram()

  • Method Details

    • aprTierName

      public AccountCashInterestProgram aprTierName(@Nullable String aprTierName)

    • getAprTierName

      @Nullable public String getAprTierName()
      The unique name of the APR tier for a specific program
      Returns:
      aprTierName

    • setAprTierName

      public void setAprTierName(@Nullable String aprTierName)

    • status

      public AccountCashInterestProgram status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      The status of the account within a cash interest program. One of: - **ACTIVE** The account is enrolled and eligible for idle cash to be swept at the end of day (EOD). - **INACTIVE** The account is not enrolled due to it either not being eligible (e.g. the updated Alpaca Customer Agreement has not been signed), an APR tier needs to be assigned, or they have been unenrolled. - **PENDING_CHANGE** An enrollment, APR Tier change, or unenrollment is in progress
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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