uipath 2.1.126__py3-none-any.whl → 2.1.127__py3-none-any.whl

uipath/_resources/SDK_REFERENCE.md

@@ -168,10 +168,10 @@ sdk.connections.list(name: Optional[str]=None, folder_path: Optional[str]=None,
 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
+sdk.connections.metadata(element_instance_id: int, connector_key: str, tool_path: str, parameters: Optional[Dict[str, str]]=None, schema_mode: bool=True, max_jit_depth: int=5) -> 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
+sdk.connections.metadata_async(element_instance_id: int, connector_key: str, tool_path: str, parameters: Optional[Dict[str, str]]=None, schema_mode: bool=True, max_jit_depth: int=5) -> uipath.models.connections.ConnectionMetadata
 
 # Retrieve connection details by its key.
 sdk.connections.retrieve(key: str) -> uipath.models.connections.Connection

uipath/_services/connections_service.py

@@ -1,6 +1,7 @@
 import json
 import logging
 from typing import Any, Dict, List, Optional
+from urllib.parse import parse_qsl, quote, urlsplit
 
 from httpx import Response
 
@@ -60,24 +61,77 @@ class ConnectionsService(BaseService):
         hide_output=True,
     )
     def metadata(
-        self, element_instance_id: int, tool_path: str, schema_mode: bool = True
+        self,
+        element_instance_id: int,
+        connector_key: str,
+        tool_path: str,
+        parameters: Optional[Dict[str, str]] = None,
+        schema_mode: bool = True,
+        max_jit_depth: int = 5,
     ) -> ConnectionMetadata:
         """Synchronously retrieve connection API metadata.
 
-        This method fetches the metadata for a connection,
-        which can be used to establish communication with an external service.
+        This method fetches the metadata for a connection. When parameters are provided,
+        it automatically fetches JIT (Just-In-Time) metadata for cascading fields in a loop,
+        following action URLs up to a maximum depth.
 
         Args:
             element_instance_id (int): The element instance ID of the connection.
+            connector_key (str): The connector key (e.g., 'uipath-atlassian-jira', 'uipath-slack').
             tool_path (str): The tool path to retrieve metadata for.
+            parameters (Optional[Dict[str, str]]): Parameter values. When provided, triggers
+                automatic JIT fetching for cascading fields.
             schema_mode (bool): Whether or not to represent the output schema in the response fields.
+            max_jit_depth (int): The maximum depth of the JIT resolution loop.
 
         Returns:
             ConnectionMetadata: The connection metadata.
+
+        Examples:
+            >>> metadata = sdk.connections.metadata(
+            ...     element_instance_id=123,
+            ...     connector_key="uipath-atlassian-jira",
+            ...     tool_path="Issue",
+            ...     parameters={"projectId": "PROJ-123"}  # Optional
+            ... )
         """
