@erdoai/cli 0.141.0 → 0.144.0

package/dist/index.js

@@ -50,7 +50,7 @@ function describeRefreshWrites(strategy, mode, key, liveMode) {
 }
 
 // src/index.ts
-import { readFileSync as readFileSync4 } from "fs";
+import { readFileSync as readFileSync4, writeFileSync as writeFileSync3 } from "fs";
 import { basename } from "path";
 import { password, select } from "@inquirer/prompts";
 import { Command as Command2, Option as Option2 } from "commander";
@@ -699,6 +699,20 @@ var ErdoClient = class {
   provisionVoiceCallerName() {
     return this.request("POST", "/v1/voice/caller-name");
   }
+  getVoiceBrandedCalling() {
+    return this.request("GET", "/v1/voice/branded-calling");
+  }
+  setVoiceBrandedCalling(body) {
+    return this.request("PUT", "/v1/voice/branded-calling", body);
+  }
+  getVoiceBrandedCallingLOA() {
+    return this.request("GET", "/v1/voice/branded-calling/loa");
+  }
+  // Filing Branded Calling is billed per branded call, so this files the same
+  // approval-gated action the chat agent files.
+  provisionVoiceBrandedCalling() {
+    return this.request("POST", "/v1/voice/branded-calling/provision");
+  }
   // 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.
@@ -6749,7 +6763,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", "caller name", "shows", "attest."],
+        ["number", "agent", "kind", "calls", "status", "waiting on", "reason", "caller name", "shows", "attest.", "brand"],
         numbers.map((n) => [
           n.address,
           n.agent_ref ?? "",
@@ -6760,7 +6774,8 @@ voiceNumbersCmd.command("list").description("List the organization's numbers wit
           n.reason ?? "",
           n.caller_name_attachment ?? "",
           describeObservedCallerName(n.caller_name_observed, n.observed_caller_name),
-          n.call_attestation ?? ""
+          n.call_attestation ?? "",
+          n.branded_calling_assignment ?? ""
         ])
       );
       process.stderr.write(`showing ${numbers.length} number(s)
@@ -6776,6 +6791,7 @@ voiceNumbersCmd.command("list").description("List the organization's numbers wit
     }
     printStaleCallerNameNote(numbers);
     printCallAttestationNote(res.call_attestation);
+    printBrandedCallingNote(res.branded_calling);
   } catch (e) {
     fail(e);
   }
@@ -6835,6 +6851,16 @@ function printCallAttestationNote(attestation) {
     console.log("Complete the business profile with: erdo org business-profile set --help, or in Settings \u2192 Business.");
   }
 }
+function printBrandedCallingNote(branded) {
+  if (!branded || branded.status === "approved") return;
+  console.log("");
+  const waiting = branded.next_step ? ` (waiting on ${branded.next_step})` : "";
+  console.log(`Branded calling: ${branded.status}${waiting}.`);
+  if (branded.reason) console.log(branded.reason);
+  if (branded.missing_inputs && branded.missing_inputs.length > 0) {
+    console.log(`Still needed: ${branded.missing_inputs.join(", ")} \u2014 erdo voice branded-calling set --help`);
+  }
+}
 function describeObservedCallerName(observed, name) {
   switch (observed) {
     case "ours":
@@ -6955,6 +6981,129 @@ voiceCallerNameCmd.command("provision").description("Register the organization's
     fail(e);
   }
 });
+var voiceBrandedCallingCmd = voiceCmd.command("branded-calling").description("The brand (display name, logo, call reason) mobile phones show when the organization's numbers call");
+function printBrandedCallingStatus(status) {
+  printAlignedTable(
+    ["field", "value"],
+    [
+      ["status", status.status],
+      ["waiting on", status.next_step ?? ""],
+      ["reason", status.reason ?? status.not_registerable_reason ?? ""],
+      ["display name", status.inputs.display_name || ""],
+      ["legal name", status.legal_name ?? ""],
+      ["call reason", status.inputs.call_reason || ""],
+      ["logo", status.logo_url ?? "not uploaded"],
+      ["signed LOA", status.loa ? status.loa.filename : "not uploaded \u2014 erdo voice branded-calling loa"],
+      ["registered as", status.registered_display_name ?? ""],
+      ["price", `$${status.price_per_call_usd} per call whose brand is delivered`]
+    ]
+  );
+  if (status.numbers.length > 0) {
+    console.log("");
+    printAlignedTable(
+      ["number", "agent", "assignment", "note"],
+      status.numbers.map((n) => [
+        n.phone_number,
+        n.agent_slug ?? "",
+        n.assignment,
+        n.not_eligible_reason ?? n.assign_error ?? ""
+      ])
+    );
+  }
+  if (status.missing_inputs && status.missing_inputs.length > 0) {
+    console.log("");
+    console.log(`Still needed: ${status.missing_inputs.join(", ")} \u2014 erdo voice branded-calling set --help`);
+  }
+  if (status.missing_profile_fields && status.missing_profile_fields.length > 0) {
+    console.log(`The business profile still needs: ${status.missing_profile_fields.join(", ")}`);
+  }
+  if (status.out_of_date) {
+    console.log("");
+    console.log(
+      "The details changed since they were filed. Register again with: erdo voice branded-calling provision (it replaces the registration; calls show no brand until the new one is approved)."
+    );
+  }
+}
+function fileAsBase64(path) {
+  return path ? readFileSync4(path).toString("base64") : void 0;
+}
+voiceBrandedCallingCmd.command("get").description("Show the brand, what it still needs, and each number's part in it").option("--json", "print the raw JSON result instead of a table").action(async (opts) => {
+  try {
+    const res = await new ErdoClient().getVoiceBrandedCalling();
+    if (opts.json) {
+      print(res);
+      return;
+    }
+    printBrandedCallingStatus(res);
+  } catch (e) {
+    fail(e);
+  }
+});
+voiceBrandedCallingCmd.command("set").description(
+  "Store the brand's details (admins only). Omitted options keep their values. Nothing reaches Twilio until erdo voice branded-calling provision is approved."
+).option(
+  "--display-name <name>",
+  "shown on the phone, at most 35 characters; defaults to the legal name. Twilio only accepts the legal name or a name legally registered to the business, and rejects the registration otherwise"
+).option("--call-reason <text>", 'the line under the name, at most 64 characters, e.g. "Your viewing request"').option("--use-case <category>", "CUSTOMER_CARE, ACCOUNT_NOTIFICATION, MARKETING, MIXED, \u2026 (see erdo voice branded-calling get --json)").option("--use-case-description <text>", "what the calls are for").option("--consent-description <text>", "how the people called agreed to be called").option("--daily-calls <n>", "calls expected per day").option("--employees <n>", "number of employees").option("--logo <file>", "the logo: PNG, JPG, WebP, GIF or BMP, at least 128 px; converted to the 256x256 BMP Twilio takes").option("--loa-file <file>", "the signed letter of authorization (PDF, JPG or PNG) \u2014 get it pre-filled with: erdo voice branded-calling loa").option("--json", "print the raw JSON result instead of a table").action(
+  async (opts) => {
+    try {
+      const res = await new ErdoClient().setVoiceBrandedCalling({
+        display_name: opts.displayName,
+        call_reason: opts.callReason,
+        use_case_category: opts.useCase,
+        use_case_description: opts.useCaseDescription,
+        consent_description: opts.consentDescription,
+        daily_call_volume: opts.dailyCalls ? Number(opts.dailyCalls) : void 0,
+        employee_count: opts.employees ? Number(opts.employees) : void 0,
+        logo_base64: fileAsBase64(opts.logo),
+        loa_base64: fileAsBase64(opts.loaFile),
+        loa_filename: opts.loaFile ? basename(opts.loaFile) : void 0
+      });
+      if (opts.json) {
+        print(res);
+        return;
+      }
+      printBrandedCallingStatus(res);
+    } catch (e) {
+      fail(e);
+    }
+  }
+);
+voiceBrandedCallingCmd.command("loa").description("Download the letter of authorization pre-filled from the business profile, for somebody at the business to sign (admins only)").option("--out <file>", "where to write the PDF", "branded-calling-letter-of-authorization.pdf").action(async (opts) => {
+  try {
+    const res = await new ErdoClient().getVoiceBrandedCallingLOA();
+    writeFileSync3(opts.out, Buffer.from(res.content, "base64"));
+    console.log(`Wrote ${opts.out}. Tick the authorization, sign and date it, then upload it with:`);
+    console.log(`  erdo voice branded-calling set --loa-file <signed file>`);
+  } catch (e) {
+    fail(e);
+  }
+});
+voiceBrandedCallingCmd.command("provision").description("File Branded Calling for every number with A attestation (approval-gated; Twilio charges per branded call)").option("--json", "print the raw JSON result instead of a summary").action(async (opts) => {
+  try {
+    const res = await new ErdoClient().provisionVoiceBrandedCalling();
+    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}`);
+      }
+    } else {
+      console.log(`Branded calling ${res.status}.`);
+      if (res.registration !== void 0) print(res.registration);
+    }
+    process.stderr.write(
+      "Twilio reviews it in about 7 business days; re-read it with: erdo voice branded-calling 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."

package/package.json

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