ktr-cli 0.1.0__py3-none-any.whl

kantree_cli/services/views.py

@@ -0,0 +1,124 @@
+from typing import Any
+
+from kantree_cli.core.client import KantreeClient
+from kantree_cli.core.errors import ValidationError
+from kantree_cli.core.response import extract_object, extract_object_list
+
+JsonObject = dict[str, Any]
+VIEW_MODES = ("kanban", "list", "table", "calendar", "timeline")
+
+
+def list_views(client: KantreeClient) -> list[JsonObject]:
+    payload = client.get_json("/views")
+    return extract_object_list(
+        payload,
+        context="`GET /views`",
+        preferred_keys=("views", "data", "items", "results"),
+    )
+
+
+def get_view(client: KantreeClient, view_id: int) -> JsonObject:
+    payload = client.get_json(f"/views/{view_id}")
+    return extract_object(
+        payload,
+        context=f"`GET /views/{view_id}`",
+        preferred_keys=("view", "data", "item", "result"),
+    )
+
+
+def create_view(
+    client: KantreeClient,
+    *,
+    name: str,
+    mode: str | None = None,
+    filter_text: str | None = None,
+    include_archived: bool | None = None,
+    include_descendants: bool | None = None,
+) -> JsonObject:
+    payload = _view_payload(
+        name=name,
+        mode=mode,
+        filter_text=filter_text,
+        include_archived=include_archived,
+        include_descendants=include_descendants,
+    )
+    response = client.request(method="POST", path="/views", json_body=payload)
+    return extract_object(
+        response.data,
+        context="`POST /views`",
+        preferred_keys=("view", "data", "item", "result"),
+    )
+
+
+def update_view(
+    client: KantreeClient,
+    *,
+    view_id: int,
+    name: str | None = None,
+    mode: str | None = None,
+    filter_text: str | None = None,
+    clear_filter: bool = False,
+    include_archived: bool | None = None,
+    include_descendants: bool | None = None,
+) -> JsonObject:
+    if filter_text is not None and clear_filter:
+        raise ValidationError("Use either `--filter` or `--clear-filter`, not both.")
+    payload = _view_payload(
+        name=name,
+        mode=mode,
+        filter_text=None if clear_filter else filter_text,
+        include_filter=filter_text is not None or clear_filter,
+        include_archived=include_archived,
+        include_descendants=include_descendants,
+    )
+    if not payload:
+        raise ValidationError(
+            "View update requires at least one of `--name`, `--mode`, `--filter`, "
+            "`--clear-filter`, `--include-archived`, `--no-include-archived`, "
+            "`--include-descendants`, or `--no-include-descendants`."
+        )
+    response = client.request(method="PUT", path=f"/views/{view_id}", json_body=payload)
+    return extract_object(
+        response.data,
+        context=f"`PUT /views/{view_id}`",
+        preferred_keys=("view", "data", "item", "result"),
+    )
+
+
+def delete_view(client: KantreeClient, *, view_id: int) -> Any:
+    response = client.request(method="DELETE", path=f"/views/{view_id}")
+    return response.data
+
+
+def view_summary(view: JsonObject) -> JsonObject:
+    summary: JsonObject = {
+        "id": view.get("id"),
+        "name": view.get("name", view.get("title")),
+    }
+    for key in ("mode", "filter", "include_archived", "include_descendants"):
+        if key in view:
+            summary[key] = view.get(key)
+    return summary
+
+
+def _view_payload(
+    *,
+    name: str | None = None,
+    mode: str | None = None,
+    filter_text: str | None = None,
+    include_filter: bool = False,
+    include_archived: bool | None = None,
+    include_descendants: bool | None = None,
+) -> JsonObject:
+    payload: JsonObject = {}
+    if name is not None:
+        payload["name"] = name
+    if mode is not None:
+        payload["mode"] = mode
+    if include_filter or filter_text is not None:
+        payload["filter"] = filter_text
+    if include_archived is not None:
+        payload["include_archived"] = include_archived
+    if include_descendants is not None:
+        payload["include_descendants"] = include_descendants
+    return payload

