ermes-cli 1.0.0__py3-none-any.whl

ermes_cli/commands/templates.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+import json as json_lib
+from typing import Optional
+import typer
+from ermes_cli.client import ErmesAPIError
+
+templates_app = typer.Typer(help="Manage templates", no_args_is_help=True)
+COLUMNS = ["id", "type", "locale", "campaign_id"]
+
+
+def _get_deps():
+    from ermes_cli.main import get_client, state
+    from ermes_cli.output import render, render_detail, render_message
+    return get_client(), state, render, render_detail, render_message
+
+
+@templates_app.command("list")
+def templates_list(template_type: Optional[str] = typer.Option(None, "--type", help="email|text|push|webhook"), limit: int = typer.Option(100, "--limit")):
+    """List templates."""
+    client, st, render, _, _ = _get_deps()
+    params = {}
+    if template_type:
+        params["filter[type]"] = template_type
+    try:
+        data = client.get_paginated("/templates", params=params, limit=limit)
+        render(data, columns=COLUMNS, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("get")
+def templates_get(template_id: int = typer.Argument(...)):
+    """Get template details."""
+    client, st, _, render_detail, _ = _get_deps()
+    try:
+        data = client.get(f"/templates/{template_id}")
+        render_detail(data, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("create")
+def templates_create(
+    template_type: str = typer.Option(..., "--type", help="email|text|push|webhook"),
+    campaign_id: int = typer.Option(..., "--campaign", help="Campaign ID to attach to"),
+    locale: str = typer.Option(..., "--locale", help="Template locale (e.g. en, de)"),
+    data: Optional[str] = typer.Option(None, "--data", help="Template data as JSON (from, subject, html, etc.)"),
+):
+    """Create a template for a campaign."""
+    client, st, _, render_detail, _ = _get_deps()
+    body: dict = {
+        "type": template_type,
+        "campaign_id": campaign_id,
+        "locale": locale,
+    }
+    if data:
+        try:
+            body["data"] = json_lib.loads(data)
+        except json_lib.JSONDecodeError as e:
+            typer.echo(f"Invalid JSON for --data: {e}", err=True)
+            raise typer.Exit(code=1)
+    try:
+        result = client.post("/templates", json=body)
+        render_detail(result, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("update")
+def templates_update(
+    template_id: int = typer.Argument(...),
+    template_type: str = typer.Option(..., "--type", help="email|text|push|webhook"),
+    data: str = typer.Option(..., "--data", help="Template data as JSON (from, subject, html, etc.)"),
+):
+    """Update a template's content."""
+    client, st, _, render_detail, _ = _get_deps()
+    try:
+        body_data = json_lib.loads(data)
+    except json_lib.JSONDecodeError as e:
+        typer.echo(f"Invalid JSON for --data: {e}", err=True)
+        raise typer.Exit(code=1)
+    try:
+        result = client.patch(f"/templates/{template_id}", json={"type": template_type, "data": body_data})
+        render_detail(result, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("delete")
+def templates_delete(template_id: int = typer.Argument(...)):
+    """Delete a template."""
+    client, st, _, _, render_message = _get_deps()
+    try:
+        client.delete(f"/templates/{template_id}")
+        render_message(f"Template {template_id} deleted.", use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("preview")
+def templates_preview(template_id: int = typer.Argument(...), data: Optional[str] = typer.Option(None, "--data", help="Preview data as JSON")):
+    """Preview a template."""
+    client, st, _, render_detail, _ = _get_deps()
+    body = {}
+    if data:
+        try:
+            body = json_lib.loads(data)
+        except json_lib.JSONDecodeError as e:
+            typer.echo(f"Invalid JSON: {e}", err=True)
+            raise typer.Exit(code=1)
+    try:
+        result = client.post(f"/templates/{template_id}/preview", json=body)
+        render_detail(result, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@templates_app.command("proof")
+def templates_proof(template_id: int = typer.Argument(...), to: str = typer.Option(..., "--to", help="Recipient email")):
+    """Send a test/proof of a template."""
+    client, st, _, _, render_message = _get_deps()
+    try:
+        client.post(f"/templates/{template_id}/proof", json={"to": to})
+        render_message(f"Proof sent to {to}.", use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)

ermes_cli/commands/users.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+import json as json_lib
+from typing import Optional
+import typer
+from ermes_cli.client import ErmesAPIError
+
+users_app = typer.Typer(help="Manage users", no_args_is_help=True)
+COLUMNS = ["id", "external_id", "email", "phone", "timezone", "locale"]
+
+
+def _get_deps():
+    from ermes_cli.main import get_client, state
+    from ermes_cli.output import render, render_detail, render_message
+    return get_client(), state, render, render_detail, render_message
+
+
+def _normalize_collection(data):
+    if isinstance(data, dict) and "results" in data:
+        data = data["results"]
+    elif (
+        isinstance(data, list)
+        and len(data) == 1
+        and isinstance(data[0], dict)
+        and "results" in data[0]
+    ):
+        data = data[0]["results"]
+    if not isinstance(data, list):
+        return [data] if data else []
+    return data
+
+
+@users_app.command("list")
+def users_list(q: Optional[str] = typer.Option(None, "--q", help="Search query"), limit: int = typer.Option(100, "--limit")):
+    """List users."""
+    client, st, render, _, _ = _get_deps()
+    params = {}
+    if q:
+        params["q"] = q
+    try:
+        data = client.get_paginated("/users", params=params, limit=limit)
+        render(data, columns=COLUMNS, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("get")
+def users_get(user_id: str = typer.Argument(..., help="User external_id (hash string)")):
+    """Get user details."""
+    client, st, _, render_detail, _ = _get_deps()
+    try:
+        data = client.get(f"/users/{user_id}")
+        render_detail(data, use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("delete")
+def users_delete(user_id: str = typer.Argument(..., help="User external_id")):
+    """Delete a user."""
+    client, st, _, _, render_message = _get_deps()
+    try:
+        client.delete(f"/users/{user_id}")
+        render_message(f"User {user_id} deleted.", use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("events")
+def users_events(user_id: str = typer.Argument(..., help="User external_id"), limit: int = typer.Option(100, "--limit")):
+    """List user events."""
+    client, st, render, _, _ = _get_deps()
+    try:
+        data = client.get_paginated(f"/users/{user_id}/events", limit=limit)
+        render(data, columns=["id", "name", "created_at"], use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("lists")
+def users_lists(user_id: str = typer.Argument(..., help="User external_id")):
+    """List user's list memberships."""
+    client, st, render, _, _ = _get_deps()
+    try:
+        data = _normalize_collection(client.get(f"/users/{user_id}/lists"))
+        render(data, columns=["id", "name", "type", "state"], use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("subscriptions")
+def users_subscriptions(user_id: str = typer.Argument(..., help="User external_id")):
+    """List user's subscriptions."""
+    client, st, render, _, _ = _get_deps()
+    try:
+        data = _normalize_collection(client.get(f"/users/{user_id}/subscriptions"))
+        render(data, columns=["subscription_id", "name", "channel", "state"], use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("subscriptions-update")
+def users_subscriptions_update(user_id: str = typer.Argument(..., help="User external_id"), data: str = typer.Argument(..., help="Subscription updates as JSON array")):
+    """Update user's subscriptions."""
+    client, st, _, _, render_message = _get_deps()
+    try:
+        body = json_lib.loads(data)
+    except json_lib.JSONDecodeError as e:
+        typer.echo(f"Invalid JSON: {e}", err=True)
+        raise typer.Exit(code=1)
+    try:
+        client.patch(f"/users/{user_id}/subscriptions", json=body)
+        render_message(f"Subscriptions updated for user {user_id}.", use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)
+
+
+@users_app.command("journeys")
+def users_journeys(user_id: str = typer.Argument(..., help="User external_id")):
+    """List user's journey participations."""
+    client, st, render, _, _ = _get_deps()
+    try:
+        data = _normalize_collection(client.get(f"/users/{user_id}/journeys"))
+        render(data, columns=["journey_id", "type", "step_id", "delay_until"], use_json=st.use_json)
+    except ErmesAPIError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1)

ermes_cli/commands/write_cmds.py

@@ -0,0 +1,87 @@
+"""`ermes write allow|deny|status` — control the write-mode guard.
+
+The guard blocks every POST/PATCH/PUT/DELETE issued through `client.py`
+unless the operator has explicitly opened a write window. This is the
+"are you sure?" speed bump for the CLI surface. See `write_mode.py` for
+the underlying state machine.
+"""
+
+from __future__ import annotations
+
+import typer
+from rich.console import Console
+
+from ermes_cli import write_mode
+
+console = Console()
+
+
+write_app = typer.Typer(
+    help="Control the write-mode guard (blocks mutations by default)",
+    no_args_is_help=True,
+)
+
+
+def _print_status(s: dict) -> None:
+    if s["allowed"]:
+        if s["mode"] == "persistent":
+            console.print(
+                "[green]Writes ALLOWED[/green] (persistent — until you run "
+                "`ermes write deny`)."
+            )
+        elif s["mode"] == "env":
+            console.print(
+                "[green]Writes ALLOWED[/green] via ERMES_ALLOW_WRITES env override."
+            )
+        else:
+            console.print(
+                f"[green]Writes ALLOWED[/green] until [bold]{s['until']}[/bold] "
+                "(UTC). Run `ermes write deny` to close early."
+            )
+    else:
+        msg = "[red]Writes BLOCKED[/red] (default)."
+        if s["until"]:
+            msg += f" Last window expired at {s['until']}."
+        console.print(msg)
+        console.print(
+            "[dim]Open a write window with:[/dim]\n"
+            "  ermes write allow                # 30 minutes\n"
+            "  ermes write allow --minutes 5    # custom window\n"
+            "  ermes write allow --persistent   # no expiry\n"
+            "[dim]Or set ERMES_ALLOW_WRITES=1 in the environment.[/dim]"
+        )
+
+
+@write_app.command("status")
+def write_status() -> None:
+    """Show the current write-mode state."""
+    _print_status(write_mode.status())
+
+
+@write_app.command("allow")
+def write_allow(
+    minutes: int = typer.Option(
+        30,
+        "--minutes",
+        "-m",
+        min=1,
+        max=24 * 60,
+        help="Open a time-limited window (default 30, max 1440 = 24h).",
+    ),
+    persistent: bool = typer.Option(
+        False,
+        "--persistent",
+        "-p",
+        help="Open indefinitely. Ignores --minutes.",
+    ),
+) -> None:
+    """Allow mutating CLI calls (POST / PATCH / PUT / DELETE)."""
+    s = write_mode.allow(minutes=minutes, persistent=persistent)
+    _print_status(s)
+
+
+@write_app.command("deny")
+def write_deny() -> None:
+    """Block all mutating CLI calls (default state)."""
+    s = write_mode.deny()
+    _print_status(s)