-        spec = self._metadata_spec(element_instance_id, tool_path, schema_mode)
-        response = self.request(spec.method, url=spec.endpoint, headers=spec.headers)
-        return ConnectionMetadata.model_validate(response.json())
+        spec = self._metadata_spec(
+            element_instance_id, connector_key, tool_path, schema_mode
+        )
+        response = self.request(
+            spec.method, url=spec.endpoint, params=spec.params, headers=spec.headers
+        )
+        data = response.json()
+        metadata = ConnectionMetadata.model_validate(data)
+
+        last_action_url = None
+        depth = 0
+
+        while (
+            parameters
+            and (action_url := self._get_jit_action_url(metadata))
+            and depth < max_jit_depth
+        ):
+            # Stop if we're about to call the same URL template again
+            if action_url == last_action_url:
+                break
+
+            last_action_url = action_url
+            depth += 1
+
+            jit_spec = self._metadata_jit_spec(
+                element_instance_id, action_url, parameters, schema_mode
+            )
+            jit_response = self.request(
+                jit_spec.method,
+                url=jit_spec.endpoint,
+                params=jit_spec.params,
+                headers=jit_spec.headers,
+            )
+            data = jit_response.json()
+            metadata = ConnectionMetadata.model_validate(data)
+
+        return metadata
 
     @traced(name="connections_list", run_type="uipath")
     def list(
@@ -217,26 +271,77 @@ class ConnectionsService(BaseService):
         hide_output=True,
     )
     async def metadata_async(
-        self, element_instance_id: int, tool_path: str, schema_mode: bool = True
+        self,
+        element_instance_id: int,
+        connector_key: str,
+        tool_path: str,
+        parameters: Optional[Dict[str, str]] = None,
+        schema_mode: bool = True,
+        max_jit_depth: int = 5,
     ) -> ConnectionMetadata:
         """Asynchronously retrieve connection API metadata.
 
-        This method fetches the metadata for a connection,
-        which can be used to establish communication with an external service.
+        This method fetches the metadata for a connection. When parameters are provided,
+        it automatically fetches JIT (Just-In-Time) metadata for cascading fields in a loop,
+        following action URLs up to a maximum depth.
 
         Args:
             element_instance_id (int): The element instance ID of the connection.
+            connector_key (str): The connector key (e.g., 'uipath-atlassian-jira', 'uipath-slack').
             tool_path (str): The tool path to retrieve metadata for.
+            parameters (Optional[Dict[str, str]]): Parameter values. When provided, triggers
+                automatic JIT fetching for cascading fields.
             schema_mode (bool): Whether or not to represent the output schema in the response fields.
+            max_jit_depth (int): The maximum depth of the JIT resolution loop.
 
         Returns:
             ConnectionMetadata: The connection metadata.
+
+        Examples:
+            >>> metadata = await sdk.connections.metadata_async(
+            ...     element_instance_id=123,
+            ...     connector_key="uipath-atlassian-jira",
+            ...     tool_path="Issue",
+            ...     parameters={"projectId": "PROJ-123"}  # Optional
+            ... )
         """
-        spec = self._metadata_spec(element_instance_id, tool_path, schema_mode)
+        spec = self._metadata_spec(
+            element_instance_id, connector_key, tool_path, schema_mode
+        )
         response = await self.request_async(
-            spec.method, url=spec.endpoint, headers=spec.headers
+            spec.method, url=spec.endpoint, params=spec.params, headers=spec.headers
         )
-        return ConnectionMetadata.model_validate(response.json())
+        data = response.json()
+        metadata = ConnectionMetadata.model_validate(data)
+
+        last_action_url = None
+        depth = 0
+
+        while (
+            parameters
+            and (action_url := self._get_jit_action_url(metadata))
+            and depth < max_jit_depth
+        ):
+            # Stop if we're about to call the same URL template again
+            if action_url == last_action_url:
+                break
+
+            last_action_url = action_url
+            depth += 1
+
+            jit_spec = self._metadata_jit_spec(
+                element_instance_id, action_url, parameters, schema_mode
+            )
+            jit_response = await self.request_async(
+                jit_spec.method,
+                url=jit_spec.endpoint,
+                params=jit_spec.params,
+                headers=jit_spec.headers,
+            )
+            data = jit_response.json()
+            metadata = ConnectionMetadata.model_validate(data)
+
+        return metadata
 
     @traced(
         name="connections_retrieve_token",
@@ -377,9 +482,13 @@ class ConnectionsService(BaseService):
         )
 
     def _metadata_spec(
-        self, element_instance_id: int, tool_path: str, schema_mode: bool
+        self,
+        element_instance_id: int,
+        connector_key: str,
+        tool_path: str,
+        schema_mode: bool,
     ) -> RequestSpec:
-        metadata_endpoint_url = f"/elements_/v3/element/instances/{element_instance_id}/elements/{tool_path}/metadata"
+        metadata_endpoint_url = f"/elements_/v3/element/instances/{element_instance_id}/elements/{connector_key}/objects/{tool_path}/metadata"
         return RequestSpec(
             method="GET",
             endpoint=Endpoint(metadata_endpoint_url),
@@ -390,6 +499,54 @@ class ConnectionsService(BaseService):
             },
         )
 
