/**
* User Service API
* Solomon AI User Service API - Manages user profiles and authentication
*
* The version of the OpenAPI document: 1.0
* Contact: yoanyomba@solomon-ai.co
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
///
import http from 'http';
import { BulkUpdateCommentsRequest } from '../model/bulkUpdateCommentsRequest';
import { BulkUpdateCommentsResponse } from '../model/bulkUpdateCommentsResponse';
import { CreateAccountRequest } from '../model/createAccountRequest';
import { CreateAccountResponse } from '../model/createAccountResponse';
import { CreateCommentEditBody } from '../model/createCommentEditBody';
import { CreateCommentEditResponse } from '../model/createCommentEditResponse';
import { CreateCommentRequest } from '../model/createCommentRequest';
import { CreateCommentResponse1 } from '../model/createCommentResponse1';
import { CreateCommentThreadRequest } from '../model/createCommentThreadRequest';
import { CreateCommentThreadResponse } from '../model/createCommentThreadResponse';
import { CreateDocumentSnapshotBody } from '../model/createDocumentSnapshotBody';
import { CreateDocumentSnapshotResponse } from '../model/createDocumentSnapshotResponse';
import { CreateFolderRequest } from '../model/createFolderRequest';
import { CreateFolderResponse } from '../model/createFolderResponse';
import { CreateMarkdownFileRequest } from '../model/createMarkdownFileRequest';
import { CreateMarkdownFileResponse } from '../model/createMarkdownFileResponse';
import { CreateWorkspaceComplianceBody } from '../model/createWorkspaceComplianceBody';
import { CreateWorkspaceComplianceResponse } from '../model/createWorkspaceComplianceResponse';
import { CreateWorkspaceRequest } from '../model/createWorkspaceRequest';
import { CreateWorkspaceResponse } from '../model/createWorkspaceResponse';
import { DeleteAccountResponse } from '../model/deleteAccountResponse';
import { DeleteCommentEditResponse } from '../model/deleteCommentEditResponse';
import { DeleteCommentResponse1 } from '../model/deleteCommentResponse1';
import { DeleteCommentThreadResponse } from '../model/deleteCommentThreadResponse';
import { DeleteDocumentSnapshotResponse } from '../model/deleteDocumentSnapshotResponse';
import { DeleteFileResponse } from '../model/deleteFileResponse';
import { DeleteFolderResponse } from '../model/deleteFolderResponse';
import { DeleteWorkspaceComplianceResponse } from '../model/deleteWorkspaceComplianceResponse';
import { DeleteWorkspaceResponse } from '../model/deleteWorkspaceResponse';
import { DeleteWorkspaceShareResponse } from '../model/deleteWorkspaceShareResponse';
import { GenerateFileEmbeddingsBody } from '../model/generateFileEmbeddingsBody';
import { GenerateFileEmbeddingsResponse } from '../model/generateFileEmbeddingsResponse';
import { GetAccountResponse } from '../model/getAccountResponse';
import { GetBackgroundJobStatusResponse } from '../model/getBackgroundJobStatusResponse';
import { GetCommentEditResponse } from '../model/getCommentEditResponse';
import { GetCommentResponse } from '../model/getCommentResponse';
import { GetCommentThreadResponse } from '../model/getCommentThreadResponse';
import { GetDocumentSnapshotResponse } from '../model/getDocumentSnapshotResponse';
import { GetFileVersionResponse } from '../model/getFileVersionResponse';
import { GetSingleCommentThreadResponse } from '../model/getSingleCommentThreadResponse';
import { GetWorkspaceComplianceResponse } from '../model/getWorkspaceComplianceResponse';
import { GetWorkspaceShareResponse } from '../model/getWorkspaceShareResponse';
import { ListAccountsResponse } from '../model/listAccountsResponse';
import { ListCommentEditsResponse } from '../model/listCommentEditsResponse';
import { ListCommentsResponse } from '../model/listCommentsResponse';
import { ListDocumentSnapshotsResponse } from '../model/listDocumentSnapshotsResponse';
import { ListFileVersionsResponse } from '../model/listFileVersionsResponse';
import { ListFilesResponse } from '../model/listFilesResponse';
import { ListFolderResponse } from '../model/listFolderResponse';
import { ListWorkspaceActivityResponse } from '../model/listWorkspaceActivityResponse';
import { ListWorkspaceResponse } from '../model/listWorkspaceResponse';
import { ListWorkspaceSharesResponse } from '../model/listWorkspaceSharesResponse';
import { ShareFileBody } from '../model/shareFileBody';
import { ShareFileResponse } from '../model/shareFileResponse';
import { ShareWorkspaceBody } from '../model/shareWorkspaceBody';
import { ShareWorkspaceResponse } from '../model/shareWorkspaceResponse';
import { UnshareFileResponse } from '../model/unshareFileResponse';
import { UpdateCommentEditRequest } from '../model/updateCommentEditRequest';
import { UpdateCommentEditResponse } from '../model/updateCommentEditResponse';
import { UpdateCommentRequest } from '../model/updateCommentRequest';
import { UpdateCommentResponse } from '../model/updateCommentResponse';
import { UpdateCommentThreadRequest } from '../model/updateCommentThreadRequest';
import { UpdateCommentThreadResponse } from '../model/updateCommentThreadResponse';
import { UpdateFileRequest } from '../model/updateFileRequest';
import { UpdateFileResponse } from '../model/updateFileResponse';
import { UpdateFolderRequest } from '../model/updateFolderRequest';
import { UpdateFolderResponse } from '../model/updateFolderResponse';
import { UpdateWorkspaceComplianceRequest } from '../model/updateWorkspaceComplianceRequest';
import { UpdateWorkspaceComplianceResponse } from '../model/updateWorkspaceComplianceResponse';
import { UpdateWorkspaceRequest } from '../model/updateWorkspaceRequest';
import { UpdateWorkspaceResponse } from '../model/updateWorkspaceResponse';
import { UpdateWorkspaceShareRequest } from '../model/updateWorkspaceShareRequest';
import { UpdateWorkspaceShareResponse } from '../model/updateWorkspaceShareResponse';
import { Authentication, Interceptor } from '../model/models';
import { ApiKeyAuth } from '../model/models';
export declare enum WorkspaceServiceApiApiKeys {
ApiKeyAuth = 0,
Bearer = 1
}
export declare class WorkspaceServiceApi {
protected _basePath: string;
protected _defaultHeaders: any;
protected _useQuerystring: boolean;
protected authentications: {
default: Authentication;
ApiKeyAuth: ApiKeyAuth;
Bearer: ApiKeyAuth;
};
protected interceptors: Interceptor[];
constructor(basePath?: string);
set useQuerystring(value: boolean);
set basePath(basePath: string);
set defaultHeaders(defaultHeaders: any);
get defaultHeaders(): any;
get basePath(): string;
setDefaultAuthentication(auth: Authentication): void;
setApiKey(key: WorkspaceServiceApiApiKeys, value: string): void;
addInterceptor(interceptor: Interceptor): void;
/**
* This endpoint updates multiple comments in bulk
* @summary Bulk update comments
* @param bulkUpdateCommentsRequest BulkUpdateCommentsRequest represents a request to update multiple comments.
*/
bulkUpdateComments(bulkUpdateCommentsRequest: BulkUpdateCommentsRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: BulkUpdateCommentsResponse;
}>;
/**
* This endpoint creates a new user account
* @summary Create a new account
* @param createAccountRequest CreateAccountRequest represents a request to create a new user account in the system. This message contains all necessary information to establish a new user account within a specific organization and tenant context.
*/
createAccount(createAccountRequest: CreateAccountRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateAccountResponse;
}>;
/**
* This endpoint creates a new comment in a thread
* @summary Create a comment
* @param createCommentRequest
*/
createComment1(createCommentRequest: CreateCommentRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateCommentResponse1;
}>;
/**
* This endpoint creates a new edit for a comment
* @summary Create a comment edit
* @param commentId comment_id identifies the comment being edited
* @param createCommentEditBody
*/
createCommentEdit(commentId: string, createCommentEditBody: CreateCommentEditBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateCommentEditResponse;
}>;
/**
* This endpoint creates a new comment thread on a file
* @summary Create a comment thread
* @param createCommentThreadRequest CreateCommentThreadRequest represents a request to create a new comment thread.
*/
createCommentThread(createCommentThreadRequest: CreateCommentThreadRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateCommentThreadResponse;
}>;
/**
* This endpoint creates a new snapshot of a document\'s content
* @summary Create a document snapshot
* @param fileId file_id identifies the file to snapshot
* @param createDocumentSnapshotBody
*/
createDocumentSnapshot(fileId: string, createDocumentSnapshotBody: CreateDocumentSnapshotBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateDocumentSnapshotResponse;
}>;
/**
* This endpoint creates a new folder
* @summary Create a folder
* @param createFolderRequest CreateFolderRequest represents a request to create a new folder within a workspace. This message contains all necessary information to establish a new folder structure while maintaining proper access controls and organizational hierarchy. Key features: - User authentication and authorization - Workspace organization - Folder naming and validation - Multi-tenant support - Organization context
*/
createFolder(createFolderRequest: CreateFolderRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateFolderResponse;
}>;
/**
* This endpoint creates a new file
* @summary Create a markdown file
* @param createMarkdownFileRequest CreateMarkdownFileRequest represents a request to create a new Markdown file in the workspace. This message contains all necessary information to create and store a Markdown file, including content, location details, and organizational context.
*/
createMarkdownFile(createMarkdownFileRequest: CreateMarkdownFileRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateMarkdownFileResponse;
}>;
/**
* This endpoint creates a new workspace
* @summary Create a workspace
* @param createWorkspaceRequest CreateWorkspaceRequest represents a request to create a new workspace in the system. This message contains all necessary information to establish a new workspace within a specific organization and tenant context. Key features: - User identification and authorization - Workspace naming and configuration - Multi-tenant support - Organization scoping
*/
createWorkspace(createWorkspaceRequest: CreateWorkspaceRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateWorkspaceResponse;
}>;
/**
* This endpoint creates compliance settings for a workspace
* @summary Create workspace compliance settings
* @param workspaceId workspace_id identifies the workspace
* @param createWorkspaceComplianceBody
*/
createWorkspaceCompliance(workspaceId: string, createWorkspaceComplianceBody: CreateWorkspaceComplianceBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: CreateWorkspaceComplianceResponse;
}>;
/**
* This endpoint deletes an account by ID
* @summary Delete an account
* @param userId user_id uniquely identifies the account to be deleted Must be a non-empty string matching the authentication system\'s user ID
* @param orgId org_id identifies the organization context for the account deletion Must be a valid organization identifier to ensure deletion occurs in correct scope
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Must be a valid tenant identifier to ensure deletion occurs in correct tenant
*/
deleteAccount(userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteAccountResponse;
}>;
/**
* This endpoint deletes a specific comment
* @summary Delete a comment
* @param commentId
* @param userId
* @param workspaceId
* @param folderId
* @param fileId
* @param threadId
* @param orgId Organization and tenant context
* @param tenantId
*/
deleteComment1(commentId: string, userId: string, workspaceId: string, folderId: string, fileId: string, threadId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteCommentResponse1;
}>;
/**
* This endpoint deletes a specific comment edit
* @summary Delete a comment edit
* @param commentId
* @param editId
* @param userId
* @param orgId Organization and tenant context
* @param tenantId
*/
deleteCommentEdit(commentId: string, editId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteCommentEditResponse;
}>;
/**
* This endpoint deletes a comment thread and all its associated comments
* @summary Delete a comment thread
* @param threadId thread_id identifies the comment thread to delete
* @param userId user_id identifies the user deleting the thread Must be authenticated and authorized to delete the thread
* @param orgId Organization and tenant context
* @param tenantId
* @param hardDelete Optional: Force delete even if thread has replies
*/
deleteCommentThread(threadId: string, userId: string, orgId: string, tenantId: string, hardDelete?: boolean, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteCommentThreadResponse;
}>;
/**
* This endpoint deletes a specific document snapshot
* @summary Delete a document snapshot
* @param fileId file_id identifies the file
* @param snapshotId snapshot_id identifies the specific snapshot to delete
* @param userId user_id identifies the user deleting the snapshot
* @param orgId Organization and tenant context
* @param tenantId
*/
deleteDocumentSnapshot(fileId: string, snapshotId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteDocumentSnapshotResponse;
}>;
/**
* This endpoint deletes a file by ID
* @summary Delete a file
* @param fileId file_id uniquely identifies the file to be deleted Must reference an existing file in the system
* @param userId user_id identifies the user requesting the file deletion Must be authenticated and authorized to delete the file
* @param folderId folder_id identifies the folder containing the file Used for hierarchical organization and access control
* @param workspaceId workspace_id identifies the workspace context for the file deletion Must be a valid workspace identifier where the file is located
* @param orgId org_id identifies the organization context for the file deletion Must be a valid organization identifier to ensure proper scoping
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Required to ensure proper isolation between different tenants
*/
deleteFile(fileId: string, userId: string, folderId: string, workspaceId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteFileResponse;
}>;
/**
* This endpoint deletes a folder by ID
* @summary Delete a folder
* @param folderId folder_id uniquely identifies the folder to be deleted Must reference an existing folder in the system
* @param userId user_id identifies the user requesting the folder deletion Must be authenticated and authorized to delete the folder
* @param workspaceId workspace_id identifies the workspace context for the folder deletion Must be a valid workspace identifier where the folder is located
* @param orgId org_id identifies the organization context for the folder deletion Must be a valid organization identifier to ensure proper scoping
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Required to ensure proper isolation between different tenants
*/
deleteFolder(folderId: string, userId: string, workspaceId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteFolderResponse;
}>;
/**
* This endpoint deletes a workspace by ID
* @summary Delete a workspace
* @param workspaceId workspace_id uniquely identifies the workspace to be deleted Must reference an existing workspace in the system
* @param userId user_id identifies the user requesting the workspace deletion Must be authenticated and authorized to delete the workspace
* @param orgId org_id identifies the organization context for the workspace deletion Must be a valid organization identifier to ensure proper scoping
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Required to ensure proper isolation between different tenants
*/
deleteWorkspace(workspaceId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteWorkspaceResponse;
}>;
/**
* This endpoint deletes compliance settings for a workspace
* @summary Delete workspace compliance settings
* @param workspaceId workspace_id identifies the workspace
* @param userId user_id identifies the user deleting the compliance settings
* @param orgId Organization and tenant context
* @param tenantId
*/
deleteWorkspaceCompliance(workspaceId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteWorkspaceComplianceResponse;
}>;
/**
* This endpoint removes a share from a workspace
* @summary Delete a workspace share
* @param workspaceId workspace_id identifies the workspace
* @param shareId share_id identifies the specific share to delete
* @param userId user_id identifies the user deleting the share
* @param orgId Organization and tenant context
* @param tenantId
*/
deleteWorkspaceShare(workspaceId: string, shareId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: DeleteWorkspaceShareResponse;
}>;
/**
* This endpoint triggers the generation of embeddings for the current state of a file
* @summary Generate file embeddings
* @param fileId file_id identifies the file to generate embeddings for
* @param generateFileEmbeddingsBody
*/
generateFileEmbeddings(fileId: string, generateFileEmbeddingsBody: GenerateFileEmbeddingsBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GenerateFileEmbeddingsResponse;
}>;
/**
* This endpoint retrieves account details by ID
* @summary Get account by ID
* @param userId user_id uniquely identifies the user whose account information is being requested Must be a non-empty string, typically matching the authentication system\'s user ID
* @param orgId org_id identifies the organization context for the account lookup Must be a valid organization identifier
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Must be a valid tenant identifier
* @param createIfNotExists create_if_not_exists determines whether to create a new account if one doesn\'t exist If true, a new account will be created with default settings when no matching account is found
* @param email email is the user\'s email address, used as an alternative lookup method Must be a valid email format if provided
* @param includeMetadata include_metadata determines whether to include the account\'s metadata in the response When true, all custom fields and extended properties will be returned
* @param includePermissions include_permissions determines whether to include the user\'s permissions in the response When true, returns the complete permission set associated with the account
*/
getAccount(userId: string, orgId: string, tenantId: string, createIfNotExists?: boolean, email?: string, includeMetadata?: boolean, includePermissions?: boolean, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetAccountResponse;
}>;
/**
* This endpoint retrieves the status of a background job like embedding generation
* @summary Get background job status
* @param jobId job_id identifies the specific background job
* @param userId user_id identifies the user requesting the job status
* @param orgId Organization and tenant context
* @param tenantId
*/
getBackgroundJobStatus(jobId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetBackgroundJobStatusResponse;
}>;
/**
* This endpoint retrieves a specific comment by its ID
* @summary Get a comment
* @param commentId comment_id identifies the comment to retrieve
* @param userId user_id identifies the user requesting the comment Must be authenticated and authorized to view the comment
* @param workspaceId
* @param folderId
* @param fileId
* @param threadId
* @param orgId Organization and tenant context
* @param tenantId
*/
getComment(commentId: string, userId: string, workspaceId: string, folderId: string, fileId: string, threadId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetCommentResponse;
}>;
/**
* This endpoint retrieves a specific comment edit
* @summary Get a comment edit
* @param commentId
* @param editId
* @param userId
* @param orgId Organization and tenant context
* @param tenantId
*/
getCommentEdit(commentId: string, editId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetCommentEditResponse;
}>;
/**
* This endpoint retrieves a specific comment thread and its comments
* @summary Get a comment thread
* @param fileId thread_id identifies the comment thread to retrieve
* @param userId user_id identifies the user requesting the thread Must be authenticated and authorized to view the thread
* @param orgId Organization and tenant context
* @param tenantId
* @param pageSize
* @param pageNumber
*/
getCommentThread(fileId: string, userId: string, orgId: string, tenantId: string, pageSize: string, pageNumber: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetCommentThreadResponse;
}>;
/**
* This endpoint retrieves a specific document snapshot
* @summary Get a document snapshot
* @param fileId file_id identifies the file
* @param snapshotId snapshot_id identifies the specific snapshot
* @param userId user_id identifies the user requesting the snapshot
* @param orgId Organization and tenant context
* @param tenantId
*/
getDocumentSnapshot(fileId: string, snapshotId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetDocumentSnapshotResponse;
}>;
/**
* This endpoint retrieves a specific version of a file
* @summary Get file version
* @param fileId file_id identifies the file
* @param versionId version_id identifies the specific version to retrieve
* @param userId user_id identifies the user requesting the file version
* @param orgId Organization and tenant context
* @param tenantId
*/
getFileVersion(fileId: string, versionId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetFileVersionResponse;
}>;
/**
* This endpoint retrieves a single comment thread by its ID
* @summary Get a single comment thread
* @param threadId thread_id identifies the specific comment thread to retrieve
* @param userId user_id identifies the user requesting the thread Must be authenticated and authorized to view the thread
* @param orgId Organization and tenant context
* @param tenantId
*/
getSingleCommentThread(threadId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetSingleCommentThreadResponse;
}>;
/**
* This endpoint retrieves compliance settings for a workspace
* @summary Get workspace compliance settings
* @param workspaceId workspace_id identifies the workspace
* @param userId user_id identifies the user requesting the compliance settings
* @param orgId Organization and tenant context
* @param tenantId
*/
getWorkspaceCompliance(workspaceId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetWorkspaceComplianceResponse;
}>;
/**
* This endpoint retrieves a specific workspace share
* @summary Get a workspace share
* @param workspaceId workspace_id identifies the workspace
* @param shareId share_id identifies the specific share to retrieve
* @param userId user_id identifies the user requesting the share
* @param orgId Organization and tenant context
* @param tenantId
*/
getWorkspaceShare(workspaceId: string, shareId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: GetWorkspaceShareResponse;
}>;
/**
* This endpoint retrieves a paginated list of accounts with optional filtering
* @summary List accounts
* @param userId user_id identifies the user requesting the account list Must be authenticated and authorized to view accounts
* @param orgId Organization and tenant context
* @param tenantId
* @param emailFilter Filter by email pattern
* @param createdAfter Filter by creation date range
* @param createdBefore
* @param includeDeleted Include deleted accounts in results
* @param pageSize Pagination parameters
* @param pageNumber
*/
listAccounts(userId: string, orgId: string, tenantId: string, emailFilter?: string, createdAfter?: Date, createdBefore?: Date, includeDeleted?: boolean, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListAccountsResponse;
}>;
/**
* This endpoint retrieves a list of edits for a comment
* @summary List comment edits
* @param commentId
* @param userId
* @param orgId Organization and tenant context
* @param tenantId
* @param pageSize
* @param pageNumber
*/
listCommentEdits(commentId: string, userId: string, orgId: string, tenantId: string, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListCommentEditsResponse;
}>;
/**
* This endpoint retrieves a paginated list of comments with optional filtering
* @summary List comments
* @param userId
* @param workspaceId
* @param folderId
* @param fileId
* @param threadId
* @param orgId
* @param tenantId
*/
listComments(userId: string, workspaceId: string, folderId: string, fileId: string, threadId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListCommentsResponse;
}>;
/**
* This endpoint retrieves a list of document snapshots for a file
* @summary List document snapshots
* @param fileId file_id identifies the file
* @param userId user_id identifies the user requesting the snapshots
* @param orgId Organization and tenant context
* @param tenantId
* @param createdAfter Filter options
* @param createdBefore
* @param pageSize Pagination
* @param pageNumber
*/
listDocumentSnapshots(fileId: string, userId: string, orgId: string, tenantId: string, createdAfter?: Date, createdBefore?: Date, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListDocumentSnapshotsResponse;
}>;
/**
* This endpoint retrieves all versions of a specific file
* @summary List file versions
* @param fileId file_id identifies the file
* @param userId user_id identifies the user requesting the file versions
* @param orgId Organization and tenant context
* @param tenantId
* @param createdAfter Filter options
* @param createdBefore
* @param modifiedBy
* @param pageSize Pagination
* @param pageNumber
*/
listFileVersions(fileId: string, userId: string, orgId: string, tenantId: string, createdAfter?: Date, createdBefore?: Date, modifiedBy?: string, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListFileVersionsResponse;
}>;
/**
* This endpoint retrieves a paginated list of files with optional filtering
* @summary List files
* @param userId user_id identifies the user requesting the file list
* @param workspaceId Required workspace_id to filter files by workspace
* @param folderId Required folder_id to filter files by folder
* @param orgId Organization and tenant context
* @param tenantId
* @param fileTypes Filter options Filter by file type
* @param namePattern Filter by name pattern
* @param tags Filter by tags
* @param includeDeleted Include soft-deleted files
* @param createdAfter Date range filters
* @param createdBefore
* @param modifiedAfter
* @param modifiedBefore
* @param minSize Size range filters (in bytes)
* @param maxSize
* @param sortBy - SORT_FIELD_UNSPECIFIED: Default value, no sort specified - SORT_FIELD_NAME: Sort by item name (alphabetical) - SORT_FIELD_CREATED_AT: Sort by creation timestamp - SORT_FIELD_UPDATED_AT: Sort by last modification time - SORT_FIELD_SIZE: Sort by file size (bytes)
* @param sortDescending
* @param pageSize Pagination
* @param pageNumber
*/
listFiles(userId: string, workspaceId: string, folderId: string, orgId: string, tenantId: string, fileTypes?: Array, namePattern?: string, tags?: Array, includeDeleted?: boolean, createdAfter?: Date, createdBefore?: Date, modifiedAfter?: Date, modifiedBefore?: Date, minSize?: string, maxSize?: string, sortBy?: 'SORT_FIELD_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_CREATED_AT' | 'SORT_FIELD_UPDATED_AT' | 'SORT_FIELD_SIZE', sortDescending?: boolean, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListFilesResponse;
}>;
/**
* This endpoint lists all folders
* @summary List folders
* @param userId user_id identifies the user making the folder listing request Must be authenticated and authorized to access the workspace
* @param folderId folder_id optionally specifies a parent folder to list contents from If not provided, lists from the workspace root
* @param workspaceId workspace_id identifies the specific workspace context Required to scope the folder listing to the correct workspace
* @param orgId org_id identifies the organization context for the folder listing Must be a valid organization identifier that the user belongs to
* @param tenantId tenant_id identifies the tenant context for the folder listing Required for multi-tenant deployments to maintain proper data isolation
*/
listFolder(userId: string, folderId: string, workspaceId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListFolderResponse;
}>;
/**
* This endpoint lists all workspaces
* @summary List workspaces
* @param userId user_id uniquely identifies the user requesting the workspace list Must be a valid, authenticated user ID from the authentication system
* @param orgId org_id identifies the organization context for listing workspaces Must be a valid organization identifier to ensure proper scoping of results
* @param tenantId tenant_id identifies the tenant context for multi-tenant deployments Required to ensure proper isolation between different tenants
* @param pageSize page_size specifies the maximum number of workspaces to return in a single response Server may return fewer workspaces than specified If unspecified, server will decide the default page size
* @param pageNumber page_number specifies which page of results to return Pages are 1-based (first page is 1) If unspecified, defaults to page 1
*/
listWorkspace(userId: string, orgId: string, tenantId: string, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListWorkspaceResponse;
}>;
/**
* This endpoint retrieves activity history for a workspace
* @summary List workspace activity
* @param workspaceId workspace_id identifies the workspace
* @param userId user_id identifies the user requesting the activity list
* @param orgId Organization and tenant context
* @param tenantId
* @param startTime Filter options
* @param endTime
* @param pageSize Pagination
* @param pageNumber
*/
listWorkspaceActivity(workspaceId: string, userId: string, orgId: string, tenantId: string, startTime?: Date, endTime?: Date, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListWorkspaceActivityResponse;
}>;
/**
* This endpoint lists all shares for a workspace
* @summary List workspace shares
* @param workspaceId workspace_id identifies the workspace
* @param userId user_id identifies the user requesting the shares
* @param orgId Organization and tenant context
* @param tenantId
* @param pageSize Pagination
* @param pageNumber
*/
listWorkspaceShares(workspaceId: string, userId: string, orgId: string, tenantId: string, pageSize?: number, pageNumber?: number, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ListWorkspaceSharesResponse;
}>;
/**
* This endpoint shares a file with specified users or generates a sharing link
* @summary Share a file
* @param fileId file_id identifies the file to be shared
* @param shareFileBody
*/
shareFile(fileId: string, shareFileBody: ShareFileBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ShareFileResponse;
}>;
/**
* This endpoint shares a workspace with a specified user
* @summary Share a workspace
* @param workspaceId workspace_id identifies the workspace to share
* @param shareWorkspaceBody
*/
shareWorkspace(workspaceId: string, shareWorkspaceBody: ShareWorkspaceBody, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: ShareWorkspaceResponse;
}>;
/**
* This endpoint revokes file sharing for specified users or disables sharing links
* @summary Unshare a file
* @param fileId file_id identifies the file to unshare
* @param shareId
* @param userId user_id identifies the user unsharing the file
* @param orgId Organization and tenant context
* @param tenantId
*/
unshareFile(fileId: string, shareId: string, userId: string, orgId: string, tenantId: string, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UnshareFileResponse;
}>;
/**
* This endpoint updates a comment\'s content or metadata
* @summary Update a comment
* @param updateCommentRequest Comment Update Operations UpdateCommentRequest represents a request to update various aspects of a comment including content, metadata, visibility, and status.
*/
updateComment(updateCommentRequest: UpdateCommentRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateCommentResponse;
}>;
/**
* This endpoint updates a specific comment edit
* @summary Update a comment edit
* @param updateCommentEditRequest
*/
updateCommentEdit(updateCommentEditRequest: UpdateCommentEditRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateCommentEditResponse;
}>;
/**
* This endpoint updates a comment thread\'s properties
* @summary Update a comment thread
* @param updateCommentThreadRequest
*/
updateCommentThread(updateCommentThreadRequest: UpdateCommentThreadRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateCommentThreadResponse;
}>;
/**
* This endpoint updates a file by ID
* @summary Update a file
* @param updateFileRequest UpdateFileRequest represents a request to update an existing file\'s metadata in the system. This message contains the updated metadata for the file, allowing modification of file attributes while maintaining version history and access controls.
*/
updateFile(updateFileRequest: UpdateFileRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateFileResponse;
}>;
/**
* This endpoint updates a folder by ID
* @summary Update a folder
* @param updateFolderRequest UpdateFolderRequest represents a request to update an existing folder\'s metadata. This message contains the updated folder metadata, allowing modification of folder attributes while maintaining proper access controls and organizational hierarchy. Key features: - Complete folder metadata updates - Maintains folder relationships - Preserves access controls - Supports audit trail
*/
updateFolder(updateFolderRequest: UpdateFolderRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateFolderResponse;
}>;
/**
* This endpoint updates a workspace by ID
* @summary Update a workspace
* @param updateWorkspaceRequest UpdateWorkspaceRequest represents a request to update an existing workspace\'s properties. This message contains the complete workspace object with updated fields, allowing modification of workspace attributes while maintaining data consistency and access controls. Key features: - Full workspace object updates - Validation of required fields - Version tracking support - Access control preservation
*/
updateWorkspace(updateWorkspaceRequest: UpdateWorkspaceRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateWorkspaceResponse;
}>;
/**
* This endpoint updates compliance settings for a workspace
* @summary Update workspace compliance settings
* @param updateWorkspaceComplianceRequest UpdateWorkspaceComplianceRequest represents a request to update compliance settings for a workspace. This operation modifies the existing compliance configuration with new settings. Required Fields: - compliance: The new compliance settings to apply to the workspace The compliance settings include: - Data retention policies - Access control requirements - Audit logging configurations - Security controls - Regulatory compliance flags Example: ```protobuf message request { compliance: { data_retention_days: 90 require_2fa: true audit_logging_enabled: true } } ```
*/
updateWorkspaceCompliance(updateWorkspaceComplianceRequest: UpdateWorkspaceComplianceRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateWorkspaceComplianceResponse;
}>;
/**
* This endpoint updates a workspace share\'s properties
* @summary Update a workspace share
* @param updateWorkspaceShareRequest UpdateWorkspaceShareRequest represents a request to update an existing workspace share. Contains the modified share object with updated permissions or settings. Required Fields: - share: The WorkspaceSharing object containing the updated share configuration
*/
updateWorkspaceShare(updateWorkspaceShareRequest: UpdateWorkspaceShareRequest, options?: {
headers: {
[name: string]: string;
};
}): Promise<{
response: http.IncomingMessage;
body: UpdateWorkspaceShareResponse;
}>;
}