@erdoai/cli 0.101.1 → 0.103.0

package/dist/index.js

@@ -609,6 +609,25 @@ var ErdoClient = class {
       `/v1/voice/phone-numbers/${encodeURIComponent(number)}/sms`
     );
   }
+  // The organization's caller name and what each number shows when it calls.
+  // Read from Erdo's own record; nothing here reaches the provider.
+  getVoiceCallerName() {
+    return this.request("GET", "/v1/voice/caller-name");
+  }
+  // Look the numbers up now — one carrier lookup, about a cent, per number.
+  // Org admins only; a number looked up in the last minute is skipped.
+  checkVoiceCallerName(number) {
+    return this.request(
+      "POST",
+      "/v1/voice/caller-name/lookup",
+      number ? { phone_number: number } : {}
+    );
+  }
+  // Registering the caller name puts the organization's name in front of the
+  // carriers, so this files the same approval-gated action the chat agent files.
+  provisionVoiceCallerName() {
+    return this.request("POST", "/v1/voice/caller-name");
+  }
   // Turn an agent's answering of texts on or off. Only the switch changes: the
   // agent's persona, number and calls are untouched, and texts keep arriving and
   // stay readable either way.
@@ -2421,14 +2440,20 @@ function printBusinessProfile(profile) {
       ["job position", profile.representative_job_position],
       ["email", profile.representative_email],
       ["phone", profile.representative_phone],
+      ["caller name", profile.caller_name || "not set"],
       ["updated", profile.updated_at ?? ""]
     ]
   );
 }
