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

Class TrustedContact

java.lang.Object
markets.alpaca.client.openapi.broker.model.TrustedContact
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class TrustedContact extends Object implements Serializable
This model input is optional. However, the client should make reasonable effort to obtain the trusted contact information. See more details in [FINRA Notice 17-11](https://www.finra.org/sites/default/files/Regulatory-Notice-17-11.pdf) Only one of the following is required: * email_address * phone_number * street_address
See Also:

  • Field Details

  • Constructor Details

    • TrustedContact

      public TrustedContact()

  • Method Details

    • city

      public TrustedContact city(@Nullable String city)

    • getCity

      @Nullable public String getCity()
      required if `street_address` is set
      Returns:
      city

    • setCity

      public void setCity(@Nullable String city)

    • country

      public TrustedContact country(@Nullable String country)

    • getCountry

      @Nullable public String getCountry()
      [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html). required if `street_address` is set
      Returns:
      country

    • setCountry

      public void setCountry(@Nullable String country)

    • emailAddress

      public TrustedContact emailAddress(@Nullable String emailAddress)

    • getEmailAddress

      @Nullable public String getEmailAddress()
      at least one of `email_address`, `phone_number` or `street_address` is required
      Returns:
      emailAddress

    • setEmailAddress

      public void setEmailAddress(@Nullable String emailAddress)

    • familyName

      public TrustedContact familyName(@Nonnull String familyName)

    • getFamilyName

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

    • setFamilyName

      public void setFamilyName(@Nonnull String familyName)

    • givenName

      public TrustedContact givenName(@Nonnull String givenName)

    • getGivenName

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

    • setGivenName

      public void setGivenName(@Nonnull String givenName)

    • phoneNumber

      public TrustedContact phoneNumber(@Nullable String phoneNumber)

    • getPhoneNumber

      @Nullable public String getPhoneNumber()
      at least one of `email_address`, `phone_number` or `street_address` is required
      Returns:
      phoneNumber

    • setPhoneNumber

      public void setPhoneNumber(@Nullable String phoneNumber)

    • postalCode

      public TrustedContact postalCode(@Nullable String postalCode)

    • getPostalCode

      @Nullable public String getPostalCode()
      required if `street_address` is set
      Returns:
      postalCode

    • setPostalCode

      public void setPostalCode(@Nullable String postalCode)

    • state

      public TrustedContact state(@Nullable String state)

    • getState

      @Nullable public String getState()
      required if `street_address` is set
      Returns:
      state

    • setState

      public void setState(@Nullable String state)

    • streetAddress

      public TrustedContact streetAddress(@Nullable List<String> streetAddress)

    • addStreetAddressItem

      public TrustedContact addStreetAddressItem(String streetAddressItem)

    • getStreetAddress

      @Nullable public List<String> getStreetAddress()
      at least one of `email_address`, `phone_number` or `street_address` is required
      Returns:
      streetAddress

    • setStreetAddress

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

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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