outbound-sdk 0.2.0 → 0.4.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/dist/alerts/index.js +50 -19
- package/dist/alerts/plugin.d.ts +20 -3
- package/dist/audit/index.js +2 -2
- package/dist/benchmarks/index.js +5 -5
- package/dist/budget/index.d.ts +3 -2
- package/dist/budget/index.js +11 -10
- package/dist/cards/content.d.ts +6 -1
- package/dist/cards/format.d.ts +17 -2
- package/dist/cards/index.d.ts +1 -1
- package/dist/cards/index.js +297 -132
- package/dist/cards/parts.d.ts +9 -2
- package/dist/cards/render.d.ts +20 -3
- package/dist/chunks/{chunk-U2D34ARZ.js → chunk-2D42TQFU.js} +3 -3
- package/dist/chunks/chunk-4PA526S7.js +17 -0
- package/dist/chunks/{chunk-6CVZOUHB.js → chunk-5CFO3CXG.js} +24 -0
- package/dist/chunks/{chunk-XNFESPZH.js → chunk-5FVKRIEJ.js} +168 -31
- package/dist/chunks/{chunk-PMSSUWD7.js → chunk-7LNJJ2RO.js} +217 -58
- package/dist/chunks/{chunk-XC6CZP73.js → chunk-7ZDS6SZD.js} +7 -1
- package/dist/chunks/{chunk-SBIZDCRY.js → chunk-A6WVOCA4.js} +4 -4
- package/dist/chunks/{chunk-VQSCHOBV.js → chunk-BLCJHP5H.js} +11 -4
- package/dist/chunks/{chunk-4PSO6JEK.js → chunk-BOWXGMN3.js} +6 -21
- package/dist/chunks/{chunk-DJ2IUQEU.js → chunk-C4LS2HNV.js} +3 -3
- package/dist/chunks/{chunk-AFU5E5QB.js → chunk-E6DSDCPI.js} +98 -69
- package/dist/chunks/{chunk-IPUYZD4O.js → chunk-GFDNRWR3.js} +1 -1
- package/dist/chunks/{chunk-PURHK3JU.js → chunk-IZFTTMJP.js} +4 -4
- package/dist/chunks/{chunk-E7JHLNLG.js → chunk-J7DDZ4C2.js} +15 -2
- package/dist/chunks/{chunk-FKH5N47I.js → chunk-K4USHN4C.js} +1 -1
- package/dist/chunks/chunk-LVQUSKEX.js +17 -0
- package/dist/chunks/{chunk-YOTW5ESM.js → chunk-PQSTQKRD.js} +2 -2
- package/dist/chunks/chunk-PTZO4QXR.js +15 -0
- package/dist/chunks/{chunk-LVYG7XZJ.js → chunk-QAKJ76HB.js} +1 -1
- package/dist/chunks/chunk-QGRZDTX4.js +26 -0
- package/dist/chunks/{chunk-R3Y56YVF.js → chunk-Y5RAJ6PZ.js} +2 -2
- package/dist/chunks/{chunk-RCZ7ZZFU.js → chunk-ZFVHM5JI.js} +3 -3
- package/dist/chunks/{chunk-UAT3JSJZ.js → chunk-ZOAG2C6V.js} +2 -2
- package/dist/cli/bin.js +17 -13
- package/dist/cli/commands.d.ts +11 -0
- package/dist/cli/index.js +17 -13
- package/dist/cli/mcp.d.ts +5 -0
- package/dist/cli/version.d.ts +2 -0
- package/dist/clients/index.d.ts +1 -1
- package/dist/clients/index.js +35 -10
- package/dist/clients/plugin.d.ts +9 -2
- package/dist/combine/index.js +7 -6
- package/dist/exporter/index.d.ts +5 -2
- package/dist/exporter/index.js +2 -2
- package/dist/failover/index.js +3 -3
- package/dist/fixtures/index.js +5 -4
- package/dist/heyreach/client.d.ts +2 -0
- package/dist/heyreach/index.js +71 -39
- package/dist/heyreach/map.d.ts +5 -2
- package/dist/identity/index.js +33 -17
- package/dist/identity/plugin.d.ts +2 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +13 -10
- package/dist/insights/campaign.d.ts +3 -0
- package/dist/insights/capped.d.ts +29 -0
- package/dist/insights/copy/copy-audit.d.ts +2 -0
- package/dist/insights/copy/copy-reuse.d.ts +27 -3
- package/dist/insights/copy/index.d.ts +8 -8
- package/dist/insights/copy/reply-timing.d.ts +8 -0
- package/dist/insights/copy/reuse-base.d.ts +32 -0
- package/dist/insights/copy/shared.d.ts +39 -15
- package/dist/insights/copy/step-funnel.d.ts +16 -5
- package/dist/insights/copy/variant-test.d.ts +19 -8
- package/dist/insights/define.d.ts +56 -2
- package/dist/insights/fields.d.ts +16 -0
- package/dist/insights/index.d.ts +2 -1
- package/dist/insights/index.js +1494 -730
- package/dist/insights/inputs.generated.d.ts +951 -0
- package/dist/insights/ops/campaign-diagnosis.d.ts +3 -1
- package/dist/insights/ops/campaign-ranking.d.ts +12 -4
- package/dist/insights/ops/channel-mix.d.ts +2 -1
- package/dist/insights/ops/client-report.d.ts +18 -5
- package/dist/insights/ops/index.d.ts +6 -2
- package/dist/insights/ops/period-comparison.d.ts +14 -3
- package/dist/insights/ops/pipeline-forecast.d.ts +14 -4
- package/dist/insights/ops/shared.d.ts +29 -24
- package/dist/insights/ops/tag-rollup.d.ts +2 -1
- package/dist/insights/people/account-summary.d.ts +13 -0
- package/dist/insights/people/dropped-replies.d.ts +8 -0
- package/dist/insights/people/find.d.ts +7 -1
- package/dist/insights/people/hot-leads.d.ts +16 -1
- package/dist/insights/people/person-summary.d.ts +6 -0
- package/dist/insights/people/read.d.ts +26 -10
- package/dist/insights/people/suppression-check.d.ts +11 -2
- package/dist/insights/plugin.d.ts +7 -5
- package/dist/insights/ref.d.ts +6 -0
- package/dist/insights/registry.d.ts +28 -16
- package/dist/insights/senders/bounce-watch.d.ts +25 -8
- package/dist/insights/senders/capacity-sends.d.ts +22 -0
- package/dist/insights/senders/domain-health.d.ts +10 -4
- package/dist/insights/senders/index.d.ts +14 -6
- package/dist/insights/senders/read.d.ts +15 -14
- package/dist/insights/senders/sender-capacity.d.ts +5 -13
- package/dist/insights/senders/sender-load.d.ts +2 -0
- package/dist/insights/stats.d.ts +8 -0
- package/dist/insights/tools.d.ts +3 -2
- package/dist/instantly/client.d.ts +2 -0
- package/dist/instantly/index.js +44 -29
- package/dist/instantly/map.d.ts +6 -2
- package/dist/internal/engine/request.d.ts +5 -0
- package/dist/internal/entities.d.ts +3 -20
- package/dist/internal/errors.d.ts +44 -0
- package/dist/internal/fields.d.ts +1 -1
- package/dist/internal/json.d.ts +9 -2
- package/dist/internal/lists.d.ts +24 -0
- package/dist/internal/numbers.d.ts +8 -0
- package/dist/internal/outbound/collections.d.ts +4 -0
- package/dist/internal/outbound/create.d.ts +24 -3
- package/dist/internal/outbound/outbound.d.ts +13 -1
- package/dist/internal/outbound/validate.d.ts +4 -0
- package/dist/internal/outbound/walker.d.ts +3 -2
- package/dist/internal/plural.d.ts +12 -0
- package/dist/internal/renamed.d.ts +28 -0
- package/dist/internal/vocabulary.d.ts +20 -0
- package/dist/loader/index.js +5 -5
- package/dist/memory/adapter.d.ts +7 -0
- package/dist/memory/demo-stats.d.ts +3 -0
- package/dist/memory/demo.d.ts +14 -3
- package/dist/memory/index.d.ts +1 -0
- package/dist/memory/index.js +200 -95
- package/dist/providers/index.d.ts +72 -0
- package/dist/providers/index.js +3 -1
- package/dist/reconcile/index.js +5 -4
- package/dist/redact/index.js +10 -4
- package/dist/redact/plugin.d.ts +7 -0
- package/dist/smartlead/index.js +102 -49
- package/dist/smartlead/shared.d.ts +13 -0
- package/dist/sync/index.js +2 -2
- package/dist/tools/ai-sdk.js +8 -6
- package/dist/tools/campaign-tools.d.ts +1 -1
- package/dist/tools/claude-agent.js +8 -6
- package/dist/tools/index.js +9 -7
- package/dist/tools/input-problem.d.ts +8 -0
- package/dist/tools/registry.d.ts +7 -2
- package/dist/tools/shared.d.ts +7 -0
- package/dist/tracing/index.js +2 -2
- package/dist/webhooks/index.js +10 -9
- package/package.json +1 -1
|
@@ -0,0 +1,951 @@
|
|
|
1
|
+
/** The input of every insight, by method name. */
|
|
2
|
+
export interface InsightInputs {
|
|
3
|
+
/** The input of `personSummary` (the `person_summary` tool). */
|
|
4
|
+
readonly personSummary: {
|
|
5
|
+
/**
|
|
6
|
+
* The most campaigns to report on. Each costs up to 2 requests.
|
|
7
|
+
*
|
|
8
|
+
* A whole number from 1 to 50. Defaults to `20`.
|
|
9
|
+
*/
|
|
10
|
+
readonly max_campaigns?: number | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* The person's email address or LinkedIn profile URL, or a lead ref as the other people insights return
|
|
13
|
+
*
|
|
14
|
+
* At least 3 characters. Required.
|
|
15
|
+
*/
|
|
16
|
+
readonly person: string;
|
|
17
|
+
};
|
|
18
|
+
/** The input of `accountSummary` (the `account_summary` tool). */
|
|
19
|
+
readonly accountSummary: {
|
|
20
|
+
/**
|
|
21
|
+
* Set to true to accept an email provider domain such as gmail.com, which is not one company
|
|
22
|
+
*
|
|
23
|
+
* Defaults to `false`.
|
|
24
|
+
*/
|
|
25
|
+
readonly allow_free_domains?: boolean | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* The company's domain, for example acme.com, or an email address whose domain is used
|
|
28
|
+
*
|
|
29
|
+
* At least 3 characters. Required.
|
|
30
|
+
*/
|
|
31
|
+
readonly domain: string;
|
|
32
|
+
/**
|
|
33
|
+
* The most campaigns to read leads from when the tool cannot list every lead at once
|
|
34
|
+
*
|
|
35
|
+
* A whole number from 1 to 200. Defaults to `20`.
|
|
36
|
+
*/
|
|
37
|
+
readonly max_campaigns?: number | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* The most leads to read in all. A vendor request returns about 50 to 100 leads.
|
|
40
|
+
*
|
|
41
|
+
* A whole number from 1 to 20,000. Defaults to `1000`.
|
|
42
|
+
*/
|
|
43
|
+
readonly max_leads?: number | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* Vendor interest labels that count as interested, matched without regard to case
|
|
46
|
+
*
|
|
47
|
+
* Defaults to `["Interested","Meeting Booked","Meeting Completed"]`.
|
|
48
|
+
*/
|
|
49
|
+
readonly positive_labels?: string[] | undefined;
|
|
50
|
+
};
|
|
51
|
+
/** The input of `leadCollisions` (the `lead_collisions` tool). */
|
|
52
|
+
readonly leadCollisions: {
|
|
53
|
+
/**
|
|
54
|
+
* The most campaigns to read. Each costs one request per page of its leads.
|
|
55
|
+
*
|
|
56
|
+
* A whole number from 1 to 200. Defaults to `20`.
|
|
57
|
+
*/
|
|
58
|
+
readonly max_campaigns?: number | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* The most leads to read from each campaign
|
|
61
|
+
*
|
|
62
|
+
* A whole number from 1 to 20,000. Defaults to `500`.
|
|
63
|
+
*/
|
|
64
|
+
readonly max_leads_per_campaign?: number | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
67
|
+
*
|
|
68
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active"]`.
|
|
69
|
+
*/
|
|
70
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
71
|
+
};
|
|
72
|
+
/** The input of `suppressionCheck` (the `suppression_check` tool). */
|
|
73
|
+
readonly suppressionCheck: {
|
|
74
|
+
/**
|
|
75
|
+
* The most block list entries to read. A vendor request returns about 50 to 100.
|
|
76
|
+
*
|
|
77
|
+
* A whole number from 1 to 100,000. Defaults to `2000`.
|
|
78
|
+
*/
|
|
79
|
+
readonly max_block_entries?: number | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* The most campaigns to check. Each costs one request per page of its leads.
|
|
82
|
+
*
|
|
83
|
+
* A whole number from 1 to 200. Defaults to `20`.
|
|
84
|
+
*/
|
|
85
|
+
readonly max_campaigns?: number | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* The most leads to read from each campaign
|
|
88
|
+
*
|
|
89
|
+
* A whole number from 1 to 20,000. Defaults to `500`.
|
|
90
|
+
*/
|
|
91
|
+
readonly max_leads_per_campaign?: number | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
94
|
+
*
|
|
95
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active"]`.
|
|
96
|
+
*/
|
|
97
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
98
|
+
};
|
|
99
|
+
/** The input of `droppedReplies` (the `dropped_replies` tool). */
|
|
100
|
+
readonly droppedReplies: {
|
|
101
|
+
/**
|
|
102
|
+
* Reply categories that need an answer. Out-of-office, bounce, unsubscribe and negative replies are left out by default.
|
|
103
|
+
*
|
|
104
|
+
* At least 1 item. Each one of `bounce`, `negative`, `neutral`, `ooo`, `positive`, `unknown`, `unsubscribe`. Defaults to `["positive","neutral","unknown"]`.
|
|
105
|
+
*/
|
|
106
|
+
readonly categories?: ("bounce" | "negative" | "neutral" | "ooo" | "positive" | "unknown" | "unsubscribe")[] | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Set to true to also check replies the vendor marks as automatic
|
|
109
|
+
*
|
|
110
|
+
* Defaults to `false`.
|
|
111
|
+
*/
|
|
112
|
+
readonly include_auto?: boolean | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* The most replies to read. Each conversation among them costs one more request to check.
|
|
115
|
+
*
|
|
116
|
+
* A whole number from 1 to 1000. Defaults to `50`.
|
|
117
|
+
*/
|
|
118
|
+
readonly max_replies?: number | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* A reply counts as dropped only after waiting this many hours without an answer
|
|
121
|
+
*
|
|
122
|
+
* A number, 0 or more. Defaults to `24`.
|
|
123
|
+
*/
|
|
124
|
+
readonly older_than_hours?: number | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* Only replies received at or after this ISO 8601 time. Null means 14 days before now.
|
|
127
|
+
*
|
|
128
|
+
* An ISO 8601 date and time with an offset, or an ISO 8601 date, `YYYY-MM-DD`. Defaults to `null`.
|
|
129
|
+
*/
|
|
130
|
+
readonly since?: string | null | undefined;
|
|
131
|
+
};
|
|
132
|
+
/** The input of `hotLeads` (the `hot_leads` tool). */
|
|
133
|
+
readonly hotLeads: {
|
|
134
|
+
/**
|
|
135
|
+
* A campaign ref (provider:workspace:id) to rank the leads of. Null ranks every lead the tool lists.
|
|
136
|
+
*
|
|
137
|
+
* Not empty. Defaults to `null`.
|
|
138
|
+
*/
|
|
139
|
+
readonly campaign?: string | null | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* The most replies, clicks or opens that earn points, so 40 opens do not outrank a reply
|
|
142
|
+
*
|
|
143
|
+
* A whole number from 1 to 9,007,199,254,740,991. Defaults to `5`.
|
|
144
|
+
*/
|
|
145
|
+
readonly count_cap?: number | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* How many leads to return
|
|
148
|
+
*
|
|
149
|
+
* A whole number from 1 to 500. Defaults to `20`.
|
|
150
|
+
*/
|
|
151
|
+
readonly limit?: number | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* The most leads to read and score. A vendor request returns about 50 to 100 leads. When more exist, the leads behind recent replies are read as well, so engaged leads past the cap are still ranked.
|
|
154
|
+
*
|
|
155
|
+
* A whole number from 1 to 20,000. Defaults to `500`.
|
|
156
|
+
*/
|
|
157
|
+
readonly max_leads?: number | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* Vendor interest labels that count as interested, matched without regard to case
|
|
160
|
+
*
|
|
161
|
+
* Defaults to `["Interested","Meeting Booked","Meeting Completed"]`.
|
|
162
|
+
*/
|
|
163
|
+
readonly positive_labels?: string[] | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* A reply today earns the full recency points, fading evenly to none after this many days
|
|
166
|
+
*
|
|
167
|
+
* A number, 1 or more. Defaults to `14`.
|
|
168
|
+
*/
|
|
169
|
+
readonly recency_days?: number | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* Points for each click, up to count_cap
|
|
172
|
+
*
|
|
173
|
+
* A number, 0 or more. Defaults to `5`.
|
|
174
|
+
*/
|
|
175
|
+
readonly weight_click?: number | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* Points for carrying a positive interest label
|
|
178
|
+
*
|
|
179
|
+
* A number, 0 or more. Defaults to `50`.
|
|
180
|
+
*/
|
|
181
|
+
readonly weight_interest?: number | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* Points for each open, up to count_cap
|
|
184
|
+
*
|
|
185
|
+
* A number, 0 or more. Defaults to `1`.
|
|
186
|
+
*/
|
|
187
|
+
readonly weight_open?: number | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* Points for a reply received right now
|
|
190
|
+
*
|
|
191
|
+
* A number, 0 or more. Defaults to `20`.
|
|
192
|
+
*/
|
|
193
|
+
readonly weight_recency?: number | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* Points for each reply, up to count_cap
|
|
196
|
+
*
|
|
197
|
+
* A number, 0 or more. Defaults to `10`.
|
|
198
|
+
*/
|
|
199
|
+
readonly weight_reply?: number | undefined;
|
|
200
|
+
};
|
|
201
|
+
/** The input of `personalizationGaps` (the `personalization_gaps` tool). */
|
|
202
|
+
readonly personalizationGaps: {
|
|
203
|
+
/**
|
|
204
|
+
* The campaign's ref (provider:workspace:id)
|
|
205
|
+
*
|
|
206
|
+
* Not empty. Required.
|
|
207
|
+
*/
|
|
208
|
+
readonly campaign: string;
|
|
209
|
+
/**
|
|
210
|
+
* How many affected leads to list. The counts cover all of them.
|
|
211
|
+
*
|
|
212
|
+
* A whole number from 1 to 5000. Defaults to `100`.
|
|
213
|
+
*/
|
|
214
|
+
readonly limit?: number | undefined;
|
|
215
|
+
/**
|
|
216
|
+
* The most leads to check. A vendor request returns about 50 to 100 leads.
|
|
217
|
+
*
|
|
218
|
+
* A whole number from 1 to 20,000. Defaults to `500`.
|
|
219
|
+
*/
|
|
220
|
+
readonly max_leads?: number | undefined;
|
|
221
|
+
};
|
|
222
|
+
/** The input of `stepFunnel` (the `step_funnel` tool). */
|
|
223
|
+
readonly stepFunnel: {
|
|
224
|
+
/**
|
|
225
|
+
* The campaign's ref, for example `instantly:acme:abc123`
|
|
226
|
+
*
|
|
227
|
+
* Not empty. Required.
|
|
228
|
+
*/
|
|
229
|
+
readonly campaign: string;
|
|
230
|
+
/**
|
|
231
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
232
|
+
*
|
|
233
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
234
|
+
*/
|
|
235
|
+
readonly from?: string | null | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
238
|
+
*
|
|
239
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
240
|
+
*/
|
|
241
|
+
readonly to?: string | null | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* A step earns its place when the low end of its reply rate interval is above this. 0 asks only that the rate is reliably above zero.
|
|
244
|
+
*
|
|
245
|
+
* A number from 0 to 1. Defaults to `0`.
|
|
246
|
+
*/
|
|
247
|
+
readonly min_reply_rate?: number | undefined;
|
|
248
|
+
};
|
|
249
|
+
/** The input of `variantTest` (the `variant_test` tool). */
|
|
250
|
+
readonly variantTest: {
|
|
251
|
+
/**
|
|
252
|
+
* The chance of calling a winner that is not one. A difference with a p-value under this is a winner.
|
|
253
|
+
*
|
|
254
|
+
* A number, more than 0 and 0.5 or less. Defaults to `0.05`.
|
|
255
|
+
*/
|
|
256
|
+
readonly alpha?: number | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* The campaign's ref, for example `instantly:acme:abc123`
|
|
259
|
+
*
|
|
260
|
+
* Not empty. Required.
|
|
261
|
+
*/
|
|
262
|
+
readonly campaign: string;
|
|
263
|
+
/**
|
|
264
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
265
|
+
*
|
|
266
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
267
|
+
*/
|
|
268
|
+
readonly from?: string | null | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
271
|
+
*
|
|
272
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
273
|
+
*/
|
|
274
|
+
readonly to?: string | null | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* What a variant is judged on. Replies and positive replies are divided by leads contacted (or sends); opens and clicks by messages delivered (or sends).
|
|
277
|
+
*
|
|
278
|
+
* Defaults to `"replied"`.
|
|
279
|
+
*/
|
|
280
|
+
readonly metric?: "replied" | "positive" | "opened" | "clicked" | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* A variant with a smaller base than this (sends, or leads contacted when the vendor counts those) is not compared.
|
|
283
|
+
*
|
|
284
|
+
* A whole number from 1 to 9,007,199,254,740,991. Defaults to `100`.
|
|
285
|
+
*/
|
|
286
|
+
readonly min_sent?: number | undefined;
|
|
287
|
+
};
|
|
288
|
+
/** The input of `copyAudit` (the `copy_audit` tool). */
|
|
289
|
+
readonly copyAudit: {
|
|
290
|
+
/**
|
|
291
|
+
* The campaign's ref, for example `instantly:acme:abc123`
|
|
292
|
+
*
|
|
293
|
+
* Not empty. Required.
|
|
294
|
+
*/
|
|
295
|
+
readonly campaign: string;
|
|
296
|
+
/**
|
|
297
|
+
* The most words a body may have.
|
|
298
|
+
*
|
|
299
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `150`.
|
|
300
|
+
*/
|
|
301
|
+
readonly max_body_words?: number | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* How many words of four or more letters may be in capitals, so one acronym is not a finding.
|
|
304
|
+
*
|
|
305
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `1`.
|
|
306
|
+
*/
|
|
307
|
+
readonly max_caps_words?: number | undefined;
|
|
308
|
+
/**
|
|
309
|
+
* The most characters a LinkedIn connection request may have.
|
|
310
|
+
*
|
|
311
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `300`.
|
|
312
|
+
*/
|
|
313
|
+
readonly max_connection_chars?: number | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* How many exclamation marks a message may have.
|
|
316
|
+
*
|
|
317
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `1`.
|
|
318
|
+
*/
|
|
319
|
+
readonly max_exclamations?: number | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* The most links an email body may have.
|
|
322
|
+
*
|
|
323
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `1`.
|
|
324
|
+
*/
|
|
325
|
+
readonly max_links?: number | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* The most characters a subject may have.
|
|
328
|
+
*
|
|
329
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `60`.
|
|
330
|
+
*/
|
|
331
|
+
readonly max_subject_chars?: number | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* Words and phrases to flag in email copy, matched whole and without case. Replaces the default list.
|
|
334
|
+
*
|
|
335
|
+
* Defaults to `["100% free","act now","buy now","cash bonus","click here","double your","earn money","free trial","guarantee","limited time","no obligation","risk-free","urgent","winner"]`.
|
|
336
|
+
*/
|
|
337
|
+
readonly spam_words?: string[] | undefined;
|
|
338
|
+
};
|
|
339
|
+
/** The input of `copyReuse` (the `copy_reuse` tool). */
|
|
340
|
+
readonly copyReuse: {
|
|
341
|
+
/**
|
|
342
|
+
* The most campaigns to read. Each costs 2 requests: its sequence and its step stats.
|
|
343
|
+
*
|
|
344
|
+
* A whole number from 1 to 200. Defaults to `20`.
|
|
345
|
+
*/
|
|
346
|
+
readonly max_campaigns?: number | undefined;
|
|
347
|
+
/**
|
|
348
|
+
* The smallest base (sends, or leads contacted when the vendor counts those) a campaign needs to count in the spread, and a piece of copy needs to be named the best.
|
|
349
|
+
*
|
|
350
|
+
* A whole number from 1 to 9,007,199,254,740,991. Defaults to `100`.
|
|
351
|
+
*/
|
|
352
|
+
readonly min_sent?: number | undefined;
|
|
353
|
+
/**
|
|
354
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
355
|
+
*
|
|
356
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
357
|
+
*/
|
|
358
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
359
|
+
};
|
|
360
|
+
/** The input of `replyTiming` (the `reply_timing` tool). */
|
|
361
|
+
readonly replyTiming: {
|
|
362
|
+
/**
|
|
363
|
+
* A campaign's ref to look at one campaign; an unknown one is refused with NotFound. null looks at every campaign.
|
|
364
|
+
*
|
|
365
|
+
* Not empty. Defaults to `null`.
|
|
366
|
+
*/
|
|
367
|
+
readonly campaign?: string | null | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* The most messages to read, sent and received together. A page of messages costs 1 request.
|
|
370
|
+
*
|
|
371
|
+
* A whole number from 1 to 50,000. Defaults to `2000`.
|
|
372
|
+
*/
|
|
373
|
+
readonly max_messages?: number | undefined;
|
|
374
|
+
/**
|
|
375
|
+
* Only messages from this time on, ISO 8601. null means 30 days before now.
|
|
376
|
+
*
|
|
377
|
+
* An ISO 8601 date and time with an offset, or `null`. Defaults to `null`.
|
|
378
|
+
*/
|
|
379
|
+
readonly since?: string | null | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* Minutes to add to UTC for the weekday and hour tables, for example -300 for New York in winter.
|
|
382
|
+
*
|
|
383
|
+
* A whole number from -720 to 840. Defaults to `0`.
|
|
384
|
+
*/
|
|
385
|
+
readonly timezone_offset_minutes?: number | undefined;
|
|
386
|
+
};
|
|
387
|
+
/** The input of `domainHealth` (the `domain_health` tool). */
|
|
388
|
+
readonly domainHealth: {
|
|
389
|
+
/**
|
|
390
|
+
* The most senders to check. Each costs 1 request.
|
|
391
|
+
*
|
|
392
|
+
* A whole number from 1 to 500. Defaults to `50`.
|
|
393
|
+
*/
|
|
394
|
+
readonly max_senders?: number | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* A domain whose warmup emails land in spam more often than this share is high risk
|
|
397
|
+
*
|
|
398
|
+
* A number from 0 to 1. Defaults to `0.1`.
|
|
399
|
+
*/
|
|
400
|
+
readonly max_spam_rate?: number | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* @deprecated Renamed to `max_spam_rate`. Removed in 0.5.0.
|
|
403
|
+
*
|
|
404
|
+
* A number from 0 to 1.
|
|
405
|
+
*/
|
|
406
|
+
readonly spam_rate_threshold?: number | undefined;
|
|
407
|
+
};
|
|
408
|
+
/** The input of `senderCapacity` (the `sender_capacity` tool). */
|
|
409
|
+
readonly senderCapacity: {
|
|
410
|
+
/**
|
|
411
|
+
* How many full days before today to average the sends over
|
|
412
|
+
*
|
|
413
|
+
* A whole number from 1 to 90. Defaults to `7`.
|
|
414
|
+
*/
|
|
415
|
+
readonly days?: number | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* The most active campaigns to read. Each costs up to 2 requests, or 3 when the vendor has no workspace totals.
|
|
418
|
+
*
|
|
419
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
420
|
+
*/
|
|
421
|
+
readonly max_campaigns?: number | undefined;
|
|
422
|
+
/**
|
|
423
|
+
* The most senders to read for the workspace, and for each campaign
|
|
424
|
+
*
|
|
425
|
+
* A whole number from 1 to 1000. Defaults to `200`.
|
|
426
|
+
*/
|
|
427
|
+
readonly max_senders?: number | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* Read the stats of each inactive or unlimited sender (1 request each) so utilization can leave their sends out. Off, utilization is null whenever such a sender exists.
|
|
430
|
+
*
|
|
431
|
+
* Defaults to `false`.
|
|
432
|
+
*/
|
|
433
|
+
readonly split_uncounted?: boolean | undefined;
|
|
434
|
+
};
|
|
435
|
+
/** The input of `bounceWatch` (the `bounce_watch` tool). */
|
|
436
|
+
readonly bounceWatch: {
|
|
437
|
+
/**
|
|
438
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
439
|
+
*
|
|
440
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
441
|
+
*/
|
|
442
|
+
readonly from?: string | null | undefined;
|
|
443
|
+
/**
|
|
444
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
445
|
+
*
|
|
446
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
447
|
+
*/
|
|
448
|
+
readonly to?: string | null | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* Also check the senders of each campaign over the threshold. Costs 1 listing per such campaign and 1 request per sender.
|
|
451
|
+
*
|
|
452
|
+
* Defaults to `true`.
|
|
453
|
+
*/
|
|
454
|
+
readonly include_senders?: boolean | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* The bounce rate, bounced divided by sent, that is too high
|
|
457
|
+
*
|
|
458
|
+
* A number from 0 to 1. Defaults to `0.03`.
|
|
459
|
+
*/
|
|
460
|
+
readonly max_bounce_rate?: number | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* The most campaigns to check. Each costs 1 request.
|
|
463
|
+
*
|
|
464
|
+
* A whole number from 1 to 500. Defaults to `50`.
|
|
465
|
+
*/
|
|
466
|
+
readonly max_campaigns?: number | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* The most senders to check for one campaign over the threshold
|
|
469
|
+
*
|
|
470
|
+
* A whole number from 1 to 200. Defaults to `10`.
|
|
471
|
+
*/
|
|
472
|
+
readonly max_senders_per_campaign?: number | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* A campaign or sender with fewer sends than this is too small to judge
|
|
475
|
+
*
|
|
476
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `100`.
|
|
477
|
+
*/
|
|
478
|
+
readonly min_sent?: number | undefined;
|
|
479
|
+
/**
|
|
480
|
+
* @deprecated Renamed to `max_bounce_rate`. Removed in 0.5.0.
|
|
481
|
+
*
|
|
482
|
+
* A number from 0 to 1.
|
|
483
|
+
*/
|
|
484
|
+
readonly threshold?: number | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
487
|
+
*
|
|
488
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active"]`.
|
|
489
|
+
*/
|
|
490
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
491
|
+
};
|
|
492
|
+
/** The input of `warmupReadiness` (the `warmup_readiness` tool). */
|
|
493
|
+
readonly warmupReadiness: {
|
|
494
|
+
/**
|
|
495
|
+
* Also check each mailbox's DNS records and warmup spam. Costs 1 more request per mailbox.
|
|
496
|
+
*
|
|
497
|
+
* Defaults to `false`.
|
|
498
|
+
*/
|
|
499
|
+
readonly check_health?: boolean | undefined;
|
|
500
|
+
/**
|
|
501
|
+
* The most senders to check
|
|
502
|
+
*
|
|
503
|
+
* A whole number from 1 to 1000. Defaults to `100`.
|
|
504
|
+
*/
|
|
505
|
+
readonly max_senders?: number | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* With check_health, a mailbox whose warmup emails land in spam more often than this share is not ready
|
|
508
|
+
*
|
|
509
|
+
* A number from 0 to 1. Defaults to `0.1`.
|
|
510
|
+
*/
|
|
511
|
+
readonly max_spam_rate?: number | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* The warmup score a mailbox needs to be ready
|
|
514
|
+
*
|
|
515
|
+
* A number from 0 to 100. Defaults to `90`.
|
|
516
|
+
*/
|
|
517
|
+
readonly min_score?: number | undefined;
|
|
518
|
+
};
|
|
519
|
+
/** The input of `senderLoad` (the `sender_load` tool). */
|
|
520
|
+
readonly senderLoad: {
|
|
521
|
+
/**
|
|
522
|
+
* The most campaigns to read. Each costs 1 request.
|
|
523
|
+
*
|
|
524
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
525
|
+
*/
|
|
526
|
+
readonly max_campaigns?: number | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* A sender attached to more campaigns than this is overused
|
|
529
|
+
*
|
|
530
|
+
* A whole number from 1 to 9,007,199,254,740,991. Defaults to `3`.
|
|
531
|
+
*/
|
|
532
|
+
readonly max_campaigns_per_sender?: number | undefined;
|
|
533
|
+
/**
|
|
534
|
+
* The most senders to read for the workspace, and for each campaign
|
|
535
|
+
*
|
|
536
|
+
* A whole number from 1 to 1000. Defaults to `200`.
|
|
537
|
+
*/
|
|
538
|
+
readonly max_senders?: number | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
541
|
+
*
|
|
542
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active"]`.
|
|
543
|
+
*/
|
|
544
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
545
|
+
};
|
|
546
|
+
/** The input of `settingsAudit` (the `settings_audit` tool). */
|
|
547
|
+
readonly settingsAudit: {
|
|
548
|
+
/**
|
|
549
|
+
* The most campaigns to audit. Each costs 1 request, or 2 when its senders can be listed.
|
|
550
|
+
*
|
|
551
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
552
|
+
*/
|
|
553
|
+
readonly max_campaigns?: number | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* The sends a day assumed for an attached sender when the senders' own daily limits are not reported
|
|
556
|
+
*
|
|
557
|
+
* A number, 1 or more. Defaults to `50`.
|
|
558
|
+
*/
|
|
559
|
+
readonly max_daily_limit_per_sender?: number | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* The most senders to count for one campaign
|
|
562
|
+
*
|
|
563
|
+
* A whole number from 1 to 1000. Defaults to `100`.
|
|
564
|
+
*/
|
|
565
|
+
readonly max_senders_per_campaign?: number | undefined;
|
|
566
|
+
/**
|
|
567
|
+
* A sending window longer than this many hours is flagged
|
|
568
|
+
*
|
|
569
|
+
* A number from 1 to 24. Defaults to `12`.
|
|
570
|
+
*/
|
|
571
|
+
readonly max_window_hours?: number | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* A wait between two sends shorter than this is flagged
|
|
574
|
+
*
|
|
575
|
+
* A number, 0 or more. Defaults to `5`.
|
|
576
|
+
*/
|
|
577
|
+
readonly min_gap_minutes?: number | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* A sending window shorter than this many hours is flagged
|
|
580
|
+
*
|
|
581
|
+
* A number from 0 to 24. Defaults to `2`.
|
|
582
|
+
*/
|
|
583
|
+
readonly min_window_hours?: number | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
586
|
+
*
|
|
587
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active"]`.
|
|
588
|
+
*/
|
|
589
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
590
|
+
};
|
|
591
|
+
/** The input of `campaignDiagnosis` (the `campaign_diagnosis` tool). */
|
|
592
|
+
readonly campaignDiagnosis: {
|
|
593
|
+
/**
|
|
594
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
595
|
+
*
|
|
596
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
597
|
+
*/
|
|
598
|
+
readonly from?: string | null | undefined;
|
|
599
|
+
/**
|
|
600
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
601
|
+
*
|
|
602
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
603
|
+
*/
|
|
604
|
+
readonly to?: string | null | undefined;
|
|
605
|
+
/**
|
|
606
|
+
* The campaign's ref
|
|
607
|
+
*
|
|
608
|
+
* At least 3 characters. Required.
|
|
609
|
+
*/
|
|
610
|
+
readonly campaign: string;
|
|
611
|
+
/**
|
|
612
|
+
* The days, ending yesterday, held against the same number before
|
|
613
|
+
*
|
|
614
|
+
* A whole number from 1 to 30. Defaults to `7`.
|
|
615
|
+
*/
|
|
616
|
+
readonly days?: number | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* Average daily sends at or over this share of the daily limit mean the limit holds volume back
|
|
619
|
+
*
|
|
620
|
+
* A number from 0 to 1. Defaults to `0.9`.
|
|
621
|
+
*/
|
|
622
|
+
readonly daily_limit_share?: number | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* A bounce rate over this is a finding
|
|
625
|
+
*
|
|
626
|
+
* A number from 0 to 1. Defaults to `0.03`.
|
|
627
|
+
*/
|
|
628
|
+
readonly max_bounce_rate?: number | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* A fall in sends, recent days against the days before, over this share is a finding
|
|
631
|
+
*
|
|
632
|
+
* A number from 0 to 1. Defaults to `0.3`.
|
|
633
|
+
*/
|
|
634
|
+
readonly max_send_drop?: number | undefined;
|
|
635
|
+
/**
|
|
636
|
+
* The most senders of the campaign to read
|
|
637
|
+
*
|
|
638
|
+
* A whole number from 1 to 500. Defaults to `50`.
|
|
639
|
+
*/
|
|
640
|
+
readonly max_senders?: number | undefined;
|
|
641
|
+
/**
|
|
642
|
+
* A share of replies that are positive under this is a finding
|
|
643
|
+
*
|
|
644
|
+
* A number from 0 to 1. Defaults to `0.2`.
|
|
645
|
+
*/
|
|
646
|
+
readonly min_positive_share?: number | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* A reply rate under this is a finding
|
|
649
|
+
*
|
|
650
|
+
* A number from 0 to 1. Defaults to `0.01`.
|
|
651
|
+
*/
|
|
652
|
+
readonly min_reply_rate?: number | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* Under this many sends, rates are not judged
|
|
655
|
+
*
|
|
656
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `50`.
|
|
657
|
+
*/
|
|
658
|
+
readonly min_sent?: number | undefined;
|
|
659
|
+
/**
|
|
660
|
+
* Sending windows open fewer hours a week than this limit volume
|
|
661
|
+
*
|
|
662
|
+
* A number from 0 to 168. Defaults to `20`.
|
|
663
|
+
*/
|
|
664
|
+
readonly min_weekly_hours?: number | undefined;
|
|
665
|
+
/**
|
|
666
|
+
* @deprecated Renamed to `days`. Removed in 0.5.0.
|
|
667
|
+
*
|
|
668
|
+
* A whole number from 1 to 30.
|
|
669
|
+
*/
|
|
670
|
+
readonly recent_days?: number | undefined;
|
|
671
|
+
};
|
|
672
|
+
/** The input of `pipelineForecast` (the `pipeline_forecast` tool). */
|
|
673
|
+
readonly pipelineForecast: {
|
|
674
|
+
/**
|
|
675
|
+
* The campaign's ref
|
|
676
|
+
*
|
|
677
|
+
* At least 3 characters. Required.
|
|
678
|
+
*/
|
|
679
|
+
readonly campaign: string;
|
|
680
|
+
/**
|
|
681
|
+
* How many complete days, ending yesterday, set the daily pace
|
|
682
|
+
*
|
|
683
|
+
* A whole number from 1 to 60. Defaults to `7`.
|
|
684
|
+
*/
|
|
685
|
+
readonly days?: number | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* The most leads to read. A page of leads is one request.
|
|
688
|
+
*
|
|
689
|
+
* A whole number from 1 to 50,000. Defaults to `2000`.
|
|
690
|
+
*/
|
|
691
|
+
readonly max_leads?: number | undefined;
|
|
692
|
+
};
|
|
693
|
+
/** The input of `anomalies` (the `anomalies` tool). */
|
|
694
|
+
readonly anomalies: {
|
|
695
|
+
/**
|
|
696
|
+
* How many days before a day form the baseline it is held to
|
|
697
|
+
*
|
|
698
|
+
* A whole number from 5 to 60. Defaults to `14`.
|
|
699
|
+
*/
|
|
700
|
+
readonly baseline_days?: number | undefined;
|
|
701
|
+
/**
|
|
702
|
+
* A campaign ref. null checks the whole workspace.
|
|
703
|
+
*
|
|
704
|
+
* At least 3 characters. Defaults to `null`.
|
|
705
|
+
*/
|
|
706
|
+
readonly campaign?: string | null | undefined;
|
|
707
|
+
/**
|
|
708
|
+
* How many complete days, ending yesterday, are checked
|
|
709
|
+
*
|
|
710
|
+
* A whole number from 1 to 90. Defaults to `30`.
|
|
711
|
+
*/
|
|
712
|
+
readonly days?: number | undefined;
|
|
713
|
+
/**
|
|
714
|
+
* The daily counts to check
|
|
715
|
+
*
|
|
716
|
+
* At least 1 item. Each one of `sent`, `contacted`, `replied`, `positive`, `bounced`, `opened`, `clicked`, `unsubscribed`. Defaults to `["sent","replied","bounced"]`.
|
|
717
|
+
*/
|
|
718
|
+
readonly metrics?: ("sent" | "contacted" | "replied" | "positive" | "bounced" | "opened" | "clicked" | "unsubscribed")[] | undefined;
|
|
719
|
+
/**
|
|
720
|
+
* The fewest baseline days with data a day needs to be tested
|
|
721
|
+
*
|
|
722
|
+
* A whole number from 2 to 9,007,199,254,740,991. Defaults to `5`.
|
|
723
|
+
*/
|
|
724
|
+
readonly min_baseline_points?: number | undefined;
|
|
725
|
+
/**
|
|
726
|
+
* How many standard deviations from the baseline mean is unusual
|
|
727
|
+
*
|
|
728
|
+
* A number, more than 0. Defaults to `2.5`.
|
|
729
|
+
*/
|
|
730
|
+
readonly threshold?: number | undefined;
|
|
731
|
+
};
|
|
732
|
+
/** The input of `periodComparison` (the `period_comparison` tool). */
|
|
733
|
+
readonly periodComparison: {
|
|
734
|
+
/**
|
|
735
|
+
* The most campaigns to read. Each costs two stats requests.
|
|
736
|
+
*
|
|
737
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
738
|
+
*/
|
|
739
|
+
readonly max_campaigns?: number | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
742
|
+
*
|
|
743
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
744
|
+
*/
|
|
745
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
746
|
+
/**
|
|
747
|
+
* The p-value under which a change counts as more than chance
|
|
748
|
+
*
|
|
749
|
+
* A number, more than 0 and less than 1. Defaults to `0.05`.
|
|
750
|
+
*/
|
|
751
|
+
readonly alpha?: number | undefined;
|
|
752
|
+
/**
|
|
753
|
+
* The length of each period, in complete days ending yesterday
|
|
754
|
+
*
|
|
755
|
+
* A whole number from 1 to 90. Defaults to `7`.
|
|
756
|
+
*/
|
|
757
|
+
readonly days?: number | undefined;
|
|
758
|
+
/**
|
|
759
|
+
* A campaign under this many sends in either period is listed apart
|
|
760
|
+
*
|
|
761
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `50`.
|
|
762
|
+
*/
|
|
763
|
+
readonly min_sent?: number | undefined;
|
|
764
|
+
};
|
|
765
|
+
/** The input of `campaignRanking` (the `campaign_ranking` tool). */
|
|
766
|
+
readonly campaignRanking: {
|
|
767
|
+
/**
|
|
768
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
769
|
+
*
|
|
770
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
771
|
+
*/
|
|
772
|
+
readonly from?: string | null | undefined;
|
|
773
|
+
/**
|
|
774
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
775
|
+
*
|
|
776
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
777
|
+
*/
|
|
778
|
+
readonly to?: string | null | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* The most campaigns to read. Each costs one stats request.
|
|
781
|
+
*
|
|
782
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
783
|
+
*/
|
|
784
|
+
readonly max_campaigns?: number | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
787
|
+
*
|
|
788
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
789
|
+
*/
|
|
790
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* The rate to rank by. For bounce_rate, lower is better.
|
|
793
|
+
*
|
|
794
|
+
* Defaults to `"reply_rate"`.
|
|
795
|
+
*/
|
|
796
|
+
readonly metric?: "reply_rate" | "positive_reply_rate" | "bounce_rate" | undefined;
|
|
797
|
+
/**
|
|
798
|
+
* Campaigns with fewer sends than this are left out of the rank
|
|
799
|
+
*
|
|
800
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `50`.
|
|
801
|
+
*/
|
|
802
|
+
readonly min_sent?: number | undefined;
|
|
803
|
+
};
|
|
804
|
+
/** The input of `channelMix` (the `channel_mix` tool). */
|
|
805
|
+
readonly channelMix: {
|
|
806
|
+
/**
|
|
807
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
808
|
+
*
|
|
809
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
810
|
+
*/
|
|
811
|
+
readonly from?: string | null | undefined;
|
|
812
|
+
/**
|
|
813
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
814
|
+
*
|
|
815
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
816
|
+
*/
|
|
817
|
+
readonly to?: string | null | undefined;
|
|
818
|
+
/**
|
|
819
|
+
* The most campaigns to read. Each costs one stats request.
|
|
820
|
+
*
|
|
821
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
822
|
+
*/
|
|
823
|
+
readonly max_campaigns?: number | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
826
|
+
*
|
|
827
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
828
|
+
*/
|
|
829
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* The p-value under which a difference counts as more than chance
|
|
832
|
+
*
|
|
833
|
+
* A number, more than 0 and less than 1. Defaults to `0.05`.
|
|
834
|
+
*/
|
|
835
|
+
readonly alpha?: number | undefined;
|
|
836
|
+
};
|
|
837
|
+
/** The input of `tagRollup` (the `tag_rollup` tool). */
|
|
838
|
+
readonly tagRollup: {
|
|
839
|
+
/**
|
|
840
|
+
* First day counted, YYYY-MM-DD. null for the whole history.
|
|
841
|
+
*
|
|
842
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
843
|
+
*/
|
|
844
|
+
readonly from?: string | null | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* Last day counted, YYYY-MM-DD. null for up to today.
|
|
847
|
+
*
|
|
848
|
+
* An ISO 8601 date, `YYYY-MM-DD`, or `null`. Defaults to `null`.
|
|
849
|
+
*/
|
|
850
|
+
readonly to?: string | null | undefined;
|
|
851
|
+
/**
|
|
852
|
+
* The most campaigns to read. Each costs one stats request.
|
|
853
|
+
*
|
|
854
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
855
|
+
*/
|
|
856
|
+
readonly max_campaigns?: number | undefined;
|
|
857
|
+
/**
|
|
858
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
859
|
+
*
|
|
860
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
861
|
+
*/
|
|
862
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* Tags with fewer sends than this are listed apart, unsorted
|
|
865
|
+
*
|
|
866
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `50`.
|
|
867
|
+
*/
|
|
868
|
+
readonly min_sent?: number | undefined;
|
|
869
|
+
};
|
|
870
|
+
/** The input of `clientReport` (the `client_report` tool). */
|
|
871
|
+
readonly clientReport: {
|
|
872
|
+
/**
|
|
873
|
+
* The most campaigns to read. Each costs two stats requests, and three more plus its leads when active.
|
|
874
|
+
*
|
|
875
|
+
* A whole number from 1 to 200. Defaults to `25`.
|
|
876
|
+
*/
|
|
877
|
+
readonly max_campaigns?: number | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* Only campaigns in one of these states are read: active, paused, completed, draft, archived or unknown
|
|
880
|
+
*
|
|
881
|
+
* At least 1 item. Each one of `active`, `archived`, `completed`, `draft`, `paused`, `unknown`. Defaults to `["active","paused","completed"]`.
|
|
882
|
+
*/
|
|
883
|
+
readonly statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
884
|
+
/**
|
|
885
|
+
* The p-value under which a change counts as more than chance
|
|
886
|
+
*
|
|
887
|
+
* A number, more than 0 and less than 1. Defaults to `0.05`.
|
|
888
|
+
*/
|
|
889
|
+
readonly alpha?: number | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* Standard deviations from the baseline that make a day unusual
|
|
892
|
+
*
|
|
893
|
+
* A number, more than 0. Defaults to `2.5`.
|
|
894
|
+
*/
|
|
895
|
+
readonly anomaly_threshold?: number | undefined;
|
|
896
|
+
/**
|
|
897
|
+
* Days before the period that form the anomaly baseline
|
|
898
|
+
*
|
|
899
|
+
* A whole number from 5 to 60. Defaults to `14`.
|
|
900
|
+
*/
|
|
901
|
+
readonly baseline_days?: number | undefined;
|
|
902
|
+
/**
|
|
903
|
+
* The length of the period, in complete days ending yesterday
|
|
904
|
+
*
|
|
905
|
+
* A whole number from 1 to 90. Defaults to `7`.
|
|
906
|
+
*/
|
|
907
|
+
readonly days?: number | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* How many best and worst campaigns to show
|
|
910
|
+
*
|
|
911
|
+
* A whole number from 1 to 20. Defaults to `3`.
|
|
912
|
+
*/
|
|
913
|
+
readonly limit?: number | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* A campaign bounce rate over this is a bounce problem
|
|
916
|
+
*
|
|
917
|
+
* A number from 0 to 1. Defaults to `0.03`.
|
|
918
|
+
*/
|
|
919
|
+
readonly max_bounce_rate?: number | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* The most leads to read per active campaign, for leads left
|
|
922
|
+
*
|
|
923
|
+
* A whole number from 1 to 50,000. Defaults to `500`.
|
|
924
|
+
*/
|
|
925
|
+
readonly max_leads_per_campaign?: number | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* The fewest baseline days with data a day needs to be tested
|
|
928
|
+
*
|
|
929
|
+
* A whole number from 2 to 9,007,199,254,740,991. Defaults to `5`.
|
|
930
|
+
*/
|
|
931
|
+
readonly min_baseline_points?: number | undefined;
|
|
932
|
+
/**
|
|
933
|
+
* Campaigns under this many sends in the period are not judged
|
|
934
|
+
*
|
|
935
|
+
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `50`.
|
|
936
|
+
*/
|
|
937
|
+
readonly min_sent?: number | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* A campaign with this many days of leads left or fewer is flagged
|
|
940
|
+
*
|
|
941
|
+
* A number, 0 or more. Defaults to `7`.
|
|
942
|
+
*/
|
|
943
|
+
readonly runway_days?: number | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* @deprecated Renamed to `limit`. Removed in 0.5.0.
|
|
946
|
+
*
|
|
947
|
+
* A whole number from 1 to 20.
|
|
948
|
+
*/
|
|
949
|
+
readonly top?: number | undefined;
|
|
950
|
+
};
|
|
951
|
+
}
|