-function printMissingProfileFields(missing) {
-  if (missing.length === 0) return;
+function printMissingProfileFields(missing, callerNameMissing = []) {
+  if (missing.length === 0 && callerNameMissing.length === 0) return;
   console.log("");
-  console.log(`Still needed before a number can be registered: ${missing.join(", ")}`);
+  if (missing.length > 0) {
+    console.log(`Still needed before a number can be registered for SMS: ${missing.join(", ")}`);
+  }
+  if (callerNameMissing.length > 0) {
+    console.log(`Still needed before the caller name can be registered: ${callerNameMissing.join(", ")}`);
+  }
   console.log("Fill them in with: erdo org business-profile set --help");
 }
 businessProfileCmd.command("get").description("Show the stored business profile and what SMS registration still needs").option(
@@ -2450,7 +2475,7 @@ businessProfileCmd.command("get").description("Show the stored business profile
       return;
     }
     printBusinessProfile(res.profile);
-    printMissingProfileFields(res.missing_fields);
+    printMissingProfileFields(res.missing_fields, res.caller_name_missing_fields ?? []);
   } catch (e) {
     fail(e);
   }
@@ -2473,7 +2498,10 @@ businessProfileCmd.command("set").description("Save the organization's business
 ).option("--first-name <name>", "given name of the person carriers may contact").option("--last-name <name>", "family name of that person").option("--title <title>", "their job title in the business's own words, e.g. Managing Partner").option(
   "--job-position <position>",
   "their role from the fixed list (ceo, cfo, director, general_counsel, gm, vp, other)"
-).option("--email <email>", "their email address").option("--phone <number>", "their phone number in E.164, e.g. +13055550123").option("--json", "print the raw JSON result instead of a table").action(
+).option("--email <email>", "their email address").option("--phone <number>", "their phone number in E.164, e.g. +13055550123").option(
+  "--caller-name <name>",
+  "the caller name (CNAM) every number shows when it calls: at most 15 characters, starting with a letter; letters, digits, spaces, periods and commas; the brand people recognise, not the legal name. Register it with: erdo voice caller-name provision"
+).option("--json", "print the raw JSON result instead of a table").action(
   async (opts) => {
     try {
       const api = new ErdoClient();
@@ -2514,7 +2542,9 @@ businessProfileCmd.command("set").description("Save the organization's business
         representative_title: opts.title ?? stored.representative_title,
         representative_job_position: opts.jobPosition ?? stored.representative_job_position,
         representative_email: opts.email ?? stored.representative_email,
-        representative_phone: opts.phone ?? stored.representative_phone
+        representative_phone: opts.phone ?? stored.representative_phone,
+        // Absent keeps the stored name server-side, so an unset flag sends none.
+        caller_name: opts.callerName
       };
       const res = await api.setBusinessProfile(body);
       if (opts.json) {
@@ -2523,7 +2553,7 @@ businessProfileCmd.command("set").description("Save the organization's business
       }
       console.log("Business profile saved.");
       printBusinessProfile(res.profile);
-      printMissingProfileFields(res.missing_fields);
+      printMissingProfileFields(res.missing_fields, res.caller_name_missing_fields ?? []);
     } catch (e) {
       fail(e);
     }
@@ -5894,7 +5924,7 @@ contact: ${parts.join(" \xB7 ")}`);
     }
   }
 );
-var voiceNumbersCmd = voiceCmd.command("numbers").description("The organization's phone numbers and their A2P SMS registration state");
+var voiceNumbersCmd = voiceCmd.command("numbers").description("The organization's phone numbers, their A2P SMS registration and their caller name");
 function printRegistrationState(registration) {
   if (registration === null || typeof registration !== "object") {
     if (registration !== void 0) print(registration);
@@ -5942,7 +5972,7 @@ voiceNumbersCmd.command("list").description("List the organization's numbers wit
     } else {
       const callable = new Set(res.person_call_numbers ?? []);
       printAlignedTable(
-        ["number", "agent", "kind", "calls", "status", "waiting on", "reason"],
+        ["number", "agent", "kind", "calls", "status", "waiting on", "reason", "caller name", "shows"],
         numbers.map((n) => [
           n.address,
           n.agent_ref ?? "",
@@ -5950,7 +5980,9 @@ voiceNumbersCmd.command("list").description("List the organization's numbers wit
           callable.has(n.address) ? "yes" : "",
           n.status,
           n.next_step ?? "",
-          n.reason ?? ""
+          n.reason ?? "",
+          n.caller_name_attachment ?? "",
+          describeObservedCallerName(n.caller_name_observed, n.observed_caller_name)
         ])
       );
       process.stderr.write(`showing ${numbers.length} number(s)
@@ -5964,6 +5996,7 @@ voiceNumbersCmd.command("list").description("List the organization's numbers wit
       );
       console.log("Complete it with: erdo org business-profile set --help, or in Settings \u2192 Business.");
     }
+    printStaleCallerNameNote(numbers);
   } catch (e) {
     fail(e);
   }
@@ -6013,6 +6046,126 @@ voiceNumbersCmd.command("provision-sms <number>").description("Ask for A2P SMS r
     fail(e);
   }
 });
