listFiles method

Future<FileListEnvelope?> listFiles({
  1. String? accountId,
  2. String? provider,
  3. String? xWorkspaceID,
  4. String? folderId,
  5. String? workspaceId,
  6. String? organizationId,
  7. int? limit,
  8. int? offset,
  9. String? sortBy,
  10. String? sortOrder,
})

List files across connected file providers.

Fan-out list. Returns files from every connected file provider unless filtered by ?accountId= or ?provider=. Folder contents are scoped via ?folderId=; omit for account root.

Parameters:

  • String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with provider. If omitted on a list endpoint the call fans out across every connected account.

  • String provider: Provider id (e.g. native-notes, notion). Selects every connected account for the provider. Mutually exclusive with accountId.

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • String folderId: Filter to one folder. Omit for the account root.

  • String workspaceId:

  • String organizationId:

  • int limit:

  • int offset:

  • String sortBy: Provider-dependent. Common values: created_at, name, size.

  • String sortOrder:

Implementation

Future<FileListEnvelope?> listFiles({ String? accountId, String? provider, String? xWorkspaceID, String? folderId, String? workspaceId, String? organizationId, int? limit, int? offset, String? sortBy, String? sortOrder, }) async {
  final response = await listFilesWithHttpInfo( accountId: accountId, provider: provider, xWorkspaceID: xWorkspaceID, folderId: folderId, workspaceId: workspaceId, organizationId: organizationId, limit: limit, offset: offset, sortBy: sortBy, sortOrder: sortOrder, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'FileListEnvelope',) as FileListEnvelope;

  }
  return null;
}