@internxt/sdk 1.4.79 → 1.6.3

package/dist/drive/storage/index.d.ts

@@ -1,8 +1,8 @@
-import { CreateFolderPayload, CreateFolderResponse, DeleteFilePayload, DriveFileData, FetchFolderContentResponse, FileEntry, MoveFilePayload, MoveFileResponse, MoveFolderPayload, MoveFolderResponse, UpdateFilePayload, UpdateFolderMetadataPayload, FetchLimitResponse, UsageResponse, AddItemsToTrashPayload, ThumbnailEntry, Thumbnail, FetchPaginatedFolderContentResponse, FileMeta, SearchResultData, FolderAncestor, FolderMeta, ReplaceFile, FetchPaginatedFilesContent, FetchPaginatedFoldersContent, MoveFolderUuidPayload, MoveFileUuidPayload } from './types';
+import { Token } from '../../auth';
 import { ApiSecurity, ApiUrl, AppDetails } from '../../shared';
 import { RequestCanceler } from '../../shared/http/client';
-import { Token } from '../../auth';
 import { UUID } from '../../shared/types/userSettings';
+import { AddItemsToTrashPayload, CheckDuplicatedFilesPayload, CheckDuplicatedFilesResponse, CheckDuplicatedFolderPayload, CheckDuplicatedFoldersResponse, CreateFolderByUuidPayload, CreateFolderPayload, CreateFolderResponse, DeleteFilePayload, DriveFileData, FetchFolderContentResponse, FetchLimitResponse, FetchPaginatedFilesContent, FetchPaginatedFolderContentResponse, FetchPaginatedFoldersContent, FileEntry, FileEntryByUuid, FileMeta, FolderAncestor, FolderMeta, FolderTreeResponse, MoveFilePayload, MoveFileResponse, MoveFileUuidPayload, MoveFolderPayload, MoveFolderResponse, MoveFolderUuidPayload, ReplaceFile, SearchResultData, Thumbnail, ThumbnailEntry, UpdateFilePayload, UpdateFolderMetadataPayload, UsageResponse } from './types';
 export * as StorageTypes from './types';
 export declare class Storage {
     private readonly client;
@@ -15,6 +15,11 @@ export declare class Storage {
      * @param payload
      */
     createFolder(payload: CreateFolderPayload): [Promise<CreateFolderResponse>, RequestCanceler];
+    /**
+     * Creates a new folder
+     * @param payload
+     */
+    createFolderByUuid(payload: CreateFolderByUuidPayload): [Promise<CreateFolderResponse>, RequestCanceler];
     /**
      * Moves a specific folder to a new location
      * @param payload
@@ -30,16 +35,49 @@ export declare class Storage {
      * @param payload
      */
     updateFolder(payload: UpdateFolderMetadataPayload): Promise<void>;
+    /**
+     * Updates the name of a folder with the given UUID.
+     *
+     * @param {Object} payload - The payload containing the folder UUID and the new name.
+     * @param {string} payload.folderUuid - The UUID of the folder to update.
+     * @param {string} payload.name - The new name for the folder.
+     * @param {Token} [resourcesToken] - An optional token for authentication.
+     * @return {Promise<void>} A promise that resolves when the folder name is successfully updated.
+     */
+    updateFolderNameWithUUID(payload: {
+        folderUuid: string;
+        name: string;
+    }, resourcesToken?: Token): Promise<void>;
     /**
      * Fetches & returns the contents of a specific folder
      * @param folderId
      */
     getFolderContent(folderId: number, trash?: boolean): [Promise<FetchFolderContentResponse>, RequestCanceler];
     /**
-     * Returns metadata of a specific file
-     * @param fileId
+     * Fetches and returns the contents of a specific folder by its UUID.
+     *
+     * @param {string} folderUuid - The UUID of the folder.
+     * @param {boolean} [trash=false] - Whether to include trash items in the response.
+     * @param {boolean} [offset] - The position of the first file to return.
+     * @param {boolean} [limit] - The max number of files to be returned.
+     * @param {boolean} [workspacesToken] - Token for accessing workspaces.
+     * @return {[Promise<FetchFolderContentResponse>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
      */
-    getFile(fileId: string): [Promise<FileMeta>, RequestCanceler];
+    getFolderContentByUuid({ folderUuid, trash, offset, limit, workspacesToken, }: {
+        folderUuid: string;
+        trash?: boolean;
+        limit?: number;
+        offset?: number;
+        workspacesToken?: string;
+    }): [Promise<FetchFolderContentResponse>, RequestCanceler];
+    /**
+     * Retrieves a file with the specified fileId along with the associated workspacesToken.
+     *
+     * @param {string} fileId - The ID of the file to retrieve.
+     * @param {string} [workspacesToken] - Token for accessing workspaces.
+     * @return {[Promise<FileMeta>, RequestCanceler]} A promise with FileMeta and a canceler for the request.
+     */
+    getFile(fileId: string, workspacesToken?: string): [Promise<FileMeta>, RequestCanceler];
     /**
      * Gets the files in a folder.
      *
@@ -99,6 +137,11 @@ export declare class Storage {
      * @param fileEntry
      */
     createFileEntry(fileEntry: FileEntry, resourcesToken?: Token): Promise<DriveFileData>;
+    /**
+     * Creates a new file entry
+     * @param fileEntry
+     */
+    createFileEntryByUuid(fileEntry: FileEntryByUuid, resourcesToken?: string): Promise<DriveFileData>;
     /**
      * Creates a new thumbnail entry
      * @param thumbnailEntry
@@ -109,6 +152,33 @@ export declare class Storage {
      * @param payload
      */
     updateFile(payload: UpdateFilePayload, resourcesToken?: Token): Promise<void>;
+    /**
+     * Updates the name of a file with the given UUID.
+     *
+     * @param {Object} payload - The payload containing the UUID and new name of the file.
+     * @param {string} payload.fileUuid - The UUID of the file.
+     * @param {string} payload.name - The new name of the file.
+     * @param {string} [resourcesToken] - The token for accessing resources.
+     * @return {Promise<void>} - A Promise that resolves when the file name is successfully updated.
+     */
+    updateFileNameWithUUID(payload: {
+        fileUuid: string;
+        name: string;
+    }, resourcesToken?: Token): Promise<void>;
+    /**
+     * Updates the name and the type from a given file UUID.
+     *
+     * @param {Object} payload - The payload containing the UUID and the new properties of the file.
+     * @param {string} payload.fileUuid - The UUID of the file.
+     * @param {string} payload.name - The new name of the file.
+     * @param {string} payload.type - The new type of the file.
+     * @param {string} [resourcesToken] - The token for accessing resources.
+     * @return {Promise<void>} - A Promise that resolves when the file name is successfully updated.
+     */
+    updateFileMetaByUUID(fileUuid: string, payload: {
+        plainName?: string;
+        type?: string | null;
+    }, resourcesToken?: Token): Promise<void>;
     /**
      * Deletes a specific file entry
      * @param payload
@@ -127,8 +197,14 @@ export declare class Storage {
     /**
      * Returns a list of the n most recent files
      * @param limit
+     * @deprecated use `getRecentFilesV2` call instead.
      */
     getRecentFiles(limit: number): Promise<DriveFileData[]>;
+    /**
+     * Returns a list of the n most recent files
+     * @param limit
+     */
+    getRecentFilesV2(limit: number): Promise<DriveFileData[]>;
     /**
      * Returns a list of items in trash
      */
@@ -155,9 +231,10 @@ export declare class Storage {
      * Get global search items.
      *
      * @param {string} search - The name of the item.
+     * @param {string} workspaceId - The ID of the workspace (optional).
      * @returns {[Promise<SearchResultData>, RequestCanceler]} An array containing a promise to get the API response and a function to cancel the request.
      */
-    getGlobalSearchItems(search: string): [Promise<SearchResultData>, RequestCanceler];
+    getGlobalSearchItems(search: string, workspaceId?: string): [Promise<SearchResultData>, RequestCanceler];
     /**
      * Returns the needed headers for the module requests
      * @private
@@ -166,17 +243,18 @@ export declare class Storage {
     /**
      * Gets the ancestors of a given folder UUID
      *
-     * @param {string} folderUUID - UUID of the folder.
-     * @returns {Promise<FolderAncestor[]>}
+     * @param {string} uuid - UUID of the folder.
+     * @param {boolean} [isShared=false] - Whether the folder is a shared item or not.
+     * @returns {Promise<FolderAncestor[]>} A promise that resolves with an array of ancestors of the given folder.
      */
-    getFolderAncestors(uuid: string): Promise<FolderAncestor[]>;
+    getFolderAncestors(uuid: string, isShared?: boolean): Promise<FolderAncestor[]>;
     /**
      * Gets the meta of a given folder UUID
      *
      * @param {string} folderUUID - UUID of the folder.
      * @returns {Promise<FolderMeta>}
      */
-    getFolderMeta(uuid: string): Promise<FolderMeta>;
+    getFolderMeta(uuid: string, workspacesToken?: string, resourcesToken?: string): Promise<FolderMeta>;
     /**
      * Gets the meta of a given folder Id
      *
@@ -192,4 +270,46 @@ export declare class Storage {
      * @returns {Promise<DriveFileData>} - The replaced file data.
      */
     replaceFile(uuid: string, payload: ReplaceFile): Promise<DriveFileData>;
+    /**
+     * Checks the size limit for a file.
+     *
+     * @param {number} size - The size of the file to check.
+     * @return {Promise<void>} - A promise that resolves when the size limit check is complete.
+     */
+    checkSizeLimit(size: number): Promise<void>;
+    /**
+     * Retrieves the folder tree based on the UUID.
+     *
+     * @param {string} uuid - The UUID of the folder.
+     * @return {Promise<FolderTreeResponse>} The promise containing the folder tree response.
+     */
+    getFolderTree(uuid: string): Promise<FolderTreeResponse>;
+    /**
+     * Checks if the given files already exist in the given folder.
+     *
+     * @param {CheckDuplicatedFilesPayload} payload - Payload containing the folder UUID and the list of files to check.
+     * @return {Promise<CheckDuplicatedFilesResponse>} - Promise that contains the duplicated files in a list.
+     */
+    checkDuplicatedFiles({ folderUuid, filesList, }: CheckDuplicatedFilesPayload): Promise<CheckDuplicatedFilesResponse>;
+    /**
+     * Checks if the given folders names already exist in the given folder
+     *
+     * @param {CheckDuplicatedFolderPayload} payload - Payload containing the folder UUID and the list of folders to check.
+     * @return {Promise<CheckDuplicatedFoldersResponse>} - Promise that contains the duplicated folders in a list.
+     */
+    checkDuplicatedFolders({ folderUuid, folderNamesList, }: CheckDuplicatedFolderPayload): Promise<CheckDuplicatedFoldersResponse>;
+    /**
+     * Gets the folder meta from a given path (e.g. "/folder1/folder2")
+     *
+     * @param {string} folderPath - The path of the folder.
+     * @returns {Promise<FolderMeta>} A promise that resolves the folder on that path.
+     */
+    getFolderByPath(folderPath: string): Promise<FolderMeta>;
+    /**
+     * Gets the file meta from a given path (e.g. "/folder1/folder2/file.png")
+     *
+     * @param {string} filePath - The path of the file.
+     * @returns {Promise<FileMeta>} A promise that resolves the file on that path.
+     */
+    getFileByPath(filePath: string): Promise<FileMeta>;
 }