fix: expose pickup form of StartTransaction (#838)

Author: radu-mocanu

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.1.46"
+version = "0.1.47"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-platform/src/uipath/platform/orchestrator/__init__.py

@@ -27,6 +27,7 @@
     CommitType,
     QueueItem,
     QueueItemPriority,
+    Strategy,
     TransactionItem,
     TransactionItemResult,
 )
@@ -56,6 +57,7 @@
     "CommitType",
     "QueueItem",
     "QueueItemPriority",
+    "Strategy",
     "TransactionItem",
     "TransactionItemResult",
     "McpServer",

packages/uipath-platform/src/uipath/platform/orchestrator/_queues_service.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Any, Dict, List, Optional, Union
 
 from httpx import Response
@@ -12,6 +13,7 @@
 from .queues import (
     CommitType,
     QueueItem,
+    Strategy,
     TransactionItem,
     TransactionItemResult,
 )
@@ -286,6 +288,120 @@ async def create_transaction_item_async(
         )
         return response.json()
 
+    @resource_override(resource_type="queue", resource_identifier="queue_name")
+    @traced(name="queues_start_transaction_item", run_type="uipath")
+    def start_transaction_item(
+        self,
+        queue_name: str,
+        *,
+        reference: str | None = None,
+        reference_filter_option: Strategy | None = None,
+        defer_date: datetime | None = None,
+        due_date: datetime | None = None,
+        parent_operation_id: str | None = None,
+        no_robot: bool = False,
+        folder_key: str | None = None,
+        folder_path: str | None = None,
+    ) -> Response:
+        """Picks up the next available item from a queue and transitions it to ``In Progress``.
+
+        Use this when you want to process an item that already exists in the queue (e.g. one
+        added previously via `create_item`). Orchestrator returns the item now in
+        ``In Progress`` status, whose ``Key`` can then be passed to
+        `update_progress_of_transaction_item` and `complete_transaction_item`.
+
+        Args:
+            queue_name: Name of the queue to pick the next item from.
+            reference (str | None): If provided, restricts the pickup to items whose
+                ``Reference`` matches this value (filter strategy controlled by
+                ``reference_filter_option``).
+            reference_filter_option (Strategy | None): Strategy used to match
+                ``reference``. Defaults to ``Strategy.EQUALS`` semantics on the server when
+                ``reference`` is set.
+            defer_date (datetime | None): Earliest date/time at which the item is
+                available for processing.
+            due_date (datetime | None): Latest date/time by which the item should be
+                processed.
+            parent_operation_id (str | None): Operation id of the caller, propagated to
+                the picked-up item.
+            no_robot: If True, the transaction will not be associated with a robot.
+                Defaults to False.
+            folder_key (str | None): The key of the folder. Overrides the default one set in the SDK config.
+            folder_path (str | None): The path of the folder. Overrides the default one set in the SDK config.
+
+        Returns:
+            Response: HTTP response containing the queue item now in ``In Progress`` state.
+        """
+        spec = self._start_transaction_item_spec(
+            queue_name=queue_name,
+            reference=reference,
+            reference_filter_option=reference_filter_option,
+            defer_date=defer_date,
+            due_date=due_date,
+            parent_operation_id=parent_operation_id,
+            no_robot=no_robot,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+        response = self.request(
+            spec.method, url=spec.endpoint, json=spec.json, headers=spec.headers
+        )
+        return response.json()
+
+    @resource_override(resource_type="queue", resource_identifier="queue_name")
+    @traced(name="queues_start_transaction_item", run_type="uipath")
+    async def start_transaction_item_async(
+        self,
+        queue_name: str,
+        *,
+        reference: str | None = None,
+        reference_filter_option: Strategy | None = None,
+        defer_date: datetime | None = None,
+        due_date: datetime | None = None,
+        parent_operation_id: str | None = None,
+        no_robot: bool = False,
+        folder_key: str | None = None,
+        folder_path: str | None = None,
+    ) -> Response:
+        """Asynchronously picks up the next available item from a queue and transitions it to ``In Progress``.
+
+        See `start_transaction_item` for behavior details.
+
+        Args:
+            queue_name: Name of the queue to pick the next item from.
+            reference (str | None): If provided, restricts the pickup to items whose
+                ``Reference`` matches this value.
+            reference_filter_option (Strategy | None): Strategy used to match ``reference``.
+            defer_date (datetime | None): Earliest date/time at which the item is
+                available for processing.
+            due_date (datetime | None): Latest date/time by which the item should be
+                processed.
+            parent_operation_id (str | None): Operation id of the caller, propagated to
+                the picked-up item.
+            no_robot: If True, the transaction will not be associated with a robot.
+                Defaults to False.
+            folder_key (str | None): The key of the folder. Overrides the default one set in the SDK config.
+            folder_path (str | None): The path of the folder. Overrides the default one set in the SDK config.
+
+        Returns:
+            Response: HTTP response containing the queue item now in ``In Progress`` state.
+        """
+        spec = self._start_transaction_item_spec(
+            queue_name=queue_name,
+            reference=reference,
+            reference_filter_option=reference_filter_option,
+            defer_date=defer_date,
+            due_date=due_date,
+            parent_operation_id=parent_operation_id,
+            no_robot=no_robot,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+        response = await self.request_async(
+            spec.method, url=spec.endpoint, json=spec.json, headers=spec.headers
+        )
+        return response.json()
+
     @resource_override(resource_type="queue", resource_identifier="queue_name")
     @traced(name="queues_update_progress_of_transaction_item", run_type="uipath")
     def update_progress_of_transaction_item(
@@ -299,6 +415,10 @@ def update_progress_of_transaction_item(
     ) -> Response:
         """Updates the progress of a transaction item.
 
+        The item must already be in ``In Progress`` state. Use `create_transaction_item`
+        to create-and-start a new item, or `start_transaction_item` to pick up an
+        existing one.
+
         Args:
             transaction_key: Unique identifier of the transaction.
             progress: Progress message to set.
@@ -332,6 +452,10 @@ async def update_progress_of_transaction_item_async(
     ) -> Response:
         """Asynchronously updates the progress of a transaction item.
 
+        The item must already be in ``In Progress`` state. Use `create_transaction_item`
+        to create-and-start a new item, or `start_transaction_item` to pick up an
+        existing one.
+
         Args:
             transaction_key: Unique identifier of the transaction.
             progress: Progress message to set.
@@ -365,6 +489,9 @@ def complete_transaction_item(
     ) -> Response:
         """Completes a transaction item with the specified result.
 
+        The item must already be in ``In Progress`` state, having been created via
+        `create_transaction_item` or picked up via `start_transaction_item`.
+
         Args:
             transaction_key: Unique identifier of the transaction to complete.
             result: Result data for the transaction, either as a dictionary or TransactionItemResult instance.
@@ -398,6 +525,9 @@ async def complete_transaction_item_async(
     ) -> Response:
         """Asynchronously completes a transaction item with the specified result.
 
+        The item must already be in ``In Progress`` state, having been created via
+        `create_transaction_item` or picked up via `start_transaction_item`.
+
         Args:
             transaction_key: Unique identifier of the transaction to complete.
             result: Result data for the transaction, either as a dictionary or TransactionItemResult instance.
@@ -545,6 +675,44 @@ def _create_transaction_item_spec(
             },
         )
 
+    def _start_transaction_item_spec(
+        self,
+        *,
+        queue_name: str,
+        reference: str | None = None,
+        reference_filter_option: Strategy | None = None,
+        defer_date: datetime | None = None,
+        due_date: datetime | None = None,
+        parent_operation_id: str | None = None,
+        no_robot: bool = False,
+        folder_key: str | None = None,
+        folder_path: str | None = None,
+    ) -> RequestSpec:
+        transaction_data: Dict[str, Any] = {"Name": queue_name}
+        if not no_robot:
+            transaction_data["RobotIdentifier"] = self._execution_context.robot_key
+        if reference is not None:
+            transaction_data["Reference"] = reference
+        if reference_filter_option is not None:
+            transaction_data["ReferenceFilterOption"] = reference_filter_option.value
+        if defer_date is not None:
+            transaction_data["DeferDate"] = defer_date.isoformat()
+        if due_date is not None:
+            transaction_data["DueDate"] = due_date.isoformat()
+        if parent_operation_id is not None:
+            transaction_data["ParentOperationId"] = parent_operation_id
+
+        return RequestSpec(
+            method="POST",
+            endpoint=Endpoint(
+                "/orchestrator_/odata/Queues/UiPathODataSvc.StartTransaction"
+            ),
+            json={"transactionData": transaction_data},
+            headers={
+                **header_folder(folder_key, folder_path),
+            },
+        )
+
     def _update_progress_of_transaction_item_spec(
         self,
         transaction_key: str,

packages/uipath-platform/src/uipath/platform/orchestrator/queues.py

@@ -25,6 +25,13 @@ class CommitType(Enum):
     PROCESS_ALL_INDEPENDENTLY = "ProcessAllIndependently"
 
 
+class Strategy(Enum):
+    """Strategy used to filter the Reference value on StartTransaction."""
+
+    EQUALS = "Equals"
+    STARTS_WITH = "StartsWith"
+
+
 class QueueItem(BaseModel):
     """Model representing an item in an Orchestrator queue."""
 
@@ -173,6 +180,18 @@ def warn_name_deprecated(cls, values: Any) -> Any:
         description="Operation id which created the queue item.",
         alias="ParentOperationId",
     )
+    reference: (
+        Annotated[str, Field(min_length=0, strict=True, max_length=128)] | None
+    ) = Field(
+        default=None,
+        description="An optional, user-specified value for queue item identification.",
+        alias="Reference",
+    )
+    reference_filter_option: Strategy | None = Field(
+        default=None,
+        description="Declares the strategy used to filter the Reference value.",
+        alias="ReferenceFilterOption",
+    )
 
 
 class TransactionItemResult(BaseModel):