uipath 2.1.125__tar.gz → 2.1.126__tar.gz

{uipath-2.1.125 → uipath-2.1.126}/.github/workflows/ci.yml

@@ -19,4 +19,4 @@ jobs:
     uses: ./.github/workflows/lint.yml
 
   test:
-    uses: ./.github/workflows/test.yml
+    uses: ./.github/workflows/test.yml

uipath-2.1.126/.pipelines/security-scans.yml

@@ -0,0 +1,53 @@
+trigger: none
+pr: none
+
+schedules:
+  - cron: "0 11 * * 1"
+    displayName: "Every Monday at 1:00 PM"
+    branches:
+      include:
+        - main
+    always: true
+
+resources:
+  repositories:
+    - repository: codeql
+      type: github
+      name: UiPath/AzurePipelinesTemplates
+      ref: refs/tags/uipath.security.codeql.1.9.5
+      endpoint: UiPath
+    - repository: fossa
+      type: github
+      name: UiPath/AzurePipelinesTemplates
+      ref: refs/tags/uipath.security.fossa.3.0.13
+      endpoint: UiPath
+
+variables:
+  - template: ./variables.yml
+
+stages:
+  - stage: FOSSA
+    dependsOn: []
+    jobs:
+      - job: FOSSA
+        steps:
+          - template: Security/fossa.steps.yml@fossa
+            parameters:
+              OS: linux
+              azureSubscription: $(azureInternalProductionEaConnectionName)
+              FOSSAFlags: '--project "Coded Agents" --branch "$(Build.SourceBranch)" --revision "$(Build.SourceVersion)-$(Build.BuildId)"'
+              FOSSATestFlags: '--project "Coded Agents" --revision "$(Build.SourceVersion)-$(Build.BuildId)"'
+              ${{ if contains(variables['Build.SourceBranch'], 'main') }}:
+                publishSecurityReports: true
+
+
+  - stage: CODEQL
+    dependsOn: []
+    jobs:
+      - job: CODEQL
+        steps:
+          - template: Security/codeql.interpreted.steps.yml@codeql
+            parameters:
+              os: 'linux64'
+              language: 'python'
+              azureSubscription: $(azureInternalProductionEaConnectionName)

uipath-2.1.126/.pipelines/variables.yml

@@ -0,0 +1,2 @@
+variables:
+  azureInternalProductionEaConnectionName: Internal-Production-EA

{uipath-2.1.125 → uipath-2.1.126}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.125
+Version: 2.1.126
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.1.125 → uipath-2.1.126}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.125"
+version = "2.1.126"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

{uipath-2.1.125 → uipath-2.1.126}/scripts/update_agents_md.py

