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

Class CIPInfo

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPInfo
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPInfo extends Object implements Serializable
Customer Identification Program (CIP) information for an account applicant.
See Also:

  • Field Details

  • Constructor Details

    • CIPInfo

      public CIPInfo()

  • Method Details

    • accountId

      public CIPInfo accountId(@Nullable UUID accountId)

    • getAccountId

      @Nullable public UUID getAccountId()
      UUID of the Account instance this CIPInfo is for
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nullable UUID accountId)

    • createdAt

      public CIPInfo createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • document

      public CIPInfo document(@Nullable CIPDocument document)

    • getDocument

      @Nullable public CIPDocument getDocument()
      Get document
      Returns:
      document

    • setDocument

      public void setDocument(@Nullable CIPDocument document)

    • id

      public CIPInfo id(@Nullable UUID id)

    • getId

      @Nullable public UUID getId()
      ID of this CIPInfo
      Returns:
      id

    • setId

      public void setId(@Nullable UUID id)

    • identity

      public CIPInfo identity(@Nullable CIPIdentity identity)

    • getIdentity

      @Nullable public CIPIdentity getIdentity()
      Get identity
      Returns:
      identity

    • setIdentity

      public void setIdentity(@Nullable CIPIdentity identity)

    • kyc

      public CIPInfo kyc(@Nullable CIPKYC kyc)

    • getKyc

      @Nullable public CIPKYC getKyc()
      Get kyc
      Returns:
      kyc

    • setKyc

      public void setKyc(@Nullable CIPKYC kyc)

    • photo

      public CIPInfo photo(@Nullable CIPPhoto photo)

    • getPhoto

      @Nullable public CIPPhoto getPhoto()
      Get photo
      Returns:
      photo

    • setPhoto

      public void setPhoto(@Nullable CIPPhoto photo)

    • providerName

      public CIPInfo providerName(@Nullable List<String> providerName)

    • addProviderNameItem

      public CIPInfo addProviderNameItem(String providerNameItem)

    • getProviderName

      @Nullable public List<String> getProviderName()
      List of KYC providers this information came from
      Returns:
      providerName

    • setProviderName

      public void setProviderName(@Nullable List<String> providerName)

    • updatedAt

      public CIPInfo updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • watchlist

      public CIPInfo watchlist(@Nullable CIPWatchlist watchlist)

    • getWatchlist

      @Nullable public CIPWatchlist getWatchlist()
      Get watchlist
      Returns:
      watchlist

    • setWatchlist

      public void setWatchlist(@Nullable CIPWatchlist watchlist)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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