plato-sdk-v2 2.8.5__py3-none-any.whl → 2.8.7__py3-none-any.whl

plato/_generated/__init__.py

@@ -1,4 +1,4 @@
-"""Plato API SDK - v0.48.2"""
+"""Plato API SDK - v0.49.7"""
 
 from . import api, errors, models
 from .client import AsyncClient, Client

plato/_generated/api/v1/session/__init__.py

@@ -29,12 +29,14 @@ from . import (
     set_session_output,
     update_session_public,
     update_session_testcase,
+    upload_review_screenshot,
 )
 
 __all__ = [
     "create_session_from_browser",
     "create_session_from_har",
     "create_session_from_env_recording",
+    "upload_review_screenshot",
     "get_sessions",
     "get_next_session_for_annotator",
     "get_grouped_replay_sessions",

plato/_generated/api/v1/session/upload_review_screenshot.py

@@ -0,0 +1,74 @@
+"""Upload Review Screenshot"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import BodyUploadReviewScreenshot
+
+
+def _build_request_args(
+    body: BodyUploadReviewScreenshot,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = "/api/v1/session/upload-review-screenshot"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "POST",
+        "url": url,
+        "json": body.model_dump(mode="json", exclude_none=True),
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    body: BodyUploadReviewScreenshot,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> Any:
+    """Upload a review screenshot to S3.
+    Used by the data-review Chrome extension to upload annotated screenshots.
+    Supports both user session and API key authentication."""
+
+    request_args = _build_request_args(
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return response.json()
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    body: BodyUploadReviewScreenshot,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> Any:
+    """Upload a review screenshot to S3.
+    Used by the data-review Chrome extension to upload annotated screenshots.
+    Supports both user session and API key authentication."""
+
+    request_args = _build_request_args(
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return response.json()

plato/_generated/api/v1/testcases/__init__.py

@@ -5,6 +5,7 @@ from . import (
     archive_organization_testcase,
     archive_testcase,
     assign_testcase_to_organizations,
+    assign_testcases_to_work_order_item,
     auto_verify_testcase,
     bulk_archive_testcases,
     convert_text_to_structured_data,
@@ -61,6 +62,7 @@ __all__ = [
     "mark_organization_test_case_completed",
     "get_human_recorder_tab_counts",
     "bulk_archive_testcases",
+    "assign_testcases_to_work_order_item",
     "archive_organization_testcase",
     "version_bump_testcase",
     "auto_verify_testcase",

plato/_generated/api/v1/testcases/assign_testcases_to_work_order_item.py

@@ -0,0 +1,74 @@
+"""Assign Testcases To Work Order Item"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import AssignToWorkOrderItemRequest
+
+
+def _build_request_args(
+    body: AssignToWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = "/api/v1/testcases/assign-to-work-order-item"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "POST",
+        "url": url,
+        "json": body.model_dump(mode="json", exclude_none=True),
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    body: AssignToWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> Any:
+    """Assign multiple test cases to a work order item.
+    Creates TestCaseStatus entries linking test cases to the work order item.
+    Admin-only endpoint."""
+
+    request_args = _build_request_args(
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return response.json()
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    body: AssignToWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> Any:
+    """Assign multiple test cases to a work order item.
+    Creates TestCaseStatus entries linking test cases to the work order item.
+    Admin-only endpoint."""
+
+    request_args = _build_request_args(
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return response.json()

plato/_generated/api/v2/__init__.py

@@ -13,6 +13,7 @@ from . import (
     releases,
     sessions,
     user,
+    work_orders,
 )
 
 __all__ = [
@@ -28,4 +29,5 @@ __all__ = [
     "releases",
     "sessions",
     "user",
+    "work_orders",
 ]

plato/_generated/api/v2/jobs/__init__.py

@@ -9,9 +9,11 @@ from . import (
     execute,
     get_flows,
     get_plato_config,
+    heartbeat,
     log_for_job,
     make,
     public_url,
+    rdp_url,
     reset,
     set_date,
     setup_sandbox,
@@ -25,6 +27,7 @@ __all__ = [
     "make",
     "reset",
     "close",
+    "heartbeat",
     "execute",
     "set_date",
     "setup_sandbox",
@@ -38,6 +41,7 @@ __all__ = [
     "wait_for_ready",
     "public_url",
     "connect_url",
+    "rdp_url",
     "connect_routing_info",
     "log_for_job",
 ]

plato/_generated/api/v2/jobs/heartbeat.py

@@ -0,0 +1,69 @@
+"""Heartbeat"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import HeartbeatJobResult
+
+
+def _build_request_args(
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/jobs/{job_id}/heartbeat"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "POST",
+        "url": url,
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> HeartbeatJobResult:
+    """Send a heartbeat to keep a specific job alive."""
+
+    request_args = _build_request_args(
+        job_id=job_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return HeartbeatJobResult.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> HeartbeatJobResult:
+    """Send a heartbeat to keep a specific job alive."""
+
+    request_args = _build_request_args(
+        job_id=job_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return HeartbeatJobResult.model_validate(response.json())

plato/_generated/api/v2/jobs/rdp_url.py

@@ -0,0 +1,93 @@
+"""Rdp Url"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import RdpUrlResult
+
+
+def _build_request_args(
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/jobs/{job_id}/rdp_url"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "GET",
+        "url": url,
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> RdpUrlResult:
+    """Get RDP viewer URL for browser-based remote desktop access.
+
+    Returns URL to the Guacamole-based RDP viewer for Windows VMs.
+    The URL includes a trailing slash which is required for proper routing.
+
+    Args:
+        job_id: The job public ID.
+
+    Returns:
+        RdpUrlResult with RDP viewer URL.
+
+    Raises:
+        404: If job not found."""
+
+    request_args = _build_request_args(
+        job_id=job_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return RdpUrlResult.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    job_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> RdpUrlResult:
+    """Get RDP viewer URL for browser-based remote desktop access.
+
+    Returns URL to the Guacamole-based RDP viewer for Windows VMs.
+    The URL includes a trailing slash which is required for proper routing.
+
+    Args:
+        job_id: The job public ID.
+
+    Returns:
+        RdpUrlResult with RDP viewer URL.
+
+    Raises:
+        404: If job not found."""
+
+    request_args = _build_request_args(
+        job_id=job_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return RdpUrlResult.model_validate(response.json())

plato/_generated/api/v2/releases/__init__.py

@@ -8,6 +8,7 @@ from . import (
     handle_import,
     list_releases,
     prep_release_assigned_testcases,
+    prep_release_from_work_order,
     update,
 )
 
@@ -18,6 +19,7 @@ __all__ = [
     "update",
     "deploy",
     "prep_release_assigned_testcases",
+    "prep_release_from_work_order",
     "handle_import",
     "handle_get_existing_public_ids",
 ]

plato/_generated/api/v2/releases/deploy.py

@@ -10,12 +10,12 @@ from plato._generated.errors import raise_for_status
 
 
 def _build_request_args(
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> dict[str, Any]:
     """Build request arguments."""
-    url = f"/api/v2/releases/{release_id}/deploy"
+    url = f"/api/v2/releases/{public_id}/deploy"
 
     headers: dict[str, str] = {}
     if authorization is not None:
@@ -32,7 +32,7 @@ def _build_request_args(
 
 def sync(
     client: httpx.Client,
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> Any:
@@ -46,7 +46,7 @@ def sync(
     - error: optional error message"""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         authorization=authorization,
         x_api_key=x_api_key,
     )
@@ -58,7 +58,7 @@ def sync(
 
 async def asyncio(
     client: httpx.AsyncClient,
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> Any:
@@ -72,7 +72,7 @@ async def asyncio(
     - error: optional error message"""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         authorization=authorization,
         x_api_key=x_api_key,
     )

plato/_generated/api/v2/releases/get.py

@@ -11,12 +11,12 @@ from plato._generated.models import ReleaseResponse
 
 
 def _build_request_args(
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> dict[str, Any]:
     """Build request arguments."""
-    url = f"/api/v2/releases/{release_id}"
+    url = f"/api/v2/releases/{public_id}"
 
     headers: dict[str, str] = {}
     if authorization is not None:
@@ -33,14 +33,14 @@ def _build_request_args(
 
 def sync(
     client: httpx.Client,
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> ReleaseResponse:
-    """Get a specific release by ID."""
+    """Get a specific release by public ID."""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         authorization=authorization,
         x_api_key=x_api_key,
     )
@@ -52,14 +52,14 @@ def sync(
 
 async def asyncio(
     client: httpx.AsyncClient,
-    release_id: int,
+    public_id: str,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> ReleaseResponse:
-    """Get a specific release by ID."""
+    """Get a specific release by public ID."""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         authorization=authorization,
         x_api_key=x_api_key,
     )

plato/_generated/api/v2/releases/prep_release_assigned_testcases.py

@@ -11,13 +11,13 @@ from plato._generated.models import PrepAssignedTestcasesRequest, ReleaseRespons
 
 
 def _build_request_args(
-    release_id: int,
+    public_id: str,
     body: PrepAssignedTestcasesRequest,
     authorization: str | None = None,
     x_api_key: str | None = None,
 ) -> dict[str, Any]:
     """Build request arguments."""
-    url = f"/api/v2/releases/{release_id}/prep/assigned_testcases"
+    url = f"/api/v2/releases/{public_id}/prep/assigned_testcases"
 
     headers: dict[str, str] = {}
     if authorization is not None:
@@ -35,7 +35,7 @@ def _build_request_args(
 
 def sync(
     client: httpx.Client,
-    release_id: int,
+    public_id: str,
     body: PrepAssignedTestcasesRequest,
     authorization: str | None = None,
     x_api_key: str | None = None,
@@ -51,7 +51,7 @@ def sync(
     Admin only."""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         body=body,
         authorization=authorization,
         x_api_key=x_api_key,
@@ -64,7 +64,7 @@ def sync(
 
 async def asyncio(
     client: httpx.AsyncClient,
-    release_id: int,
+    public_id: str,
     body: PrepAssignedTestcasesRequest,
     authorization: str | None = None,
     x_api_key: str | None = None,
@@ -80,7 +80,7 @@ async def asyncio(
     Admin only."""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         body=body,
         authorization=authorization,
         x_api_key=x_api_key,

plato/_generated/api/v2/releases/prep_release_from_work_order.py

@@ -0,0 +1,85 @@
+"""Prep Release From Work Order"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import PrepFromWorkOrderRequest, ReleaseResponse
+
+
+def _build_request_args(
+    public_id: str,
+    body: PrepFromWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/releases/{public_id}/prep/work_order"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "POST",
+        "url": url,
+        "json": body.model_dump(mode="json", exclude_none=True),
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    public_id: str,
+    body: PrepFromWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> ReleaseResponse:
+    """Prep a release with selected testcases from a work order.
+
+    Allows granular selection of individual testcases to include in the release.
+    Collects linked testcase_artifacts, artifacts, and simulators automatically.
+
+    Admin only."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return ReleaseResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    public_id: str,
+    body: PrepFromWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> ReleaseResponse:
+    """Prep a release with selected testcases from a work order.
+
+    Allows granular selection of individual testcases to include in the release.
+    Collects linked testcase_artifacts, artifacts, and simulators automatically.
+
+    Admin only."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return ReleaseResponse.model_validate(response.json())