@arcsend/cli 1.0.0 → 1.2.0

package/README.md

@@ -15,9 +15,7 @@ npx @arcsend/cli --help
 Get an API key from your ArcSend workspace (Settings → API Keys), then:
 
 ```bash
-arcsend auth setup --key arc_xxxxxxxx
-# dedicated instance? point at your domain:
-arcsend auth setup --key arc_xxxxxxxx --url https://send.yourdomain.com
+arcsend auth setup --key arc_xxxxxxxx --url https://app.arcsend.io   # your instance URL — the /cli page has it pre-filled
 ```
 
 Or use env vars: `ARCSEND_API_KEY`, `ARCSEND_URL`.

package/dist/index.js

@@ -10,7 +10,6 @@ import chalk2 from "chalk";
 import { homedir } from "os";
 import { join } from "path";
 import { readFileSync, writeFileSync, mkdirSync, existsSync, chmodSync } from "fs";
-var DEFAULT_URL = "https://send.highsend.io";
 var CONFIG_DIR = join(homedir(), ".arcsend");
 var CONFIG_PATH = join(CONFIG_DIR, "config.txt");
 function loadConfig(keyOverride, urlOverride) {
@@ -26,7 +25,7 @@ function loadConfig(keyOverride, urlOverride) {
       if (!baseUrl && (key === "instance_url" || key === "url")) baseUrl = val;
     }
   }
