honeycomb-api 0.1.0__py3-none-any.whl → 0.5.3__py3-none-any.whl

honeycomb/resources/boards.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
+import builtins
 from typing import TYPE_CHECKING, Any
 
-from ..models.boards import Board, BoardCreate
+from ..models.boards import Board, BoardCreate, BoardView, BoardViewCreate
+from ..models.tool_inputs import PositionInput
 from .base import BaseResource
 
 if TYPE_CHECKING:
@@ -37,6 +39,13 @@ class BoardsResource(BaseResource):
             return f"{base}/{board_id}"
         return base
 
+    def _build_view_path(self, board_id: str, view_id: str | None = None) -> str:
+        """Build API path for board views."""
+        base = f"/1/boards/{board_id}/views"
+        if view_id:
+            return f"{base}/{view_id}"
+        return base
+
     # -------------------------------------------------------------------------
     # Async methods
     # -------------------------------------------------------------------------
@@ -96,17 +105,21 @@ class BoardsResource(BaseResource):
         await self._delete_async(self._build_path(board_id))
 
     async def create_from_bundle_async(self, bundle: BoardBundle) -> Board:
-        """Create board from BoardBundle with automatic query creation.
+        """Create board from BoardBundle with automatic query and view creation.
 
         Orchestrates:
         1. Create queries + annotations from QueryBuilder instances
         2. Assemble all panel configurations
         3. Create board with all panels
+        4. Create views for the board (if any)
 
         Panels are added to the board in the order they appear in the bundle:
         - Auto-layout: Honeycomb arranges panels in this order
         - Manual-layout: Respects explicit positions
 
+        If view creation fails, a warning is issued but the board creation succeeds.
+        Views can be created manually later using create_view_async().
+
         Args:
             bundle: BoardBundle from BoardBuilder.build()
 
@@ -123,6 +136,7 @@ class BoardsResource(BaseResource):
             ...                 .last_1_hour()
             ...                 .count()
             ...         )
