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

Class AccountCashInterestPatch

java.lang.Object
markets.alpaca.client.openapi.broker.model.AccountCashInterestPatch
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AccountCashInterestPatch extends Object implements Serializable
Use this property to change the account's configuration for the USD cash interest program. To enroll the account, specify the apr_tier_name. The status should not be specified on enrollment. To change the APR tier, specify the new apr_tier_name. The status should not be specified on tier changes. The unenroll, set the status to INACTIVE. After any change, the response will contain a status of PENDING_CHANGE. An event showing the status change to ACTIVE (for enrollment or tier changes) or INACTIVE (for unenrollment) will be generated when the change is complete.
See Also:

  • Field Details

  • Constructor Details

    • AccountCashInterestPatch

      public AccountCashInterestPatch()

  • Method Details

    • USD

      public AccountCashInterestPatch USD(@Nullable AccountCashInterestProgram USD)

    • getUSD

      @Nullable public AccountCashInterestProgram getUSD()
      Get USD
      Returns:
      USD

    • setUSD

      public void setUSD(@Nullable AccountCashInterestProgram USD)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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