-  baseUrl = (baseUrl || DEFAULT_URL).replace(/\/+$/, "");
+  baseUrl = baseUrl.replace(/\/+$/, "");
   return { apiKey, baseUrl };
 }
 function saveConfig(apiKey, url) {
@@ -282,7 +281,10 @@ var Api = class {
     if (this.ready) return;
     const { apiKey, baseUrl } = loadConfig(this.keyOverride, this.urlOverride);
     if (!apiKey) {
-      fail("No API key. Use --api-key, set ARCSEND_API_KEY, or run `arcsend auth setup --key <key>`.");
+      fail("No API key. Use --api-key, set ARCSEND_API_KEY, or run `arcsend auth setup --key <key> --url <url>`.");
+    }
+    if (!baseUrl) {
+      fail("No instance URL. Use --url, set ARCSEND_URL, or run `arcsend auth setup --key <key> --url https://your-instance` (e.g. https://app.arcsend.io \u2014 your /cli page has it pre-filled).");
     }
     this.apiKey = apiKey;
     this.baseUrl = `${baseUrl}/api/external`;
@@ -958,36 +960,48 @@ var campaigns = {
       params: [{ name: "id", positional: true, desc: "campaign id" }, ...replyFilters],
       output: { columns: REPLY_COLS, headers: REPLY_HDRS, noun: "reply(ies)" }
     },
-    // Account assignment
+    // Sender-account assignment (by email — additive attach/detach, or full replace)
     {
       name: "accounts",
-      summary: "List sending accounts assigned to a campaign.",
+      summary: "List sender accounts assigned to a campaign.",
       method: "GET",
-      path: "/campaigns/:id/accounts",
+      path: "/campaigns/:id/sender-accounts",
       params: [{ name: "id", positional: true, desc: "campaign id" }],
-      output: { columns: ["id", "email", "status", "daily_limit"], headers: ["ID", "Email", "Status", "Limit"], noun: "account(s)" }
+      output: { columns: ["email", "status", "daily_limit", "is_paused"], headers: ["Email", "Status", "Limit", "Paused"], noun: "account(s)" }
     },
     {
-      name: "assign",
-      summary: "Set the campaign's sending accounts (REPLACES the current set).",
+      name: "attach",
+      summary: "Attach sender accounts to a campaign by email (additive \u2014 keeps existing).",
       method: "POST",
-      path: "/campaigns/:id/accounts",
+      path: "/campaigns/:id/sender-accounts/attach",
       params: [
-        { name: "id", positional: true, echoBody: true, apiName: "campaign_id", desc: "campaign id" },
-        { name: "ids", type: "csv", required: true, apiName: "account_ids", desc: "comma-separated account ids (full replace set)" }
+        { name: "id", positional: true, desc: "campaign id" },
+        { name: "emails", type: "csv", required: true, desc: "comma-separated sender-account emails to attach" }
       ],
-      success: "Accounts assigned."
+      success: "Sender accounts attached."
     },
     {
-      name: "unassign",
-      summary: "Remove specific sending accounts from a campaign.",
+      name: "detach",
+      summary: "Detach specific sender accounts from a campaign, by email.",
       method: "POST",
-      path: "/campaigns/:id/accounts/batch-unassign",
+      path: "/campaigns/:id/sender-accounts/detach",
+      params: [
+        { name: "id", positional: true, desc: "campaign id" },
+        { name: "emails", type: "csv", required: true, desc: "comma-separated sender-account emails to detach" }
+      ],
+      success: "Sender accounts detached."
+    },
+    {
+      name: "replace",
+      summary: "Replace the campaign's entire sender-account set with exactly these emails.",
+      method: "PUT",
+      path: "/campaigns/:id/sender-accounts",
+      confirm: "Replace ALL of this campaign's sender accounts with the provided set?",
       params: [
         { name: "id", positional: true, desc: "campaign id" },
-        { name: "ids", type: "csv", required: true, apiName: "account_ids", desc: "comma-separated account ids to remove" }
+        { name: "emails", type: "csv", required: true, desc: "comma-separated sender-account emails (full replace set)" }
       ],
-      success: "Accounts unassigned."
+      success: "Sender accounts replaced."
     }
   ],
   subgroups: [
@@ -1134,16 +1148,181 @@ var campaigns = {
   ]
 };
 
+// src/defs/subsequences.ts
+var TRIGGERS = "replied | sentiment_interested | sentiment_not_interested | sentiment_not_now | sentiment_question | sentiment_referral | reply_keyword | no_reply | lead_status";
+var subsequences = {
+  name: "subsequences",
+  summary: "In-campaign branches. A lead matching a trigger (reply/sentiment/keyword/no-reply) is moved off the main line onto its own mini-sequence. Max 10 per campaign.",
+  commands: [
+    {
+      name: "list",
+      summary: "List a campaign's subsequences.",
+      method: "GET",
+      path: "/campaigns/:campaign/subsequences",
+      params: [{ name: "campaign", positional: true, desc: "campaign id" }],
+      output: { columns: ["id", "name", "trigger_type", "is_active"], headers: ["ID", "Name", "Trigger", "Active"], noun: "subsequence(s)" }
+    },
+    {
+      name: "create",
+      summary: "Create a subsequence (max 10 per campaign).",
+      method: "POST",
+      path: "/campaigns/:campaign/subsequences",
+      params: [
+        { name: "campaign", positional: true, desc: "campaign id" },
+        { name: "name", required: true, desc: "subsequence name" },
+        { name: "triggerType", required: true, apiName: "trigger_type", desc: TRIGGERS },
+        { name: "triggerConfig", type: "json", apiName: "trigger_config", desc: `JSON config \u2014 {"keyword":"pricing"} for reply_keyword, {"status":"meeting_booked"} for lead_status` },
+        { name: "delayDays", type: "number", apiName: "initial_delay_days", desc: "wait days before the first step" },
+        { name: "delayHours", type: "number", apiName: "initial_delay_hours", desc: "wait hours before the first step" }
+      ],
+      success: "Subsequence created."
+    },
+    {
+      name: "get",
+      summary: "Show one subsequence.",
+      method: "GET",
+      path: "/campaigns/:campaign/subsequences/:id",
+      params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }]
+    },
+    {
+      name: "update",
+      summary: "Update a subsequence (name, trigger config, delay, or active state). trigger_type is immutable.",
+      method: "PATCH",
+      path: "/campaigns/:campaign/subsequences/:id",
+      params: [
+        { name: "campaign", positional: true, desc: "campaign id" },
+        { name: "id", positional: true, desc: "subsequence id" },
+        { name: "name", desc: "new name" },
+        { name: "triggerConfig", type: "json", apiName: "trigger_config", desc: "new trigger config JSON" },
+        { name: "delayDays", type: "number", apiName: "initial_delay_days", desc: "wait days before the first step" },
+        { name: "delayHours", type: "number", apiName: "initial_delay_hours", desc: "wait hours before the first step" },
+        { name: "active", type: "tri", negFlag: "--inactive", apiName: "is_active", desc: "activate / pause the subsequence" }
+      ],
+      success: "Subsequence updated."
+    },
+    {
+      name: "delete",
+      summary: "Delete a subsequence (its steps go too; its leads return to the main line).",
+      method: "DELETE",
+      path: "/campaigns/:campaign/subsequences/:id",
+      confirm: "Delete this subsequence?",
+      params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }],
+      success: "Deleted."
+    },
+    {
+      name: "move",
+      summary: "Move leads (by email) onto a subsequence. Cancels their queued main-line sends. Fails if the subsequence is paused.",
+      method: "POST",
+      path: "/campaigns/:campaign/subsequences/:id/move",
+      params: [
+        { name: "campaign", positional: true, desc: "campaign id" },
+        { name: "id", positional: true, desc: "subsequence id" },
+        { name: "emails", type: "csv", required: true, desc: "comma-separated lead emails to move" }
+      ],
+      success: "Leads moved."
+    },
+    {
+      name: "remove",
+      summary: "Remove leads (by email) from a subsequence, releasing them to the main line.",
+      method: "POST",
+      path: "/campaigns/:campaign/subsequences/:id/remove",
+      params: [
+        { name: "campaign", positional: true, desc: "campaign id" },
+        { name: "id", positional: true, desc: "subsequence id" },
+        { name: "emails", type: "csv", required: true, desc: "comma-separated lead emails to remove" }
+      ],
+      success: "Leads removed."
+    },
+    {
+      name: "pause",
+      summary: "Pause a subsequence \u2014 no new leads enter and its steps freeze until resumed.",
+      method: "POST",
+      path: "/campaigns/:campaign/subsequences/:id/pause",
+      params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }],
+      success: "Paused."
+    },
+    {
+      name: "resume",
+      summary: "Resume a paused subsequence.",
+      method: "POST",
+      path: "/campaigns/:campaign/subsequences/:id/resume",
+      params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }],
+      success: "Resumed."
+    }
+  ],
+  subgroups: [
+    {
+      name: "steps",
+      summary: "The email steps inside a subsequence. Step 1 needs a subject; every step needs a body. Spintax {a|b} and {{variables}} are supported.",
+      commands: [
+        {
+          name: "list",
+          summary: "List a subsequence's steps.",
+          method: "GET",
+          path: "/campaigns/:campaign/subsequences/:id/steps",
+          params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }],
+          output: { columns: ["step_number", "variant", "subject", "delay_days", "delay_hours"], headers: ["Step", "Var", "Subject", "Days", "Hrs"], noun: "step(s)" }
+        },
+        {
+          name: "add",
+          summary: "Add an email step to a subsequence.",
+          method: "POST",
+          path: "/campaigns/:campaign/subsequences/:id/steps",
+          params: [
+            { name: "campaign", positional: true, desc: "campaign id" },
+            { name: "id", positional: true, desc: "subsequence id" },
+            { name: "step", type: "number", required: true, apiName: "step_number", desc: "step number (1 = first)" },
+            { name: "body", required: true, desc: "email body (spintax + {{vars}} allowed)" },
+            { name: "subject", desc: "subject line (required on step 1)" },
+            { name: "delayDays", type: "number", apiName: "delay_days", desc: "days after the previous step" },
+            { name: "delayHours", type: "number", apiName: "delay_hours", desc: "additional hours" },
+            { name: "variant", desc: "A/B variant: A, B, C, or D (default A)" },
+            { name: "splitWeight", type: "number", apiName: "split_weight", desc: "A/B weight 1-100 (blank = equal split)" }
+          ],
+          success: "Step added."
+        },
+        {
+          name: "update",
+          summary: "Update a subsequence step.",
+          method: "PATCH",
+          path: "/campaigns/:campaign/subsequences/:id/steps/:step",
+          params: [
+            { name: "campaign", positional: true, desc: "campaign id" },
+            { name: "id", positional: true, desc: "subsequence id" },
+            { name: "step", positional: true, desc: "sequence step id" },
+            { name: "stepNumber", type: "number", apiName: "step_number", desc: "step number" },
+            { name: "subject", desc: "subject line" },
+            { name: "body", desc: "email body" },
+            { name: "delayDays", type: "number", apiName: "delay_days", desc: "days after the previous step" },
+            { name: "delayHours", type: "number", apiName: "delay_hours", desc: "additional hours" },
+            { name: "splitWeight", type: "number", apiName: "split_weight", desc: "A/B weight 1-100" }
+          ],
+          success: "Step updated."
+        },
+        {
+          name: "delete",
+          summary: "Delete a subsequence step.",
+          method: "DELETE",
+          path: "/campaigns/:campaign/subsequences/:id/steps/:step",
+          confirm: "Delete this step?",
+          params: [{ name: "campaign", positional: true, desc: "campaign id" }, { name: "id", positional: true, desc: "subsequence id" }, { name: "step", positional: true, desc: "sequence step id" }],
+          success: "Deleted."
+        }
+      ]
+    }
+  ]
+};
+
 // src/defs/accounts.ts
 var accounts = {
   name: "accounts",
-  summary: "Sending accounts (mailboxes). Connect/reconnect happens in the app; here you list, inspect, edit, scan, and remove them.",
+  summary: "Sending accounts (mailboxes), addressed by email. Connect/reconnect happens in the app; here you list, inspect, edit, scan, and remove them.",
   commands: [
     {
       name: "list",
       summary: "List sending accounts with operational filters.",
       method: "GET",
-      path: "/accounts",
+      path: "/sender-accounts",
       paged: true,
       params: [
         { name: "status", desc: "connected|connecting|disconnected|error" },
@@ -1159,25 +1338,25 @@ var accounts = {
     },
     {
       name: "get",
-      summary: "Show one account in full.",
+      summary: "Show one sender account in full.",
       method: "GET",
-      path: "/accounts/:id",
-      params: [{ name: "id", positional: true, desc: "account id" }]
+      path: "/sender-accounts/:email",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }]
     },
     {
       name: "stats",
-      summary: "Sending stats for one account.",
+      summary: "Sending stats for one sender account.",
       method: "GET",
-      path: "/accounts/:id/stats",
-      params: [{ name: "id", positional: true, desc: "account id" }]
+      path: "/sender-accounts/:email/stats",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }]
     },
     {
       name: "update",
-      summary: "Edit an account: sender name, daily limit (1\u201350), pause state, or tags.",
+      summary: "Edit a sender account: sender name, daily limit (1\u201350), pause state, or tags.",
       method: "PATCH",
-      path: "/accounts/:id",
+      path: "/sender-accounts/:email",
       params: [
-        { name: "id", positional: true, desc: "account id" },
+        { name: "email", positional: true, desc: "sender-account email" },
         { name: "senderName", apiName: "sender_name", desc: "the From display name" },
         { name: "dailyLimit", type: "number", apiName: "daily_limit", desc: "emails/day, 1\u201350 (default 5)" },
         { name: "paused", type: "tri", negFlag: "--active", apiName: "is_paused", desc: "pause (stop sending) / re-activate the account" },
@@ -1188,12 +1367,12 @@ var accounts = {
     },
     {
       name: "bulk-action",
-      summary: "Apply one action (pause/unpause/delete) to up to 200 accounts.",
+      summary: "Apply one action (pause/unpause/delete) to up to 200 sender accounts, by email.",
       method: "POST",
-      path: "/accounts/bulk-action",
+      path: "/sender-accounts/bulk-action",
       confirm: "Apply this action to all listed accounts?",
       params: [
-        { name: "ids", type: "csv", required: true, apiName: "account_ids", desc: "comma-separated account ids (1\u2013200)" },
+        { name: "emails", type: "csv", required: true, desc: "comma-separated sender-account emails (1\u2013200)" },
         { name: "action", required: true, desc: "pause|unpause|delete" }
       ],
       success: "Applied."
@@ -1202,17 +1381,17 @@ var accounts = {
       name: "dns-check",
       summary: "Run an SPF/DKIM/DMARC check on the account's sending domain.",
       method: "POST",
-      path: "/accounts/:id/dns-check",
-      params: [{ name: "id", positional: true, desc: "account id" }],
+      path: "/sender-accounts/:email/dns-check",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }],
       success: "DNS check run."
     },
     {
       name: "delete",
-      summary: "Delete (disconnect) an account.",
+      summary: "Delete (disconnect) a sender account.",
       method: "DELETE",
-      path: "/accounts/:id",
+      path: "/sender-accounts/:email",
       confirm: "Delete this account?",
-      params: [{ name: "id", positional: true, desc: "account id" }],
+      params: [{ name: "email", positional: true, desc: "sender-account email" }],
       success: "Deleted."
     }
   ]
