FilesApi class

Constructors

FilesApi([ApiClient? apiClient])

Properties

apiClient → ApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

bulkDeleteFiles(BulkDeleteFilesRequest bulkDeleteFilesRequest) → Future<BulkFilesResponse?>

Delete multiple files in one call.

bulkDeleteFilesWithHttpInfo(BulkDeleteFilesRequest bulkDeleteFilesRequest) → Future<Response>

Delete multiple files in one call.

bulkMoveFiles(BulkMoveFilesRequest bulkMoveFilesRequest) → Future<BulkFilesResponse?>

Move multiple files to a target folder.

bulkMoveFilesWithHttpInfo(BulkMoveFilesRequest bulkMoveFilesRequest) → Future<Response>

Move multiple files to a target folder.

commitChunkedUpload(CommitChunkedUploadRequest commitChunkedUploadRequest) → Future<CommitChunkedUploadResponse?>

Finalize a chunked-upload session and create the file row.

commitChunkedUploadWithHttpInfo(CommitChunkedUploadRequest commitChunkedUploadRequest) → Future<Response>

Finalize a chunked-upload session and create the file row.

createFileFolder(CreateFolderRequest createFolderRequest, {String? accountId, String? provider, String? xWorkspaceID}) → Future<Folder?>

Create a folder.

createFileFolderWithHttpInfo(CreateFolderRequest createFolderRequest, {String? accountId, String? provider, String? xWorkspaceID}) → Future<Response>

Create a folder.

deleteFile(String id, {String? accountId, String? xWorkspaceID}) → Future<void>

Delete a file.

deleteFileWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete a file.

extractFileText(String id, {String? accountId, String? xWorkspaceID, int? pageStart, int? pageEnd, int? maxChars}) → Future<ExtractTextResult?>

Extract text content from a PDF (or other supported file).

extractFileTextWithHttpInfo(String id, {String? accountId, String? xWorkspaceID, int? pageStart, int? pageEnd, int? maxChars}) → Future<Response>

Extract text content from a PDF (or other supported file).

getChunkedFileManifest(String id, {String? accountId, String? xWorkspaceID}) → Future<ChunkedFileManifest?>

Fetch the block manifest for a chunked-uploaded file.

getChunkedFileManifestWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch the block manifest for a chunked-uploaded file.

getFile(String id, {String? accountId, String? xWorkspaceID}) → Future<SpatioFile?>

Fetch one file's metadata.

getFileDownloadUrl(String id, {String? accountId, String? xWorkspaceID}) → Future<DownloadFileResponse?>

Mint a fresh signed download URL.

getFileDownloadUrlWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Mint a fresh signed download URL.

getFileWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch one file's metadata.

initChunkedUpload(InitChunkedUploadRequest initChunkedUploadRequest) → Future<InitChunkedUploadResponse?>

Begin a content-addressed chunked upload session.

initChunkedUploadWithHttpInfo(InitChunkedUploadRequest initChunkedUploadRequest) → Future<Response>

Begin a content-addressed chunked upload session.

listFileFolders({String? accountId, String? provider, String? xWorkspaceID, String? parentId, String? workspaceId, String? organizationId, int? limit, int? offset}) → Future<FolderListEnvelope?>

List folders across connected file providers.

listFileFoldersWithHttpInfo({String? accountId, String? provider, String? xWorkspaceID, String? parentId, String? workspaceId, String? organizationId, int? limit, int? offset}) → Future<Response>

List folders across connected file providers.

