[SILO-690] feat: new api clients and tests (#9)

* add clients for project ws features + stickies + initiatives + teamspaces

* bump version to 0.2.1

---------

Co-authored-by: Surya Prashanth <[email protected]>

Author: Saurabhkmr98

.gitignore

@@ -46,6 +46,7 @@ coverage.xml
 .hypothesis/
 venv/
 .venv/
+.env
 .python-version
 .pytest_cache
 

README.md

@@ -234,6 +234,9 @@ client.epics             # Epic management
 client.intake            # Intake management
 client.pages             # Page management
 client.customers         # Customer management
+client.teamspaces        # Teamspace management
+client.stickies         # Sticky management
+client.initiatives      # Initiative management
 ```
 
 ### Resource Organization

plane/__init__.py

@@ -1,13 +1,17 @@
 from .api.cycles import Cycles
+from .api.initiatives import Initiatives
 from .api.labels import Labels
 from .api.modules import Modules
 from .api.pages import Pages
 from .api.projects import Projects
 from .api.states import States
+from .api.stickies import Stickies
+from .api.teamspaces import Teamspaces
 from .api.users import Users
 from .api.work_item_properties import WorkItemProperties
 from .api.work_item_types import WorkItemTypes
 from .api.work_items import WorkItems
+from .api.workspaces import Workspaces
 from .client import (
     OAuthAuthorizationParams,
     OAuthClient,
@@ -30,10 +34,14 @@
     "Projects",
     "Labels",
     "States",
+    "Stickies",
+    "Initiatives",
+    "Teamspaces",
     "Users",
     "Modules",
     "Cycles",
     "Pages",
+    "Workspaces",
     "PlaneError",
     "ConfigurationError",
     "HttpError",

plane/api/__init__.py

@@ -1,5 +1,8 @@
 from .base_resource import BaseResource
 from .customers import Customers
+from .initiatives import Initiatives
+from .stickies import Stickies
+from .teamspaces import Teamspaces
 from .work_item_properties import WorkItemProperties
 from .work_items import WorkItems
 
@@ -8,4 +11,7 @@
     "WorkItems",
     "WorkItemProperties",
     "Customers",
+    "Stickies",
+    "Initiatives",
+    "Teamspaces",
 ]

plane/api/base_resource.py

@@ -57,9 +57,11 @@ def _patch(self, endpoint: str, data: Mapping[str, Any] | None = None) -> Any:
         )
         return self._handle_response(response)
 
-    def _delete(self, endpoint: str) -> None:
+    def _delete(self, endpoint: str, data: Mapping[str, Any] | None = None) -> None:
         url = self._build_url(endpoint)
-        response = self.session.delete(url, headers=self._headers(), timeout=self.config.timeout)
+        response = self.session.delete(
+            url, headers=self._headers(), json=data, timeout=self.config.timeout
+        )
         self._handle_response(response)
 
     # Helpers

plane/api/initiatives/__init__.py

@@ -0,0 +1,4 @@
+from .base import Initiatives
+
+__all__ = ["Initiatives"]
+

plane/api/initiatives/base.py

@@ -0,0 +1,98 @@
+from collections.abc import Mapping
+from typing import Any
+
+from ...models.initiatives import (
+    CreateInitiative,
+    Initiative,
+    PaginatedInitiativeResponse,
+    UpdateInitiative,
+)
+from ..base_resource import BaseResource
+from .epics import InitiativeEpics
+from .labels import InitiativeLabels
+from .projects import InitiativeProjects
+
+
+class Initiatives(BaseResource):
+    """API client for managing initiatives in workspaces."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+        # Initialize sub-resources
+        self.labels = InitiativeLabels(config)
+        self.projects = InitiativeProjects(config)
+        self.epics = InitiativeEpics(config)
+
+    def create(self, workspace_slug: str, data: CreateInitiative) -> Initiative:
+        """Create a new initiative in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Initiative data
+
+        Returns:
+            The created initiative
+        """
+        response = self._post(
+            f"{workspace_slug}/initiatives",
+            data.model_dump(exclude_none=True),
+        )
+        return Initiative.model_validate(response)
+
+    def retrieve(self, workspace_slug: str, initiative_id: str) -> Initiative:
+        """Retrieve an initiative by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+
+        Returns:
+            The requested initiative
+        """
+        response = self._get(f"{workspace_slug}/initiatives/{initiative_id}")
+        return Initiative.model_validate(response)
+
+    def update(
+        self, workspace_slug: str, initiative_id: str, data: UpdateInitiative
+    ) -> Initiative:
+        """Update an initiative by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            data: Updated initiative data
+
+        Returns:
+            The updated initiative
+        """
+        response = self._patch(
+            f"{workspace_slug}/initiatives/{initiative_id}",
+            data.model_dump(exclude_none=True),
+        )
+        return Initiative.model_validate(response)
+
+    def delete(self, workspace_slug: str, initiative_id: str) -> None:
+        """Delete an initiative by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+        """
+        return self._delete(f"{workspace_slug}/initiatives/{initiative_id}")
+
+    def list(
+        self, workspace_slug: str, params: Mapping[str, Any] | None = None
+    ) -> PaginatedInitiativeResponse:
+        """List initiatives in the workspace with optional filtering.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            params: Optional query parameters (e.g., per_page, cursor)
+
+        Returns:
+            Paginated list of initiatives
+        """
+        response = self._get(f"{workspace_slug}/initiatives", params=params)
+        return PaginatedInitiativeResponse.model_validate(response)
+

plane/api/initiatives/epics.py

@@ -0,0 +1,60 @@
+from collections.abc import Iterable, Mapping
+from typing import Any
+
+from ...models.epics import Epic, PaginatedEpicResponse
+from ..base_resource import BaseResource
+
+
+class InitiativeEpics(BaseResource):
+    """API client for managing epics associated with initiatives."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(
+        self, workspace_slug: str, initiative_id: str, params: Mapping[str, Any] | None = None
+    ) -> PaginatedEpicResponse:
+        """List epics associated with an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            params: Optional query parameters (e.g., per_page, cursor)
+
+        Returns:
+            Paginated list of epics
+        """
+        response = self._get(f"{workspace_slug}/initiatives/{initiative_id}/epics", params=params)
+        return PaginatedEpicResponse.model_validate(response)
+
+    def add(
+        self, workspace_slug: str, initiative_id: str, epic_ids: Iterable[str]
+    ) -> Iterable[Epic]:
+        """Add epics to an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            epic_ids: List of epic UUIDs to add
+
+        Returns:
+            List of added epics
+        """
+        response = self._post(
+            f"{workspace_slug}/initiatives/{initiative_id}/epics",
+            {"epic_ids": epic_ids},
+        )
+        return [Epic.model_validate(epic) for epic in response]
+
+    def remove(self, workspace_slug: str, initiative_id: str, epic_ids: Iterable[str]) -> None:
+        """Remove epics from an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            epic_ids: List of epic UUIDs to remove
+        """
+        return self._delete(
+            f"{workspace_slug}/initiatives/{initiative_id}/epics",
+            {"epic_ids": epic_ids},
+        )

plane/api/initiatives/labels.py

@@ -0,0 +1,139 @@
+from collections.abc import Iterable, Mapping
+from typing import Any
+
+from ...models.initiatives import (
+    CreateInitiativeLabel,
+    InitiativeLabel,
+    PaginatedInitiativeLabelResponse,
+    UpdateInitiativeLabel,
+)
+from ..base_resource import BaseResource
+
+
+class InitiativeLabels(BaseResource):
+    """API client for managing labels associated with initiatives."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def create(self, workspace_slug: str, data: CreateInitiativeLabel) -> InitiativeLabel:
+        """Create a new initiative label in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Initiative label data
+
+        Returns:
+            The created initiative label
+        """
+        response = self._post(
+            f"{workspace_slug}/initiatives/labels",
+            data.model_dump(exclude_none=True),
+        )
+        return InitiativeLabel.model_validate(response)
+
+    def retrieve(self, workspace_slug: str, label_id: str) -> InitiativeLabel:
+        """Retrieve an initiative label by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            label_id: UUID of the initiative label
+
+        Returns:
+            The requested initiative label
+        """
+        response = self._get(f"{workspace_slug}/initiatives/labels/{label_id}")
+        return InitiativeLabel.model_validate(response)
+
+    def update(
+        self, workspace_slug: str, label_id: str, data: UpdateInitiativeLabel
+    ) -> InitiativeLabel:
+        """Update an initiative label by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            label_id: UUID of the initiative label
+            data: Updated initiative label data
+
+        Returns:
+            The updated initiative label
+        """
+        response = self._patch(
+            f"{workspace_slug}/initiatives/labels/{label_id}",
+            data.model_dump(exclude_none=True),
+        )
+        return InitiativeLabel.model_validate(response)
+
+    def delete(self, workspace_slug: str, label_id: str) -> None:
+        """Delete an initiative label by ID.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            label_id: UUID of the initiative label
+        """
+        return self._delete(f"{workspace_slug}/initiatives/labels/{label_id}")
+
+    def list(
+        self, workspace_slug: str, params: Mapping[str, Any] | None = None
+    ) -> PaginatedInitiativeLabelResponse:
+        """List initiative labels in the workspace with optional filtering.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            params: Optional query parameters (e.g., per_page, cursor)
+
+        Returns:
+            Paginated list of initiative labels
+        """
+        response = self._get(f"{workspace_slug}/initiatives/labels", params=params)
+        return PaginatedInitiativeLabelResponse.model_validate(response)
+
+    def list_labels(
+        self, workspace_slug: str, initiative_id: str, params: Mapping[str, Any] | None = None
+    ) -> PaginatedInitiativeLabelResponse:
+        """List labels associated with an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            params: Optional query parameters (e.g., per_page, cursor)
+
+        Returns:
+            Paginated list of initiative labels
+        """
+        response = self._get(f"{workspace_slug}/initiatives/{initiative_id}/labels", params=params)
+        return PaginatedInitiativeLabelResponse.model_validate(response)
+
+    def add_labels(
+        self, workspace_slug: str, initiative_id: str, label_ids: Iterable[str]
+    ) -> Iterable[InitiativeLabel]:
+        """Add labels to an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            label_ids: List of label UUIDs to add
+
+        Returns:
+            List of added initiative labels
+        """
+        response = self._post(
+            f"{workspace_slug}/initiatives/{initiative_id}/labels",
+            {"label_ids": label_ids},
+        )
+        return [InitiativeLabel.model_validate(label) for label in response]
+
+    def remove_labels(
+        self, workspace_slug: str, initiative_id: str, label_ids: Iterable[str]
+    ) -> None:
+        """Remove labels from an initiative.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            initiative_id: UUID of the initiative
+            label_ids: List of label UUIDs to remove
+        """
+        return self._delete(
+            f"{workspace_slug}/initiatives/{initiative_id}/labels",
+            {"label_ids": label_ids},
+        )