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

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

@@ -11,13 +11,13 @@ from plato._generated.models import ReleaseResponse, UpdateReleaseRequest
 
 
 def _build_request_args(
-    release_id: int,
+    public_id: str,
     body: UpdateReleaseRequest,
     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:
@@ -35,7 +35,7 @@ def _build_request_args(
 
 def sync(
     client: httpx.Client,
-    release_id: int,
+    public_id: str,
     body: UpdateReleaseRequest,
     authorization: str | None = None,
     x_api_key: str | None = None,
@@ -43,7 +43,7 @@ def sync(
     """Update a release's manifest. Only drafted releases can be updated."""
 
     request_args = _build_request_args(
-        release_id=release_id,
+        public_id=public_id,
         body=body,
         authorization=authorization,
         x_api_key=x_api_key,
@@ -56,7 +56,7 @@ def sync(
 
 async def asyncio(
     client: httpx.AsyncClient,
-    release_id: int,
+    public_id: str,
     body: UpdateReleaseRequest,
     authorization: str | None = None,
     x_api_key: str | None = None,
@@ -64,7 +64,7 @@ async def asyncio(
     """Update a release's manifest. Only drafted releases can be updated."""
 
     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/sessions/__init__.py

@@ -12,6 +12,7 @@ from . import (
     get_connect_url,
     get_presigned_url,
     get_public_url,
+    get_rdp_url,
     get_s3_content,
     get_session_details,
     get_session_documents,
@@ -60,6 +61,7 @@ __all__ = [
     "wait_for_ready",
     "get_public_url",
     "get_connect_url",
+    "get_rdp_url",
     "list_sessions",
     "get_session_details",
     "get_session_documents",

plato/_generated/api/v2/sessions/get_rdp_url.py

@@ -0,0 +1,87 @@
+"""Get 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 RdpUrlResponse
+
+
+def _build_request_args(
+    session_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/sessions/{session_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,
+    session_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> RdpUrlResponse:
+    """Get RDP viewer URLs for all jobs in a session.
+
+    Returns browser-accessible URLs to the Guacamole-based RDP viewer for Windows VMs.
+    The URLs include a trailing slash which is required for proper routing.
+
+    Args:
+        session_id: The session ID.
+
+    Returns:
+        RdpUrlResponse with RDP URL for each job."""
+
+    request_args = _build_request_args(
+        session_id=session_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return RdpUrlResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    session_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> RdpUrlResponse:
+    """Get RDP viewer URLs for all jobs in a session.
+
+    Returns browser-accessible URLs to the Guacamole-based RDP viewer for Windows VMs.
+    The URLs include a trailing slash which is required for proper routing.
+
+    Args:
+        session_id: The session ID.
+
+    Returns:
+        RdpUrlResponse with RDP URL for each job."""
+
+    request_args = _build_request_args(
+        session_id=session_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return RdpUrlResponse.model_validate(response.json())

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

@@ -0,0 +1,19 @@
+"""API endpoints."""
+
+from . import (
+    archive_work_order,
+    archive_work_order_item,
+    create_work_order,
+    create_work_order_item,
+    get_work_order,
+    list_work_orders,
+)
+
+__all__ = [
+    "list_work_orders",
+    "create_work_order",
+    "get_work_order",
+    "create_work_order_item",
+    "archive_work_order",
+    "archive_work_order_item",
+]

plato/_generated/api/v2/work_orders/archive_work_order.py

@@ -0,0 +1,81 @@
+"""Archive 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 WorkOrderResponse
+
+
+def _build_request_args(
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/work-orders/{public_id}/archive"
+
+    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,
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderResponse:
+    """Archive a work order and all its items and testcase statuses.
+
+    For each testcase that would become orphaned (no other active statuses
+    and not in Plato General), creates a copy in Plato General.
+
+    Users can only archive work orders belonging to their organization.
+    Admins can archive any work order."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderResponse:
+    """Archive a work order and all its items and testcase statuses.
+
+    For each testcase that would become orphaned (no other active statuses
+    and not in Plato General), creates a copy in Plato General.
+
+    Users can only archive work orders belonging to their organization.
+    Admins can archive any work order."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderResponse.model_validate(response.json())

plato/_generated/api/v2/work_orders/archive_work_order_item.py

@@ -0,0 +1,81 @@
+"""Archive 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 WorkOrderItemResponse
+
+
+def _build_request_args(
+    item_public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/work-orders/items/{item_public_id}/archive"
+
+    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,
+    item_public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderItemResponse:
+    """Archive a work order item and all its testcase statuses.
+
+    For each testcase that would become orphaned (no other active statuses
+    and not in Plato General), creates a copy in Plato General.
+
+    Users can only archive items belonging to their organization's work orders.
+    Admins can archive any item."""
+
+    request_args = _build_request_args(
+        item_public_id=item_public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderItemResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    item_public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderItemResponse:
+    """Archive a work order item and all its testcase statuses.
+
+    For each testcase that would become orphaned (no other active statuses
+    and not in Plato General), creates a copy in Plato General.
+
+    Users can only archive items belonging to their organization's work orders.
+    Admins can archive any item."""
+
+    request_args = _build_request_args(
+        item_public_id=item_public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderItemResponse.model_validate(response.json())

plato/_generated/api/v2/work_orders/create_work_order.py

@@ -0,0 +1,76 @@
+"""Create 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 CreateWorkOrderRequest, WorkOrderResponse
+
+
+def _build_request_args(
+    body: CreateWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = "/api/v2/work-orders"
+
+    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: CreateWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderResponse:
+    """Create a new work order.
+
+    Users create work orders for their own organization.
+    Admins can create work orders for any organization by specifying organization_id."""
+
+    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 WorkOrderResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    body: CreateWorkOrderRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderResponse:
+    """Create a new work order.
+
+    Users create work orders for their own organization.
+    Admins can create work orders for any organization by specifying organization_id."""
+
+    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 WorkOrderResponse.model_validate(response.json())

plato/_generated/api/v2/work_orders/create_work_order_item.py

@@ -0,0 +1,81 @@
+"""Create 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 CreateWorkOrderItemRequest, WorkOrderItemResponse
+
+
+def _build_request_args(
+    public_id: str,
+    body: CreateWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/work-orders/{public_id}/items"
+
+    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: CreateWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderItemResponse:
+    """Create a new work order item.
+
+    Users can only add items to work orders belonging to their organization.
+    Admins can add items to any work order."""
+
+    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 WorkOrderItemResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    public_id: str,
+    body: CreateWorkOrderItemRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderItemResponse:
+    """Create a new work order item.
+
+    Users can only add items to work orders belonging to their organization.
+    Admins can add items to any work order."""
+
+    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 WorkOrderItemResponse.model_validate(response.json())

plato/_generated/api/v2/work_orders/get_work_order.py

@@ -0,0 +1,75 @@
+"""Get 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 WorkOrderWithItemsResponse
+
+
+def _build_request_args(
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/work-orders/{public_id}"
+
+    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,
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderWithItemsResponse:
+    """Get a work order with its items and testcase statuses.
+
+    Users can only view work orders belonging to their organization.
+    Admins can view any work order."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderWithItemsResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    public_id: str,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> WorkOrderWithItemsResponse:
+    """Get a work order with its items and testcase statuses.
+
+    Users can only view work orders belonging to their organization.
+    Admins can view any work order."""
+
+    request_args = _build_request_args(
+        public_id=public_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return WorkOrderWithItemsResponse.model_validate(response.json())

plato/_generated/api/v2/work_orders/list_work_orders.py

@@ -0,0 +1,80 @@
+"""List Work Orders"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import WorkOrderResponse
+
+
+def _build_request_args(
+    organization_id: int | None = None,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = "/api/v2/work-orders"
+
+    params: dict[str, Any] = {}
+    if organization_id is not None:
+        params["organization_id"] = organization_id
+
+    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,
+        "params": params,
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    organization_id: int | None = None,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> list[WorkOrderResponse]:
+    """List work orders.
+
+    Admins can see all work orders or filter by org_id.
+    Non-admins see only their org's work orders."""
+
+    request_args = _build_request_args(
+        organization_id=organization_id,
+        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,
+    organization_id: int | None = None,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> list[WorkOrderResponse]:
+    """List work orders.
+
+    Admins can see all work orders or filter by org_id.
+    Non-admins see only their org's work orders."""
+
+    request_args = _build_request_args(
+        organization_id=organization_id,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return response.json()