Add snapshot get/delete, image build list, and volume list filters for sandbox API parity

Author: shrisukhani

hyperbrowser/client/managers/async_manager/sandbox.py

@@ -15,6 +15,8 @@
     SandboxExposeResult,
     SandboxImageBuild,
     SandboxImageBuildCreateResult,
+    SandboxImageBuildListParams,
+    SandboxImageBuildListResponse,
     SandboxImageListParams,
     SandboxImageListResponse,
     SandboxImageInit,
@@ -25,8 +27,10 @@
     SandboxNetworkPolicy,
     SandboxNetworkUpdateResult,
     SandboxRuntimeSession,
+    SandboxSnapshotDeleteResult,
     SandboxSnapshotListParams,
     SandboxSnapshotListResponse,
+    SandboxSnapshotSummary,
     SandboxUnexposeResult,
     StartSandboxFromSnapshotParams,
 )
@@ -37,6 +41,7 @@
     CreateSandboxParams as CreateSandboxParamsDict,
     SandboxExecParams as SandboxExecParamsDict,
     SandboxExposeParams as SandboxExposeParamsDict,
+    SandboxImageBuildListParams as SandboxImageBuildListParamsDict,
     SandboxImageInit as SandboxImageInitDict,
     SandboxImageListParams as SandboxImageListParamsDict,
     SandboxListParams as SandboxListParamsDict,
@@ -450,6 +455,14 @@ async def list_snapshots(
         )
         return SandboxSnapshotListResponse(**payload)
 
+    async def get_snapshot(self, snapshot: str) -> SandboxSnapshotSummary:
+        payload = await self._request("GET", f"/snapshots/{snapshot}")
+        return SandboxSnapshotSummary(**payload["snapshot"])
+
+    async def delete_snapshot(self, snapshot: str) -> SandboxSnapshotDeleteResult:
+        payload = await self._request("DELETE", f"/snapshots/{snapshot}")
+        return SandboxSnapshotDeleteResult(**payload)
+
     async def stop(self, sandbox_id: str) -> BasicResponse:
         payload = await self._request("PUT", f"/sandbox/{sandbox_id}/stop")
         return BasicResponse(**payload)
@@ -491,6 +504,22 @@ async def cancel_image_build(self, build_id: str) -> SandboxImageBuild:
         payload = await self._request("POST", f"/images/builds/{build_id}/cancel")
         return SandboxImageBuild(**payload["build"])
 
+    async def list_image_builds(
+        self,
+        params: Optional[
+            Union[SandboxImageBuildListParamsDict, SandboxImageBuildListParams]
+        ] = None,
+    ) -> SandboxImageBuildListResponse:
+        payload = await self._request(
+            "GET",
+            "/images/builds",
+            params=dump_request(
+                params if params is not None else {},
+                SandboxImageBuildListParams,
+            ),
+        )
+        return SandboxImageBuildListResponse(**payload)
+
     async def wait_for_image_build(
         self,
         build_id: str,

hyperbrowser/client/managers/async_manager/volume.py

@@ -1,8 +1,14 @@
-from typing import Union
+from typing import Optional, Union
 
 from hyperbrowser.client._request import dump_request
-from hyperbrowser.models.volume import CreateVolumeParams, Volume, VolumeListResponse
+from hyperbrowser.models.volume import (
+    CreateVolumeParams,
+    Volume,
+    VolumeListParams,
+    VolumeListResponse,
+)
 from hyperbrowser.types import CreateVolumeParams as CreateVolumeParamsDict
+from hyperbrowser.types import VolumeListParams as VolumeListParamsDict
 
 
 class VolumeManager:
@@ -19,8 +25,17 @@ async def create(
         )
         return Volume(**response.data)
 
-    async def list(self) -> VolumeListResponse:
-        response = await self._client.transport.get(self._client._build_url("/volume"))
+    async def list(
+        self,
+        params: Optional[Union[VolumeListParamsDict, VolumeListParams]] = None,
+    ) -> VolumeListResponse:
+        response = await self._client.transport.get(
+            self._client._build_url("/volume"),
+            params=dump_request(
+                params if params is not None else {},
+                VolumeListParams,
+            ),
+        )
         return VolumeListResponse(**response.data)
 
     async def get(self, volume_id: str) -> Volume:

hyperbrowser/client/managers/sync_manager/sandbox.py

@@ -13,6 +13,8 @@
     SandboxExposeResult,
     SandboxImageBuild,
     SandboxImageBuildCreateResult,
+    SandboxImageBuildListParams,
+    SandboxImageBuildListResponse,
     SandboxImageListParams,
     SandboxImageListResponse,
     SandboxImageInit,
@@ -23,8 +25,10 @@
     SandboxNetworkPolicy,
     SandboxNetworkUpdateResult,
     SandboxRuntimeSession,
+    SandboxSnapshotDeleteResult,
     SandboxSnapshotListParams,
     SandboxSnapshotListResponse,
+    SandboxSnapshotSummary,
     SandboxUnexposeResult,
     StartSandboxFromSnapshotParams,
 )
