archil-openapi 0.0.2__tar.gz → 0.0.4__tar.gz

{archil_openapi-0.0.2 → archil_openapi-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: archil-openapi
-Version: 0.0.2
+Version: 0.0.4
 Summary: Generated low-level Python client for the Archil control plane API
 Keywords: archil,openapi
 Author: Archil, Inc.

{archil_openapi-0.0.2 → archil_openapi-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "archil-openapi"
-version = "0.0.2"
+version = "0.0.4"
 description = "Generated low-level Python client for the Archil control plane API"
 readme = "README.md"
 license = { file = "LICENSE" }

archil_openapi-0.0.4/src/archil_openapi/api/disks/create_share_url.py

@@ -0,0 +1,208 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_response_share_url import ApiResponseShareUrl
+from ...models.create_share_url_request import CreateShareUrlRequest
+from ...models.error_response import ErrorResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+    *,
+    body: CreateShareUrlRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/disks/{id}/share".format(
+            id=id,
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ApiResponseShareUrl, ErrorResponse]]:
+    if response.status_code == 200:
+        response_200 = ApiResponseShareUrl.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ApiResponseShareUrl, ErrorResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateShareUrlRequest,
+) -> Response[Union[ApiResponseShareUrl, ErrorResponse]]:
+    """Create a share URL for a file
+
+     Creates a signed, time-limited URL for downloading a file without
+    authentication. The URL expires after 24 hours by default.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (CreateShareUrlRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponseShareUrl, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateShareUrlRequest,
+) -> Optional[Union[ApiResponseShareUrl, ErrorResponse]]:
+    """Create a share URL for a file
+
+     Creates a signed, time-limited URL for downloading a file without
+    authentication. The URL expires after 24 hours by default.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (CreateShareUrlRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponseShareUrl, ErrorResponse]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateShareUrlRequest,
+) -> Response[Union[ApiResponseShareUrl, ErrorResponse]]:
+    """Create a share URL for a file
+
+     Creates a signed, time-limited URL for downloading a file without
+    authentication. The URL expires after 24 hours by default.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (CreateShareUrlRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponseShareUrl, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateShareUrlRequest,
+) -> Optional[Union[ApiResponseShareUrl, ErrorResponse]]:
+    """Create a share URL for a file
+
+     Creates a signed, time-limited URL for downloading a file without
+    authentication. The URL expires after 24 hours by default.
+
+    Args:
+        id (str):  Example: dsk-0123456789abcdef.
+        body (CreateShareUrlRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponseShareUrl, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed

{archil_openapi-0.0.2 → archil_openapi-0.0.4}/src/archil_openapi/api/sandboxes/delete_sandbox.py

@@ -74,7 +74,8 @@ def sync_detailed(
 ) -> Response[Union[Any, ErrorResponse]]:
     """Delete a sandbox
 
-     Permanently deletes a stopped, exited, or failed sandbox.
+     Permanently deletes a stopped, exited, or failed sandbox and its backing disk. A sandbox with child
+    forks cannot be deleted until those children are deleted, starting with the deepest ones.
 
     Args:
         sid (UUID):
@@ -105,7 +106,8 @@ def sync(
 ) -> Optional[Union[Any, ErrorResponse]]:
     """Delete a sandbox
 
-     Permanently deletes a stopped, exited, or failed sandbox.
+     Permanently deletes a stopped, exited, or failed sandbox and its backing disk. A sandbox with child
+    forks cannot be deleted until those children are deleted, starting with the deepest ones.
 
     Args:
         sid (UUID):
@@ -131,7 +133,8 @@ async def asyncio_detailed(
 ) -> Response[Union[Any, ErrorResponse]]:
     """Delete a sandbox
 
-     Permanently deletes a stopped, exited, or failed sandbox.
+     Permanently deletes a stopped, exited, or failed sandbox and its backing disk. A sandbox with child
+    forks cannot be deleted until those children are deleted, starting with the deepest ones.
 
     Args:
         sid (UUID):
@@ -160,7 +163,8 @@ async def asyncio(
 ) -> Optional[Union[Any, ErrorResponse]]:
     """Delete a sandbox
 
-     Permanently deletes a stopped, exited, or failed sandbox.
+     Permanently deletes a stopped, exited, or failed sandbox and its backing disk. A sandbox with child
+    forks cannot be deleted until those children are deleted, starting with the deepest ones.
 
     Args:
         sid (UUID):

archil_openapi-0.0.4/src/archil_openapi/api/sandboxes/fork_sandbox.py

@@ -0,0 +1,255 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_response_sandbox import ApiResponseSandbox
+from ...models.error_response import ErrorResponse
+from ...models.fork_sandbox_request import ForkSandboxRequest
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    sid: UUID,
+    *,
+    body: ForkSandboxRequest,
+    wait: Union[Unset, bool] = False,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    params: dict[str, Any] = {}
+
+    params["wait"] = wait
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/sandboxes/{sid}/fork".format(
+            sid=sid,
+        ),
+        "params": params,
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ApiResponseSandbox, ErrorResponse]]:
+    if response.status_code == 202:
+        response_202 = ApiResponseSandbox.from_dict(response.json())
+
+        return response_202
+
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 409:
+        response_409 = ErrorResponse.from_dict(response.json())
+
+        return response_409
+
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = ErrorResponse.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ApiResponseSandbox, ErrorResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    sid: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ForkSandboxRequest,
+    wait: Union[Unset, bool] = False,
+) -> Response[Union[ApiResponseSandbox, ErrorResponse]]:
+    """Fork a sandbox
+
+     Checkpoints a running source sandbox and creates an isolated writable
+    disk branch. Forks from running or paused sources resume from the
+    source's CPU, memory, and disk state. Forks from stopped sources
+    cold-boot from the saved disk checkpoint. A running source is
+    resumed after its checkpoint; paused and stopped sources remain
+    inactive. Forked sandboxes may themselves be forked.
+
+    Args:
+        sid (UUID):
+        wait (Union[Unset, bool]):  Default: False.
+        body (ForkSandboxRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponseSandbox, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        sid=sid,
+        body=body,
+        wait=wait,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    sid: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ForkSandboxRequest,
+    wait: Union[Unset, bool] = False,
+) -> Optional[Union[ApiResponseSandbox, ErrorResponse]]:
+    """Fork a sandbox
+
+     Checkpoints a running source sandbox and creates an isolated writable
+    disk branch. Forks from running or paused sources resume from the
+    source's CPU, memory, and disk state. Forks from stopped sources
+    cold-boot from the saved disk checkpoint. A running source is
+    resumed after its checkpoint; paused and stopped sources remain
+    inactive. Forked sandboxes may themselves be forked.
+
+    Args:
+        sid (UUID):
+        wait (Union[Unset, bool]):  Default: False.
+        body (ForkSandboxRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponseSandbox, ErrorResponse]
+    """
+
+    return sync_detailed(
+        sid=sid,
+        client=client,
+        body=body,
+        wait=wait,
+    ).parsed
+
+
+async def asyncio_detailed(
+    sid: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ForkSandboxRequest,
+    wait: Union[Unset, bool] = False,
+) -> Response[Union[ApiResponseSandbox, ErrorResponse]]:
+    """Fork a sandbox
+
+     Checkpoints a running source sandbox and creates an isolated writable
+    disk branch. Forks from running or paused sources resume from the
+    source's CPU, memory, and disk state. Forks from stopped sources
+    cold-boot from the saved disk checkpoint. A running source is
+    resumed after its checkpoint; paused and stopped sources remain
+    inactive. Forked sandboxes may themselves be forked.
+
+    Args:
+        sid (UUID):
+        wait (Union[Unset, bool]):  Default: False.
+        body (ForkSandboxRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ApiResponseSandbox, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        sid=sid,
+        body=body,
+        wait=wait,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    sid: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: ForkSandboxRequest,
+    wait: Union[Unset, bool] = False,
+) -> Optional[Union[ApiResponseSandbox, ErrorResponse]]:
+    """Fork a sandbox
+
+     Checkpoints a running source sandbox and creates an isolated writable
+    disk branch. Forks from running or paused sources resume from the
+    source's CPU, memory, and disk state. Forks from stopped sources
+    cold-boot from the saved disk checkpoint. A running source is
+    resumed after its checkpoint; paused and stopped sources remain
+    inactive. Forked sandboxes may themselves be forked.
+
+    Args:
+        sid (UUID):
+        wait (Union[Unset, bool]):  Default: False.
+        body (ForkSandboxRequest):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ApiResponseSandbox, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            sid=sid,
+            client=client,
+            body=body,
+            wait=wait,
+        )
+    ).parsed

{archil_openapi-0.0.2 → archil_openapi-0.0.4}/src/archil_openapi/api/sandboxes/stop_sandbox.py

@@ -89,12 +89,12 @@ def sync_detailed(
     *,
     client: Union[AuthenticatedClient, Client],
 ) -> Response[Union[ApiResponseSandbox, ErrorResponse]]:
-    """Stop a sandbox without saving memory
+    """Stop a sandbox
 
-     Shuts down the VM without creating a memory snapshot. When the sandbox
-    is paused, this invalidates its committed snapshot and changes it to
-    `stopped`. The sandbox's identity, configuration, and disk state remain
-    available for a later cold start.
+     Gracefully shuts down the guest, then checkpoints its disk before
+    entering `stopped`. The sandbox and any forks from it cold-boot from
+    disk state. Stopping a paused sandbox reuses its existing disk
+    checkpoint. In-flight execs receive the guest shutdown signal.
 
     Args:
         sid (UUID):
@@ -123,12 +123,12 @@ def sync(
     *,
     client: Union[AuthenticatedClient, Client],
 ) -> Optional[Union[ApiResponseSandbox, ErrorResponse]]:
-    """Stop a sandbox without saving memory
+    """Stop a sandbox
 
-     Shuts down the VM without creating a memory snapshot. When the sandbox
-    is paused, this invalidates its committed snapshot and changes it to
-    `stopped`. The sandbox's identity, configuration, and disk state remain
-    available for a later cold start.
+     Gracefully shuts down the guest, then checkpoints its disk before
+    entering `stopped`. The sandbox and any forks from it cold-boot from
+    disk state. Stopping a paused sandbox reuses its existing disk
+    checkpoint. In-flight execs receive the guest shutdown signal.
 
     Args:
         sid (UUID):
@@ -152,12 +152,12 @@ async def asyncio_detailed(
     *,
     client: Union[AuthenticatedClient, Client],
 ) -> Response[Union[ApiResponseSandbox, ErrorResponse]]:
-    """Stop a sandbox without saving memory
+    """Stop a sandbox
 
-     Shuts down the VM without creating a memory snapshot. When the sandbox
-    is paused, this invalidates its committed snapshot and changes it to
-    `stopped`. The sandbox's identity, configuration, and disk state remain
-    available for a later cold start.
+     Gracefully shuts down the guest, then checkpoints its disk before
+    entering `stopped`. The sandbox and any forks from it cold-boot from
+    disk state. Stopping a paused sandbox reuses its existing disk
+    checkpoint. In-flight execs receive the guest shutdown signal.
 
     Args:
         sid (UUID):
@@ -184,12 +184,12 @@ async def asyncio(
     *,
     client: Union[AuthenticatedClient, Client],
 ) -> Optional[Union[ApiResponseSandbox, ErrorResponse]]:
-    """Stop a sandbox without saving memory
+    """Stop a sandbox
 
-     Shuts down the VM without creating a memory snapshot. When the sandbox
-    is paused, this invalidates its committed snapshot and changes it to
-    `stopped`. The sandbox's identity, configuration, and disk state remain
-    available for a later cold start.
+     Gracefully shuts down the guest, then checkpoints its disk before
+    entering `stopped`. The sandbox and any forks from it cold-boot from
+    disk state. Stopping a paused sandbox reuses its existing disk
+    checkpoint. In-flight execs receive the guest shutdown signal.
 
     Args:
         sid (UUID):

{archil_openapi-0.0.2 → archil_openapi-0.0.4}/src/archil_openapi/models/__init__.py

@@ -25,6 +25,8 @@ from .api_response_sandbox_exec_list import ApiResponseSandboxExecList
 from .api_response_sandbox_exec_list_data import ApiResponseSandboxExecListData
 from .api_response_sandbox_list import ApiResponseSandboxList
 from .api_response_sandbox_list_data import ApiResponseSandboxListData
+from .api_response_share_url import ApiResponseShareUrl
+from .api_response_share_url_data import ApiResponseShareUrlData
 from .api_response_token_created import ApiResponseTokenCreated
 from .api_response_token_created_data import ApiResponseTokenCreatedData
 from .api_response_token_list import ApiResponseTokenList
@@ -44,6 +46,7 @@ from .create_api_token_request import CreateApiTokenRequest
 from .create_disk_request import CreateDiskRequest
 from .create_sandbox_request import CreateSandboxRequest
 from .create_sandbox_request_env import CreateSandboxRequestEnv
+from .create_share_url_request import CreateShareUrlRequest
 from .delegation_entry import DelegationEntry
 from .disk_metrics import DiskMetrics
 from .disk_response import DiskResponse
@@ -56,6 +59,7 @@ from .exec_mount import ExecMount
 from .exec_request import ExecRequest
 from .exec_request_disks import ExecRequestDisks
 from .exec_timing import ExecTiming
+from .fork_sandbox_request import ForkSandboxRequest
 from .google_cloud_storage import GoogleCloudStorage
 from .google_cloud_storage_type import GoogleCloudStorageType
 from .grep_disk_request import GrepDiskRequest
@@ -115,6 +119,8 @@ __all__ = (
     "ApiResponseSandboxExecListData",
     "ApiResponseSandboxList",
     "ApiResponseSandboxListData",
+    "ApiResponseShareUrl",
+    "ApiResponseShareUrlData",
     "ApiResponseTokenCreated",
     "ApiResponseTokenCreatedData",
     "ApiResponseTokenList",
@@ -134,6 +140,7 @@ __all__ = (
     "CreateDiskRequest",
     "CreateSandboxRequest",
     "CreateSandboxRequestEnv",
+    "CreateShareUrlRequest",
     "DelegationEntry",
     "DiskMetrics",
     "DiskResponse",
@@ -146,6 +153,7 @@ __all__ = (
     "ExecRequest",
     "ExecRequestDisks",
     "ExecTiming",
+    "ForkSandboxRequest",
     "GoogleCloudStorage",
     "GoogleCloudStorageType",
     "GrepDiskRequest",