+            ...         .add_view("Active Only", [{"column": "status", "operation": "=", "value": "active"}])
             ...         .build()
             ... )
         """
@@ -194,13 +208,31 @@ class BoardsResource(BaseResource):
             preset_filters=bundle.preset_filters,
         )
 
-        return await self.create_async(board_create)
+        board = await self.create_async(board_create)
+
+        # Create views after board creation
+        if bundle.views:
+            import warnings
+
+            for view_create in bundle.views:
+                try:
+                    await self.create_view_async(board.id, view_create)
+                except Exception as e:
+                    # Log but don't fail - board was created successfully
+                    # User can retry view creation manually
+                    warnings.warn(
+                        f"Failed to create view '{view_create.name}' for board '{board.id}': {e}",
+                        UserWarning,
+                        stacklevel=2,
+                    )
+
+        return board
 
     def _build_query_panel_dict(
         self,
         query_id: str,
         annotation_id: str,
-        position: tuple[int, int, int, int] | None,
+        position: PositionInput | None,
         style: str,
         visualization: dict[str, Any] | None,
     ) -> dict[str, Any]:
@@ -220,45 +252,124 @@ class BoardsResource(BaseResource):
         }
         if position:
             panel["position"] = {
-                "x_coordinate": position[0],
-                "y_coordinate": position[1],
-                "width": position[2],
-                "height": position[3],
+                "x_coordinate": position.x_coordinate,
+                "y_coordinate": position.y_coordinate,
+                "width": position.width,
+                "height": position.height,
             }
         return panel
 
     def _build_slo_panel_dict(
         self,
         slo_id: str,
-        position: tuple[int, int, int, int] | None,
+        position: PositionInput | None,
     ) -> dict[str, Any]:
         """Build SLO panel dictionary for API."""
         panel = {"type": "slo", "slo_panel": {"slo_id": slo_id}}
         if position:
             panel["position"] = {
-                "x_coordinate": position[0],
-                "y_coordinate": position[1],
-                "width": position[2],
-                "height": position[3],
+                "x_coordinate": position.x_coordinate,
+                "y_coordinate": position.y_coordinate,
+                "width": position.width,
+                "height": position.height,
             }
         return panel
 
     def _build_text_panel_dict(
         self,
         content: str,
-        position: tuple[int, int, int, int] | None,
+        position: PositionInput | None,
     ) -> dict[str, Any]:
         """Build text panel dictionary for API."""
         panel = {"type": "text", "text_panel": {"content": content}}
         if position:
             panel["position"] = {
-                "x_coordinate": position[0],
-                "y_coordinate": position[1],
-                "width": position[2],
-                "height": position[3],
+                "x_coordinate": position.x_coordinate,
+                "y_coordinate": position.y_coordinate,
+                "width": position.width,
+                "height": position.height,
             }
         return panel
 
+    # -------------------------------------------------------------------------
+    # Board View Methods - Async
+    # -------------------------------------------------------------------------
+
+    async def list_views_async(self, board_id: str) -> list[BoardView]:
+        """List all views for a board (async).
+
+        Args:
+            board_id: Board ID.
+
+        Returns:
+            List of BoardView objects (max 50 per board).
+        """
+        data = await self._get_async(self._build_view_path(board_id))
+        return self._parse_model_list(BoardView, data)
+
+    async def get_view_async(self, board_id: str, view_id: str) -> BoardView:
+        """Get a specific board view (async).
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+
+        Returns:
+            BoardView object.
+        """
+        data = await self._get_async(self._build_view_path(board_id, view_id))
+        return self._parse_model(BoardView, data)
+
+    async def create_view_async(self, board_id: str, view: BoardViewCreate) -> BoardView:
+        """Create a new board view (async).
+
+        Args:
+            board_id: Board ID.
+            view: View configuration.
+
+        Returns:
+            Created BoardView object.
+
+        Note:
+            Each board is limited to 50 views maximum.
+        """
+        data = await self._post_async(
+            self._build_view_path(board_id),
+            json=view.model_dump_for_api(),
+        )
+        return self._parse_model(BoardView, data)
+
+    async def update_view_async(
+        self,
+        board_id: str,
+        view_id: str,
+        view: BoardViewCreate,
+    ) -> BoardView:
+        """Update an existing board view (async).
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+            view: Updated view configuration.
+
+        Returns:
+            Updated BoardView object.
+        """
+        data = await self._put_async(
+            self._build_view_path(board_id, view_id),
+            json=view.model_dump_for_api(),
+        )
+        return self._parse_model(BoardView, data)
+
+    async def delete_view_async(self, board_id: str, view_id: str) -> None:
+        """Delete a board view (async).
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+        """
+        await self._delete_async(self._build_view_path(board_id, view_id))
+
     # -------------------------------------------------------------------------
     # Sync methods
     # -------------------------------------------------------------------------
@@ -348,3 +459,146 @@ class BoardsResource(BaseResource):
         import asyncio
 
         return asyncio.run(self.create_from_bundle_async(bundle))
+
+    # -------------------------------------------------------------------------
+    # Board View Methods - Sync
+    # -------------------------------------------------------------------------
+
+    def list_views(self, board_id: str) -> builtins.list[BoardView]:
+        """List all views for a board.
+
+        Args:
+            board_id: Board ID.
+
+        Returns:
+            List of BoardView objects (max 50 per board).
+        """
+        if not self._client.is_sync:
+            raise RuntimeError("Use list_views_async() for async mode, or pass sync=True to client")
+        data = self._get_sync(self._build_view_path(board_id))
+        return self._parse_model_list(BoardView, data)
+
+    def get_view(self, board_id: str, view_id: str) -> BoardView:
+        """Get a specific board view.
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+
+        Returns:
+            BoardView object.
+        """
+        if not self._client.is_sync:
+            raise RuntimeError("Use get_view_async() for async mode, or pass sync=True to client")
+        data = self._get_sync(self._build_view_path(board_id, view_id))
+        return self._parse_model(BoardView, data)
+
+    def create_view(self, board_id: str, view: BoardViewCreate) -> BoardView:
+        """Create a new board view.
+
+        Args:
+            board_id: Board ID.
+            view: View configuration.
+
+        Returns:
+            Created BoardView object.
+
+        Note:
+            Each board is limited to 50 views maximum.
+        """
+        if not self._client.is_sync:
+            raise RuntimeError(
+                "Use create_view_async() for async mode, or pass sync=True to client"
+            )
+        data = self._post_sync(
+            self._build_view_path(board_id),
+            json=view.model_dump_for_api(),
+        )
+        return self._parse_model(BoardView, data)
+
+    def update_view(self, board_id: str, view_id: str, view: BoardViewCreate) -> BoardView:
+        """Update an existing board view.
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+            view: Updated view configuration.
+
+        Returns:
+            Updated BoardView object.
+        """
+        if not self._client.is_sync:
+            raise RuntimeError(
+                "Use update_view_async() for async mode, or pass sync=True to client"
+            )
+        data = self._put_sync(
+            self._build_view_path(board_id, view_id),
+            json=view.model_dump_for_api(),
+        )
+        return self._parse_model(BoardView, data)
+
+    def delete_view(self, board_id: str, view_id: str) -> None:
+        """Delete a board view.
+
+        Args:
+            board_id: Board ID.
+            view_id: View ID.
+        """
+        if not self._client.is_sync:
+            raise RuntimeError(
+                "Use delete_view_async() for async mode, or pass sync=True to client"
+            )
+        self._delete_sync(self._build_view_path(board_id, view_id))
+
+    # -------------------------------------------------------------------------
+    # Export/Import with Views
+    # -------------------------------------------------------------------------
+
+    async def export_with_views_async(self, board_id: str) -> dict[str, Any]:
+        """Export board with views included (async).
+
+        Returns a dictionary suitable for JSON serialization and import,
+        including all board data and associated views.
+
+        Args:
+            board_id: Board ID
+
+        Returns:
+            Dict with board data and views (IDs stripped for portability)
+
+        Example:
+            >>> data = await client.boards.export_with_views_async("board-123")
+            >>> with open("board.json", "w") as f:
+            ...     json.dump(data, f, indent=2)
+        """
+        board = await self.get_async(board_id)
+        views = await self.list_views_async(board_id)
+
+        # Export board without IDs and timestamps for portability
+        data = board.model_dump(exclude={"id", "created_at", "updated_at"}, mode="json")
+
+        # Add views (without IDs)
+        if views:
+            data["views"] = [v.model_dump(exclude={"id"}, mode="json") for v in views]
+
+        return data
+
+    def export_with_views(self, board_id: str) -> dict[str, Any]:
+        """Export board with views included (sync).
+
+        Returns a dictionary suitable for JSON serialization and import,
+        including all board data and associated views.
+
+        Args:
+            board_id: Board ID
+
+        Returns:
+            Dict with board data and views (IDs stripped for portability)
+        """
+        if not self._client.is_sync:
+            raise RuntimeError(
+                "Use export_with_views_async() for async mode, or pass sync=True to client"
+            )
+        import asyncio
+
+        return asyncio.run(self.export_with_views_async(board_id))

honeycomb/resources/datasets.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from ..models.datasets import Dataset, DatasetCreate
+from ..models.datasets import Dataset, DatasetCreate, DatasetUpdate
 from .base import BaseResource
 
 if TYPE_CHECKING:
@@ -40,6 +40,14 @@ class DatasetsResource(BaseResource):
     # Async methods
     # -------------------------------------------------------------------------
 
+    def _parse_dataset(self, data: dict) -> Dataset:
+        """Parse a dataset from API response, handling nested settings."""
+        return Dataset.from_api_response(data)
+
+    def _parse_dataset_list(self, data: list) -> list[Dataset]:
+        """Parse a list of datasets from API response."""
+        return [self._parse_dataset(item) for item in data]
+
     async def list_async(self) -> list[Dataset]:
         """List all datasets (async).
 
