feat: add connections retrieve payload

Author: cristipufu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.1.17"
+version = "2.1.18"
 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"

src/uipath/_services/connections_service.py

@@ -1,9 +1,14 @@
+import json
 import logging
+from typing import Any, Dict
+
+import httpx
 
 from .._config import Config
 from .._execution_context import ExecutionContext
 from .._utils import Endpoint, RequestSpec
-from ..models import Connection, ConnectionToken
+from .._utils._ssl_context import get_httpx_client_kwargs
+from ..models import Connection, ConnectionToken, EventArguments
 from ..tracing._traced import traced
 from ._base_service import BaseService
 
@@ -112,6 +117,84 @@ async def retrieve_token_async(self, key: str) -> ConnectionToken:
         )
         return ConnectionToken.model_validate(response.json())
 
+    @traced(
+        name="connections_retrieve_event_payload",
+        run_type="uipath",
+    )
+    def retrieve_event_payload(self, event_args: EventArguments) -> Dict[str, Any]:
+        """Retrieve event payload from UiPath Integration Service.
+
+        Args:
+            key (str): The unique identifier of the connection.
+            event_args (EventArguments): The event arguments. Should be passed along from the job's input.
+
+        Returns:
+            Dict[str, Any]: The event payload data
+        """
+        if not event_args.additional_event_data:
+            raise ValueError("additional_event_data is required")
+
+        # Parse additional event data to get event id
+        event_data = json.loads(event_args.additional_event_data)
+
+        event_id = None
+        if "processedEventId" in event_data:
+            event_id = event_data["processedEventId"]
+        elif "rawEventId" in event_data:
+            event_id = event_data["rawEventId"]
+        else:
+            raise ValueError("Event Id not found in additional event data")
+
+        # Build request URL using connection token's API base URI
+        spec = self._retrieve_event_payload_spec("v1", event_id)
+
+        response = self.request(spec.method, url=spec.endpoint)
+
+        return response.json()
+
+    @traced(
+        name="connections_retrieve_event_payload",
+        run_type="uipath",
+    )
+    async def retrieve_event_payload_async(
+        self, event_args: EventArguments
+    ) -> Dict[str, Any]:
+        """Retrieve event payload from UiPath Integration Service.
+
+        Args:
+            key (str): The unique identifier of the connection.
+            event_args (EventArguments): The event arguments. Should be passed along from the job's input.
+
+        Returns:
+            Dict[str, Any]: The event payload data
+        """
+        if not event_args.additional_event_data:
+            raise ValueError("additional_event_data is required")
+
+        # Parse additional event data to get event id
+        event_data = json.loads(event_args.additional_event_data)
+
+        event_id = None
+        if "processedEventId" in event_data:
+            event_id = event_data["processedEventId"]
+        elif "rawEventId" in event_data:
+            event_id = event_data["rawEventId"]
+        else:
+            raise ValueError("Event Id not found in additional event data")
+
+        # Build request URL using connection token's API base URI
+        spec = self._retrieve_event_payload_spec("v1", event_id)
+
+        response = await self.request_async(spec.method, url=spec.endpoint)
+
+        return response.json()
+
+    def _retrieve_event_payload_spec(self, version: str, event_id: str) -> RequestSpec:
+        return RequestSpec(
+            method="GET",
+            endpoint=Endpoint(f"/elements_/{version}/events/{event_id}"),
+        )
+
     def _retrieve_spec(self, key: str) -> RequestSpec:
         return RequestSpec(
             method="GET",

src/uipath/models/__init__.py

@@ -3,7 +3,7 @@
 from .assets import Asset, UserAsset
 from .attachment import Attachment
 from .buckets import Bucket
-from .connections import Connection, ConnectionToken
+from .connections import Connection, ConnectionToken, EventArguments
 from .context_grounding import ContextGroundingQueryResponse
 from .context_grounding_index import ContextGroundingIndex
 from .errors import BaseUrlMissingError, SecretMissingError
@@ -39,6 +39,7 @@
     "TransactionItemResult",
     "Connection",
     "ConnectionToken",
+    "EventArguments",
     "Job",
     "InvokeProcess",
     "ActionSchema",

src/uipath/models/connections.py

@@ -49,3 +49,20 @@ class ConnectionToken(BaseModel):
     expires_in: Optional[int] = Field(default=None, alias="expiresIn")
     api_base_uri: Optional[str] = Field(default=None, alias="apiBaseUri")
     element_instance_id: Optional[int] = Field(default=None, alias="elementInstanceId")
+
+
+class EventArguments(BaseModel):
+    event_connector: Optional[str] = Field(default=None, alias="UiPathEventConnector")
+    event: Optional[str] = Field(default=None, alias="UiPathEvent")
+    event_object_type: Optional[str] = Field(
+        default=None, alias="UiPathEventObjectType"
+    )
+    event_object_id: Optional[str] = Field(default=None, alias="UiPathEventObjectId")
+    additional_event_data: Optional[str] = Field(
+        default=None, alias="UiPathAdditionalEventData"
+    )
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra="allow",
+    )