+    def _metadata_jit_spec(
+        self,
+        element_instance_id: int,
+        dynamic_path: str,
+        parameters: Dict[str, str],
+        schema_mode: bool,
+    ) -> RequestSpec:
+        """Build request spec for JIT metadata with dynamic path parameter substitution.
+
+        For example, if the dynamic path is "elements/jira/projects/{projectId}/issues", and the parameters
+        are {"projectId": "PROJ-123"}, the resolved path will be "elements/jira/projects/PROJ-123/issues".
+        """
+        for key, value in parameters.items():
+            dynamic_path = dynamic_path.replace(
+                f"{{{key}}}", quote(str(value), safe="")
+            )
+        split = urlsplit(dynamic_path.lstrip("/"))
+        query_params = dict(parse_qsl(split.query))
+
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(
+                f"/elements_/v3/element/instances/{element_instance_id}/{split.path}"
+            ),
+            params=query_params,
+            headers={
+                "accept": "application/schema+json"
+                if schema_mode
+                else "application/json"
+            },
+        )
+
+    def _get_jit_action_url(
+        self, connection_metadata: ConnectionMetadata
+    ) -> Optional[str]:
+        """Return the URL of the JIT action that should be triggered dynamically."""
+        if "method" not in connection_metadata.metadata:
+            return None
+
+        methods = connection_metadata.metadata["method"]
+        actions = [
+            action
+            for method_data in methods.values()
+            for action in method_data.get("design", {}).get("actions", [])
+            if action.get("actionType") == "api"
+        ]
+        return actions[0].get("apiConfiguration", {}).get("url") if actions else None
+
     def _retrieve_token_spec(
         self, key: str, token_type: ConnectionTokenType = ConnectionTokenType.DIRECT
     ) -> RequestSpec:

uipath/models/connections.py

@@ -8,6 +8,7 @@ class ConnectionMetadata(BaseModel):
     """Metadata about a connection."""
 
     fields: dict[str, Any] = Field(default_factory=dict, alias="fields")
+    metadata: dict[str, Any] = Field(default_factory=dict, alias="metadata")
 
     model_config = ConfigDict(populate_by_name=True, extra="allow")
 

{uipath-2.1.126.dist-info → uipath-2.1.127.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.126
+Version: 2.1.127
 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.126.dist-info → uipath-2.1.127.dist-info}/RECORD

@@ -109,7 +109,7 @@ uipath/_resources/AGENTS.md,sha256=nRQNAVeEBaBvuMzXw8uXtMnGebLClUgwIMlgb8_qU9o,1
 uipath/_resources/CLAUDE.md,sha256=kYsckFWTVe948z_fNWLysCHvi9_YpchBXl3s1Ek03lU,10
 uipath/_resources/CLI_REFERENCE.md,sha256=PNVZINTXDSW4XN8QtxV3kS2WLreR7UyLfSso1_VXWBg,6758
 uipath/_resources/REQUIRED_STRUCTURE.md,sha256=3laqGiNa3kauJ7jRI1d7w_fWKUDkqYBjcTT_6_8FAGk,1417
-uipath/_resources/SDK_REFERENCE.md,sha256=qYsI1ap3OZ55wy7yk49YksgunEO1f2rtNSvQQynp058,27218
+uipath/_resources/SDK_REFERENCE.md,sha256=-KvQ6MFVVssuFfWEc6j05f0Uuexn8Kl84w-iQsZU5Po,27388
 uipath/_services/__init__.py,sha256=_LNy4u--VlhVtTO66bULbCoBjyJBTuyh9jnzjWrv-h4,1140
 uipath/_services/_base_service.py,sha256=6yGNEZ-px6lVR9l4wiMr8NDSeLrZU6nmjUlRp3lMDi8,5665
 uipath/_services/actions_service.py,sha256=2RPMR-hFMsOlqEyjIf3aF7-lrf57jdrSD0pBjj0Kyko,16040
