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

Class Disclosures

java.lang.Object
markets.alpaca.client.openapi.broker.model.Disclosures
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Disclosures extends Object implements Serializable
Disclosures fields denote if the account owner falls under each category defined by FINRA rule. The client has to ask questions for the end user and the values should reflect their answers. If one of the answers is true (yes), the account goes into ACTION_REQUIRED status.
See Also:

  • Field Details

  • Constructor Details

    • Disclosures

      public Disclosures()

  • Method Details

    • context

      public Disclosures context(@Nullable List<DisclosureContextAnnotation> context)

    • addContextItem

      public Disclosures addContextItem(DisclosureContextAnnotation contextItem)

    • getContext

      @Nullable public List<DisclosureContextAnnotation> getContext()
      Array of annotations describing the rationale for marking `is_control_person`, `is_affiliated_exchange_or_finra`, and/or `immediate_family_exposed` as true
      Returns:
      context

    • setContext

      public void setContext(@Nullable List<DisclosureContextAnnotation> context)

    • employerAddress

      public Disclosures employerAddress(@Nullable String employerAddress)

    • getEmployerAddress

      @Nullable public String getEmployerAddress()
      The employer's address if the user is employed.
      Returns:
      employerAddress

    • setEmployerAddress

      public void setEmployerAddress(@Nullable String employerAddress)

    • employerName

      public Disclosures employerName(@Nullable String employerName)

    • getEmployerName

      @Nullable public String getEmployerName()
      The name of the employer if the user is employed.
      Returns:
      employerName

    • setEmployerName

      public void setEmployerName(@Nullable String employerName)

    • employmentPosition

      public Disclosures employmentPosition(@Nullable String employmentPosition)

    • getEmploymentPosition

      @Nullable public String getEmploymentPosition()
      The user's position if they are employed.
      Returns:
      employmentPosition

    • setEmploymentPosition

      public void setEmploymentPosition(@Nullable String employmentPosition)

    • employmentSector

      public Disclosures employmentSector(@Nullable Disclosures.EmploymentSectorEnum employmentSector)

    • getEmploymentSector

      @Nullable public Disclosures.EmploymentSectorEnum getEmploymentSector()
      The industry sector of employment. If the `employment_status` is `unemployed` or `student`, set this property to `not_employed`. If the `employment_status` is `retired`, set this to `self_employed`.
      Returns:
      employmentSector

    • setEmploymentSector

      public void setEmploymentSector(@Nullable Disclosures.EmploymentSectorEnum employmentSector)

    • employmentStatus

      public Disclosures employmentStatus(@Nullable Disclosures.EmploymentStatusEnum employmentStatus)

    • getEmploymentStatus

      @Nullable public Disclosures.EmploymentStatusEnum getEmploymentStatus()
      One of the following: `employed`, `unemployed`, `retired`, or `student`.
      Returns:
      employmentStatus

    • setEmploymentStatus

      public void setEmploymentStatus(@Nullable Disclosures.EmploymentStatusEnum employmentStatus)

    • immediateFamilyExposed

      public Disclosures immediateFamilyExposed(@Nonnull Boolean immediateFamilyExposed)

    • getImmediateFamilyExposed

      @Nonnull public Boolean getImmediateFamilyExposed()
      If your user's immediate family member (sibling, husband/wife, child, parent) is either politically exposed or holds a control position.
      Returns:
      immediateFamilyExposed

    • setImmediateFamilyExposed

      public void setImmediateFamilyExposed(@Nonnull Boolean immediateFamilyExposed)

    • isAffiliatedExchangeOrFinra

      public Disclosures isAffiliatedExchangeOrFinra(@Nonnull Boolean isAffiliatedExchangeOrFinra)

    • getIsAffiliatedExchangeOrFinra

      @Nonnull public Boolean getIsAffiliatedExchangeOrFinra()
      Whether user is affiliated with any exchanges or FINRA.
      Returns:
      isAffiliatedExchangeOrFinra

    • setIsAffiliatedExchangeOrFinra

      public void setIsAffiliatedExchangeOrFinra(@Nonnull Boolean isAffiliatedExchangeOrFinra)

    • isControlPerson

      public Disclosures isControlPerson(@Nonnull Boolean isControlPerson)

    • getIsControlPerson

      @Nonnull public Boolean getIsControlPerson()
      Whether user holds a controlling position in a publicly traded company, member of the board of directors or has policy making abilities in a publicly traded company.
      Returns:
      isControlPerson

    • setIsControlPerson

      public void setIsControlPerson(@Nonnull Boolean isControlPerson)

    • isPoliticallyExposed

      public Disclosures isPoliticallyExposed(@Nonnull Boolean isPoliticallyExposed)

    • getIsPoliticallyExposed

      @Nonnull public Boolean getIsPoliticallyExposed()
      Whether the user is politically exposed.
      Returns:
      isPoliticallyExposed

    • setIsPoliticallyExposed

      public void setIsPoliticallyExposed(@Nonnull Boolean isPoliticallyExposed)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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