+function describeObservedCallerName(observed, name) {
+  switch (observed) {
+    case "ours":
+      return `\u2713 ${name ?? ""}`.trim();
+    case "other":
+      return `${name ?? ""} \u2014 not your business`;
+    case "none":
+      return "(no name)";
+    default:
+      return "";
+  }
+}
+function printStaleCallerNameNote(numbers) {
+  const stale = numbers.filter((n) => (n.caller_name_observed ?? n.observed) === "other");
+  if (stale.length === 0) return;
+  console.log("");
+  for (const n of stale) {
+    console.log(
+      `${n.address ?? n.phone_number ?? "a number"} calls out as "${n.observed_caller_name ?? n.observed_name ?? ""}", which is not this business.`
+    );
+  }
+  console.log("Register the organization's caller name with: erdo voice caller-name provision");
+  console.log("Check what a number shows now (about $0.01 each): erdo voice caller-name check [number]");
+}
+var voiceCallerNameCmd = voiceCmd.command("caller-name").description("The name US carriers show when the organization's numbers call");
+function printCallerNameStatus(status) {
+  printAlignedTable(
+    ["field", "value"],
+    [
+      ["declared name", status.caller_name || "not set \u2014 erdo org business-profile set --caller-name <name>"],
+      ["registered name", status.registered_name ?? ""],
+      ["status", status.status],
+      ["waiting on", status.next_step ?? ""],
+      ["reason", status.reason ?? status.not_registerable_reason ?? ""]
+    ]
+  );
+  if (status.numbers.length > 0) {
+    console.log("");
+    printAlignedTable(
+      ["number", "agent", "attachment", "shows", "last checked"],
+      status.numbers.map((n) => [
+        n.phone_number,
+        n.agent_slug ?? "",
+        n.registerable ? n.attachment : `not registerable \u2014 ${n.not_registerable_reason ?? ""}`,
+        describeObservedCallerName(n.observed, n.observed_name),
+        n.last_checked_at ? `${n.last_checked_at}${n.last_check_failed ? " (failed)" : ""}` : ""
+      ])
+    );
+  }
+  if (status.caller_name_out_of_date) {
+    console.log("");
+    console.log(
+      `The caller name was changed after it was registered: carriers still show ${status.registered_name}. Replace it with: erdo voice caller-name provision (it deletes the current registration and re-enters review).`
+    );
+  }
+  if (status.missing_profile_fields && status.missing_profile_fields.length > 0) {
+    console.log("");
+    console.log(`The business profile still needs: ${status.missing_profile_fields.join(", ")}`);
+    console.log("Complete it with: erdo org business-profile set --help, or in Settings \u2192 Business.");
+  }
+  printStaleCallerNameNote(status.numbers);
+}
+voiceCallerNameCmd.command("get").description("Show the caller name, its registration, and what each number shows when it calls").option("--json", "print the raw JSON result instead of a table").action(async (opts) => {
+  try {
+    const res = await new ErdoClient().getVoiceCallerName();
+    if (opts.json) {
+      print(res);
+      return;
+    }
+    printCallerNameStatus(res);
+  } catch (e) {
+    fail(e);
+  }
+});
+voiceCallerNameCmd.command("check [number]").description(
+  "Look the numbers up now to see what they show when they call \u2014 about $0.01 per number (admins only; a number checked in the last minute is skipped)"
+).option("--json", "print the raw JSON result instead of a table").action(async (number, opts) => {
+  try {
+    const res = await new ErdoClient().checkVoiceCallerName(number);
+    if (opts.json) {
+      print(res);
+      return;
+    }
+    console.log(
+      `Checked ${res.checked.length} number(s)` + (res.failed.length > 0 ? `, ${res.failed.length} lookup(s) failed` : "") + (res.skipped.length > 0 ? `, skipped ${res.skipped.length}` : "") + "."
+    );
+    for (const skip of res.skipped) console.log(`  skipped ${skip.phone_number}: ${skip.reason}`);
+    for (const failed of res.failed) console.log(`  lookup failed for ${failed} \u2014 try again later`);
+    console.log("");
+    printCallerNameStatus(res.caller_name);
+  } catch (e) {
+    fail(e);
+  }
+});
+voiceCallerNameCmd.command("provision").description("Register the organization's caller name for every number it holds (approval-gated, free)").option("--json", "print the raw JSON result instead of a summary").action(async (opts) => {
+  try {
+    const res = await new ErdoClient().provisionVoiceCallerName();
+    if (opts.json) {
+      print(res);
+      return;
+    }
+    if (res.status === "pending_approval") {
+      console.log("Nothing has been registered yet \u2014 an approval card was filed and awaits a decision.");
+      if (res.action_display) console.log(`action: ${res.action_display}`);
+      if (res.approval_request_id) {
+        console.log(`approval request: ${res.approval_request_id}`);
+        console.log(`  erdo approvals show ${res.approval_request_id}`);
+        console.log(`  erdo approvals decide ${res.approval_request_id} --approve`);
+      }
+    } else {
+      console.log(`Caller name ${res.status}.`);
+      if (res.registration !== void 0) print(res.registration);
+    }
+    process.stderr.write(
+      "Twilio reviews the name, then it takes 48\u201372 hours to appear; re-read it with: erdo voice caller-name get\n"
+    );
+  } catch (e) {
+    fail(e);
+  }
+});
 var voiceAgentsCmd = voiceCmd.command("agents").description("List the organization's concierges and change settings on one");
 voiceAgentsCmd.command("list", { isDefault: true }).description(
   "List the organization's concierges: the voice agents that answer its website widget, its phone and its texts. The id is what the lead playbook stores as its linked concierge (`erdo leads playbook set --agent-id`). Archived agents are not listed."
@@ -6366,20 +6519,39 @@ datasetsCmd.command("from-integration <app>").description("Create a dataset back
     fail(e);
   }
 });
