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

Class Beneficiary

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

  • Field Details

  • Constructor Details

    • Beneficiary

      public Beneficiary()

  • Method Details

    • dateOfBirth

      public Beneficiary dateOfBirth(@Nonnull String dateOfBirth)

    • getDateOfBirth

      @Nonnull public String getDateOfBirth()
      Get dateOfBirth
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nonnull String dateOfBirth)

    • familyName

      public Beneficiary familyName(@Nonnull String familyName)

    • getFamilyName

      @Nonnull public String getFamilyName()
      Get familyName
      Returns:
      familyName

    • setFamilyName

      public void setFamilyName(@Nonnull String familyName)

    • givenName

      public Beneficiary givenName(@Nonnull String givenName)

    • getGivenName

      @Nonnull public String getGivenName()
      Get givenName
      Returns:
      givenName

    • setGivenName

      public void setGivenName(@Nonnull String givenName)

    • middleName

      public Beneficiary middleName(@Nonnull String middleName)

    • getMiddleName

      @Nonnull public String getMiddleName()
      Get middleName
      Returns:
      middleName

    • setMiddleName

      public void setMiddleName(@Nonnull String middleName)

    • relationship

      public Beneficiary relationship(@Nonnull String relationship)

    • getRelationship

      @Nonnull public String getRelationship()
      Get relationship
      Returns:
      relationship

    • setRelationship

      public void setRelationship(@Nonnull String relationship)

    • sharePct

      public Beneficiary sharePct(@Nonnull String sharePct)

    • getSharePct

      @Nonnull public String getSharePct()
      Get sharePct
      Returns:
      sharePct

    • setSharePct

      public void setSharePct(@Nonnull String sharePct)

    • taxId

      public Beneficiary taxId(@Nonnull String taxId)

    • getTaxId

      @Nonnull public String getTaxId()
      Get taxId
      Returns:
      taxId

    • setTaxId

      public void setTaxId(@Nonnull String taxId)

    • taxIdType

      public Beneficiary taxIdType(@Nonnull String taxIdType)

    • getTaxIdType

      @Nonnull public String getTaxIdType()
      Get taxIdType
      Returns:
      taxIdType

    • setTaxIdType

      public void setTaxIdType(@Nonnull String taxIdType)

    • type

      public Beneficiary type(@Nonnull String type)

    • getType

      @Nonnull public String getType()
      Get type
      Returns:
      type

    • setType

      public void setType(@Nonnull String type)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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