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

Class DisclosureContextAnnotation

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

  • Field Details

  • Constructor Details

    • DisclosureContextAnnotation

      public DisclosureContextAnnotation()

  • Method Details

    • companyCity

      public DisclosureContextAnnotation companyCity(@Nullable String companyCity)

    • getCompanyCity

      @Nullable public String getCompanyCity()
      Required for FINRA affiliations and controlled firms.
      Returns:
      companyCity

    • setCompanyCity

      public void setCompanyCity(@Nullable String companyCity)

    • companyComplianceEmail

      public DisclosureContextAnnotation companyComplianceEmail(@Nullable String companyComplianceEmail)

    • getCompanyComplianceEmail

      @Nullable public String getCompanyComplianceEmail()
      Required for FINRA affiliations and controlled firms.
      Returns:
      companyComplianceEmail

    • setCompanyComplianceEmail

      public void setCompanyComplianceEmail(@Nullable String companyComplianceEmail)

    • companyCountry

      public DisclosureContextAnnotation companyCountry(@Nullable String companyCountry)

    • getCompanyCountry

      @Nullable public String getCompanyCountry()
      Required for FINRA affiliations and controlled firms.
      Returns:
      companyCountry

    • setCompanyCountry

      public void setCompanyCountry(@Nullable String companyCountry)

    • companyName

      public DisclosureContextAnnotation companyName(@Nullable String companyName)

    • getCompanyName

      @Nullable public String getCompanyName()
      Required for FINRA affiliations and controlled firms.
      Returns:
      companyName

    • setCompanyName

      public void setCompanyName(@Nullable String companyName)

    • companyState

      public DisclosureContextAnnotation companyState(@Nullable String companyState)

    • getCompanyState

      @Nullable public String getCompanyState()
      Required if and only if `company_country` is `USA`.
      Returns:
      companyState

    • setCompanyState

      public void setCompanyState(@Nullable String companyState)

    • companyStreetAddress

      public DisclosureContextAnnotation companyStreetAddress(@Nullable String companyStreetAddress)

    • getCompanyStreetAddress

      @Nullable public String getCompanyStreetAddress()
      Required for FINRA affiliations and controlled firms.
      Returns:
      companyStreetAddress

    • setCompanyStreetAddress

      public void setCompanyStreetAddress(@Nullable String companyStreetAddress)

    • contextType

      public DisclosureContextAnnotation contextType(@Nonnull DisclosureContextAnnotation.ContextTypeEnum contextType)

    • getContextType

      @Nonnull public DisclosureContextAnnotation.ContextTypeEnum getContextType()
      Specifies the type of disclosure annotation. Valid types are FINRA affiliations, for users affiliated with or employed by a FINRA member firm, a Stock Exchange Member, FINRA, Registered Investment Advisor, or a Municipal Securities Broker/Dealer; Company control relationships, for senior executives, and 10% or greater shareholders, of a publicly traded company; and immediate family members of politically exposed individuals.
      Returns:
      contextType

    • setContextType

      public void setContextType(@Nonnull DisclosureContextAnnotation.ContextTypeEnum contextType)

    • familyName

      public DisclosureContextAnnotation familyName(@Nullable String familyName)

    • getFamilyName

      @Nullable public String getFamilyName()
      Required for immediate family members of politically exposed persons.
      Returns:
      familyName

    • setFamilyName

      public void setFamilyName(@Nullable String familyName)

    • givenName

      public DisclosureContextAnnotation givenName(@Nullable String givenName)

    • getGivenName

      @Nullable public String getGivenName()
      Required for immediate family members of politically exposed persons.
      Returns:
      givenName

    • setGivenName

      public void setGivenName(@Nullable String givenName)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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