@@ -152,6 +152,8 @@ def generate_quick_api_docs() -> str:
     Returns:
         Markdown string with SDK API documentation
     """
+    from functools import cached_property
+
     from uipath import UiPath
 
     output = StringIO()
@@ -178,7 +180,7 @@ def generate_quick_api_docs() -> str:
         if name.startswith("_"):
             continue
         attr = getattr(UiPath, name, None)
-        if isinstance(attr, property):
+        if isinstance(attr, (property, cached_property)):
             uipath_properties.append(name)
 
     uipath_properties.sort()
@@ -186,12 +188,19 @@ def generate_quick_api_docs() -> str:
     for service_name in uipath_properties:
         try:
             service_property = getattr(UiPath, service_name)
-            if not isinstance(service_property, property):
+            if not isinstance(service_property, (property, cached_property)):
                 continue
 
-            service_doc = (
-                service_property.fget.__doc__ if service_property.fget else None
-            )
+            # Get the function object (property uses .fget, cached_property uses .func)
+            if isinstance(service_property, cached_property):
+                func = service_property.func
+            else:
+                func = service_property.fget  # type: ignore[assignment]
+
+            if func is None:
+                continue
+
+            service_doc = func.__doc__
 
             description = (
                 service_doc.strip().split("\n")[0]
@@ -200,9 +209,8 @@ def generate_quick_api_docs() -> str:
             )
 
             return_annotation = None
-            if service_property.fget:
-                property_sig = inspect.signature(service_property.fget)
-                return_annotation = property_sig.return_annotation
+            property_sig = inspect.signature(func)
+            return_annotation = property_sig.return_annotation
 
             output.write(f"### {service_name.replace('_', ' ').title()}\n\n")
             output.write(f"{description}\n\n")
@@ -473,6 +481,115 @@ def generate_cli_docs() -> str:
     return output.getvalue()
 
 
+def generate_service_cli_docs() -> str:
+    """Generate documentation for service CLI commands.
+
+    Returns:
+        Markdown string with service CLI commands documentation
+    """
+    from uipath._cli import cli
+
+    output = StringIO()
+    output.write("\n## Service Commands Reference\n\n")
+    output.write(
+        "The UiPath CLI provides commands for interacting with UiPath platform services. "
+        "These commands allow you to manage buckets, assets, jobs, and other resources.\n\n"
+    )
+
+    # Find all service command groups (Groups registered in CLI)
+    service_groups = []
+    for name, cmd in sorted(cli.commands.items()):
+        if isinstance(cmd, click.Group) and name not in [
+            "init",
+            "run",
+            "eval",
+            "new",
+            "pack",
+            "publish",
+            "deploy",
+        ]:
+            service_groups.append((name, cmd))
+
+    if not service_groups:
+        return ""
+
+    for service_name, service_group in service_groups:
+        output.write(f"### `uipath {service_name}`\n\n")
+        output.write(f"{service_group.help or 'Manage ' + service_name}\n\n")
+
+        # Document subcommands
+        if hasattr(service_group, "commands"):
+            subcommands = sorted(service_group.commands.items())
+            output.write("**Subcommands:**\n\n")
+
+            for subcmd_name, subcmd in subcommands:
+                # Handle nested groups (e.g., buckets files)
+                if isinstance(subcmd, click.Group):
+                    output.write(f"#### `uipath {service_name} {subcmd_name}`\n\n")
+                    output.write(f"{subcmd.help or f'{subcmd_name} commands'}\n\n")
+
+                    if hasattr(subcmd, "commands"):
+                        nested_cmds = sorted(subcmd.commands.items())
+                        for nested_name, nested_cmd in nested_cmds:
+                            cmd_info = get_command_help(
+                                nested_cmd,
+                                f"{service_name} {subcmd_name} {nested_name}",
+                            )
+                            _write_command_doc(
+                                output, cmd_info, service_name, subcmd_name
+                            )
+                else:
+                    cmd_info = get_command_help(subcmd, f"{service_name} {subcmd_name}")
+                    _write_command_doc(output, cmd_info, service_name)
+
+        output.write("---\n\n")
+
+    return output.getvalue()
+
+
+def _write_command_doc(
+    output: StringIO, cmd_info: Dict[str, Any], *path_parts: str
+) -> None:
+    """Write command documentation to output stream.
+
+    Args:
+        output: StringIO buffer to write to
+        cmd_info: Command information dict
+        path_parts: Command path parts (e.g., "buckets", "files")
+    """
+    full_path = " ".join(path_parts + (cmd_info["name"].split()[-1],))
+
+    output.write(f"**`uipath {full_path}`**\n\n")
+    output.write(f"{cmd_info['help']}\n\n")
+
+    arguments = [p for p in cmd_info["params"] if p["type"] == "Argument"]
+    options = [p for p in cmd_info["params"] if p["type"] == "Option"]
+
+    if arguments:
+        output.write("Arguments:\n")
+        for arg in arguments:
+            required = " (required)" if arg.get("required") else ""
+            help_text = arg["help"] if arg["help"] else "N/A"
+            output.write(f"- `{arg['name']}`{required}: {help_text}\n")
+        output.write("\n")
+
+    if options:
+        output.write("Options:\n")
+        for opt in options:
+            opts_str = ", ".join(f"`{o}`" for o in opt.get("opts", []))
+            help_text = opt["help"] if opt["help"] else ""
+
+            if opt.get("default") is not None and not opt.get("is_flag"):
+                default = opt["default"]
+                if isinstance(default, str):
+                    help_text += f" (default: `{default}`)"
+                else:
+                    help_text += f" (default: `{default}`)"
+
+            output.write(f"- {opts_str}: {help_text}\n")
+        output.write("\n")
+
+
 def generate_agents_md_reference_files() -> None:
     """Generate separate reference files."""
     resources_dir = Path(__file__).parent.parent / "src" / "uipath" / "_resources"
@@ -482,12 +599,15 @@ def generate_agents_md_reference_files() -> None:
 
     api_docs = generate_quick_api_docs()
     cli_docs = generate_cli_docs()
+    service_cli_docs = generate_service_cli_docs()
 
     with open(sdk_reference_path, "w", encoding="utf-8") as f:
         f.write(api_docs.lstrip("\n"))
 
     with open(cli_reference_path, "w", encoding="utf-8") as f:
         f.write(cli_docs.lstrip("\n"))
+        if service_cli_docs:
+            f.write(service_cli_docs)
 
 
 def main():

{uipath-2.1.125 → uipath-2.1.126}/src/uipath/_cli/_auth/_auth_service.py

@@ -19,7 +19,7 @@ from uipath.models.auth import TokenData
 class AuthService:
     def __init__(
         self,
-        environment: str,
+        environment: Optional[str],
         *,
         force: bool,
         client_id: Optional[str] = None,
@@ -34,7 +34,7 @@ class AuthService:
         self._client_secret = client_secret
         self._base_url = base_url
         self._tenant = tenant
-        self._domain = resolve_domain(self._base_url, environment, self._force)
+        self._domain = resolve_domain(self._base_url, environment)
         self._scope = scope
 
     def authenticate(self) -> None:

{uipath-2.1.125 → uipath-2.1.126}/src/uipath/_cli/_auth/_url_utils.py

@@ -7,9 +7,7 @@ from .._utils._console import ConsoleLogger
 console = ConsoleLogger()
 
 
-def resolve_domain(
-    base_url: Optional[str], environment: Optional[str], force: bool = False
-) -> str:
+def resolve_domain(base_url: Optional[str], environment: Optional[str]) -> str:
     """Resolve the UiPath domain, giving priority to base_url when valid.
 
     Args:
