@uipath/uipath-typescript 1.3.8 → 1.3.10

package/dist/buckets/index.d.ts

@@ -396,6 +396,11 @@ type BucketGetAllOptions = RequestOptions & PaginationOptions & {
 };
 interface BucketGetByIdOptions extends BaseOptions {
 }
+/**
+ * Options for getting a single bucket by name
+ */
+interface BucketGetByNameOptions extends FolderScopedOptions {
+}
 /**
  * Maps header names to their values
  *
@@ -498,6 +503,45 @@ interface BlobItem {
      */
     lastModified: string | null;
 }
+/**
+ * Represents a file or directory entry in a bucket
+ */
+interface BucketFile {
+    /**
+     * Full path to the file or directory
+     */
+    path: string;
+    /**
+     * Content type of the file (empty for directories)
+     */
+    contentType: string;
+    /**
+     * Size of the file in bytes
+     */
+    size: number;
+    /**
+     * Whether the entry is a directory
+     */
+    isDirectory: boolean;
+    /**
+     * Identifier of the file, when available
+     */
+    id: string | null;
+}
+/**
+ * Options for listing files in a bucket directory
+ */
+type BucketGetFilesOptions = RequestOptions & PaginationOptions & FolderScopedOptions & {
+    /**
+     * Regex pattern to filter file names (e.g., '.*\\.pdf$')
+     */
+    fileNameRegex?: string;
+};
+/**
+ * Options for deleting a file from a bucket
+ */
+interface BucketDeleteFileOptions extends FolderScopedOptions {
+}
 /**
  * Options for uploading files to a bucket
  */
@@ -606,6 +650,26 @@ interface BucketServiceModel {
      * ```
      */
     getById(bucketId: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
+    /**
+     * Retrieves a single orchestrator storage bucket by name.
+     *
+     * @param name - Bucket name to search for
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
+     * @returns Promise resolving to a single bucket
+     * {@link BucketGetResponse}
+     * @example
+     * ```typescript
+     * // By folder ID
+     * await buckets.getByName('MyBucket', { folderId: <folderId> });
+     *
+     * // By folder key (GUID)
+     * await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
+     *
+     * // By folder path
+     * await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
+     * ```
+     */
+    getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
     /**
      * Gets metadata for files in a bucket with optional filtering and pagination
      *
@@ -683,6 +747,64 @@ interface BucketServiceModel {
      * ```
      */
     uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
+    /**
+     * Deletes a file from a bucket
+     *
+     * @param bucketId - The ID of the bucket
+     * @param path - The full path to the file to delete
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the file is deleted
+     * @example
+     * ```typescript
+     * // Delete a file from a bucket
+     * await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
+     * ```
+     */
+    deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
+    /**
+     * Lists all files in a bucket.
+     *
+     * Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
+     * and filter / orderby / select / expand. {@link BucketFile} entries include
+     * `isDirectory` so callers can distinguish folders from files.
+     *
+     * The method returns either:
+     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
+     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param bucketId - The ID of the bucket
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
+     * {@link BucketGetFilesOptions}
+     * @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
+     * {@link BucketFile}
+     * @example
+     * ```typescript
+     * // List all files in the bucket
+     * const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
+     *
+     * // Filter by regex pattern
+     * const pdfs = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   fileNameRegex: '.*\\.pdf$'
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
 }
 
 declare class BucketService extends FolderScopedService implements BucketServiceModel {
@@ -704,6 +826,30 @@ declare class BucketService extends FolderScopedService implements BucketService
      * ```
      */
     getById(id: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
+    /**
+     * Retrieves a single orchestrator storage bucket by name.
+     *
+     * @param name - Bucket name to search for
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
+     * @returns Promise resolving to a single bucket
+     * {@link BucketGetResponse}
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // By folder ID
+     * await buckets.getByName('MyBucket', { folderId: <folderId> });
+     *
+     * // By folder key (GUID)
+     * await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
+     *
+     * // By folder path
+     * await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
+     * ```
+     */
+    getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
     /**
      * Gets all buckets across folders with optional filtering and folder scoping
      *
@@ -855,6 +1001,72 @@ declare class BucketService extends FolderScopedService implements BucketService
      * @returns Promise resolving to blob file access information
      */
     private _getUri;
+    /**
+     * Lists all files in a bucket.
+     *
+     * Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
+     * and filter / orderby / select / expand. {@link BucketFile} entries include
+     * `isDirectory` so callers can distinguish folders from files.
+     *
+     * The method returns either:
+     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
+     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param bucketId - The ID of the bucket
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
+     * @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // List all files in the bucket
+     * const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
+     *
+     * // Filter by regex pattern
+     * const pdfs = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   fileNameRegex: '.*\\.pdf$'
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
+    /**
+     * Deletes a file from a bucket
+     *
+     * @param bucketId - The ID of the bucket
+     * @param path - The full path to the file to delete
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the file is deleted
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // Delete a file from a bucket
+     * await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
+     * ```
+     */
+    deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
     /**
      * Gets a direct upload URL for a file in the bucket
      *
@@ -865,4 +1077,4 @@ declare class BucketService extends FolderScopedService implements BucketService
 }
 
 export { BucketOptions, BucketService, BucketService as Buckets };
-export type { BlobItem, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, ResponseDictionary };
+export type { BlobItem, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, ResponseDictionary };