@@ -117,7 +117,7 @@ uipath/_services/api_client.py,sha256=kGm04ijk9AOEQd2BMxvQg-2QoB8dmyoDwFFDPyutAG
 uipath/_services/assets_service.py,sha256=Z46_Nm4X7R0JcwF_Fph-5GwQ_qhQHRKJltCtwo3J8Yo,12090
 uipath/_services/attachments_service.py,sha256=NPQYK7CGjfBaNT_1S5vEAfODmOChTbQZforllFM2ofU,26678
 uipath/_services/buckets_service.py,sha256=FGWhJ3ewMEAahcSPY60wtFB0_qwAfaQAaAjqrC52VDk,44603
-uipath/_services/connections_service.py,sha256=tKJHHOKQYKR6LkgB-V_2d0vFpLEdFeMzwj_xmBVHUDw,18416
+uipath/_services/connections_service.py,sha256=SoOV8ZFn0AenhyodfqgO8oF7VmnWx9RdccCm0qosbxI,24059
 uipath/_services/context_grounding_service.py,sha256=Pjx-QQQEiSKD-hY6ityj3QUSALN3fIcKLLHr_NZ0d_g,37117
 uipath/_services/documents_service.py,sha256=2mPZzmOl2r5i8RYvdeRSJtEFWSSsiXqIauTgNTW75s4,45341
 uipath/_services/entities_service.py,sha256=QKCLE6wRgq3HZraF-M2mljy-8il4vsNHrQhUgkewVVk,14028
@@ -201,7 +201,7 @@ uipath/models/assets.py,sha256=7x3swJRnG_a4VgjdXKKwraJLT5TF0u4wHsl6coOjX0g,2762
 uipath/models/attachment.py,sha256=lI6BxBY6DY5U6qZbxhkNu-usseA1zovYSTRtLq50ubI,1029
 uipath/models/auth.py,sha256=-CEo5KZVtZZgbAMatN6B1vBmGp8lTTumR8sMthRmL8I,345
 uipath/models/buckets.py,sha256=7uDonM5ddfhunP6Vn24kEa-iW_ZluJU4SaWEqB2dWu8,2754
-uipath/models/connections.py,sha256=jmzlfnddqlxjmiVhqsETRV6TQPH3fFqJGsygG0gUf7g,2745
+uipath/models/connections.py,sha256=g51K2zHnOz6_IRJ5YYMfrEav7PPwQzRO5FH8KjYUYo8,2822
 uipath/models/context_grounding.py,sha256=3MaF2Fv2QYle8UUWvKGkCN5XGpx2T4a34fdbBqJ2fCs,1137
 uipath/models/context_grounding_index.py,sha256=OhRyxZDHDSrEmBFK0-JLqMMMT64jir4XkHtQ54IKtc0,2683
 uipath/models/documents.py,sha256=gh063bG0pl4YGThWQIgprwRCKxnKVoMOZrXDfDEVnQw,7337
@@ -224,8 +224,8 @@ uipath/tracing/_utils.py,sha256=emsQRgYu-P1gj1q7XUPJD94mOa12JvhheRkuZJpLd9Y,1505
 uipath/utils/__init__.py,sha256=VD-KXFpF_oWexFg6zyiWMkxl2HM4hYJMIUDZ1UEtGx0,105
 uipath/utils/_endpoints_manager.py,sha256=tnF_FiCx8qI2XaJDQgYkMN_gl9V0VqNR1uX7iawuLp8,8230
 uipath/utils/dynamic_schema.py,sha256=w0u_54MoeIAB-mf3GmwX1A_X8_HDrRy6p998PvX9evY,3839
-uipath-2.1.126.dist-info/METADATA,sha256=Umc-QEHEH74tS4WbseveiLgf31w4y1Iv-uRRHaKic9g,6626
-uipath-2.1.126.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.1.126.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.1.126.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.1.126.dist-info/RECORD,,
+uipath-2.1.127.dist-info/METADATA,sha256=2oA6gGyXHLX8-Cr7G2onsb1-XXfeY6G4_iXQlZgcK-E,6626
+uipath-2.1.127.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.1.127.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.1.127.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.1.127.dist-info/RECORD,,