uipath 2.1.131__py3-none-any.whl → 2.1.133__py3-none-any.whl

uipath/_resources/CLI_REFERENCE.md

@@ -221,3 +221,343 @@ The `uipath.json` file is automatically generated by `uipath init` and defines y
 - The `jsonSchema` must match your Pydantic models exactly
 - Re-run `uipath init --infer-bindings` instead of manual edits when possible
 
+
+## Service Commands Reference
+
+The UiPath CLI provides commands for interacting with UiPath platform services. These commands allow you to manage buckets, assets, jobs, and other resources.
+
+### `uipath buckets`
+
+Manage UiPath storage buckets and files.
+
+Buckets are cloud storage containers for files used by automation processes.
+
+
+Bucket Operations:
+    list      - List all buckets
+    create    - Create a new bucket
+    delete    - Delete a bucket
+    retrieve  - Get bucket details
+    exists    - Check if bucket exists
+
+
+File Operations (use 'buckets files' subcommand):
+    files list     - List files in a bucket
+    files search   - Search files using glob patterns
+    files upload   - Upload a file to a bucket
+    files download - Download a file from a bucket
+    files delete   - Delete a file from a bucket
+    files exists   - Check if a file exists
+
+
+Examples:
+    
+    # Bucket operations with explicit folder
+    uipath buckets list --folder-path "Shared"
+    uipath buckets create my-bucket --description "Data storage"
+    uipath buckets exists my-bucket
+    uipath buckets delete my-bucket --confirm
+    
+    # Using environment variable for folder context
+    export UIPATH_FOLDER_PATH="Shared"
+    uipath buckets list
+    uipath buckets create my-bucket --description "Data storage"
+    
+    # File operations
+    uipath buckets files list my-bucket
+    uipath buckets files search my-bucket "*.pdf"
+    uipath buckets files upload my-bucket ./data.csv remote/data.csv
+    uipath buckets files download my-bucket data.csv ./local.csv
+    uipath buckets files delete my-bucket old-data.csv --confirm
+    uipath buckets files exists my-bucket data.csv
+
+
+**Subcommands:**
+
+**`uipath buckets create`**
+
+Create a new Bucket.
+
+Examples:
+    uipath buckets create my-resource
+    uipath buckets create my-resource --folder-path Shared
+
+
+Arguments:
+- `name` (required): N/A
+
+Options:
+- `--description`: Bucket description
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets delete`**
+
+Delete a bucket.
+
+    
+    Examples:
+        uipath buckets delete my-bucket --confirm
+        uipath buckets delete my-bucket --dry-run
+    
+
+Arguments:
+- `name` (required): N/A
+
+Options:
+- `--confirm`: Skip confirmation prompt
+- `--dry-run`: Show what would be deleted without deleting
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets exists`**
+
+Check if a Bucket exists.
+
+Examples:
+    uipath buckets exists my-resource
+    uipath buckets exists my-resource --folder-path Shared
+
+
+Arguments:
+- `name` (required): N/A
+
+Options:
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+#### `uipath buckets files`
+
+Manage files within buckets.
+
+    
+    Examples:
+        
+        # List files in a bucket
+        uipath buckets files list my-bucket
+        
+        # Search for files with glob pattern
+        uipath buckets files search my-bucket "*.pdf"
+        
+        # Upload a file
+        uipath buckets files upload my-bucket ./data.csv remote/data.csv
+        
+        # Download a file
+        uipath buckets files download my-bucket data.csv ./local.csv
+        
+        # Delete a file
+        uipath buckets files delete my-bucket old-data.csv --confirm
+        
+        # Check if file exists
+        uipath buckets files exists my-bucket data.csv
+    
+
+**`uipath buckets files delete`**
+
+Delete a file from a bucket.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+        FILE_PATH: Path to file in bucket
+
+    
+    Examples:
+        uipath buckets files delete my-bucket old-data.csv --confirm
+        uipath buckets files delete reports archive/old.pdf --dry-run
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+- `file_path` (required): N/A
+
+Options:
+- `--confirm`: Skip confirmation prompt
+- `--dry-run`: Show what would be deleted
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets files download`**
+
+Download a file from a bucket.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+        REMOTE_PATH: Path to file in bucket
+        LOCAL_PATH: Local destination path
+
+    
+    Examples:
+        uipath buckets files download my-bucket data.csv ./downloads/data.csv
+        uipath buckets files download reports monthly/report.pdf ./report.pdf
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+- `remote_path` (required): N/A
+- `local_path` (required): N/A
+
+Options:
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets files exists`**
+
+Check if a file exists in a bucket.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+        FILE_PATH: Path to file in bucket
+
+    
+    Examples:
+        uipath buckets files exists my-bucket data.csv
+        uipath buckets files exists reports monthly/report.pdf
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+- `file_path` (required): N/A
+
+Options:
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets files list`**
+
+List files in a bucket.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+
+    
+    Examples:
+        uipath buckets files list my-bucket
+        uipath buckets files list my-bucket --prefix "data/"
+        uipath buckets files list reports --limit 10 --format json
+        uipath buckets files list my-bucket --all
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+
+Options:
+- `--prefix`: Filter files by prefix (default: ``)
+- `--limit`: Maximum number of files to return (default: `Sentinel.UNSET`)
+- `--offset`: Number of files to skip (default: `0`)
+- `--all`: Fetch all files (auto-paginate)
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets files search`**
+
+Search for files using glob patterns.
+
+    Uses the GetFiles API which supports glob patterns like *.pdf or data_*.csv.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+        PATTERN: Glob pattern to match files (e.g., "*.pdf", "data_*.csv")
+
+    
+    Examples:
+        uipath buckets files search my-bucket "*.pdf"
+        uipath buckets files search reports "*.csv" --recursive
+        uipath buckets files search my-bucket "data_*.json" --prefix "archive/"
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+- `pattern` (required): N/A
+
+Options:
+- `--prefix`: Directory path to search in (default: ``)
+- `--recursive`: Search subdirectories recursively
+- `--limit`: Maximum number of files to return (default: `Sentinel.UNSET`)
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets files upload`**
+
+Upload a file to a bucket.
+
+    
+    Arguments:
+        BUCKET_NAME: Name of the bucket
+        LOCAL_PATH: Local file to upload
+        REMOTE_PATH: Destination path in bucket
+
+    
+    Examples:
+        uipath buckets files upload my-bucket ./data.csv remote/data.csv
+        uipath buckets files upload reports ./report.pdf monthly/report.pdf
+    
+
+Arguments:
+- `bucket_name` (required): N/A
+- `local_path` (required): N/A
+- `remote_path` (required): N/A
+
+Options:
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets list`**
+
+List all Buckets.
+
+Examples:
+    uipath buckets list
+    uipath buckets list --folder-path Shared
+
+
+Options:
+- `--limit`: Maximum number of items to return (default: `Sentinel.UNSET`)
+- `--offset`: Number of items to skip (default: `0`)
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+**`uipath buckets retrieve`**
+
+Retrieve a bucket by name or key.
+
+    
+    Examples:
+        uipath buckets retrieve --name "my-bucket"
+        uipath buckets retrieve --key "abc-123-def-456" --format json
+    
+
+Options:
+- `--name`: Bucket name (default: `Sentinel.UNSET`)
+- `--key`: Bucket key (UUID) (default: `Sentinel.UNSET`)
+- `--folder-path`: Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: `Sentinel.UNSET`)
+- `--folder-key`: Folder key (UUID) (default: `Sentinel.UNSET`)
+- `--format`: Output format (overrides global) (default: `Sentinel.UNSET`)
+- `--output`, `-o`: Output file (overrides global) (default: `Sentinel.UNSET`)
+
+---
+