@@ -47,7 +55,7 @@ class DatasetsResource(BaseResource):
             List of Dataset objects.
         """
         data = await self._get_async(self._build_path())
-        return self._parse_model_list(Dataset, data)
+        return self._parse_dataset_list(data)
 
     async def get_async(self, slug: str) -> Dataset:
         """Get a specific dataset (async).
@@ -59,7 +67,7 @@ class DatasetsResource(BaseResource):
             Dataset object.
         """
         data = await self._get_async(self._build_path(slug))
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
 
     async def create_async(self, dataset: DatasetCreate) -> Dataset:
         """Create a new dataset (async).
@@ -71,9 +79,9 @@ class DatasetsResource(BaseResource):
             Created Dataset object.
         """
         data = await self._post_async(self._build_path(), json=dataset.model_dump_for_api())
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
 
-    async def update_async(self, slug: str, dataset: DatasetCreate) -> Dataset:
+    async def update_async(self, slug: str, dataset: DatasetCreate | DatasetUpdate) -> Dataset:
         """Update an existing dataset (async).
 
         Args:
@@ -84,7 +92,20 @@ class DatasetsResource(BaseResource):
             Updated Dataset object.
         """
         data = await self._put_async(self._build_path(slug), json=dataset.model_dump_for_api())
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
+
+    async def set_delete_protected_async(self, slug: str, protected: bool) -> Dataset:
+        """Set delete protection on a dataset (async).
+
+        Args:
+            slug: Dataset slug.
+            protected: True to enable delete protection, False to disable.
+
+        Returns:
+            Updated Dataset object.
+        """
+        update = DatasetUpdate(delete_protected=protected)
+        return await self.update_async(slug=slug, dataset=update)
 
     async def delete_async(self, slug: str) -> None:
         """Delete a dataset (async).
