Class ListDocumentsRequest

java.lang.Object
ai.vectros.resources.documents.requests.ListDocumentsRequest

public final class ListDocumentsRequest extends Object
  • Method Details

    • getUserId

      public Optional<String> getUserId()
      Returns:
      Filter by owning user — the Vectros-assigned UUID of a user. To resolve from your own identifier, call GET /v1/users?externalId=.
    • getOrgId

      public Optional<String> getOrgId()
      Returns:
      Filter by owning organization — the Vectros-assigned UUID of an organization. To resolve from your own identifier, call GET /v1/orgs?externalId=.
    • getClientId

      public Optional<String> getClientId()
      Returns:
      Filter by associated client — the Vectros-assigned UUID of a client. To resolve from your own identifier, call GET /v1/clients?externalId=.
    • getFolderId

      public Optional<String> getFolderId()
      Returns:
      List only documents in this folder (the Vectros folder ID). Can be combined with the owner filters.
    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor — pass the nextCursor returned by the previous page.
    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of documents to return per page (1-100; defaults to 20).
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object
    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • builder

      public static ListDocumentsRequest.Builder builder()