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

Class AccountUpdateRequest

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

  • Field Details

  • Constructor Details

    • AccountUpdateRequest

      public AccountUpdateRequest()

  • Method Details

    • agreements

      public AccountUpdateRequest agreements(@Nullable List<Agreement> agreements)

    • addAgreementsItem

      public AccountUpdateRequest addAgreementsItem(Agreement agreementsItem)

    • getAgreements

      @Nullable public List<Agreement> getAgreements()
      Additional agreements, or new revisions of existing agreements, read and signed by the account holder.
      Returns:
      agreements

    • setAgreements

      public void setAgreements(@Nullable List<Agreement> agreements)

    • allowInstantAch

      public AccountUpdateRequest allowInstantAch(@Nullable Boolean allowInstantAch)

    • getAllowInstantAch

      @Nullable public Boolean getAllowInstantAch()
      If provided, updates whether the account is enabled for Instant ACH by the partner. Omitting the field leaves the current setting unchanged.
      Returns:
      allowInstantAch

    • setAllowInstantAch

      public void setAllowInstantAch(@Nullable Boolean allowInstantAch)

    • beneficiaries

      public AccountUpdateRequest beneficiaries(@Nullable List<Beneficiary> beneficiaries)

    • addBeneficiariesItem

      public AccountUpdateRequest addBeneficiariesItem(Beneficiary beneficiariesItem)

    • getBeneficiaries

      @Nullable public List<Beneficiary> getBeneficiaries()
      Get beneficiaries
      Returns:
      beneficiaries

    • setBeneficiaries

      public void setBeneficiaries(@Nullable List<Beneficiary> beneficiaries)

    • cashInterest

      public AccountUpdateRequest cashInterest(@Nullable AccountCashInterestPatch cashInterest)

    • getCashInterest

      @Nullable public AccountCashInterestPatch getCashInterest()
      Get cashInterest
      Returns:
      cashInterest

    • setCashInterest

      public void setCashInterest(@Nullable AccountCashInterestPatch cashInterest)

    • contact

      public AccountUpdateRequest contact(@Nullable Contact contact)

    • getContact

      @Nullable public Contact getContact()
      Get contact
      Returns:
      contact

    • setContact

      public void setContact(@Nullable Contact contact)

    • disclosures

      public AccountUpdateRequest disclosures(@Nullable Disclosures disclosures)

    • getDisclosures

      @Nullable public Disclosures getDisclosures()
      Get disclosures
      Returns:
      disclosures

    • setDisclosures

      public void setDisclosures(@Nullable Disclosures disclosures)

    • enabledAssets

      public AccountUpdateRequest enabledAssets(@Nullable List<EnabledAssetClass> enabledAssets)

    • addEnabledAssetsItem

      public AccountUpdateRequest addEnabledAssetsItem(EnabledAssetClass enabledAssetsItem)

    • getEnabledAssets

      @Nullable public List<EnabledAssetClass> getEnabledAssets()
      The asset classes enabled on the account. Omit this field to leave the account's enabled assets unchanged. Updates are additive only: the submitted list must contain every asset class already enabled on the account, because asset removal is not supported. For example, to enable crypto for an account that currently trades only equities, submit `[\"us_equity\", \"crypto\"]` together with the signed crypto agreement. `us_option` may appear in this list for options-enabled accounts and must be re-listed on additive updates, but options cannot be enabled through this endpoint.
      Returns:
      enabledAssets

    • setEnabledAssets

      public void setEnabledAssets(@Nullable List<EnabledAssetClass> enabledAssets)

    • fpsl

      public AccountUpdateRequest fpsl(@Nullable AccountFPSLPatch fpsl)

    • getFpsl

      @Nullable public AccountFPSLPatch getFpsl()
      Get fpsl
      Returns:
      fpsl

    • setFpsl

      public void setFpsl(@Nullable AccountFPSLPatch fpsl)

    • identity

      public AccountUpdateRequest identity(@Nullable Identity identity)

    • getIdentity

      @Nullable public Identity getIdentity()
      Get identity
      Returns:
      identity

    • setIdentity

      public void setIdentity(@Nullable Identity identity)

    • primaryAccountHolderId

      public AccountUpdateRequest primaryAccountHolderId(@Nullable UUID primaryAccountHolderId)

    • getPrimaryAccountHolderId

      @Nullable public UUID getPrimaryAccountHolderId()
      The UUID of the primary account holder. This field is immutable after the account is created. - Omitting the field, or supplying the value already associated with the account, is a no-op. - Supplying a value different from the current primary account holder returns HTTP 403.
      Returns:
      primaryAccountHolderId

    • setPrimaryAccountHolderId

      public void setPrimaryAccountHolderId(@Nullable UUID primaryAccountHolderId)

    • trustedContact

      public AccountUpdateRequest trustedContact(@Nullable TrustedContact trustedContact)

    • getTrustedContact

      @Nullable public TrustedContact getTrustedContact()
      Get trustedContact
      Returns:
      trustedContact

    • setTrustedContact

      public void setTrustedContact(@Nullable TrustedContact trustedContact)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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