@@ -27,10 +25,9 @@ def resolve_domain(
         if domain:
             return domain
 
-    # If base_url is not set (or force is False), check UIPATH_URL
-    if not base_url or not force:
+    if environment is None:
         uipath_url = os.getenv("UIPATH_URL")
-        if uipath_url and environment == "cloud":
+        if uipath_url:
             parsed = urlparse(uipath_url)
             if parsed.scheme and parsed.netloc:
                 domain = f"{parsed.scheme}://{parsed.netloc}"

{uipath-2.1.125 → uipath-2.1.126}/src/uipath/_cli/_utils/_common.py

@@ -38,7 +38,6 @@ def environment_options(function):
         "--cloud",
         "environment",
         flag_value="cloud",
-        default=True,
         help="Use production environment",
     )(function)
     return function

{uipath-2.1.125 → uipath-2.1.126}/src/uipath/_resources/SDK_REFERENCE.md

@@ -70,6 +70,129 @@ sdk.assets.update_async(robot_asset: uipath.models.assets.UserAsset, folder_key:
 
 ```
 
+### Attachments
+
+Attachments service
+
+```python
+# Delete an attachment.
+sdk.attachments.delete(key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+
+# Delete an attachment asynchronously.
+sdk.attachments.delete_async(key: uuid.UUID, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+
+# Download an attachment.
+sdk.attachments.download(key: uuid.UUID, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> str
+
+# Download an attachment asynchronously.
+sdk.attachments.download_async(key: uuid.UUID, destination_path: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> str
+
+# Upload a file or content to UiPath as an attachment.
+sdk.attachments.upload(name: str, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
+
+# Upload a file or content to UiPath as an attachment asynchronously.
+sdk.attachments.upload_async(name: str, content: Union[str, bytes, NoneType]=None, source_path: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uuid.UUID
+
+```
+
+### Buckets
+
+Buckets service
+
+```python
+# Create a new bucket.
+sdk.buckets.create(name: str, description: Optional[str]=None, identifier: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None) -> uipath.models.buckets.Bucket
+
+# 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 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
+
+# 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
+
+# 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
+
+# Download a file from a bucket asynchronously.
+sdk.buckets.download_async(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
+
+# Check if bucket exists.
+sdk.buckets.exists(name: str, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> bool
+
+# Async version of exists().
+sdk.buckets.exists_async(name: 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]
+
+# Async version of get_files().
+sdk.buckets.get_files_async(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.AsyncIterator[uipath.models.buckets.BucketFile]
+
+# List buckets with auto-pagination.
+sdk.buckets.list(folder_path: Optional[str]=None, folder_key: Optional[str]=None, name: Optional[str]=None) -> typing.Iterator[uipath.models.buckets.Bucket]
+
+# Async version of list() with auto-pagination.
+sdk.buckets.list_async(folder_path: Optional[str]=None, folder_key: Optional[str]=None, name: Optional[str]=None) -> typing.AsyncIterator[uipath.models.buckets.Bucket]
+
+# List files in a bucket.
+sdk.buckets.list_files(name: Optional[str]=None, key: Optional[str]=None, prefix: str="", folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.Iterator[uipath.models.buckets.BucketFile]
+
+# List files in a bucket asynchronously.
+sdk.buckets.list_files_async(name: Optional[str]=None, key: Optional[str]=None, prefix: str="", folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> typing.AsyncIterator[uipath.models.buckets.BucketFile]
+
+# Retrieve bucket information by its name.
+sdk.buckets.retrieve(name: Optional[str]=None, key: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.buckets.Bucket
+
+# Asynchronously retrieve bucket information by its name.
+sdk.buckets.retrieve_async(name: Optional[str]=None, key: Optional[str]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> uipath.models.buckets.Bucket
+
+# Upload a file to a bucket.
+sdk.buckets.upload(key: Optional[str]=None, name: Optional[str]=None, blob_file_path: str, content_type: Optional[str]=None, source_path: Optional[str]=None, content: Union[str, bytes, NoneType]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+
+# Upload a file to a bucket asynchronously.
+sdk.buckets.upload_async(key: Optional[str]=None, name: Optional[str]=None, blob_file_path: str, content_type: Optional[str]=None, source_path: Optional[str]=None, content: Union[str, bytes, NoneType]=None, folder_key: Optional[str]=None, folder_path: Optional[str]=None) -> None
+
+```
+
+### Connections
+
+Connections service
+
+```python
+# Lists all connections with optional filtering.
+sdk.connections.list(name: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None, connector_key: Optional[str]=None, skip: Optional[int]=None, top: Optional[int]=None) -> typing.List[uipath.models.connections.Connection]
+
+# Asynchronously lists all connections with optional filtering.
+sdk.connections.list_async(name: Optional[str]=None, folder_path: Optional[str]=None, folder_key: Optional[str]=None, connector_key: Optional[str]=None, skip: Optional[int]=None, top: Optional[int]=None) -> typing.List[uipath.models.connections.Connection]
+
+# Synchronously retrieve connection API metadata.
+sdk.connections.metadata(element_instance_id: int, tool_path: str, schema_mode: bool=True) -> uipath.models.connections.ConnectionMetadata
+
+# Asynchronously retrieve connection API metadata.
+sdk.connections.metadata_async(element_instance_id: int, tool_path: str, schema_mode: bool=True) -> uipath.models.connections.ConnectionMetadata
+
+# Retrieve connection details by its key.
+sdk.connections.retrieve(key: str) -> uipath.models.connections.Connection
+
+# Asynchronously retrieve connection details by its key.
+sdk.connections.retrieve_async(key: str) -> uipath.models.connections.Connection
+
+# Retrieve event payload from UiPath Integration Service.
+sdk.connections.retrieve_event_payload(event_args: uipath.models.connections.EventArguments) -> typing.Dict[str, typing.Any]
+
+# Retrieve event payload from UiPath Integration Service.
+sdk.connections.retrieve_event_payload_async(event_args: uipath.models.connections.EventArguments) -> typing.Dict[str, typing.Any]
+
+# Retrieve an authentication token for a connection.
+sdk.connections.retrieve_token(key: str, token_type: <enum 'ConnectionTokenType="direct") -> uipath.models.connections.ConnectionToken
+
+# Asynchronously retrieve an authentication token for a connection.
+sdk.connections.retrieve_token_async(key: str, token_type: <enum 'ConnectionTokenType="direct") -> uipath.models.connections.ConnectionToken
+
+```
+
 ### Context Grounding
 
 Context Grounding service
@@ -193,6 +316,16 @@ sdk.entities.update_records_async(entity_key: str, records: List[Any], schema: O
 
 ```
 
+### Folders
+
+Folders service
+
+```python
+# Retrieve the folder key by folder path with pagination support.
+sdk.folders.retrieve_key(folder_path: str) -> typing.Optional[str]
+
+```
+
 ### Jobs
 
 Jobs service

{uipath-2.1.125 → uipath-2.1.126}/tests/cli/test_portal_service_refresh_token.py

@@ -112,15 +112,15 @@ class TestPortalServiceRefreshToken:
     @pytest.mark.parametrize(
         "env_var_url, environment, expected_token_url",
         [
-            # UIPATH_URL should be used when environment is "cloud" (default)
+            # UIPATH_URL should be used when environment is None (no flag specified)
             (
                 "https://custom.automationsuite.org/org/tenant",
-                "cloud",
+                None,
                 "https://custom.automationsuite.org/identity_/connect/token",
             ),
             (
                 "https://mycompany.uipath.com/org/tenant/",
-                "cloud",
+                None,
                 "https://mycompany.uipath.com/identity_/connect/token",
             ),
             # Explicit environment flags should override UIPATH_URL
@@ -134,6 +134,11 @@ class TestPortalServiceRefreshToken:
                 "staging",
                 "https://staging.uipath.com/identity_/connect/token",
             ),
+            (
+                "https://custom.automationsuite.org/org/tenant",
+                "cloud",
+                "https://cloud.uipath.com/identity_/connect/token",
+            ),
         ],
     )
     def test_post_refresh_token_request_with_uipath_url_env(
@@ -329,7 +334,7 @@ class TestPortalServiceRefreshToken:
             # Domain with trailing slash should not create double slash
             (
                 "https://example.uipath.com/",
-                "cloud",
+                None,
                 "https://example.uipath.com/identity_/connect/token",
             ),
             # Domain without scheme gets .uipath.com appended (current behavior)
@@ -391,13 +396,13 @@ class TestPortalServiceRefreshToken:
             (
                 "refresh_with_uipath_url_env_variable",
                 {"UIPATH_URL": "https://custom.automationsuite.org/org/tenant"},
-                "cloud",  # cloud is default when no flag specified
+                None,  # None when no flag specified
                 "https://custom.automationsuite.org/identity_/connect/token",
             ),
             (
                 "refresh_with_uipath_url_env_variable_with_trailing_slash",
                 {"UIPATH_URL": "https://custom.uipath.com/org/tenant/"},
-                "cloud",
+                None,
                 "https://custom.uipath.com/identity_/connect/token",
             ),
             (
@@ -413,15 +418,15 @@ class TestPortalServiceRefreshToken:
                 "https://staging.uipath.com/identity_/connect/token",
             ),
             (
-                "refresh_with_cloud_flag",
-                {},
-                "cloud",
+                "refresh_with_cloud_flag_overrides_env",
+                {"UIPATH_URL": "https://custom.uipath.com/org/tenant"},
+                "cloud",  # cloud flag overrides UIPATH_URL
                 "https://cloud.uipath.com/identity_/connect/token",
             ),
             (
                 "refresh_default_to_cloud",
                 {},
-                "cloud",
+                None,  # None defaults to cloud
                 "https://cloud.uipath.com/identity_/connect/token",
             ),
         ],

{uipath-2.1.125 → uipath-2.1.126}/uv.lock

@@ -3047,7 +3047,7 @@ wheels = [
 
 [[package]]
 name = "uipath"
-version = "2.1.125"
+version = "2.1.126"
 source = { editable = "." }
 dependencies = [
     { name = "azure-monitor-opentelemetry" },