kantree_cli/services/webhooks.py

@@ -0,0 +1,120 @@
+from typing import Any
+
+from kantree_cli.core.client import KantreeClient
+from kantree_cli.core.errors import ValidationError
+from kantree_cli.core.response import (
+    extract_object,
+    extract_object_list,
+)
+
+JsonObject = dict[str, Any]
+
+
+def list_workspace_webhooks(client: KantreeClient, workspace_id: int) -> list[JsonObject]:
+    payload = client.get_json(f"/projects/{workspace_id}/webhooks")
+    return extract_object_list(
+        payload,
+        context=f"`GET /projects/{workspace_id}/webhooks`",
+        preferred_keys=("webhooks", "data", "items", "results"),
+    )
+
+
+def get_workspace_webhook(
+    client: KantreeClient,
+    *,
+    workspace_id: int,
+    webhook_id: int,
+) -> JsonObject:
+    payload = client.get_json(f"/projects/{workspace_id}/webhooks/{webhook_id}")
+    return extract_object(
+        payload,
+        context=f"`GET /projects/{workspace_id}/webhooks/{webhook_id}`",
+        preferred_keys=("webhook", "data", "item", "result"),
+    )
+
+
+def create_workspace_webhook(
+    client: KantreeClient,
+    *,
+    workspace_id: int,
+    url: str,
+    events: list[str],
+    active: bool | None = None,
+    card_object_only: bool | None = None,
+    card_object_only_as_array: bool | None = None,
+) -> JsonObject:
+    payload: JsonObject = {
+        "url": url,
+        "events": events,
+    }
+    if active is not None:
+        payload["active"] = active
+    if card_object_only is not None:
+        payload["card_object_only"] = card_object_only
+    if card_object_only_as_array is not None:
+        payload["card_object_only_as_array"] = card_object_only_as_array
+
+    response = client.request(
+        method="POST",
+        path=f"/projects/{workspace_id}/webhooks",
+        json_body=payload,
+    )
+    return extract_object(
+        response.data,
+        context=f"`POST /projects/{workspace_id}/webhooks`",
+        preferred_keys=("webhook", "data", "item", "result"),
+    )
+
+
+def update_workspace_webhook(
+    client: KantreeClient,
+    *,
+    workspace_id: int,
+    webhook_id: int,
+    url: str | None = None,
+    events: list[str] | None = None,
+    active: bool | None = None,
+    card_object_only: bool | None = None,
+    card_object_only_as_array: bool | None = None,
+) -> JsonObject:
+    payload: JsonObject = {}
+    if url is not None:
+        payload["url"] = url
+    if events is not None:
+        payload["events"] = events
+    if active is not None:
+        payload["active"] = active
+    if card_object_only is not None:
+        payload["card_object_only"] = card_object_only
+    if card_object_only_as_array is not None:
+        payload["card_object_only_as_array"] = card_object_only_as_array
+    if not payload:
+        raise ValidationError(
+            "Webhook update requires at least one field: `--url`, `--events`, `--active`/`--inactive`, "
+            "`--card-object-only`/`--no-card-object-only`, or "
+            "`--card-object-only-as-array`/`--no-card-object-only-as-array`."
+        )
+
+    response = client.request(
+        method="PUT",
+        path=f"/projects/{workspace_id}/webhooks/{webhook_id}",
+        json_body=payload,
+    )
+    return extract_object(
+        response.data,
+        context=f"`PUT /projects/{workspace_id}/webhooks/{webhook_id}`",
+        preferred_keys=("webhook", "data", "item", "result"),
+    )
+
+
+def delete_workspace_webhook(
+    client: KantreeClient,
+    *,
+    workspace_id: int,
+    webhook_id: int,
+) -> Any:
+    response = client.request(
+        method="DELETE",
+        path=f"/projects/{workspace_id}/webhooks/{webhook_id}",
+    )
+    return response.data