@@ -35,6 +39,7 @@
     CreateSandboxParams as CreateSandboxParamsDict,
     SandboxExecParams as SandboxExecParamsDict,
     SandboxExposeParams as SandboxExposeParamsDict,
+    SandboxImageBuildListParams as SandboxImageBuildListParamsDict,
     SandboxImageInit as SandboxImageInitDict,
     SandboxImageListParams as SandboxImageListParamsDict,
     SandboxListParams as SandboxListParamsDict,
@@ -442,6 +447,14 @@ def list_snapshots(
         )
         return SandboxSnapshotListResponse(**payload)
 
+    def get_snapshot(self, snapshot: str) -> SandboxSnapshotSummary:
+        payload = self._request("GET", f"/snapshots/{snapshot}")
+        return SandboxSnapshotSummary(**payload["snapshot"])
+
+    def delete_snapshot(self, snapshot: str) -> SandboxSnapshotDeleteResult:
+        payload = self._request("DELETE", f"/snapshots/{snapshot}")
+        return SandboxSnapshotDeleteResult(**payload)
+
     def stop(self, sandbox_id: str) -> BasicResponse:
         payload = self._request("PUT", f"/sandbox/{sandbox_id}/stop")
         return BasicResponse(**payload)
@@ -483,6 +496,22 @@ def cancel_image_build(self, build_id: str) -> SandboxImageBuild:
         payload = self._request("POST", f"/images/builds/{build_id}/cancel")
         return SandboxImageBuild(**payload["build"])
 
+    def list_image_builds(
+        self,
+        params: Optional[
+            Union[SandboxImageBuildListParamsDict, SandboxImageBuildListParams]
+        ] = None,
+    ) -> SandboxImageBuildListResponse:
+        payload = self._request(
+            "GET",
+            "/images/builds",
+            params=dump_request(
+                params if params is not None else {},
+                SandboxImageBuildListParams,
+            ),
+        )
+        return SandboxImageBuildListResponse(**payload)
+
     def wait_for_image_build(
         self,
         build_id: str,

hyperbrowser/client/managers/sync_manager/volume.py

@@ -1,8 +1,14 @@
-from typing import Union
+from typing import Optional, Union
 
 from hyperbrowser.client._request import dump_request
-from hyperbrowser.models.volume import CreateVolumeParams, Volume, VolumeListResponse
+from hyperbrowser.models.volume import (
+    CreateVolumeParams,
+    Volume,
+    VolumeListParams,
+    VolumeListResponse,
+)
 from hyperbrowser.types import CreateVolumeParams as CreateVolumeParamsDict
+from hyperbrowser.types import VolumeListParams as VolumeListParamsDict
 
 
 class VolumeManager:
@@ -19,8 +25,17 @@ def create(
         )
         return Volume(**response.data)
 
-    def list(self) -> VolumeListResponse:
-        response = self._client.transport.get(self._client._build_url("/volume"))
+    def list(
+        self,
+        params: Optional[Union[VolumeListParamsDict, VolumeListParams]] = None,
+    ) -> VolumeListResponse:
+        response = self._client.transport.get(
+            self._client._build_url("/volume"),
+            params=dump_request(
+                params if params is not None else {},
+                VolumeListParams,
+            ),
+        )
         return VolumeListResponse(**response.data)
 
     def get(self, volume_id: str) -> Volume:

hyperbrowser/models/__init__.py

@@ -210,7 +210,7 @@
     ProfileListResponse,
     ProfileResponse,
 )
