@inkbox/cli 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.js +2 -1
- package/dist/client.js.map +1 -1
- package/dist/commands/sms-opt-in.js +63 -0
- package/dist/commands/sms-opt-in.js.map +1 -0
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/client.js
CHANGED
|
@@ -12,10 +12,11 @@ export function createClient(opts) {
|
|
|
12
12
|
process.exit(1);
|
|
13
13
|
}
|
|
14
14
|
const vaultKey = opts.vaultKey ?? process.env.INKBOX_VAULT_KEY;
|
|
15
|
+
const baseUrl = opts.baseUrl ?? process.env.INKBOX_BASE_URL;
|
|
15
16
|
return new Inkbox({
|
|
16
17
|
apiKey,
|
|
17
18
|
vaultKey: vaultKey || undefined,
|
|
18
|
-
baseUrl
|
|
19
|
+
baseUrl,
|
|
19
20
|
});
|
|
20
21
|
}
|
|
21
22
|
//# sourceMappingURL=client.js.map
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,IAAI,IAAI,GAAG,GAAG,CAAC;IACf,OAAO,IAAI,CAAC,MAAM;QAAE,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,OAAO,IAAI,CAAC,IAAI,EAAgB,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAgB;IAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IACzD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CACX,gEAAgE,CACjE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAC/D,OAAO,IAAI,MAAM,CAAC;QAChB,MAAM;QACN,QAAQ,EAAE,QAAQ,IAAI,SAAS;QAC/B,OAAO
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,IAAI,IAAI,GAAG,GAAG,CAAC;IACf,OAAO,IAAI,CAAC,MAAM;QAAE,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,OAAO,IAAI,CAAC,IAAI,EAAgB,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAgB;IAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IACzD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CACX,gEAAgE,CACjE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IAC5D,OAAO,IAAI,MAAM,CAAC;QAChB,MAAM;QACN,QAAQ,EAAE,QAAQ,IAAI,SAAS;QAC/B,OAAO;KACR,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { createClient, getGlobalOpts } from "../client.js";
|
|
2
|
+
import { output } from "../output.js";
|
|
3
|
+
import { withErrorHandler } from "../errors.js";
|
|
4
|
+
export function registerSmsOptInCommands(program) {
|
|
5
|
+
const optIn = program
|
|
6
|
+
.command("sms-opt-in")
|
|
7
|
+
.description("SMS opt-in / opt-out registry (per-recipient consent state). " +
|
|
8
|
+
"Writes require your org to be on its own active, customer-managed 10DLC campaign.");
|
|
9
|
+
optIn
|
|
10
|
+
.command("list")
|
|
11
|
+
.description("List your org's consent rows, newest-updated first")
|
|
12
|
+
.option("--status <state>", "Filter by 'opted_in' or 'opted_out' (omit for both)")
|
|
13
|
+
.option("--limit <n>", "Max rows to return (1-200)", "50")
|
|
14
|
+
.option("--offset <n>", "Pagination offset", "0")
|
|
15
|
+
.action(withErrorHandler(async function (cmdOpts) {
|
|
16
|
+
const opts = getGlobalOpts(this);
|
|
17
|
+
const inkbox = createClient(opts);
|
|
18
|
+
const rows = await inkbox.smsOptIns.list({
|
|
19
|
+
status: cmdOpts.status,
|
|
20
|
+
limit: parseInt(cmdOpts.limit, 10),
|
|
21
|
+
offset: parseInt(cmdOpts.offset, 10),
|
|
22
|
+
});
|
|
23
|
+
output(rows, {
|
|
24
|
+
json: !!opts.json,
|
|
25
|
+
columns: [
|
|
26
|
+
"receiverNumber",
|
|
27
|
+
"status",
|
|
28
|
+
"source",
|
|
29
|
+
"optedInAt",
|
|
30
|
+
"optedOutAt",
|
|
31
|
+
"updatedAt",
|
|
32
|
+
],
|
|
33
|
+
});
|
|
34
|
+
}));
|
|
35
|
+
optIn
|
|
36
|
+
.command("get <receiver-number>")
|
|
37
|
+
.description("Look up the consent state for one recipient (E.164)")
|
|
38
|
+
.action(withErrorHandler(async function (receiverNumber) {
|
|
39
|
+
const opts = getGlobalOpts(this);
|
|
40
|
+
const inkbox = createClient(opts);
|
|
41
|
+
const row = await inkbox.smsOptIns.get(receiverNumber);
|
|
42
|
+
output(row, { json: !!opts.json });
|
|
43
|
+
}));
|
|
44
|
+
optIn
|
|
45
|
+
.command("opt-in <receiver-number>")
|
|
46
|
+
.description("Mark a recipient as opted in (requires active, customer-managed 10DLC campaign)")
|
|
47
|
+
.action(withErrorHandler(async function (receiverNumber) {
|
|
48
|
+
const opts = getGlobalOpts(this);
|
|
49
|
+
const inkbox = createClient(opts);
|
|
50
|
+
const row = await inkbox.smsOptIns.optIn(receiverNumber);
|
|
51
|
+
output(row, { json: !!opts.json });
|
|
52
|
+
}));
|
|
53
|
+
optIn
|
|
54
|
+
.command("opt-out <receiver-number>")
|
|
55
|
+
.description("Mark a recipient as opted out (requires active, customer-managed 10DLC campaign)")
|
|
56
|
+
.action(withErrorHandler(async function (receiverNumber) {
|
|
57
|
+
const opts = getGlobalOpts(this);
|
|
58
|
+
const inkbox = createClient(opts);
|
|
59
|
+
const row = await inkbox.smsOptIns.optOut(receiverNumber);
|
|
60
|
+
output(row, { json: !!opts.json });
|
|
61
|
+
}));
|
|
62
|
+
}
|
|
63
|
+
//# sourceMappingURL=sms-opt-in.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sms-opt-in.js","sourceRoot":"","sources":["../../src/commands/sms-opt-in.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,UAAU,wBAAwB,CAAC,OAAgB;IACvD,MAAM,KAAK,GAAG,OAAO;SAClB,OAAO,CAAC,YAAY,CAAC;SACrB,WAAW,CACV,+DAA+D;QAC7D,mFAAmF,CACtF,CAAC;IAEJ,KAAK;SACF,OAAO,CAAC,MAAM,CAAC;SACf,WAAW,CAAC,oDAAoD,CAAC;SACjE,MAAM,CACL,kBAAkB,EAClB,qDAAqD,CACtD;SACA,MAAM,CAAC,aAAa,EAAE,4BAA4B,EAAE,IAAI,CAAC;SACzD,MAAM,CAAC,cAAc,EAAE,mBAAmB,EAAE,GAAG,CAAC;SAChD,MAAM,CACL,gBAAgB,CAAC,KAAK,WAEpB,OAA2D;QAE3D,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;YACvC,MAAM,EAAE,OAAO,CAAC,MAAoC;YACpD,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;YAClC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,EAAE;YACX,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;YACjB,OAAO,EAAE;gBACP,gBAAgB;gBAChB,QAAQ;gBACR,QAAQ;gBACR,WAAW;gBACX,YAAY;gBACZ,WAAW;aACZ;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CACH,CAAC;IAEJ,KAAK;SACF,OAAO,CAAC,uBAAuB,CAAC;SAChC,WAAW,CAAC,qDAAqD,CAAC;SAClE,MAAM,CACL,gBAAgB,CAAC,KAAK,WAEpB,cAAsB;QAEtB,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACvD,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CACH,CAAC;IAEJ,KAAK;SACF,OAAO,CAAC,0BAA0B,CAAC;SACnC,WAAW,CACV,iFAAiF,CAClF;SACA,MAAM,CACL,gBAAgB,CAAC,KAAK,WAEpB,cAAsB;QAEtB,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CACH,CAAC;IAEJ,KAAK;SACF,OAAO,CAAC,2BAA2B,CAAC;SACpC,WAAW,CACV,kFAAkF,CACnF;SACA,MAAM,CACL,gBAAgB,CAAC,KAAK,WAEpB,cAAsB;QAEtB,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CACH,CAAC;AACN,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -6,6 +6,7 @@ import { registerIdentityCommands } from "./commands/identity.js";
|
|
|
6
6
|
import { registerEmailCommands } from "./commands/email.js";
|
|
7
7
|
import { registerPhoneCommands } from "./commands/phone.js";
|
|
8
8
|
import { registerTextCommands } from "./commands/text.js";
|
|
9
|
+
import { registerSmsOptInCommands } from "./commands/sms-opt-in.js";
|
|
9
10
|
import { registerVaultCommands } from "./commands/vault.js";
|
|
10
11
|
import { registerMailboxCommands } from "./commands/mailbox.js";
|
|
11
12
|
import { registerTunnelCommands } from "./commands/tunnel.js";
|
|
@@ -22,7 +23,7 @@ const program = new Command()
|
|
|
22
23
|
.version("0.1.0")
|
|
23
24
|
.option("--api-key <key>", "Inkbox API key (or set INKBOX_API_KEY)")
|
|
24
25
|
.option("--vault-key <key>", "Vault key for decrypt operations (or set INKBOX_VAULT_KEY)")
|
|
25
|
-
.option("--base-url <url>", "Override API base URL")
|
|
26
|
+
.option("--base-url <url>", "Override API base URL (or set INKBOX_BASE_URL)")
|
|
26
27
|
.option("--json", "Output as JSON", false);
|
|
27
28
|
registerWhoamiCommand(program);
|
|
28
29
|
registerSignupCommands(program);
|
|
@@ -30,6 +31,7 @@ registerIdentityCommands(program);
|
|
|
30
31
|
registerEmailCommands(program);
|
|
31
32
|
registerPhoneCommands(program);
|
|
32
33
|
registerTextCommands(program);
|
|
34
|
+
registerSmsOptInCommands(program);
|
|
33
35
|
registerVaultCommands(program);
|
|
34
36
|
registerMailboxCommands(program);
|
|
35
37
|
registerTunnelCommands(program);
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE;KAC1B,IAAI,CAAC,QAAQ,CAAC;KACd,WAAW,CAAC,4EAA4E,CAAC;KACzF,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,iBAAiB,EAAE,wCAAwC,CAAC;KACnE,MAAM,CAAC,mBAAmB,EAAE,4DAA4D,CAAC;KACzF,MAAM,CAAC,kBAAkB,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE;KAC1B,IAAI,CAAC,QAAQ,CAAC;KACd,WAAW,CAAC,4EAA4E,CAAC;KACzF,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,iBAAiB,EAAE,wCAAwC,CAAC;KACnE,MAAM,CAAC,mBAAmB,EAAE,4DAA4D,CAAC;KACzF,MAAM,CAAC,kBAAkB,EAAE,gDAAgD,CAAC;KAC5E,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAE7C,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC/B,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAChC,wBAAwB,CAAC,OAAO,CAAC,CAAC;AAClC,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC/B,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC/B,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAC9B,wBAAwB,CAAC,OAAO,CAAC,CAAC;AAClC,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC/B,uBAAuB,CAAC,OAAO,CAAC,CAAC;AACjC,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAChC,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAChC,0BAA0B,CAAC,OAAO,CAAC,CAAC;AACpC,uBAAuB,CAAC,OAAO,CAAC,CAAC;AACjC,uBAAuB,CAAC,OAAO,CAAC,CAAC;AACjC,wBAAwB,CAAC,OAAO,CAAC,CAAC;AAClC,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC/B,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAEhC,OAAO,CAAC,KAAK,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inkbox/cli",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "CLI for the Inkbox API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prepublishOnly": "npm run build"
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@inkbox/sdk": "^0.4.
|
|
20
|
+
"@inkbox/sdk": "^0.4.1",
|
|
21
21
|
"commander": "^13.0.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|