[INFRA-394] feat: add workspace-level API resources to SDK (#39)

* feat: add workspace-level API resources to SDK (INFRA-394)

- Add WorkspaceTemplates resource with workitem, project, and page
  template sub-resources (list/create/update/delete each)
- Add WorkspaceWorkItemTypes resource (list/create/update) with
  WorkspaceWorkItemTypeProperties sub-resource (list/link/unlink)
- Add WorkspaceWorkItemProperties resource (list/create/update/delete)
  with WorkspaceWorkItemPropertyOptions sub-resource (list/create/update)
- Add WorkspaceProjectLabels resource (list/create/update/delete)
- Add WorkspaceProjectStates resource (list/create/update/delete)
- Add WorkItemRelationDefinitions resource with is_default/is_active
  query param filters (list/create/update/delete)
- Add Releases resource (list/create/update) with ReleaseTags,
  ReleaseLabels, and ReleaseItemLabels sub-resources
- Add Pydantic models for all new resources
- Register all 7 resources on PlaneClient
- Export all new classes from plane/__init__.py
- Add unit tests for all new resources

Co-authored-by: Plane AI <noreply@plane.so>

* fix: address CodeRabbit review comments on INFRA-394 PR #39

- rename ReleaseItemLabels.add/remove → create/delete (CRUD naming)
- rename WorkspaceWorkItemTypeProperties.link/unlink → create/delete;
  create now accepts WorkspaceWorkItemTypePropertyLink DTO directly
- test_releases: remove broad try/except around update (let it propagate);
  assert release.id and label.id are not None before use; update add/remove
  call sites to create/delete
- test_work_item_relation_definitions: narrow except Exception → HttpError
  in teardown
- test_workspace_templates: narrow all 3 teardown except Exception → HttpError
- test_workspace_work_item_types: assert wit.id is not None before
  properties.list; add lifecycle test for property create/delete

Co-authored-by: Plane AI <noreply@plane.so>

* fix: let exceptions propagate in workspace WIT property lifecycle test

- remove try/except HttpError in test_create_delete_property_link so API
  failures surface as test failures instead of warnings
- remove redundant try/finally around update assertions in
  test_create_update_workspace_work_item_type
- drop now-unused warnings and HttpError imports

Co-authored-by: Plane AI <noreply@plane.so>

---------

Co-authored-by: Plane AI <noreply@plane.so>

Author: mguptahub

plane/__init__.py

@@ -7,13 +7,20 @@
 from .api.modules import Modules
 from .api.pages import Pages
 from .api.projects import Projects
+from .api.releases import Releases
 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_relation_definitions import WorkItemRelationDefinitions
 from .api.work_item_types import WorkItemTypes
 from .api.work_items import WorkItems
+from .api.workspace_project_labels import WorkspaceProjectLabels
+from .api.workspace_project_states import WorkspaceProjectStates
+from .api.workspace_templates import WorkspaceTemplates
+from .api.workspace_work_item_properties import WorkspaceWorkItemProperties
+from .api.workspace_work_item_types import WorkspaceWorkItemTypes
 from .api.workspaces import Workspaces
 from .client import (
     OAuthAuthorizationParams,
@@ -35,6 +42,7 @@
     "WorkItems",
     "WorkItemTypes",
     "WorkItemProperties",
+    "WorkItemRelationDefinitions",
     "Projects",
     "Labels",
     "States",
@@ -48,6 +56,12 @@
     "Estimates",
     "Pages",
     "Workspaces",
+    "Releases",
+    "WorkspaceTemplates",
+    "WorkspaceWorkItemTypes",
+    "WorkspaceWorkItemProperties",
+    "WorkspaceProjectLabels",
+    "WorkspaceProjectStates",
     "PlaneError",
     "ConfigurationError",
     "HttpError",

plane/api/releases/__init__.py

@@ -0,0 +1,3 @@
+from .base import Releases
+
+__all__ = ["Releases"]

plane/api/releases/base.py

@@ -0,0 +1,55 @@
+from typing import Any
+
+from ...models.releases import CreateRelease, Release, UpdateRelease
+from ..base_resource import BaseResource
+from .item_labels import ReleaseItemLabels
+from .labels import ReleaseLabels
+from .tags import ReleaseTags
+
+
+class Releases(BaseResource):
+    """API client for managing workspace-level releases."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+        # Initialize sub-resources
+        self.tags = ReleaseTags(config)
+        self.labels = ReleaseLabels(config)
+        self.item_labels = ReleaseItemLabels(config)
+
+    def list(self, workspace_slug: str) -> list[Release]:
+        """List all releases in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+        """
+        response = self._get(f"{workspace_slug}/releases/")
+        return [Release.model_validate(item) for item in response]
+
+    def create(self, workspace_slug: str, data: CreateRelease) -> Release:
+        """Create a new release in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Release data
+        """
+        response = self._post(
+            f"{workspace_slug}/releases/",
+            data.model_dump(exclude_none=True),
+        )
+        return Release.model_validate(response)
+
+    def update(self, workspace_slug: str, release_id: str, data: UpdateRelease) -> Release:
+        """Update a release in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            release_id: UUID of the release
+            data: Updated release data
+        """
+        response = self._patch(
+            f"{workspace_slug}/releases/{release_id}/",
+            data.model_dump(exclude_none=True),
+        )
+        return Release.model_validate(response)

plane/api/releases/item_labels.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from typing import Any
+
+from ...models.releases import AddReleaseItemLabel, ReleaseLabel
+from ..base_resource import BaseResource
+
+
+class ReleaseItemLabels(BaseResource):
+    """API client for managing labels on a specific release."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(self, workspace_slug: str, release_id: str) -> list[ReleaseLabel]:
+        """List labels assigned to a release.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            release_id: UUID of the release
+        """
+        response = self._get(f"{workspace_slug}/releases/{release_id}/labels/")
+        return [ReleaseLabel.model_validate(item) for item in response]
+
+    def create(
+        self, workspace_slug: str, release_id: str, data: AddReleaseItemLabel
+    ) -> list[ReleaseLabel]:
+        """Add labels to a release.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            release_id: UUID of the release
+            data: Label IDs to add
+        """
+        response = self._post(
+            f"{workspace_slug}/releases/{release_id}/labels/",
+            data.model_dump(exclude_none=True),
+        )
+        return [ReleaseLabel.model_validate(item) for item in response]
+
+    def delete(self, workspace_slug: str, release_id: str, label_id: str) -> None:
+        """Remove a label from a release.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            release_id: UUID of the release
+            label_id: UUID of the label to remove
+        """
+        return self._delete(f"{workspace_slug}/releases/{release_id}/labels/{label_id}/")

plane/api/releases/labels.py

@@ -0,0 +1,33 @@
+from typing import Any
+
+from ...models.releases import CreateReleaseLabel, ReleaseLabel
+from ..base_resource import BaseResource
+
+
+class ReleaseLabels(BaseResource):
+    """API client for managing release labels."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(self, workspace_slug: str) -> list[ReleaseLabel]:
+        """List all release labels in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+        """
+        response = self._get(f"{workspace_slug}/releases/labels/")
+        return [ReleaseLabel.model_validate(item) for item in response]
+
+    def create(self, workspace_slug: str, data: CreateReleaseLabel) -> ReleaseLabel:
+        """Create a new release label in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Release label data
+        """
+        response = self._post(
+            f"{workspace_slug}/releases/labels/",
+            data.model_dump(exclude_none=True),
+        )
+        return ReleaseLabel.model_validate(response)

plane/api/releases/tags.py

@@ -0,0 +1,33 @@
+from typing import Any
+
+from ...models.releases import CreateReleaseTag, ReleaseTag
+from ..base_resource import BaseResource
+
+
+class ReleaseTags(BaseResource):
+    """API client for managing release tags."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(self, workspace_slug: str) -> list[ReleaseTag]:
+        """List all release tags in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+        """
+        response = self._get(f"{workspace_slug}/releases/tags/")
+        return [ReleaseTag.model_validate(item) for item in response]
+
+    def create(self, workspace_slug: str, data: CreateReleaseTag) -> ReleaseTag:
+        """Create a new release tag in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Release tag data
+        """
+        response = self._post(
+            f"{workspace_slug}/releases/tags/",
+            data.model_dump(exclude_none=True),
+        )
+        return ReleaseTag.model_validate(response)

plane/api/work_item_relation_definitions.py

@@ -0,0 +1,85 @@
+from typing import Any
+
+from ..models.work_item_relation_definitions import (
+    CreateWorkItemRelationDefinition,
+    UpdateWorkItemRelationDefinition,
+    WorkItemRelationDefinition,
+)
+from .base_resource import BaseResource
+
+
+class WorkItemRelationDefinitions(BaseResource):
+    """API client for managing workspace-level work item relation definitions."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(
+        self,
+        workspace_slug: str,
+        is_default: bool | None = None,
+        is_active: bool | None = None,
+    ) -> list[WorkItemRelationDefinition]:
+        """List all work item relation definitions in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            is_default: Optional filter by default status
+            is_active: Optional filter by active status
+        """
+        params: dict[str, Any] = {}
+        if is_default is not None:
+            params["is_default"] = str(is_default).lower()
+        if is_active is not None:
+            params["is_active"] = str(is_active).lower()
+
+        response = self._get(
+            f"{workspace_slug}/work-item-relation-definitions/",
+            params=params if params else None,
+        )
+        return [WorkItemRelationDefinition.model_validate(item) for item in response]
+
+    def create(
+        self, workspace_slug: str, data: CreateWorkItemRelationDefinition
+    ) -> WorkItemRelationDefinition:
+        """Create a new work item relation definition in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Relation definition data
+        """
+        response = self._post(
+            f"{workspace_slug}/work-item-relation-definitions/",
+            data.model_dump(exclude_none=True),
+        )
+        return WorkItemRelationDefinition.model_validate(response)
+
+    def update(
+        self,
+        workspace_slug: str,
+        definition_id: str,
+        data: UpdateWorkItemRelationDefinition,
+    ) -> WorkItemRelationDefinition:
+        """Update a work item relation definition in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            definition_id: UUID of the relation definition
+            data: Updated relation definition data
+        """
+        response = self._patch(
+            f"{workspace_slug}/work-item-relation-definitions/{definition_id}/",
+            data.model_dump(exclude_none=True),
+        )
+        return WorkItemRelationDefinition.model_validate(response)
+
+    def delete(self, workspace_slug: str, definition_id: str) -> None:
+        """Delete a work item relation definition in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            definition_id: UUID of the relation definition
+        """
+        return self._delete(
+            f"{workspace_slug}/work-item-relation-definitions/{definition_id}/"
+        )

plane/api/workspace_project_labels.py

@@ -0,0 +1,64 @@
+from typing import Any
+
+from ..models.workspace_project_labels import (
+    CreateWorkspaceProjectLabel,
+    UpdateWorkspaceProjectLabel,
+    WorkspaceProjectLabel,
+)
+from .base_resource import BaseResource
+
+
+class WorkspaceProjectLabels(BaseResource):
+    """API client for managing workspace-level project labels."""
+
+    def __init__(self, config: Any) -> None:
+        super().__init__(config, "/workspaces/")
+
+    def list(self, workspace_slug: str) -> list[WorkspaceProjectLabel]:
+        """List all project labels in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+        """
+        response = self._get(f"{workspace_slug}/project-labels/")
+        return [WorkspaceProjectLabel.model_validate(item) for item in response]
+
+    def create(
+        self, workspace_slug: str, data: CreateWorkspaceProjectLabel
+    ) -> WorkspaceProjectLabel:
+        """Create a new project label in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            data: Project label data
+        """
+        response = self._post(
+            f"{workspace_slug}/project-labels/",
+            data.model_dump(exclude_none=True),
+        )
+        return WorkspaceProjectLabel.model_validate(response)
+
+    def update(
+        self, workspace_slug: str, label_id: str, data: UpdateWorkspaceProjectLabel
+    ) -> WorkspaceProjectLabel:
+        """Update a project label in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            label_id: UUID of the label
+            data: Updated label data
+        """
+        response = self._patch(
+            f"{workspace_slug}/project-labels/{label_id}/",
+            data.model_dump(exclude_none=True),
+        )
+        return WorkspaceProjectLabel.model_validate(response)
+
+    def delete(self, workspace_slug: str, label_id: str) -> None:
+        """Delete a project label in the workspace.
+
+        Args:
+            workspace_slug: The workspace slug identifier
+            label_id: UUID of the label
+        """
+        return self._delete(f"{workspace_slug}/project-labels/{label_id}/")