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

Class OwnerDocumentUploadRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.OwnerDocumentUploadRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OwnerDocumentUploadRequest extends Object implements Serializable
The request to upload a document for an owner of the account
See Also:

  • Field Details

  • Constructor Details

    • OwnerDocumentUploadRequest

      public OwnerDocumentUploadRequest()

  • Method Details

    • content

      public OwnerDocumentUploadRequest content(@Nonnull String content)

    • getContent

      @Nonnull public String getContent()
      The base64 string encoding of the document contents. This property is required unless content_data is provided.
      Returns:
      content

    • setContent

      public void setContent(@Nonnull String content)

    • contentData

      public OwnerDocumentUploadRequest contentData(@Nullable W8benDocument contentData)

    • getContentData

      @Nullable public W8benDocument getContentData()
      Get contentData
      Returns:
      contentData

    • setContentData

      public void setContentData(@Nullable W8benDocument contentData)

    • documentSubType

      public OwnerDocumentUploadRequest documentSubType(@Nullable String documentSubType)

    • getDocumentSubType

      @Nullable public String getDocumentSubType()
      The specific type of document, e.g. passport. This is a free-form property.
      Returns:
      documentSubType

    • setDocumentSubType

      public void setDocumentSubType(@Nullable String documentSubType)

    • documentType

      public OwnerDocumentUploadRequest documentType(@Nonnull OwnerDocumentType documentType)

    • getDocumentType

      @Nonnull public OwnerDocumentType getDocumentType()
      Get documentType
      Returns:
      documentType

    • setDocumentType

      public void setDocumentType(@Nonnull OwnerDocumentType documentType)

    • mimeType

      public OwnerDocumentUploadRequest mimeType(@Nullable String mimeType)

    • getMimeType

      @Nullable public String getMimeType()
      This field is required if content is specified. ENUM: application/pdf, image/png, or image/jpeg. If document_type is w8ben then application/json is also accepted
      Returns:
      mimeType

    • setMimeType

      public void setMimeType(@Nullable String mimeType)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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