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

Class Contact

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

  • Field Details

  • Constructor Details

    • Contact

      public Contact()

  • Method Details

    • city

      public Contact city(@Nonnull String city)

    • getCity

      @Nonnull public String getCity()
      Get city
      Returns:
      city

    • setCity

      public void setCity(@Nonnull String city)

    • country

      public Contact country(@Nullable String country)

    • getCountry

      @Nullable public String getCountry()
      country code in ISO 3166-1 alpha-3 format, representing the country the person/entity resides in.
      Returns:
      country

    • setCountry

      public void setCountry(@Nullable String country)

    • emailAddress

      public Contact emailAddress(@Nonnull String emailAddress)

    • getEmailAddress

      @Nonnull public String getEmailAddress()
      Get emailAddress
      Returns:
      emailAddress

    • setEmailAddress

      public void setEmailAddress(@Nonnull String emailAddress)

    • phoneNumber

      public Contact phoneNumber(@Nonnull String phoneNumber)

    • getPhoneNumber

      @Nonnull public String getPhoneNumber()
      Phone number should include the country code, format: \"+15555555555\"
      Returns:
      phoneNumber

    • setPhoneNumber

      public void setPhoneNumber(@Nonnull String phoneNumber)

    • postalCode

      public Contact postalCode(@Nullable String postalCode)

    • getPostalCode

      @Nullable public String getPostalCode()
      Get postalCode
      Returns:
      postalCode

    • setPostalCode

      public void setPostalCode(@Nullable String postalCode)

    • state

      public Contact state(@Nullable String state)

    • getState

      @Nullable public String getState()
      Required if the country or country_of_tax_residence (in the identity model below) is 'USA'.
      Returns:
      state

    • setState

      public void setState(@Nullable String state)

    • streetAddress

      public Contact streetAddress(@Nonnull List<String> streetAddress)

    • addStreetAddressItem

      public Contact addStreetAddressItem(String streetAddressItem)

    • getStreetAddress

      @Nonnull public List<String> getStreetAddress()
      The user's street address. If multiple lines in address, pass in as additional array elements. Maximum of 3 objects in array
      Returns:
      streetAddress

    • setStreetAddress

      public void setStreetAddress(@Nonnull List<String> streetAddress)

    • unit

      public Contact unit(@Nullable String unit)

    • getUnit

      @Nullable public String getUnit()
      The specific apartment number if applicable
      Returns:
      unit

    • setUnit

      public void setUnit(@Nullable String unit)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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