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

Class CIPWatchlist

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPWatchlist
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPWatchlist extends Object implements Serializable
Represents the result of checking to see if the applicant is in any watchlists for a CIPInfo
See Also:

  • Field Details

  • Constructor Details

    • CIPWatchlist

      public CIPWatchlist()

  • Method Details

    • adverseMedia

      public CIPWatchlist adverseMedia(@Nullable String adverseMedia)

    • getAdverseMedia

      @Nullable public String getAdverseMedia()
      The result of the check. Either `clear` or `consider`.
      Returns:
      adverseMedia

    • setAdverseMedia

      public void setAdverseMedia(@Nullable String adverseMedia)

    • createdAt

      public CIPWatchlist createdAt(@Nullable String createdAt)

    • getCreatedAt

      @Nullable public String getCreatedAt()
      datetime when check happened
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)

    • id

      public CIPWatchlist id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Your internal ID of check
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • monitoredLists

      public CIPWatchlist monitoredLists(@Nullable String monitoredLists)

    • getMonitoredLists

      @Nullable public String getMonitoredLists()
      The result of the check. Either `clear` or `consider`.
      Returns:
      monitoredLists

    • setMonitoredLists

      public void setMonitoredLists(@Nullable String monitoredLists)

    • politicallyExposedPerson

      public CIPWatchlist politicallyExposedPerson(@Nullable String politicallyExposedPerson)

    • getPoliticallyExposedPerson

      @Nullable public String getPoliticallyExposedPerson()
      The result of the check. Either `clear` or `consider`.
      Returns:
      politicallyExposedPerson

    • setPoliticallyExposedPerson

      public void setPoliticallyExposedPerson(@Nullable String politicallyExposedPerson)

    • records

      public CIPWatchlist records(@Nullable String records)

    • getRecords

      @Nullable public String getRecords()
      a json object. Example [{\"text\": \"Record info\"}]
      Returns:
      records

    • setRecords

      public void setRecords(@Nullable String records)

    • result

      public CIPWatchlist result(@Nullable String result)

    • getResult

      @Nullable public String getResult()
      The result of the check. Either `clear` or `consider`.
      Returns:
      result

    • setResult

      public void setResult(@Nullable String result)

    • sanction

      public CIPWatchlist sanction(@Nullable String sanction)

    • getSanction

      @Nullable public String getSanction()
      The result of the check. Either `clear` or `consider`.
      Returns:
      sanction

    • setSanction

      public void setSanction(@Nullable String sanction)

    • status

      public CIPWatchlist status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      An enum representing the status of the CIPInfo \"complete\" \"withdrawn\"
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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