uipath/_resources/SDK_REFERENCE.md

@@ -106,11 +106,17 @@ sdk.buckets.create(name: str, description: Optional[str]=None, identifier: Optio
 # Async version of create().
 sdk.buckets.create_async(name: str, description: Optional[str]=None, identifier: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None) -> uipath.models.buckets.Bucket
 
+# Delete a bucket.
+sdk.buckets.delete(name: Optional[str]=None, key: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None) -> None
+
+# Async version of delete().
+sdk.buckets.delete_async(name: Optional[str]=None, key: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None) -> None
+
 # Delete a file from a bucket.
-sdk.buckets.delete(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+sdk.buckets.delete_file(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
 
 # Delete a file from a bucket asynchronously.
-sdk.buckets.delete_async(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+sdk.buckets.delete_file_async(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
 
 # Download a file from a bucket.
 sdk.buckets.download(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
@@ -124,6 +130,12 @@ sdk.buckets.exists(name: str, folder_key: Optional[str]=None, folder_path: Optio
 # Async version of exists().
 sdk.buckets.exists_async(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> bool
 
+# Check if a file exists in a bucket.
+sdk.buckets.exists_file(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> bool
+
+# Async version of exists_file().
+sdk.buckets.exists_file_async(name: Optional[str]=None, key: Optional[str]=None, blob_file_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> bool
+
 # Get files using OData GetFiles API (Studio-compatible).
 sdk.buckets.get_files(name: Optional[str]=None, key: Optional[str]=None, prefix: str="", recursive: bool=False, file_name_glob: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Iterator[uipath.models.buckets.BucketFile]
 

uipath/_services/buckets_service.py

@@ -258,6 +258,62 @@ class BucketsService(FolderContext, BaseService):
         bucket = Bucket.model_validate(response)
         return bucket
 
+    @traced(name="buckets_delete", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
+    def delete(
+        self,
+        *,
+        name: Optional[str] = None,
+        key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+        folder_key: Optional[str] = None,
+    ) -> None:
+        """Delete a bucket.
+
+        Args:
+            name: Bucket name
+            key: Bucket identifier (UUID)
+            folder_path: Folder path
+            folder_key: Folder key
+
+        Raises:
+            LookupError: If bucket is not found
+
+        Examples:
+            >>> sdk.buckets.delete(name="old-storage")
+            >>> sdk.buckets.delete(key="abc-123-def")
+        """
+        bucket = self.retrieve(
+            name=name, key=key, folder_key=folder_key, folder_path=folder_path
+        )
+
+        self.request(
+            "DELETE",
+            url=f"/orchestrator_/odata/Buckets({bucket.id})",
+            headers={**self.folder_headers},
+        )
+
+    @traced(name="buckets_delete", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
+    async def delete_async(
+        self,
+        *,
+        name: Optional[str] = None,
+        key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+        folder_key: Optional[str] = None,
+    ) -> None:
+        """Async version of delete()."""
+        bucket = await self.retrieve_async(
+            name=name, key=key, folder_key=folder_key, folder_path=folder_path
+        )
+
+        await self.request_async(
+            "DELETE",
+            url=f"/orchestrator_/odata/Buckets({bucket.id})",
+            headers={**self.folder_headers},
+        )
+
     @traced(name="buckets_download", run_type="uipath")
     @infer_bindings(resource_type="bucket")
     def download(
@@ -845,9 +901,116 @@ class BucketsService(FolderContext, BaseService):
             if not continuation_token:
                 break
 
-    @traced(name="buckets_delete", run_type="uipath")
+    @traced(name="buckets_exists_file", run_type="uipath")
     @infer_bindings(resource_type="bucket")
-    def delete(
+    def exists_file(
+        self,
+        *,
+        name: Optional[str] = None,
+        key: Optional[str] = None,
+        blob_file_path: str,
+        folder_key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+    ) -> bool:
+        """Check if a file exists in a bucket.
+
+        Args:
+            name: Bucket name
+            key: Bucket identifier
+            blob_file_path: Path to the file in the bucket (cannot be empty)
+            folder_key: Folder key
+            folder_path: Folder path
+
+        Returns:
+            bool: True if file exists, False otherwise
+
+        Note:
+            This method uses short-circuit iteration to stop at the first match,
+            making it memory-efficient even for large buckets. It will raise
+            LookupError if the bucket itself doesn't exist.
+
+        Raises:
+            ValueError: If blob_file_path is empty or whitespace-only
+            LookupError: If bucket is not found
+
+        Examples:
+            >>> if sdk.buckets.exists_file(name="my-storage", blob_file_path="data/file.csv"):
+            ...     print("File exists")
+            >>> # Check in specific folder
+            >>> exists = sdk.buckets.exists_file(
+            ...     name="my-storage",
+            ...     blob_file_path="reports/2024/summary.pdf",
+            ...     folder_path="Production"
+            ... )
+        """
+        if not blob_file_path or not blob_file_path.strip():
+            raise ValueError("blob_file_path cannot be empty or whitespace-only")
+
+        normalized_target = (
+            blob_file_path if blob_file_path.startswith("/") else f"/{blob_file_path}"
+        )
+        for file in self.list_files(
+            name=name,
+            key=key,
+            prefix=blob_file_path,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        ):
+            if file.path == normalized_target:
+                return True
+        return False
+
+    @traced(name="buckets_exists_file", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
+    async def exists_file_async(
+        self,
+        *,
+        name: Optional[str] = None,
+        key: Optional[str] = None,
+        blob_file_path: str,
+        folder_key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+    ) -> bool:
+        """Async version of exists_file().
+
+        Args:
+            name: Bucket name
+            key: Bucket identifier
+            blob_file_path: Path to the file in the bucket (cannot be empty)
+            folder_key: Folder key
+            folder_path: Folder path
+
+        Returns:
+            bool: True if file exists, False otherwise
+
+        Raises:
+            ValueError: If blob_file_path is empty or whitespace-only
+            LookupError: If bucket is not found
+
+        Examples:
+            >>> if await sdk.buckets.exists_file_async(name="my-storage", blob_file_path="data/file.csv"):
+            ...     print("File exists")
+        """
+        if not blob_file_path or not blob_file_path.strip():
+            raise ValueError("blob_file_path cannot be empty or whitespace-only")
+
+        normalized_target = (
+            blob_file_path if blob_file_path.startswith("/") else f"/{blob_file_path}"
+        )
+        async for file in self.list_files_async(
+            name=name,
+            key=key,
+            prefix=blob_file_path,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        ):
+            if file.path == normalized_target:
+                return True
+        return False
+
+    @traced(name="buckets_delete_file", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
+    def delete_file(
         self,
         *,
         name: Optional[str] = None,
@@ -866,7 +1029,7 @@ class BucketsService(FolderContext, BaseService):
             folder_path: Folder path
 
         Examples:
-            >>> sdk.buckets.delete(name="my-storage", blob_file_path="data/file.txt")
+            >>> sdk.buckets.delete_file(name="my-storage", blob_file_path="data/file.txt")
         """
         bucket = self.retrieve(
             name=name, key=key, folder_key=folder_key, folder_path=folder_path
@@ -881,9 +1044,9 @@ class BucketsService(FolderContext, BaseService):
             headers=spec.headers,
         )
 
-    @traced(name="buckets_delete", run_type="uipath")
+    @traced(name="buckets_delete_file", run_type="uipath")
     @infer_bindings(resource_type="bucket")
-    async def delete_async(
+    async def delete_file_async(
         self,
         *,
         name: Optional[str] = None,
@@ -902,7 +1065,7 @@ class BucketsService(FolderContext, BaseService):
             folder_path: Folder path
 
         Examples:
-            >>> await sdk.buckets.delete_async(name="my-storage", blob_file_path="data/file.txt")
+            >>> await sdk.buckets.delete_file_async(name="my-storage", blob_file_path="data/file.txt")
         """
         bucket = await self.retrieve_async(
             name=name, key=key, folder_key=folder_key, folder_path=folder_path