fix workflow result parsing

Author: LordOfTheVillage

linkedapi/__init__.py

@@ -81,7 +81,7 @@
 from linkedapi.types import __all__ as _types_all
 from linkedapi.webhooks import parse_webhook_event
 
-__version__ = "1.3.11"
+__version__ = "1.4.2"
 PredefinedOperation = Operation
 
 __all__ = [

linkedapi/types/workflow.py

@@ -44,7 +44,8 @@ class WorkflowCancelResponse(LinkedApiModel):
 
 
 class WorkflowResponse(LinkedApiModel):
-    workflow_id: str
+    # GET /workflows/{id} never returns workflowId; only the start response carries it.
+    workflow_id: str | None = None
     workflow_status: WorkflowStatus
     message: str | None = None
     pending_reason: WorkflowPendingReason | None = None

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "linkedapi"
-version = "1.4.1"
+version = "1.4.2"
 description = "Official synchronous Python SDK for Linked API."
 readme = "README.md"
 requires-python = ">=3.10"

tests/test_operations.py

@@ -370,7 +370,6 @@ def test_execute_and_result_flow_returns_pydantic_data(
     fake_http_client.queue_response(result={"workflowId": "wf1", "workflowStatus": "pending"})
     fake_http_client.queue_response(
         result={
-            "workflowId": "wf1",
             "workflowStatus": "completed",
             "completion": {
                 "actionType": "st.openPersonPage",

tests/test_polling.py

@@ -17,15 +17,10 @@
 
 
 def test_operation_result_polls_until_completion(fake_http_client: FakeHttpClient) -> None:
-    fake_http_client.queue_response(
-        result={"workflowId": "wf1", "workflowStatus": "pending", "message": "queued"}
-    )
-    fake_http_client.queue_response(
-        result={"workflowId": "wf1", "workflowStatus": "running", "message": "running"}
-    )
+    fake_http_client.queue_response(result={"workflowStatus": "pending", "message": "queued"})
+    fake_http_client.queue_response(result={"workflowStatus": "running", "message": "running"})
     fake_http_client.queue_response(
         result={
-            "workflowId": "wf1",
             "workflowStatus": "completed",
             "completion": {
                 "actionType": "st.retrieveSSI",
@@ -52,7 +47,6 @@ def test_operation_result_wraps_response_validation_error(
 ) -> None:
     fake_http_client.queue_response(
         result={
-            "workflowId": "wf1",
             "workflowStatus": "completed",
             "completion": {
                 "actionType": "st.openPersonPage",

tests/test_working_hours_contract.py

@@ -72,7 +72,6 @@ class TestStatusCarriesPendingReason:
     def test_carries_the_outside_working_hours_reason(self) -> None:
         operation = _operation(
             {
-                "workflowId": "wf-1",
                 "workflowStatus": "pending",
                 "pendingReason": "outsideWorkingHours",
             }
@@ -84,17 +83,15 @@ def test_carries_the_outside_working_hours_reason(self) -> None:
         assert result.pending_reason == "outsideWorkingHours"
 
     def test_carries_the_queued_reason(self) -> None:
-        operation = _operation(
-            {"workflowId": "wf-1", "workflowStatus": "pending", "pendingReason": "queued"}
-        )
+        operation = _operation({"workflowStatus": "pending", "pendingReason": "queued"})
 
         result = operation.status("wf-1")
 
         assert isinstance(result, WorkflowInProgressResponse)
         assert result.pending_reason == "queued"
 
     def test_keeps_none_when_the_api_sends_nothing(self) -> None:
-        operation = _operation({"workflowId": "wf-1", "workflowStatus": "running"})
+        operation = _operation({"workflowStatus": "running"})
 
         result = operation.status("wf-1")