@@ -1558,24 +1737,24 @@ var warmup = {
       name: "list",
       summary: "List accounts with their warmup status.",
       method: "GET",
-      path: "/warmup/accounts",
+      path: "/warmup/sender-accounts",
       paged: true,
       params: [{ name: "active", type: "tri", negFlag: "--inactive", apiName: "is_active", desc: "only warming / only not-warming" }],
-      output: { columns: ["id", "email", "warmup_enabled", "warmup_score"], headers: ["ID", "Email", "Enabled", "Score"], noun: "account(s)" }
+      output: { columns: ["email", "warmup_enabled", "warmup_score", "days_warming"], headers: ["Email", "Enabled", "Score", "Days"], noun: "account(s)" }
     },
     {
       name: "get",
       summary: "Show one account's warmup detail.",
       method: "GET",
-      path: "/warmup/accounts/:id",
-      params: [{ name: "id", positional: true, desc: "account id" }]
+      path: "/warmup/sender-accounts/:email",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }]
     },
     {
       name: "enable",
       summary: "Enable warmup for an account (must be connected). Optionally set targets.",
       method: "POST",
-      path: "/warmup/accounts/:id/enable",
-      params: [{ name: "id", positional: true, desc: "account id" }, ...warmupSettings],
+      path: "/warmup/sender-accounts/:email/enable",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }, ...warmupSettings],
       validate: "warmup.settings",
       success: "Warmup enabled."
     },
