shipmail-cli 0.1.3 → 0.1.4

package/dist/cli.js

@@ -12,7 +12,7 @@ import {
 } from "shipmail";
 
 // src/version.ts
-var VERSION = "0.1.3";
+var VERSION = "0.1.4";
 
 // src/cli.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -242,6 +242,18 @@ Usage:
   shipmail webhooks create --url https://example.com/hook --events message.received,message.bounced
   shipmail suppressions list
   shipmail suppressions remove <email>
+  shipmail audiences list [--limit 25] [--cursor cur]
+  shipmail audiences create <name> --consent-source "Signup form" [--description "..."]
+  shipmail audiences get <id>
+  shipmail audiences update <id> [--name "..."] [--description "..."]
+  shipmail audiences delete <id>
+  shipmail audiences subscribers add <audience-id> <email> [--name "Jane"] [--consent-source "..."]
+  shipmail audiences subscribers list <audience-id> [--status subscribed] [--email jane@x.com] [--limit 25]
+  shipmail audiences subscribers get <audience-id> <subscriber-id>
+  shipmail audiences subscribers by-email <audience-id> <email>
+  shipmail audiences subscribers update <audience-id> <subscriber-id> [--name "..."]
+  shipmail audiences subscribers unsubscribe <audience-id> <subscriber-id>
+  shipmail audiences subscribers remove <audience-id> <subscriber-id>
 
 Global options:
   --api-key <key>       API key. Defaults to SHIPMAIL_API_KEY.
@@ -575,6 +587,158 @@ async function runSuppressions(client, parsed, out) {
   }
   throw new CliUsageError("Unknown suppressions command.");
 }
+var SUBSCRIBER_STATUS_VALUES = [
+  "subscribed",
+  "unsubscribed",
+  "bounced",
+  "complained",
+  "suppressed",
+  "transactional_only"
+];
+function subscriberListParams(options) {
+  const email = getString(options, "email");
+  const statusRaw = getString(options, "status");
+  const status = statusRaw ? SUBSCRIBER_STATUS_VALUES.find((s) => s === statusRaw) : void 0;
+  if (statusRaw && !status) {
+    throw new CliUsageError(`Invalid --status: ${statusRaw}.`);
+  }
+  return {
+    cursor: getString(options, "cursor"),
+    limit: getNumber(options, "limit"),
+    ...status ? { status } : {},
+    ...email ? { email } : {}
+  };
+}
+async function runSubscribers(client, parsed, out) {
+  const action = parsed.positional[2];
+  const audienceId = requirePositional(parsed.positional, 3, "audience id");
+  if (action === "list") {
+    writeJson(
+      out,
+      await client.audiences.subscribers.list(audienceId, subscriberListParams(parsed.options))
+    );
+    return;
+  }
+  if (action === "add") {
+    const name = getString(parsed.options, "name");
+    const consentSource = getString(parsed.options, "consent-source");
+    const consentIp = getString(parsed.options, "consent-ip");
+    writeJson(
+      out,
+      await client.audiences.subscribers.add(audienceId, {
+        email_address: requirePositional(parsed.positional, 4, "email"),
+        ...name ? { display_name: name } : {},
+        ...consentSource ? { consent_source: consentSource } : {},
+        ...consentIp ? { consent_ip: consentIp } : {}
+      })
+    );
+    return;
+  }
+  if (action === "get") {
+    writeJson(
+      out,
+      await client.audiences.subscribers.get(
+        audienceId,
+        requirePositional(parsed.positional, 4, "subscriber id")
+      )
+    );
+    return;
+  }
+  if (action === "by-email") {
+    writeJson(
+      out,
+      await client.audiences.subscribers.getByEmail(
+        audienceId,
+        requirePositional(parsed.positional, 4, "email")
+      )
+    );
+    return;
+  }
+  if (action === "update") {
+    const subscriberId = requirePositional(parsed.positional, 4, "subscriber id");
+    const name = getString(parsed.options, "name");
+    writeJson(
+      out,
+      await client.audiences.subscribers.update(audienceId, subscriberId, {
+        ...name ? { display_name: name } : {}
+      })
+    );
+    return;
+  }
+  if (action === "unsubscribe") {
+    writeJson(
+      out,
+      await client.audiences.subscribers.unsubscribe(
+        audienceId,
+        requirePositional(parsed.positional, 4, "subscriber id")
+      )
+    );
+    return;
+  }
+  if (action === "remove") {
+    const subscriberId = requirePositional(parsed.positional, 4, "subscriber id");
+    await client.audiences.subscribers.remove(audienceId, subscriberId);
+    writeJson(out, { ok: true, id: subscriberId });
+    return;
+  }
+  throw new CliUsageError("Unknown audiences subscribers command.");
+}
+async function runAudiences(client, parsed, out) {
+  const subcommand = parsed.positional[1];
+  if (subcommand === "subscribers") {
+    await runSubscribers(client, parsed, out);
+    return;
+  }
+  if (subcommand === "list") {
+    writeJson(
+      out,
+      await client.audiences.list({
+        cursor: getString(parsed.options, "cursor"),
+        limit: getNumber(parsed.options, "limit")
+      })
+    );
+    return;
+  }
+  if (subcommand === "create") {
+    const description = getString(parsed.options, "description");
+    writeJson(
+      out,
+      await client.audiences.create({
+        name: requirePositional(parsed.positional, 2, "audience name"),
+        consent_source: getRequiredString(parsed.options, "consent-source"),
+        ...description ? { description } : {}
+      })
+    );
+    return;
+  }
+  if (subcommand === "get") {
+    writeJson(
+      out,
+      await client.audiences.get(requirePositional(parsed.positional, 2, "audience id"))
+    );
+    return;
+  }
+  if (subcommand === "update") {
+    const id = requirePositional(parsed.positional, 2, "audience id");
+    const name = getString(parsed.options, "name");
+    const description = getString(parsed.options, "description");
+    writeJson(
+      out,
+      await client.audiences.update(id, {
+        ...name ? { name } : {},
+        ...description ? { description } : {}
+      })
+    );
+    return;
+  }
+  if (subcommand === "delete") {
+    const id = requirePositional(parsed.positional, 2, "audience id");
+    await client.audiences.delete(id);
+    writeJson(out, { ok: true, id });
+    return;
+  }
+  throw new CliUsageError("Unknown audiences command.");
+}
 function writeError(err, errOut) {
   if (err instanceof CliUsageError) {
     errOut.write(`Error: ${err.message}
@@ -633,6 +797,7 @@ async function runCli(argv, options = {}) {
     else if (command === "messages") await runMessages(client, parsed, out);
     else if (command === "webhooks") await runWebhooks(client, parsed, out);
     else if (command === "suppressions") await runSuppressions(client, parsed, out);
+    else if (command === "audiences") await runAudiences(client, parsed, out);
     else throw new CliUsageError(`Unknown command: ${command}.`);
     return 0;
   } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipmail-cli",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Official CLI for the ShipMail API",
   "type": "module",
   "bin": {
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "shipmail": "0.1.21"
+    "shipmail": "0.1.24"
   },
   "devDependencies": {
     "tsup": "^8.4.0",