shipmail-cli 0.4.5 → 0.4.7

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 ShipMail
+Copyright (c) 2025 Shipmail
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/cli.js

@@ -8,13 +8,13 @@ import { env as processEnv, exit, stderr, stdout } from "process";
 import { fileURLToPath } from "url";
 import {
   CONFERENCING_PROVIDER_IDS,
-  ShipMailClient,
-  ShipMailError,
+  ShipmailClient,
+  ShipmailError,
   WEBHOOK_EVENT_TYPES
 } from "shipmail";
 
 // src/version.ts
-var VERSION = "0.4.5";
+var VERSION = "0.4.7";
 
 // src/cli.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -143,7 +143,7 @@ function createClient(parsed, options) {
     organizationId: organizationId(parsed, env),
     ...options.fetch ? { fetch: options.fetch } : {}
   };
-  return new ShipMailClient(config);
+  return new ShipmailClient(config);
 }
 function writeJson(out, value) {
   out.write(`${JSON.stringify(value, null, 2)}
@@ -185,6 +185,19 @@ function parseStylingMode(options) {
   if (value === "styled" || value === "plain") return value;
   throw new CliUsageError("--styling-mode must be styled or plain.");
 }
+async function automationDefinition(value) {
+  const parsed = await readJsonInput(value);
+  if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
+    throw new CliUsageError("--definition must be a JSON automation definition object.");
+  }
+  return parsed;
+}
+function automationStatus(options) {
+  const value = getString(options, "status");
+  if (value === void 0) return void 0;
+  if (value === "active" || value === "paused" || value === "disabled") return value;
+  throw new CliUsageError("--status must be active, paused, or disabled.");
+}
 async function newsletterCreateParams(options) {
   const audience_id = getRequiredString(options, "audience-id");
   const sender_identity_id = getRequiredString(options, "sender-identity-id");
@@ -278,7 +291,7 @@ async function rawApiRequest(parsed, runOptions, method, path, body, authRequire
   }
   const targetOrganizationId = organizationId(parsed, env);
   if (targetOrganizationId) {
-    headers["X-ShipMail-Organization-Id"] = targetOrganizationId;
+    headers["X-Shipmail-Organization-Id"] = targetOrganizationId;
   }
   let requestBody;
   if (body !== void 0) {
@@ -324,6 +337,11 @@ Usage:
   shipmail status
   shipmail capabilities
   shipmail api <METHOD> <PATH> [--data JSON|@file] [--output file]
+  shipmail automations list
+  shipmail automations create --name "Daily brief" --definition JSON|@file [--idempotency-key key]
+  shipmail automations get <id>
+  shipmail automations update <id> [--name "..."] [--definition JSON|@file] [--status active|paused|disabled] [--idempotency-key key]
+  shipmail automations run <id> [--idempotency-key key]
   shipmail domains list [--limit 25] [--cursor cur]
   shipmail domains search <keyword>
   shipmail domains create <name>
@@ -1839,6 +1857,53 @@ async function runBookingPages(client, parsed, out) {
   }
   throw new CliUsageError("Unknown booking-pages command.");
 }
+async function runAutomations(client, parsed, out) {
+  const subcommand = parsed.positional[1];
+  const idempotencyKey = getString(parsed.options, "idempotency-key");
+  const options = idempotencyKey ? { idempotencyKey } : void 0;
+  if (subcommand === "list") {
+    writeJson(out, await client.automations.list());
+    return;
+  }
+  if (subcommand === "create") {
+    writeJson(
+      out,
+      await client.automations.create(
+        {
+          name: getRequiredString(parsed.options, "name"),
+          definition: await automationDefinition(getRequiredString(parsed.options, "definition"))
+        },
+        options
+      )
+    );
+    return;
+  }
+  const id = requirePositional(parsed.positional, 2, "automation id");
+  if (subcommand === "get") {
+    writeJson(out, await client.automations.get(id));
+    return;
+  }
+  if (subcommand === "update") {
+    const name = getString(parsed.options, "name");
+    const definitionInput = getString(parsed.options, "definition");
+    const status = automationStatus(parsed.options);
+    const params = {
+      ...name !== void 0 ? { name } : {},
+      ...definitionInput !== void 0 ? { definition: await automationDefinition(definitionInput) } : {},
+      ...status !== void 0 ? { status } : {}
+    };
+    if (Object.keys(params).length === 0) {
+      throw new CliUsageError("Provide --name, --definition, or --status.");
+    }
+    writeJson(out, await client.automations.update(id, params, options));
+    return;
+  }
+  if (subcommand === "run") {
+    writeJson(out, await client.automations.run(id, options));
+    return;
+  }
+  throw new CliUsageError("Unknown automations command.");
+}
 async function runPartner(client, parsed, out) {
   const group = parsed.positional[1];
   if (group === "usage") {
@@ -1942,7 +2007,7 @@ ${JSON.stringify(err.body, null, 2)}
 `);
     return;
   }
-  if (err instanceof ShipMailError) {
+  if (err instanceof ShipmailError) {
     const shipmailError = err;
     const status = shipmailError.status !== void 0 ? ` (HTTP ${shipmailError.status})` : "";
     const requestId = shipmailError.requestId ? ` request_id=${shipmailError.requestId}` : "";
@@ -1994,7 +2059,8 @@ async function runCli(argv, options = {}) {
       return 0;
     }
     const client = createClient(parsed, options);
-    if (command === "domains") await runDomains(client, parsed, out);
+    if (command === "automations") await runAutomations(client, parsed, out);
+    else if (command === "domains") await runDomains(client, parsed, out);
     else if (command === "mailboxes") await runMailboxes(client, parsed, out);
     else if (command === "inbox") await runInbox(client, parsed, out);
     else if (command === "messages") await runMessages(client, parsed, out);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shipmail-cli",
-  "version": "0.4.5",
-  "description": "Official CLI for the ShipMail API",
+  "version": "0.4.7",
+  "description": "Official CLI for the Shipmail API",
   "type": "module",
   "bin": {
     "shipmail": "dist/cli.js"
@@ -26,7 +26,7 @@
     "domain",
     "terminal"
   ],
-  "author": "ShipMail",
+  "author": "Shipmail",
   "license": "MIT",
   "homepage": "https://shipmail.to/docs/cli",
   "repository": {
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "shipmail": "0.4.10"
+    "shipmail": "0.4.14"
   },
   "devDependencies": {
     "tsup": "^8.4.0",