listFiles({String? accountId, String? provider, String? xWorkspaceID, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<FileListEnvelope?>

List files across connected file providers.

listFilesAndFolders({String? accountId, String? provider, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<FilesAndFoldersResponse?>

Aggregate list of files + folders for renderer file-browser views.

listFilesAndFoldersWithHttpInfo({String? accountId, String? provider, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<Response>

Aggregate list of files + folders for renderer file-browser views.

listFilesWithHttpInfo({String? accountId, String? provider, String? xWorkspaceID, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<Response>

List files across connected file providers.

moveFile(String id, MoveFileRequest moveFileRequest, {String? accountId, String? xWorkspaceID}) → Future<MoveFileResponse?>

Move a single file to a target folder.

moveFileWithHttpInfo(String id, MoveFileRequest moveFileRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Move a single file to a target folder.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchFiles(String query, {String? accountId, String? provider, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset}) → Future<SearchFilesResponse?>

Substring-match search across the caller's files.

searchFilesWithHttpInfo(String query, {String? accountId, String? provider, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset}) → Future<Response>

Substring-match search across the caller's files.

toString() → String

A string representation of this object.

inherited

updateFile(String id, UpdateFileRequest updateFileRequest, {String? accountId, String? xWorkspaceID}) → Future<SpatioFile?>

Update a file's metadata (name, folder, custom fields).

updateFileWithHttpInfo(String id, UpdateFileRequest updateFileRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Update a file's metadata (name, folder, custom fields).

uploadChunkedBlock(String sessionId, String blockHash, MultipartFile block, {int? blockIndex}) → Future<UploadChunkedBlockResponse?>

Upload one block for an open chunked-upload session.

uploadChunkedBlockWithHttpInfo(String sessionId, String blockHash, MultipartFile block, {int? blockIndex}) → Future<Response>

Upload one block for an open chunked-upload session.

uploadFile(MultipartFile file, {String? folderId, String? workspaceId, String? organizationId, String? accountId}) → Future<SpatioFile?>

Upload a file via multipart form.

uploadFileBase64(UploadFileBase64Request uploadFileBase64Request) → Future<SpatioFile?>

Upload a file via JSON with base64-encoded content.

uploadFileBase64WithHttpInfo(UploadFileBase64Request uploadFileBase64Request) → Future<Response>

Upload a file via JSON with base64-encoded content.

uploadFileWithHttpInfo(MultipartFile file, {String? folderId, String? workspaceId, String? organizationId, String? accountId}) → Future<Response>

Upload a file via multipart form.

workspaceCommitChunkedUpload(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped chunked-upload commit (RBAC-protected).

workspaceCommitChunkedUploadWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped chunked-upload commit (RBAC-protected).

workspaceCreateFileFolder(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped create-folder (RBAC-protected).

workspaceCreateFileFolderWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped create-folder (RBAC-protected).

workspaceDeleteFile(String org, String workspace, String id) → Future<void>

Workspace-scoped delete-file.

workspaceDeleteFileWithHttpInfo(String org, String workspace, String id) → Future<Response>

Workspace-scoped delete-file.

workspaceGetFile(String org, String workspace, String id) → Future<Map<String, Object>?>

Workspace-scoped get-file.

workspaceGetFileDownload(String org, String workspace, String id) → Future<Map<String, Object>?>

Workspace-scoped signed-download URL.

workspaceGetFileDownloadWithHttpInfo(String org, String workspace, String id) → Future<Response>

Workspace-scoped signed-download URL.

workspaceGetFileManifest(String org, String workspace, String id) → Future<Map<String, Object>?>

Workspace-scoped chunked-file manifest.

workspaceGetFileManifestWithHttpInfo(String org, String workspace, String id) → Future<Response>

Workspace-scoped chunked-file manifest.

workspaceGetFileWithHttpInfo(String org, String workspace, String id) → Future<Response>

Workspace-scoped get-file.

workspaceInitChunkedUpload(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped chunked-upload init (RBAC-protected).

workspaceInitChunkedUploadWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped chunked-upload init (RBAC-protected).

workspaceListFileFolders(String org, String workspace) → Future<Map<String, Object>?>

Workspace-scoped list-folders (RBAC-protected).

workspaceListFileFoldersWithHttpInfo(String org, String workspace) → Future<Response>

Workspace-scoped list-folders (RBAC-protected).

workspaceListFiles(String org, String workspace) → Future<Map<String, Object>?>

Workspace-scoped list-files (RBAC-protected).

workspaceListFilesWithHttpInfo(String org, String workspace) → Future<Response>

Workspace-scoped list-files (RBAC-protected).

workspaceMoveFile(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped move-file.

workspaceMoveFileWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped move-file.

workspaceUpdateFile(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped update-file.

workspaceUpdateFileWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped update-file.

workspaceUploadChunkedBlock(String org, String workspace, MultipartFile body) → Future<Map<String, Object>?>

Workspace-scoped chunked-upload block (RBAC-protected).

workspaceUploadChunkedBlockWithHttpInfo(String org, String workspace, MultipartFile body) → Future<Response>

Workspace-scoped chunked-upload block (RBAC-protected).

workspaceUploadFile(String org, String workspace, {MultipartFile? file}) → Future<Map<String, Object>?>

Workspace-scoped multipart upload (RBAC-protected).

workspaceUploadFileBase64(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Workspace-scoped base64 upload (RBAC-protected).

workspaceUploadFileBase64WithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Workspace-scoped base64 upload (RBAC-protected).

workspaceUploadFileWithHttpInfo(String org, String workspace, {MultipartFile? file}) → Future<Response>

Workspace-scoped multipart upload (RBAC-protected).

Operators

operator ==(Object other) → bool

The equality operator.

inherited