Package ai.vectros.resources.folders

Class AsyncRawFoldersClient

java.lang.Object
ai.vectros.resources.folders.AsyncRawFoldersClient
public class AsyncRawFoldersClient extends Object

  • Field Details

  • Constructor Details

    • AsyncRawFoldersClient

      public AsyncRawFoldersClient(ClientOptions clientOptions)

  • Method Details

    • listFolders

      public CompletableFuture<VectrosApiHttpResponse<FolderPage>> listFolders()
      Returns a paginated list of your folders. Pass parentFolderId to list the direct children of a specific folder (tree navigation); omit it for a flat list across your account. You can also filter by owner using userId or scope. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • listFolders

      public CompletableFuture<VectrosApiHttpResponse<FolderPage>> listFolders(RequestOptions requestOptions)
      Returns a paginated list of your folders. Pass parentFolderId to list the direct children of a specific folder (tree navigation); omit it for a flat list across your account. You can also filter by owner using userId or scope. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • listFolders

      public CompletableFuture<VectrosApiHttpResponse<FolderPage>> listFolders(ListFoldersRequest request)
      Returns a paginated list of your folders. Pass parentFolderId to list the direct children of a specific folder (tree navigation); omit it for a flat list across your account. You can also filter by owner using userId or scope. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • listFolders

      public CompletableFuture<VectrosApiHttpResponse<FolderPage>> listFolders(ListFoldersRequest request, RequestOptions requestOptions)
      Returns a paginated list of your folders. Pass parentFolderId to list the direct children of a specific folder (tree navigation); omit it for a flat list across your account. You can also filter by owner using userId or scope. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • createFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> createFolder(FolderRequest body)
      Creates a folder to organize your documents and records. If parentFolderId is omitted, the folder is created under your context's default root folder. Folder creation is idempotent by (slug + parent): if a folder with the same slug already exists under the same parent, that existing folder is returned unchanged instead of a duplicate being created. The response's created field (and the HTTP status — 201 when created, 200 when an existing folder was returned) tells the two apart. To overwrite an existing folder's mutable fields instead of returning it unchanged, set ?upsert=true (this also requires the folders:u scope). Requires the folders:c scope to create. Being returned the existing folder on a collision is a read of that folder's data and additionally requires the folders:r scope — a credential holding folders:c alone receives a 400 ("already exists") on collision instead of the folder.

    • createFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> createFolder(FolderRequest body, RequestOptions requestOptions)
      Creates a folder to organize your documents and records. If parentFolderId is omitted, the folder is created under your context's default root folder. Folder creation is idempotent by (slug + parent): if a folder with the same slug already exists under the same parent, that existing folder is returned unchanged instead of a duplicate being created. The response's created field (and the HTTP status — 201 when created, 200 when an existing folder was returned) tells the two apart. To overwrite an existing folder's mutable fields instead of returning it unchanged, set ?upsert=true (this also requires the folders:u scope). Requires the folders:c scope to create. Being returned the existing folder on a collision is a read of that folder's data and additionally requires the folders:r scope — a credential holding folders:c alone receives a 400 ("already exists") on collision instead of the folder.

    • createFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> createFolder(CreateFolderRequest request)
      Creates a folder to organize your documents and records. If parentFolderId is omitted, the folder is created under your context's default root folder. Folder creation is idempotent by (slug + parent): if a folder with the same slug already exists under the same parent, that existing folder is returned unchanged instead of a duplicate being created. The response's created field (and the HTTP status — 201 when created, 200 when an existing folder was returned) tells the two apart. To overwrite an existing folder's mutable fields instead of returning it unchanged, set ?upsert=true (this also requires the folders:u scope). Requires the folders:c scope to create. Being returned the existing folder on a collision is a read of that folder's data and additionally requires the folders:r scope — a credential holding folders:c alone receives a 400 ("already exists") on collision instead of the folder.

    • createFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> createFolder(CreateFolderRequest request, RequestOptions requestOptions)
      Creates a folder to organize your documents and records. If parentFolderId is omitted, the folder is created under your context's default root folder. Folder creation is idempotent by (slug + parent): if a folder with the same slug already exists under the same parent, that existing folder is returned unchanged instead of a duplicate being created. The response's created field (and the HTTP status — 201 when created, 200 when an existing folder was returned) tells the two apart. To overwrite an existing folder's mutable fields instead of returning it unchanged, set ?upsert=true (this also requires the folders:u scope). Requires the folders:c scope to create. Being returned the existing folder on a collision is a read of that folder's data and additionally requires the folders:r scope — a credential holding folders:c alone receives a 400 ("already exists") on collision instead of the folder.

    • getFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> getFolder(String id)
      Retrieves a single folder by its ID. Requires the folders:r scope.

    • getFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> getFolder(String id, RequestOptions requestOptions)
      Retrieves a single folder by its ID. Requires the folders:r scope.

    • getFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> getFolder(String id, GetFolderRequest request)
      Retrieves a single folder by its ID. Requires the folders:r scope.

    • getFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> getFolder(String id, GetFolderRequest request, RequestOptions requestOptions)
      Retrieves a single folder by its ID. Requires the folders:r scope.

    • updateFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> updateFolder(String id, UpdateFolderRequest request)
      Replaces a folder's name and description. Omitted fields are preserved (a null does not clear a field). The slug and parent folder are immutable and cannot be changed here. Requires the folders:u scope.

    • updateFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> updateFolder(String id, UpdateFolderRequest request, RequestOptions requestOptions)
      Replaces a folder's name and description. Omitted fields are preserved (a null does not clear a field). The slug and parent folder are immutable and cannot be changed here. Requires the folders:u scope.

    • deleteFolder

      public CompletableFuture<VectrosApiHttpResponse<Void>> deleteFolder(String id)
      Permanently deletes a folder. The folder must be empty (contain no documents or sub-folders) and must not be protected. Your context's root folder is protected and cannot be deleted. Requires the folders:d scope.

    • deleteFolder

      public CompletableFuture<VectrosApiHttpResponse<Void>> deleteFolder(String id, RequestOptions requestOptions)
      Permanently deletes a folder. The folder must be empty (contain no documents or sub-folders) and must not be protected. Your context's root folder is protected and cannot be deleted. Requires the folders:d scope.

    • deleteFolder

      public CompletableFuture<VectrosApiHttpResponse<Void>> deleteFolder(String id, DeleteFolderRequest request)
      Permanently deletes a folder. The folder must be empty (contain no documents or sub-folders) and must not be protected. Your context's root folder is protected and cannot be deleted. Requires the folders:d scope.

    • deleteFolder

      public CompletableFuture<VectrosApiHttpResponse<Void>> deleteFolder(String id, DeleteFolderRequest request, RequestOptions requestOptions)
      Permanently deletes a folder. The folder must be empty (contain no documents or sub-folders) and must not be protected. Your context's root folder is protected and cannot be deleted. Requires the folders:d scope.

    • patchFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> patchFolder(String id, PatchFolderRequest request)
      Partially updates a folder using an RFC 7386 JSON Merge Patch. The name, description, and ownership fields (userId, scopes) are applied when present and left unchanged when omitted; sending any of these as null is rejected, because clearing a field is not supported in this release (omit it instead). slug and parentFolderId are immutable — a folder cannot be re-slugged or moved via the API — and the request is rejected if either is present. Pass expectedVersion for optimistic concurrency (you get a 409 if the folder changed since you last read it). Requires the folders:u scope.

    • patchFolder

      public CompletableFuture<VectrosApiHttpResponse<FolderResponse>> patchFolder(String id, PatchFolderRequest request, RequestOptions requestOptions)
      Partially updates a folder using an RFC 7386 JSON Merge Patch. The name, description, and ownership fields (userId, scopes) are applied when present and left unchanged when omitted; sending any of these as null is rejected, because clearing a field is not supported in this release (omit it instead). slug and parentFolderId are immutable — a folder cannot be re-slugged or moved via the API — and the request is rejected if either is present. Pass expectedVersion for optimistic concurrency (you get a 409 if the folder changed since you last read it). Requires the folders:u scope.

    • getFolderVersions

      public CompletableFuture<VectrosApiHttpResponse<ModelDataVersionPage>> getFolderVersions(String id)
      Returns the audit trail of changes (create, update, and delete events) for a folder, newest first. Folder version history is always recorded; there is no setting to turn it off. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • getFolderVersions

      public CompletableFuture<VectrosApiHttpResponse<ModelDataVersionPage>> getFolderVersions(String id, RequestOptions requestOptions)
      Returns the audit trail of changes (create, update, and delete events) for a folder, newest first. Folder version history is always recorded; there is no setting to turn it off. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • getFolderVersions

      public CompletableFuture<VectrosApiHttpResponse<ModelDataVersionPage>> getFolderVersions(String id, GetFolderVersionsRequest request)
      Returns the audit trail of changes (create, update, and delete events) for a folder, newest first. Folder version history is always recorded; there is no setting to turn it off. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.

    • getFolderVersions

      public CompletableFuture<VectrosApiHttpResponse<ModelDataVersionPage>> getFolderVersions(String id, GetFolderVersionsRequest request, RequestOptions requestOptions)
      Returns the audit trail of changes (create, update, and delete events) for a folder, newest first. Folder version history is always recorded; there is no setting to turn it off. Results are returned as a {data, nextCursor} envelope — pass nextCursor as startFrom to fetch the next page. Requires the folders:r scope.