@@ -1583,16 +1762,16 @@ var warmup = {
       name: "disable",
       summary: "Disable warmup for an account (cancels pending warmup sends).",
       method: "POST",
-      path: "/warmup/accounts/:id/disable",
-      params: [{ name: "id", positional: true, desc: "account id" }],
+      path: "/warmup/sender-accounts/:email/disable",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }],
       success: "Warmup disabled."
     },
     {
       name: "settings",
       summary: "Update warmup targets for an account.",
       method: "PATCH",
-      path: "/warmup/accounts/:id/settings",
-      params: [{ name: "id", positional: true, desc: "account id" }, ...warmupSettings],
+      path: "/warmup/sender-accounts/:email/settings",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }, ...warmupSettings],
       validate: "warmup.settings",
       success: "Warmup settings updated."
     },
@@ -1601,8 +1780,8 @@ var warmup = {
       name: "history",
       summary: "Warmup send/receive history for an account.",
       method: "GET",
-      path: "/warmup/history/:id",
-      params: [{ name: "id", positional: true, desc: "account id" }, { name: "limit", type: "number", default: "50", desc: "rows (default 50)" }]
+      path: "/warmup/sender-accounts/:email/history",
+      params: [{ name: "email", positional: true, desc: "sender-account email" }, { name: "limit", type: "number", default: "50", desc: "rows (default 50)" }]
     }
   ]
 };