-datasetsCmd.command("configure-integration <dataset-id>").description("Set an integration dataset's segment scope and optionally enable canonical sync").requiredOption("-s, --segments <csv>", "segment names or ids (see: erdo integrations tables <app>)").option("--enable-sync", "enable canonical data-platform sync").action(async (datasetID, opts) => {
-  try {
-    const segments = opts.segments.split(",").map((segment) => segment.trim()).filter(Boolean);
-    const result = await new ErdoClient().configureIntegrationDataset(datasetID, {
-      segments,
-      enable_sync: opts.enableSync
-    });
-    console.log(
-      `Configured dataset ${result.dataset_id}, status: ${result.status}, sync: ${result.sync_enabled ? "enabled" : "unchanged"}`
-    );
-  } catch (e) {
-    fail(e);
+datasetsCmd.command("configure-integration <dataset-id>").description(
+  "Set an integration dataset's segment scope and enable canonical sync, or --disable-sync to retire a superseded/stale synced dataset (tears down the warehouse copy and stops it being read or monitored; reversible with --enable-sync)"
+).option("-s, --segments <csv>", "segment names or ids (see: erdo integrations tables <app>)").option(
+  "--enable-sync",
+  "enable canonical data-platform sync; on its own it restores a retired sync and keeps the saved segment scope"
+).option(
+  "--disable-sync",
+  "tear down the canonical data-platform sync \u2014 retire a superseded or stale synced dataset; ignores --segments"
+).action(
+  async (datasetID, opts) => {
+    try {
+      if (opts.enableSync && opts.disableSync) {
+        fail("Pass either --enable-sync or --disable-sync, not both");
+        return;
+      }
+      if (!opts.disableSync && !opts.enableSync && !opts.segments) {
+        fail("--segments is required unless you pass --enable-sync or --disable-sync");
+        return;
+      }
+      const segments = (opts.segments ?? "").split(",").map((segment) => segment.trim()).filter(Boolean);
+      const result = await new ErdoClient().configureIntegrationDataset(datasetID, {
+        segments,
+        enable_sync: opts.enableSync,
+        disable_sync: opts.disableSync
+      });
+      console.log(
+        opts.disableSync ? `Retired sync for dataset ${result.dataset_id} (status: ${result.status}). Re-enable with --enable-sync.` : `Configured dataset ${result.dataset_id}, status: ${result.status}, sync: ${result.sync_enabled ? "enabled" : "unchanged"}`
+      );
+    } catch (e) {
+      fail(e);
+    }
   }
-});
+);
 var refreshCmd = datasetsCmd.command("refresh").description(
   "The recipe that keeps a dataset current, and the triggers that run it \u2014 read it with `show`, install or replace it with `set`, and run it once now with `run`"
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erdoai/cli",
-  "version": "0.101.1",
+  "version": "0.103.0",
   "description": "Erdo CLI — drive datasets, pages, and evals from the terminal or CI",
   "type": "module",
   "bin": {