@@ -107,7 +128,7 @@ class DatasetsResource(BaseResource):
         if not self._client.is_sync:
             raise RuntimeError("Use list_async() for async mode, or pass sync=True to client")
         data = self._get_sync(self._build_path())
-        return self._parse_model_list(Dataset, data)
+        return self._parse_dataset_list(data)
 
     def get(self, slug: str) -> Dataset:
         """Get a specific dataset.
@@ -121,7 +142,7 @@ class DatasetsResource(BaseResource):
         if not self._client.is_sync:
             raise RuntimeError("Use get_async() for async mode, or pass sync=True to client")
         data = self._get_sync(self._build_path(slug))
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
 
     def create(self, dataset: DatasetCreate) -> Dataset:
         """Create a new dataset.
@@ -135,9 +156,9 @@ class DatasetsResource(BaseResource):
         if not self._client.is_sync:
             raise RuntimeError("Use create_async() for async mode, or pass sync=True to client")
         data = self._post_sync(self._build_path(), json=dataset.model_dump_for_api())
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
 
-    def update(self, slug: str, dataset: DatasetCreate) -> Dataset:
+    def update(self, slug: str, dataset: DatasetCreate | DatasetUpdate) -> Dataset:
         """Update an existing dataset.
 
         Args:
@@ -150,7 +171,24 @@ class DatasetsResource(BaseResource):
         if not self._client.is_sync:
             raise RuntimeError("Use update_async() for async mode, or pass sync=True to client")
         data = self._put_sync(self._build_path(slug), json=dataset.model_dump_for_api())
-        return self._parse_model(Dataset, data)
+        return self._parse_dataset(data)
+
+    def set_delete_protected(self, slug: str, protected: bool) -> Dataset:
+        """Set delete protection on a dataset.
+
+        Args:
+            slug: Dataset slug.
+            protected: True to enable delete protection, False to disable.
+
+        Returns:
+            Updated Dataset object.
+        """
+        if not self._client.is_sync:
+            raise RuntimeError(
+                "Use set_delete_protected_async() for async mode, or pass sync=True to client"
+            )
+        update = DatasetUpdate(delete_protected=protected)
+        return self.update(slug=slug, dataset=update)
 
     def delete(self, slug: str) -> None:
         """Delete a dataset.