-from .volume import CreateVolumeParams, Volume, VolumeListResponse
+from .volume import CreateVolumeParams, Volume, VolumeListParams, VolumeListResponse
 from .scrape import (
     BatchScrapeJobResponse,
     BatchScrapeJobStatusResponse,
@@ -310,6 +310,7 @@
     SandboxImageListResponse,
     SandboxImageSummary,
     SandboxSnapshotStatus,
+    SandboxSnapshotDeleteResult,
     SandboxSnapshotListResponse,
     SandboxSnapshotSummary,
     SandboxSnapshotListParams,
@@ -323,6 +324,8 @@
     SandboxImageBuildUpload,
     SandboxImageBuild,
     SandboxImageBuildCreateResult,
+    SandboxImageBuildListParams,
+    SandboxImageBuildListResponse,
     SandboxExposeParams,
     SandboxExposeResult,
     SandboxUnexposeResult,
@@ -530,6 +533,7 @@
     # volume
     "CreateVolumeParams",
     "Volume",
+    "VolumeListParams",
     "VolumeListResponse",
     # scrape
     "BatchScrapeJobResponse",
@@ -604,6 +608,7 @@
     "SandboxImageListResponse",
     "SandboxImageSummary",
     "SandboxSnapshotStatus",
+    "SandboxSnapshotDeleteResult",
     "SandboxSnapshotListResponse",
     "SandboxSnapshotSummary",
     "SandboxSnapshotListParams",
@@ -617,6 +622,8 @@
     "SandboxImageBuildUpload",
     "SandboxImageBuild",
     "SandboxImageBuildCreateResult",
+    "SandboxImageBuildListParams",
+    "SandboxImageBuildListResponse",
     "SandboxExposeParams",
     "SandboxExposeResult",
     "SandboxUnexposeResult",

hyperbrowser/models/sandbox.py

@@ -309,6 +309,9 @@ class SandboxSnapshotSummary(SandboxBaseModel):
     image_name: str = Field(alias="imageName")
     image_id: str = Field(alias="imageId")
     status: SandboxSnapshotStatus
+    vcpus: Optional[int] = None
+    mem_mib: Optional[int] = Field(default=None, alias="memMiB")
+    disk_size_mib: Optional[int] = Field(default=None, alias="diskSizeMiB")
     compatibility_tag: Optional[str] = Field(default=None, alias="compatibilityTag")
     metadata: Dict[str, object]
     uploaded: bool
@@ -334,6 +337,10 @@ class SandboxSnapshotListResponse(SandboxBaseModel):
     per_page: Optional[int] = Field(default=None, alias="perPage")
 
 
+class SandboxSnapshotDeleteResult(SandboxBaseModel):
+    deleted: bool
+
+
 class SandboxMemorySnapshotParams(SandboxBaseModel):
     snapshot_name: Optional[str] = Field(
         default=None, serialization_alias="snapshotName"
@@ -423,6 +430,15 @@ class SandboxImageBuildCreateResult(SandboxBaseModel):
     upload: SandboxImageBuildUpload
 
 
+class SandboxImageBuildListParams(SandboxBaseModel):
+    status: Optional[str] = None
+    limit: Optional[int] = Field(default=None, ge=1)
+
+
+class SandboxImageBuildListResponse(SandboxBaseModel):
+    builds: List[SandboxImageBuild]
+
+
 class SandboxExecParams(SandboxBaseModel):
     command: str
     args: Optional[List[str]] = None

hyperbrowser/models/volume.py

@@ -13,6 +13,12 @@ class CreateVolumeParams(VolumeBaseModel):
     name: str
 
 
+class VolumeListParams(VolumeBaseModel):
+    page: Optional[int] = Field(default=None, ge=1)
+    limit: Optional[int] = Field(default=None, ge=1)
+    search: Optional[str] = None
+
+
 class Volume(VolumeBaseModel):
     id: str
     name: str
@@ -27,3 +33,6 @@ def parse_optional_int_fields(cls, value):
 
 class VolumeListResponse(VolumeBaseModel):
     volumes: List[Volume]
+    total_count: Optional[int] = Field(default=None, alias="totalCount")
+    page: Optional[int] = None
+    per_page: Optional[int] = Field(default=None, alias="perPage")

hyperbrowser/types/__init__.py

@@ -81,6 +81,7 @@
     SandboxFileWriteEntry,
     SandboxFileWriteTextParams,
     SandboxImageBuildInputFormat,
+    SandboxImageBuildListParams,
     SandboxImageInit,
     SandboxImageListParams,
     SandboxListParams,
@@ -132,7 +133,7 @@
     UpdateSessionScreenParams,
     UpdateSessionSolveCaptchasParams,
 )
-from .volume import CreateVolumeParams
+from .volume import CreateVolumeParams, VolumeListParams
 from .web import (
     FetchBrowserLocationOptions,
     FetchBrowserOptions,
@@ -235,6 +236,7 @@
     "SandboxFileWriteEntry",
     "SandboxFileWriteTextParams",
     "SandboxImageBuildInputFormat",
+    "SandboxImageBuildListParams",
     "SandboxImageInit",
     "SandboxImageListParams",
     "SandboxListParams",
@@ -282,6 +284,7 @@
     "UpdateSessionScreenParams",
     "UpdateSessionSolveCaptchasParams",
     "CreateVolumeParams",
+    "VolumeListParams",
     "FetchBrowserLocationOptions",
     "FetchBrowserOptions",
     "FetchCacheOptions",

hyperbrowser/types/sandbox.py

@@ -128,6 +128,13 @@ class SandboxSnapshotListParams(TypedDict, total=False):
     page: Optional[int]
 
 
+class SandboxImageBuildListParams(TypedDict, total=False):
+    """Filters for listing sandbox image builds."""
+
+    status: Optional[str]
+    limit: Optional[int]
+
+
 class SandboxMemorySnapshotParams(TypedDict, total=False):
     """Parameters for creating a sandbox memory snapshot."""
 
@@ -415,6 +422,7 @@ class SandboxTerminalKillParams(TypedDict, total=False):
     "SandboxFileWriteEntry",
     "SandboxFileWriteTextParams",
     "SandboxImageBuildInputFormat",
+    "SandboxImageBuildListParams",
     "SandboxImageInit",
     "SandboxImageListParams",
     "SandboxListParams",

hyperbrowser/types/volume.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from typing_extensions import TypedDict
 
 
@@ -7,4 +9,12 @@ class CreateVolumeParams(TypedDict):
     name: str
 
 
-__all__ = ["CreateVolumeParams"]
+class VolumeListParams(TypedDict, total=False):
+    """Filters and pagination for listing sandbox volumes."""
+
+    page: Optional[int]
+    limit: Optional[int]
+    search: Optional[str]
+
+
+__all__ = ["CreateVolumeParams", "VolumeListParams"]