@dealmachine/cli 0.1.0
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/LICENSE +21 -0
- package/README.md +1141 -0
- package/dist/agents/dealmachine-playbook.md +936 -0
- package/dist/commands/account.d.ts +5 -0
- package/dist/commands/account.d.ts.map +1 -0
- package/dist/commands/account.js +17 -0
- package/dist/commands/account.js.map +1 -0
- package/dist/commands/activity.d.ts +16 -0
- package/dist/commands/activity.d.ts.map +1 -0
- package/dist/commands/activity.js +110 -0
- package/dist/commands/activity.js.map +1 -0
- package/dist/commands/addresses.d.ts +9 -0
- package/dist/commands/addresses.d.ts.map +1 -0
- package/dist/commands/addresses.js +63 -0
- package/dist/commands/addresses.js.map +1 -0
- package/dist/commands/agents.d.ts +10 -0
- package/dist/commands/agents.d.ts.map +1 -0
- package/dist/commands/agents.js +115 -0
- package/dist/commands/agents.js.map +1 -0
- package/dist/commands/comps.d.ts +16 -0
- package/dist/commands/comps.d.ts.map +1 -0
- package/dist/commands/comps.js +131 -0
- package/dist/commands/comps.js.map +1 -0
- package/dist/commands/config.d.ts +7 -0
- package/dist/commands/config.d.ts.map +1 -0
- package/dist/commands/config.js +83 -0
- package/dist/commands/config.js.map +1 -0
- package/dist/commands/crm.d.ts +122 -0
- package/dist/commands/crm.d.ts.map +1 -0
- package/dist/commands/crm.js +519 -0
- package/dist/commands/crm.js.map +1 -0
- package/dist/commands/dev.d.ts +8 -0
- package/dist/commands/dev.d.ts.map +1 -0
- package/dist/commands/dev.js +102 -0
- package/dist/commands/dev.js.map +1 -0
- package/dist/commands/dialer.d.ts +79 -0
- package/dist/commands/dialer.d.ts.map +1 -0
- package/dist/commands/dialer.js +389 -0
- package/dist/commands/dialer.js.map +1 -0
- package/dist/commands/enrich.d.ts +46 -0
- package/dist/commands/enrich.d.ts.map +1 -0
- package/dist/commands/enrich.js +649 -0
- package/dist/commands/enrich.js.map +1 -0
- package/dist/commands/exports.d.ts +13 -0
- package/dist/commands/exports.d.ts.map +1 -0
- package/dist/commands/exports.js +92 -0
- package/dist/commands/exports.js.map +1 -0
- package/dist/commands/fields.d.ts +12 -0
- package/dist/commands/fields.d.ts.map +1 -0
- package/dist/commands/fields.js +43 -0
- package/dist/commands/fields.js.map +1 -0
- package/dist/commands/filters.d.ts +12 -0
- package/dist/commands/filters.d.ts.map +1 -0
- package/dist/commands/filters.js +41 -0
- package/dist/commands/filters.js.map +1 -0
- package/dist/commands/lists.d.ts +62 -0
- package/dist/commands/lists.d.ts.map +1 -0
- package/dist/commands/lists.js +329 -0
- package/dist/commands/lists.js.map +1 -0
- package/dist/commands/locations.d.ts +15 -0
- package/dist/commands/locations.d.ts.map +1 -0
- package/dist/commands/locations.js +68 -0
- package/dist/commands/locations.js.map +1 -0
- package/dist/commands/login.d.ts +11 -0
- package/dist/commands/login.d.ts.map +1 -0
- package/dist/commands/login.js +144 -0
- package/dist/commands/login.js.map +1 -0
- package/dist/commands/logout.d.ts +5 -0
- package/dist/commands/logout.d.ts.map +1 -0
- package/dist/commands/logout.js +24 -0
- package/dist/commands/logout.js.map +1 -0
- package/dist/commands/mail.d.ts +112 -0
- package/dist/commands/mail.d.ts.map +1 -0
- package/dist/commands/mail.js +727 -0
- package/dist/commands/mail.js.map +1 -0
- package/dist/commands/people.d.ts +36 -0
- package/dist/commands/people.d.ts.map +1 -0
- package/dist/commands/people.js +226 -0
- package/dist/commands/people.js.map +1 -0
- package/dist/commands/phones.d.ts +9 -0
- package/dist/commands/phones.d.ts.map +1 -0
- package/dist/commands/phones.js +53 -0
- package/dist/commands/phones.js.map +1 -0
- package/dist/commands/properties.d.ts +38 -0
- package/dist/commands/properties.d.ts.map +1 -0
- package/dist/commands/properties.js +225 -0
- package/dist/commands/properties.js.map +1 -0
- package/dist/commands/subscription.d.ts +7 -0
- package/dist/commands/subscription.d.ts.map +1 -0
- package/dist/commands/subscription.js +36 -0
- package/dist/commands/subscription.js.map +1 -0
- package/dist/commands/tasks.d.ts +28 -0
- package/dist/commands/tasks.d.ts.map +1 -0
- package/dist/commands/tasks.js +128 -0
- package/dist/commands/tasks.js.map +1 -0
- package/dist/commands/usage.d.ts +7 -0
- package/dist/commands/usage.d.ts.map +1 -0
- package/dist/commands/usage.js +41 -0
- package/dist/commands/usage.js.map +1 -0
- package/dist/commands/whoami.d.ts +9 -0
- package/dist/commands/whoami.d.ts.map +1 -0
- package/dist/commands/whoami.js +40 -0
- package/dist/commands/whoami.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1942 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/api.d.ts +53 -0
- package/dist/lib/api.d.ts.map +1 -0
- package/dist/lib/api.js +110 -0
- package/dist/lib/api.js.map +1 -0
- package/dist/lib/client.d.ts +18 -0
- package/dist/lib/client.d.ts.map +1 -0
- package/dist/lib/client.js +88 -0
- package/dist/lib/client.js.map +1 -0
- package/dist/lib/config.d.ts +22 -0
- package/dist/lib/config.d.ts.map +1 -0
- package/dist/lib/config.js +65 -0
- package/dist/lib/config.js.map +1 -0
- package/dist/lib/output.d.ts +36 -0
- package/dist/lib/output.d.ts.map +1 -0
- package/dist/lib/output.js +164 -0
- package/dist/lib/output.js.map +1 -0
- package/dist/lib/searchProtocol.d.ts +10 -0
- package/dist/lib/searchProtocol.d.ts.map +1 -0
- package/dist/lib/searchProtocol.js +46 -0
- package/dist/lib/searchProtocol.js.map +1 -0
- package/package.json +52 -0
|
@@ -0,0 +1,727 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mail commands — campaigns, designs, return addresses, wallet
|
|
3
|
+
*/
|
|
4
|
+
import chalk from 'chalk';
|
|
5
|
+
import { apiRequest, formatDate } from '../lib/client.js';
|
|
6
|
+
import { parseRequestBody, printJson, printHeader, printTable, printKeyValue, printPagination, truncate, createSpinner, } from '../lib/output.js';
|
|
7
|
+
// ============================================================================
|
|
8
|
+
// Campaigns — List
|
|
9
|
+
// ============================================================================
|
|
10
|
+
export async function mailCampaignsList(options) {
|
|
11
|
+
const spinner = createSpinner('Fetching campaigns...').start();
|
|
12
|
+
const data = await apiRequest('/mail/campaigns', {
|
|
13
|
+
query: {
|
|
14
|
+
...(options.status && { status: options.status }),
|
|
15
|
+
...(options.search && { search: options.search }),
|
|
16
|
+
...(options.page && { page: parseInt(options.page, 10) }),
|
|
17
|
+
...(options.perPage && { per_page: parseInt(options.perPage, 10) }),
|
|
18
|
+
},
|
|
19
|
+
});
|
|
20
|
+
spinner.stop();
|
|
21
|
+
if (options.json) {
|
|
22
|
+
printJson(data);
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
printHeader('Mail Campaigns');
|
|
26
|
+
console.log();
|
|
27
|
+
if (data.data.length > 0) {
|
|
28
|
+
const rows = data.data.map((c) => ({
|
|
29
|
+
id: truncate(c.id, 20),
|
|
30
|
+
name: truncate(c.name, 30),
|
|
31
|
+
status: c.status,
|
|
32
|
+
recipients: c.total_recipients,
|
|
33
|
+
sent: c.total_sent,
|
|
34
|
+
delivered: c.total_delivered,
|
|
35
|
+
created: formatDate(c.created_at),
|
|
36
|
+
}));
|
|
37
|
+
printTable(rows, ['id', 'name', 'status', 'recipients', 'sent', 'delivered', 'created']);
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
console.log(chalk.dim(' No campaigns found.'));
|
|
41
|
+
}
|
|
42
|
+
const p = data.pagination;
|
|
43
|
+
console.log();
|
|
44
|
+
console.log(chalk.dim(`Page ${p.page} — ${p.total} total campaigns${p.has_more ? ' (more available)' : ''}`));
|
|
45
|
+
console.log();
|
|
46
|
+
}
|
|
47
|
+
// ============================================================================
|
|
48
|
+
// Campaigns — Create
|
|
49
|
+
// ============================================================================
|
|
50
|
+
export async function mailCampaignsCreate(options) {
|
|
51
|
+
const requestBody = await parseRequestBody(options);
|
|
52
|
+
const spinner = createSpinner('Creating campaign...').start();
|
|
53
|
+
const data = await apiRequest('/mail/campaigns', {
|
|
54
|
+
method: 'POST',
|
|
55
|
+
body: requestBody,
|
|
56
|
+
});
|
|
57
|
+
spinner.stop();
|
|
58
|
+
if (options.json) {
|
|
59
|
+
printJson(data);
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
const c = data.data;
|
|
63
|
+
printHeader('Campaign Created');
|
|
64
|
+
printKeyValue({
|
|
65
|
+
'Campaign ID': c.id,
|
|
66
|
+
Name: c.name,
|
|
67
|
+
Status: c.status,
|
|
68
|
+
Recipients: c.total_recipients,
|
|
69
|
+
Steps: c.steps.length,
|
|
70
|
+
Created: formatDate(c.created_at),
|
|
71
|
+
});
|
|
72
|
+
console.log();
|
|
73
|
+
}
|
|
74
|
+
// ============================================================================
|
|
75
|
+
// Campaigns — Get
|
|
76
|
+
// ============================================================================
|
|
77
|
+
export async function mailCampaignsGet(id, options) {
|
|
78
|
+
const spinner = createSpinner('Fetching campaign...').start();
|
|
79
|
+
const data = await apiRequest(`/mail/campaigns/${id}`);
|
|
80
|
+
spinner.stop();
|
|
81
|
+
if (options.json) {
|
|
82
|
+
printJson(data);
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
const c = data.data;
|
|
86
|
+
printHeader(`Campaign ${c.id}`);
|
|
87
|
+
printKeyValue({
|
|
88
|
+
Name: c.name,
|
|
89
|
+
Description: c.description || '—',
|
|
90
|
+
Status: c.status,
|
|
91
|
+
Audience: c.audience_kind || '—',
|
|
92
|
+
Recipients: c.total_recipients,
|
|
93
|
+
Sent: c.total_sent,
|
|
94
|
+
Delivered: c.total_delivered,
|
|
95
|
+
Steps: c.steps.length,
|
|
96
|
+
Created: formatDate(c.created_at),
|
|
97
|
+
Launched: c.launched_at ? formatDate(c.launched_at) : '—',
|
|
98
|
+
Completed: c.completed_at ? formatDate(c.completed_at) : '—',
|
|
99
|
+
});
|
|
100
|
+
if (c.steps.length > 0) {
|
|
101
|
+
console.log();
|
|
102
|
+
console.log(chalk.bold('Steps'));
|
|
103
|
+
console.log(chalk.dim('─'.repeat(50)));
|
|
104
|
+
const stepRows = c.steps.map((s) => ({
|
|
105
|
+
order: s.step_order,
|
|
106
|
+
name: s.step_name || '—',
|
|
107
|
+
design: s.design_id ? truncate(s.design_id, 16) : '(prompt)',
|
|
108
|
+
delay: `${s.delay_days}d`,
|
|
109
|
+
repeat: s.repeat_count,
|
|
110
|
+
}));
|
|
111
|
+
printTable(stepRows, ['order', 'name', 'design', 'delay', 'repeat']);
|
|
112
|
+
}
|
|
113
|
+
console.log();
|
|
114
|
+
}
|
|
115
|
+
// ============================================================================
|
|
116
|
+
// Campaigns — Update
|
|
117
|
+
// ============================================================================
|
|
118
|
+
export async function mailCampaignsUpdate(id, options) {
|
|
119
|
+
const requestBody = await parseRequestBody(options);
|
|
120
|
+
const spinner = createSpinner('Updating campaign...').start();
|
|
121
|
+
const data = await apiRequest(`/mail/campaigns/${id}`, {
|
|
122
|
+
method: 'PATCH',
|
|
123
|
+
body: requestBody,
|
|
124
|
+
});
|
|
125
|
+
spinner.stop();
|
|
126
|
+
if (options.json) {
|
|
127
|
+
printJson(data);
|
|
128
|
+
return;
|
|
129
|
+
}
|
|
130
|
+
const c = data.data;
|
|
131
|
+
printHeader('Campaign Updated');
|
|
132
|
+
printKeyValue({
|
|
133
|
+
'Campaign ID': c.id,
|
|
134
|
+
Name: c.name,
|
|
135
|
+
Status: c.status,
|
|
136
|
+
Updated: formatDate(c.updated_at),
|
|
137
|
+
});
|
|
138
|
+
console.log();
|
|
139
|
+
}
|
|
140
|
+
// ============================================================================
|
|
141
|
+
// Campaigns — Delete (Cancel)
|
|
142
|
+
// ============================================================================
|
|
143
|
+
export async function mailCampaignsDelete(id, options) {
|
|
144
|
+
const spinner = createSpinner('Cancelling campaign...').start();
|
|
145
|
+
const data = await apiRequest(`/mail/campaigns/${id}`, {
|
|
146
|
+
method: 'DELETE',
|
|
147
|
+
});
|
|
148
|
+
spinner.stop();
|
|
149
|
+
if (options.json) {
|
|
150
|
+
printJson(data);
|
|
151
|
+
return;
|
|
152
|
+
}
|
|
153
|
+
console.log(chalk.green(` Campaign ${id} cancelled.`));
|
|
154
|
+
console.log();
|
|
155
|
+
}
|
|
156
|
+
// ============================================================================
|
|
157
|
+
// Campaigns — Send (Launch)
|
|
158
|
+
// ============================================================================
|
|
159
|
+
export async function mailCampaignsSend(id, options) {
|
|
160
|
+
const spinner = createSpinner('Launching campaign...').start();
|
|
161
|
+
const data = await apiRequest(`/mail/campaigns/${id}/send`, {
|
|
162
|
+
method: 'POST',
|
|
163
|
+
body: {},
|
|
164
|
+
});
|
|
165
|
+
spinner.stop();
|
|
166
|
+
if (options.json) {
|
|
167
|
+
printJson(data);
|
|
168
|
+
return;
|
|
169
|
+
}
|
|
170
|
+
const c = data.data;
|
|
171
|
+
printHeader('Campaign Launched');
|
|
172
|
+
printKeyValue({
|
|
173
|
+
'Campaign ID': c.id,
|
|
174
|
+
Name: c.name,
|
|
175
|
+
Status: c.status,
|
|
176
|
+
Recipients: c.total_recipients,
|
|
177
|
+
});
|
|
178
|
+
console.log();
|
|
179
|
+
}
|
|
180
|
+
// ============================================================================
|
|
181
|
+
// Campaigns — Pause
|
|
182
|
+
// ============================================================================
|
|
183
|
+
export async function mailCampaignsPause(id, options) {
|
|
184
|
+
const spinner = createSpinner('Pausing campaign...').start();
|
|
185
|
+
const data = await apiRequest(`/mail/campaigns/${id}/pause`, {
|
|
186
|
+
method: 'POST',
|
|
187
|
+
body: {},
|
|
188
|
+
});
|
|
189
|
+
spinner.stop();
|
|
190
|
+
if (options.json) {
|
|
191
|
+
printJson(data);
|
|
192
|
+
return;
|
|
193
|
+
}
|
|
194
|
+
console.log(chalk.green(` Campaign ${id} paused.`));
|
|
195
|
+
console.log();
|
|
196
|
+
}
|
|
197
|
+
// ============================================================================
|
|
198
|
+
// Campaigns — Resume
|
|
199
|
+
// ============================================================================
|
|
200
|
+
export async function mailCampaignsResume(id, options) {
|
|
201
|
+
const spinner = createSpinner('Resuming campaign...').start();
|
|
202
|
+
const data = await apiRequest(`/mail/campaigns/${id}/resume`, {
|
|
203
|
+
method: 'POST',
|
|
204
|
+
body: {},
|
|
205
|
+
});
|
|
206
|
+
spinner.stop();
|
|
207
|
+
if (options.json) {
|
|
208
|
+
printJson(data);
|
|
209
|
+
return;
|
|
210
|
+
}
|
|
211
|
+
console.log(chalk.green(` Campaign ${id} resumed.`));
|
|
212
|
+
console.log();
|
|
213
|
+
}
|
|
214
|
+
// ============================================================================
|
|
215
|
+
// Campaigns — Recipients
|
|
216
|
+
// ============================================================================
|
|
217
|
+
export async function mailCampaignsRecipients(id, options) {
|
|
218
|
+
const spinner = createSpinner('Fetching recipients...').start();
|
|
219
|
+
const data = await apiRequest(`/mail/campaigns/${id}/recipients`, {
|
|
220
|
+
query: {
|
|
221
|
+
...(options.page && { page: parseInt(options.page, 10) }),
|
|
222
|
+
...(options.perPage && { per_page: parseInt(options.perPage, 10) }),
|
|
223
|
+
},
|
|
224
|
+
});
|
|
225
|
+
spinner.stop();
|
|
226
|
+
if (options.json) {
|
|
227
|
+
printJson(data);
|
|
228
|
+
return;
|
|
229
|
+
}
|
|
230
|
+
printHeader(`Recipients for Campaign ${id}`);
|
|
231
|
+
console.log();
|
|
232
|
+
if (data.data.length > 0) {
|
|
233
|
+
const rows = data.data.map((r) => ({
|
|
234
|
+
id: truncate(r.id, 16),
|
|
235
|
+
name: r.recipient_name ? truncate(r.recipient_name, 20) : '—',
|
|
236
|
+
address: r.recipient_address_1 ? truncate(r.recipient_address_1, 25) : '—',
|
|
237
|
+
city: r.recipient_city || '—',
|
|
238
|
+
state: r.recipient_state || '—',
|
|
239
|
+
status: r.status,
|
|
240
|
+
step: r.current_step_order,
|
|
241
|
+
}));
|
|
242
|
+
printTable(rows, ['id', 'name', 'address', 'city', 'state', 'status', 'step']);
|
|
243
|
+
}
|
|
244
|
+
else {
|
|
245
|
+
console.log(chalk.dim(' No recipients found.'));
|
|
246
|
+
}
|
|
247
|
+
const p = data.pagination;
|
|
248
|
+
printPagination({ ...p, total_results: p.total, total_pages: Math.ceil(p.total / p.per_page) });
|
|
249
|
+
console.log();
|
|
250
|
+
}
|
|
251
|
+
// ============================================================================
|
|
252
|
+
// Campaigns — Analytics
|
|
253
|
+
// ============================================================================
|
|
254
|
+
export async function mailCampaignsAnalytics(id, options) {
|
|
255
|
+
const spinner = createSpinner('Fetching analytics...').start();
|
|
256
|
+
const data = await apiRequest(`/mail/campaigns/${id}/analytics`);
|
|
257
|
+
spinner.stop();
|
|
258
|
+
if (options.json) {
|
|
259
|
+
printJson(data);
|
|
260
|
+
return;
|
|
261
|
+
}
|
|
262
|
+
const a = data.data;
|
|
263
|
+
printHeader(`Analytics — ${a.campaign_name}`);
|
|
264
|
+
printKeyValue({
|
|
265
|
+
Recipients: a.total_recipients,
|
|
266
|
+
Sent: a.total_sent,
|
|
267
|
+
Delivered: a.total_delivered,
|
|
268
|
+
Bounced: a.total_bounced,
|
|
269
|
+
Responses: a.total_responses,
|
|
270
|
+
'Delivery Rate': `${a.delivery_rate.toFixed(1)}%`,
|
|
271
|
+
'Response Rate': `${a.response_rate.toFixed(1)}%`,
|
|
272
|
+
});
|
|
273
|
+
console.log();
|
|
274
|
+
}
|
|
275
|
+
// ============================================================================
|
|
276
|
+
// Campaigns — Cost Estimate
|
|
277
|
+
// ============================================================================
|
|
278
|
+
export async function mailCampaignsCostEstimate(id, options) {
|
|
279
|
+
const spinner = createSpinner('Estimating cost...').start();
|
|
280
|
+
const data = await apiRequest(`/mail/campaigns/${id}/cost-estimate`);
|
|
281
|
+
spinner.stop();
|
|
282
|
+
if (options.json) {
|
|
283
|
+
printJson(data);
|
|
284
|
+
return;
|
|
285
|
+
}
|
|
286
|
+
const e = data.data;
|
|
287
|
+
printHeader('Cost Estimate');
|
|
288
|
+
printKeyValue({
|
|
289
|
+
Recipients: e.recipient_count,
|
|
290
|
+
'Price Per Card': `$${(e.price_per_card_cents / 100).toFixed(2)}`,
|
|
291
|
+
'Total Cost': `$${e.total_cost_dollars.toFixed(2)}`,
|
|
292
|
+
'Pay Now': `$${(e.pay_now_cost_cents / 100).toFixed(2)}`,
|
|
293
|
+
'Pay Later': `$${(e.pay_later_cost_cents / 100).toFixed(2)}`,
|
|
294
|
+
'Wallet Balance': `$${(e.wallet_balance_cents / 100).toFixed(2)}`,
|
|
295
|
+
'Can Afford': e.can_afford ? 'yes' : 'no',
|
|
296
|
+
});
|
|
297
|
+
console.log();
|
|
298
|
+
}
|
|
299
|
+
// ============================================================================
|
|
300
|
+
// Designs — List
|
|
301
|
+
// ============================================================================
|
|
302
|
+
export async function mailDesignsList(options) {
|
|
303
|
+
const spinner = createSpinner('Fetching designs...').start();
|
|
304
|
+
const data = await apiRequest('/mail/designs', {
|
|
305
|
+
query: {
|
|
306
|
+
...(options.status && { status: options.status }),
|
|
307
|
+
...(options.size && { size: options.size }),
|
|
308
|
+
...(options.search && { search: options.search }),
|
|
309
|
+
...(options.page && { page: parseInt(options.page, 10) }),
|
|
310
|
+
...(options.perPage && { per_page: parseInt(options.perPage, 10) }),
|
|
311
|
+
},
|
|
312
|
+
});
|
|
313
|
+
spinner.stop();
|
|
314
|
+
if (options.json) {
|
|
315
|
+
printJson(data);
|
|
316
|
+
return;
|
|
317
|
+
}
|
|
318
|
+
printHeader('Mail Designs');
|
|
319
|
+
console.log();
|
|
320
|
+
if (data.data.length > 0) {
|
|
321
|
+
const rows = data.data.map((d) => ({
|
|
322
|
+
id: truncate(d.id, 20),
|
|
323
|
+
name: truncate(d.name, 25),
|
|
324
|
+
status: d.status,
|
|
325
|
+
size: d.size,
|
|
326
|
+
orientation: d.orientation,
|
|
327
|
+
created: formatDate(d.created_at),
|
|
328
|
+
}));
|
|
329
|
+
printTable(rows, ['id', 'name', 'status', 'size', 'orientation', 'created']);
|
|
330
|
+
}
|
|
331
|
+
else {
|
|
332
|
+
console.log(chalk.dim(' No designs found.'));
|
|
333
|
+
}
|
|
334
|
+
const p = data.pagination;
|
|
335
|
+
console.log();
|
|
336
|
+
console.log(chalk.dim(`Page ${p.page} — ${p.total} total designs${p.has_more ? ' (more available)' : ''}`));
|
|
337
|
+
console.log();
|
|
338
|
+
}
|
|
339
|
+
// ============================================================================
|
|
340
|
+
// Designs — Create
|
|
341
|
+
// ============================================================================
|
|
342
|
+
export async function mailDesignsCreate(options) {
|
|
343
|
+
const requestBody = await parseRequestBody(options);
|
|
344
|
+
const spinner = createSpinner('Creating design...').start();
|
|
345
|
+
const data = await apiRequest('/mail/designs', {
|
|
346
|
+
method: 'POST',
|
|
347
|
+
body: requestBody,
|
|
348
|
+
});
|
|
349
|
+
spinner.stop();
|
|
350
|
+
if (options.json) {
|
|
351
|
+
printJson(data);
|
|
352
|
+
return;
|
|
353
|
+
}
|
|
354
|
+
const d = data.data;
|
|
355
|
+
printHeader('Design Created');
|
|
356
|
+
printKeyValue({
|
|
357
|
+
'Design ID': d.id,
|
|
358
|
+
Name: d.name,
|
|
359
|
+
Status: d.status,
|
|
360
|
+
Size: d.size,
|
|
361
|
+
Orientation: d.orientation,
|
|
362
|
+
Created: formatDate(d.created_at),
|
|
363
|
+
});
|
|
364
|
+
if (d.front_preview_url) {
|
|
365
|
+
console.log();
|
|
366
|
+
console.log(chalk.dim(` Front preview: ${d.front_preview_url}`));
|
|
367
|
+
}
|
|
368
|
+
console.log();
|
|
369
|
+
}
|
|
370
|
+
// ============================================================================
|
|
371
|
+
// Designs — Get
|
|
372
|
+
// ============================================================================
|
|
373
|
+
export async function mailDesignsGet(id, options) {
|
|
374
|
+
const spinner = createSpinner('Fetching design...').start();
|
|
375
|
+
const data = await apiRequest(`/mail/designs/${id}`);
|
|
376
|
+
spinner.stop();
|
|
377
|
+
if (options.json) {
|
|
378
|
+
printJson(data);
|
|
379
|
+
return;
|
|
380
|
+
}
|
|
381
|
+
const d = data.data;
|
|
382
|
+
printHeader(`Design ${d.id}`);
|
|
383
|
+
printKeyValue({
|
|
384
|
+
Name: d.name,
|
|
385
|
+
Status: d.status,
|
|
386
|
+
Size: d.size,
|
|
387
|
+
Orientation: d.orientation,
|
|
388
|
+
Layout: d.layout || '—',
|
|
389
|
+
Theme: d.theme || '—',
|
|
390
|
+
Prompt: d.prompt ? truncate(d.prompt, 60) : '—',
|
|
391
|
+
'Front Preview': d.front_preview_url || '—',
|
|
392
|
+
'Back Preview': d.back_preview_url || '—',
|
|
393
|
+
Created: formatDate(d.created_at),
|
|
394
|
+
Published: d.published_at ? formatDate(d.published_at) : '—',
|
|
395
|
+
});
|
|
396
|
+
console.log();
|
|
397
|
+
}
|
|
398
|
+
// ============================================================================
|
|
399
|
+
// Designs — Update
|
|
400
|
+
// ============================================================================
|
|
401
|
+
export async function mailDesignsUpdate(id, options) {
|
|
402
|
+
const requestBody = await parseRequestBody(options);
|
|
403
|
+
const spinner = createSpinner('Updating design...').start();
|
|
404
|
+
const data = await apiRequest(`/mail/designs/${id}`, {
|
|
405
|
+
method: 'PATCH',
|
|
406
|
+
body: requestBody,
|
|
407
|
+
});
|
|
408
|
+
spinner.stop();
|
|
409
|
+
if (options.json) {
|
|
410
|
+
printJson(data);
|
|
411
|
+
return;
|
|
412
|
+
}
|
|
413
|
+
const d = data.data;
|
|
414
|
+
printHeader('Design Updated');
|
|
415
|
+
printKeyValue({
|
|
416
|
+
'Design ID': d.id,
|
|
417
|
+
Name: d.name,
|
|
418
|
+
Status: d.status,
|
|
419
|
+
Updated: formatDate(d.updated_at),
|
|
420
|
+
});
|
|
421
|
+
console.log();
|
|
422
|
+
}
|
|
423
|
+
// ============================================================================
|
|
424
|
+
// Designs — Delete
|
|
425
|
+
// ============================================================================
|
|
426
|
+
export async function mailDesignsDelete(id, options) {
|
|
427
|
+
const spinner = createSpinner('Deleting design...').start();
|
|
428
|
+
const data = await apiRequest(`/mail/designs/${id}`, {
|
|
429
|
+
method: 'DELETE',
|
|
430
|
+
});
|
|
431
|
+
spinner.stop();
|
|
432
|
+
if (options.json) {
|
|
433
|
+
printJson(data);
|
|
434
|
+
return;
|
|
435
|
+
}
|
|
436
|
+
console.log(chalk.green(` Design ${id} deleted.`));
|
|
437
|
+
console.log();
|
|
438
|
+
}
|
|
439
|
+
// ============================================================================
|
|
440
|
+
// Return Addresses — List
|
|
441
|
+
// ============================================================================
|
|
442
|
+
export async function mailReturnAddressesList(options) {
|
|
443
|
+
const spinner = createSpinner('Fetching return addresses...').start();
|
|
444
|
+
const data = await apiRequest('/mail/return-addresses');
|
|
445
|
+
spinner.stop();
|
|
446
|
+
if (options.json) {
|
|
447
|
+
printJson(data);
|
|
448
|
+
return;
|
|
449
|
+
}
|
|
450
|
+
printHeader('Return Addresses');
|
|
451
|
+
console.log();
|
|
452
|
+
if (data.data.length > 0) {
|
|
453
|
+
const rows = data.data.map((a) => ({
|
|
454
|
+
id: truncate(a.id, 16),
|
|
455
|
+
label: a.label || '—',
|
|
456
|
+
name: truncate(a.name, 20),
|
|
457
|
+
address: truncate(`${a.address_1}, ${a.city}, ${a.state} ${a.zip}`, 40),
|
|
458
|
+
default: a.is_default ? 'yes' : '—',
|
|
459
|
+
validated: a.is_validated ? 'yes' : 'no',
|
|
460
|
+
}));
|
|
461
|
+
printTable(rows, ['id', 'label', 'name', 'address', 'default', 'validated']);
|
|
462
|
+
}
|
|
463
|
+
else {
|
|
464
|
+
console.log(chalk.dim(' No return addresses found.'));
|
|
465
|
+
}
|
|
466
|
+
console.log();
|
|
467
|
+
}
|
|
468
|
+
// ============================================================================
|
|
469
|
+
// Return Addresses — Create
|
|
470
|
+
// ============================================================================
|
|
471
|
+
export async function mailReturnAddressesCreate(options) {
|
|
472
|
+
const requestBody = await parseRequestBody(options);
|
|
473
|
+
const spinner = createSpinner('Creating return address...').start();
|
|
474
|
+
const data = await apiRequest('/mail/return-addresses', {
|
|
475
|
+
method: 'POST',
|
|
476
|
+
body: requestBody,
|
|
477
|
+
});
|
|
478
|
+
spinner.stop();
|
|
479
|
+
if (options.json) {
|
|
480
|
+
printJson(data);
|
|
481
|
+
return;
|
|
482
|
+
}
|
|
483
|
+
const a = data.data;
|
|
484
|
+
printHeader('Return Address Created');
|
|
485
|
+
printKeyValue({
|
|
486
|
+
ID: a.id,
|
|
487
|
+
Name: a.name,
|
|
488
|
+
Label: a.label || '—',
|
|
489
|
+
Address: `${a.address_1}, ${a.city}, ${a.state} ${a.zip}`,
|
|
490
|
+
Validated: a.is_validated ? 'yes' : 'no',
|
|
491
|
+
Default: a.is_default ? 'yes' : 'no',
|
|
492
|
+
});
|
|
493
|
+
if (data.corrected) {
|
|
494
|
+
console.log(chalk.yellow(' Address was corrected by USPS validation.'));
|
|
495
|
+
}
|
|
496
|
+
console.log();
|
|
497
|
+
}
|
|
498
|
+
// ============================================================================
|
|
499
|
+
// Return Addresses — Get
|
|
500
|
+
// ============================================================================
|
|
501
|
+
export async function mailReturnAddressesGet(id, options) {
|
|
502
|
+
const spinner = createSpinner('Fetching return address...').start();
|
|
503
|
+
const data = await apiRequest(`/mail/return-addresses/${id}`);
|
|
504
|
+
spinner.stop();
|
|
505
|
+
if (options.json) {
|
|
506
|
+
printJson(data);
|
|
507
|
+
return;
|
|
508
|
+
}
|
|
509
|
+
const a = data.data;
|
|
510
|
+
printHeader(`Return Address ${a.id}`);
|
|
511
|
+
printKeyValue({
|
|
512
|
+
Name: a.name,
|
|
513
|
+
Label: a.label || '—',
|
|
514
|
+
'Address 1': a.address_1,
|
|
515
|
+
'Address 2': a.address_2 || '—',
|
|
516
|
+
City: a.city,
|
|
517
|
+
State: a.state,
|
|
518
|
+
ZIP: a.zip,
|
|
519
|
+
Validated: a.is_validated ? 'yes' : 'no',
|
|
520
|
+
Default: a.is_default ? 'yes' : 'no',
|
|
521
|
+
Created: formatDate(a.created_at),
|
|
522
|
+
});
|
|
523
|
+
console.log();
|
|
524
|
+
}
|
|
525
|
+
// ============================================================================
|
|
526
|
+
// Return Addresses — Update
|
|
527
|
+
// ============================================================================
|
|
528
|
+
export async function mailReturnAddressesUpdate(id, options) {
|
|
529
|
+
const requestBody = await parseRequestBody(options);
|
|
530
|
+
const spinner = createSpinner('Updating return address...').start();
|
|
531
|
+
const data = await apiRequest(`/mail/return-addresses/${id}`, {
|
|
532
|
+
method: 'PATCH',
|
|
533
|
+
body: requestBody,
|
|
534
|
+
});
|
|
535
|
+
spinner.stop();
|
|
536
|
+
if (options.json) {
|
|
537
|
+
printJson(data);
|
|
538
|
+
return;
|
|
539
|
+
}
|
|
540
|
+
const a = data.data;
|
|
541
|
+
printHeader('Return Address Updated');
|
|
542
|
+
printKeyValue({
|
|
543
|
+
ID: a.id,
|
|
544
|
+
Name: a.name,
|
|
545
|
+
Address: `${a.address_1}, ${a.city}, ${a.state} ${a.zip}`,
|
|
546
|
+
Validated: a.is_validated ? 'yes' : 'no',
|
|
547
|
+
});
|
|
548
|
+
if (data.corrected) {
|
|
549
|
+
console.log(chalk.yellow(' Address was corrected by USPS validation.'));
|
|
550
|
+
}
|
|
551
|
+
console.log();
|
|
552
|
+
}
|
|
553
|
+
// ============================================================================
|
|
554
|
+
// Return Addresses — Delete
|
|
555
|
+
// ============================================================================
|
|
556
|
+
export async function mailReturnAddressesDelete(id, options) {
|
|
557
|
+
const spinner = createSpinner('Deleting return address...').start();
|
|
558
|
+
const data = await apiRequest(`/mail/return-addresses/${id}`, {
|
|
559
|
+
method: 'DELETE',
|
|
560
|
+
});
|
|
561
|
+
spinner.stop();
|
|
562
|
+
if (options.json) {
|
|
563
|
+
printJson(data);
|
|
564
|
+
return;
|
|
565
|
+
}
|
|
566
|
+
console.log(chalk.green(` Return address ${id} deleted.`));
|
|
567
|
+
console.log();
|
|
568
|
+
}
|
|
569
|
+
// ============================================================================
|
|
570
|
+
// Return Addresses — Set Default
|
|
571
|
+
// ============================================================================
|
|
572
|
+
export async function mailReturnAddressesSetDefault(id, options) {
|
|
573
|
+
const spinner = createSpinner('Setting default...').start();
|
|
574
|
+
const data = await apiRequest(`/mail/return-addresses/${id}/default`, {
|
|
575
|
+
method: 'POST',
|
|
576
|
+
body: {},
|
|
577
|
+
});
|
|
578
|
+
spinner.stop();
|
|
579
|
+
if (options.json) {
|
|
580
|
+
printJson(data);
|
|
581
|
+
return;
|
|
582
|
+
}
|
|
583
|
+
const a = data.data;
|
|
584
|
+
console.log(chalk.green(` Return address ${a.id} (${a.name}) set as default.`));
|
|
585
|
+
console.log();
|
|
586
|
+
}
|
|
587
|
+
// ============================================================================
|
|
588
|
+
// Wallet — Balance
|
|
589
|
+
// ============================================================================
|
|
590
|
+
export async function mailWalletBalance(options) {
|
|
591
|
+
const spinner = createSpinner('Fetching wallet balance...').start();
|
|
592
|
+
const data = await apiRequest('/mail/wallet/balance');
|
|
593
|
+
spinner.stop();
|
|
594
|
+
if (options.json) {
|
|
595
|
+
printJson(data);
|
|
596
|
+
return;
|
|
597
|
+
}
|
|
598
|
+
const w = data.data;
|
|
599
|
+
printHeader('Mail Wallet');
|
|
600
|
+
printKeyValue({
|
|
601
|
+
Balance: w.balance_formatted,
|
|
602
|
+
Available: w.available_formatted,
|
|
603
|
+
Pending: `$${(w.pending_cents / 100).toFixed(2)}`,
|
|
604
|
+
'Lifetime Credits': `$${(w.lifetime_credits_cents / 100).toFixed(2)}`,
|
|
605
|
+
'Lifetime Spent': `$${(w.lifetime_spent_cents / 100).toFixed(2)}`,
|
|
606
|
+
'Auto-Reload': w.auto_reload.enabled
|
|
607
|
+
? `Enabled (threshold: $${(w.auto_reload.threshold_cents / 100).toFixed(2)}, amount: $${(w.auto_reload.amount_cents / 100).toFixed(2)})`
|
|
608
|
+
: 'Disabled',
|
|
609
|
+
});
|
|
610
|
+
console.log();
|
|
611
|
+
}
|
|
612
|
+
// ============================================================================
|
|
613
|
+
// Wallet — Add Funds
|
|
614
|
+
// ============================================================================
|
|
615
|
+
export async function mailWalletAddFunds(options) {
|
|
616
|
+
const requestBody = await parseRequestBody(options);
|
|
617
|
+
const spinner = createSpinner('Adding funds...').start();
|
|
618
|
+
const data = await apiRequest('/mail/wallet/add-funds', {
|
|
619
|
+
method: 'POST',
|
|
620
|
+
body: requestBody,
|
|
621
|
+
});
|
|
622
|
+
spinner.stop();
|
|
623
|
+
if (options.json) {
|
|
624
|
+
printJson(data);
|
|
625
|
+
return;
|
|
626
|
+
}
|
|
627
|
+
const r = data.data;
|
|
628
|
+
printHeader('Add Funds');
|
|
629
|
+
printKeyValue({
|
|
630
|
+
'Payment Intent': r.payment_intent_id,
|
|
631
|
+
Amount: `$${(r.amount_cents / 100).toFixed(2)}`,
|
|
632
|
+
Succeeded: r.succeeded ? 'yes' : 'no',
|
|
633
|
+
'Requires Action': r.requires_action ? 'yes' : 'no',
|
|
634
|
+
});
|
|
635
|
+
console.log();
|
|
636
|
+
}
|
|
637
|
+
// ============================================================================
|
|
638
|
+
// Wallet — Transactions
|
|
639
|
+
// ============================================================================
|
|
640
|
+
export async function mailWalletTransactions(options) {
|
|
641
|
+
const spinner = createSpinner('Fetching transactions...').start();
|
|
642
|
+
const data = await apiRequest('/mail/wallet/transactions', {
|
|
643
|
+
query: {
|
|
644
|
+
...(options.type && { type: options.type }),
|
|
645
|
+
...(options.referenceType && { reference_type: options.referenceType }),
|
|
646
|
+
...(options.campaignId && { campaign_id: options.campaignId }),
|
|
647
|
+
...(options.page && { page: parseInt(options.page, 10) }),
|
|
648
|
+
...(options.perPage && { per_page: parseInt(options.perPage, 10) }),
|
|
649
|
+
},
|
|
650
|
+
});
|
|
651
|
+
spinner.stop();
|
|
652
|
+
if (options.json) {
|
|
653
|
+
printJson(data);
|
|
654
|
+
return;
|
|
655
|
+
}
|
|
656
|
+
printHeader('Wallet Transactions');
|
|
657
|
+
console.log();
|
|
658
|
+
if (data.data.length > 0) {
|
|
659
|
+
const rows = data.data.map((t) => ({
|
|
660
|
+
id: truncate(t.id, 16),
|
|
661
|
+
type: t.type,
|
|
662
|
+
amount: `$${(t.amount_cents / 100).toFixed(2)}`,
|
|
663
|
+
balance: `$${(t.balance_after_cents / 100).toFixed(2)}`,
|
|
664
|
+
description: t.description ? truncate(t.description, 30) : '—',
|
|
665
|
+
date: formatDate(t.created_at),
|
|
666
|
+
}));
|
|
667
|
+
printTable(rows, ['id', 'type', 'amount', 'balance', 'description', 'date']);
|
|
668
|
+
}
|
|
669
|
+
else {
|
|
670
|
+
console.log(chalk.dim(' No transactions found.'));
|
|
671
|
+
}
|
|
672
|
+
const p = data.pagination;
|
|
673
|
+
console.log();
|
|
674
|
+
console.log(chalk.dim(`Page ${p.page} — ${p.total} total transactions${p.has_more ? ' (more available)' : ''}`));
|
|
675
|
+
console.log();
|
|
676
|
+
}
|
|
677
|
+
// ============================================================================
|
|
678
|
+
// Wallet — Pricing
|
|
679
|
+
// ============================================================================
|
|
680
|
+
export async function mailWalletPricing(options) {
|
|
681
|
+
const spinner = createSpinner('Fetching pricing...').start();
|
|
682
|
+
const data = await apiRequest('/mail/wallet/pricing');
|
|
683
|
+
spinner.stop();
|
|
684
|
+
if (options.json) {
|
|
685
|
+
printJson(data);
|
|
686
|
+
return;
|
|
687
|
+
}
|
|
688
|
+
printHeader('Mail Pricing');
|
|
689
|
+
console.log();
|
|
690
|
+
console.log(chalk.dim(` Plan: ${data.data.plan_slug}`));
|
|
691
|
+
if (data.data.current_usage !== undefined) {
|
|
692
|
+
console.log(chalk.dim(` Current usage: ${data.data.current_usage} cards`));
|
|
693
|
+
}
|
|
694
|
+
console.log();
|
|
695
|
+
if (data.data.sizes.length > 0) {
|
|
696
|
+
const rows = data.data.sizes.map((s) => ({
|
|
697
|
+
size: s.size,
|
|
698
|
+
price: `$${(s.price_cents / 100).toFixed(2)}`,
|
|
699
|
+
label: s.label || '—',
|
|
700
|
+
}));
|
|
701
|
+
printTable(rows, ['size', 'price', 'label']);
|
|
702
|
+
}
|
|
703
|
+
if (data.data.bands && data.data.bands.length > 0) {
|
|
704
|
+
console.log();
|
|
705
|
+
console.log(chalk.bold('Plan Metadata Pricing'));
|
|
706
|
+
console.log(chalk.dim('─'.repeat(50)));
|
|
707
|
+
for (const band of data.data.bands) {
|
|
708
|
+
const prices = band.prices
|
|
709
|
+
.map((p) => `${p.size}: $${(p.price_cents / 100).toFixed(2)}`)
|
|
710
|
+
.join(', ');
|
|
711
|
+
console.log(` ${band.label || 'Plan price'}: ${prices}`);
|
|
712
|
+
}
|
|
713
|
+
}
|
|
714
|
+
if (data.data.plans && data.data.plans.length > 0) {
|
|
715
|
+
console.log();
|
|
716
|
+
console.log(chalk.bold('Catalog Prices'));
|
|
717
|
+
console.log(chalk.dim('─'.repeat(50)));
|
|
718
|
+
for (const plan of data.data.plans) {
|
|
719
|
+
const prices = plan.prices
|
|
720
|
+
.map((p) => `${p.size}: $${(p.price_cents / 100).toFixed(2)}`)
|
|
721
|
+
.join(', ');
|
|
722
|
+
console.log(` ${plan.plan_name}: ${prices}`);
|
|
723
|
+
}
|
|
724
|
+
}
|
|
725
|
+
console.log();
|
|
726
|
+
}
|
|
727
|
+
//# sourceMappingURL=mail.js.map
|