@@ -2016,6 +2195,7 @@ var workspaces = {
 var groups = [
   workspaces,
   campaigns,
+  subsequences,
   accounts,
   leads,
   inbox,
@@ -2031,7 +2211,7 @@ var groups = [
 // src/commands/auth.ts
 function registerAuth(program2) {
   const auth = program2.command("auth").description("API key setup + identity");
-  auth.command("setup").description("Save your API key + instance URL to ~/.arcsend/config.txt (chmod 600)").requiredOption("--key <key>", "Your arc_ API key").option("--url <url>", "Instance URL", DEFAULT_URL).action((opts) => {
+  auth.command("setup").description("Save your API key + instance URL to ~/.arcsend/config.txt (chmod 600)").requiredOption("--key <key>", "Your arc_ API key").requiredOption("--url <url>", "Your instance URL, e.g. https://app.arcsend.io (the /cli page has it pre-filled)").action((opts) => {
     saveConfig(opts.key, opts.url);
     ok(`Saved credentials to ${CONFIG_PATH}`);
   });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcsend/cli",
-  "version": "1.0.0",
-  "description": "ArcSend — cold email automation from your terminal",
+  "version": "1.2.0",
+  "description": "ArcSend \u2014 cold email automation from your terminal",
   "type": "module",
   "bin": {
     "arcsend": "./dist/index.js"
@@ -41,4 +41,4 @@
     "tsx": "^4.16.0",
     "typescript": "^5.5.0"
   }
-}
+}