outbound-sdk 0.5.0 → 0.7.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/check-schema.d.ts +1 -1
- package/dist/alerts/index.js +6 -6
- package/dist/audit/index.js +2 -2
- package/dist/benchmarks/index.js +4 -4
- package/dist/budget/index.js +2 -2
- package/dist/cards/format.d.ts +1 -1
- package/dist/cards/index.js +101 -62
- package/dist/cards/parts.d.ts +1 -6
- package/dist/chunks/{chunk-BLCJHP5H.js → chunk-45TXPJW7.js} +1 -0
- package/dist/chunks/chunk-4AVYRVN5.js +239 -0
- package/dist/chunks/{chunk-YYCT3NGV.js → chunk-65YAGEWZ.js} +24 -7
- package/dist/chunks/{chunk-BN6WCAWX.js → chunk-7I3EPR23.js} +3 -3
- package/dist/chunks/{chunk-3S32R2MH.js → chunk-BNDHEDHD.js} +2 -53
- package/dist/chunks/chunk-DNPNTD5W.js +81 -0
- package/dist/chunks/chunk-FALWG5U3.js +56 -0
- package/dist/chunks/{chunk-OLPMBRXM.js → chunk-GL7BABF2.js} +2 -2
- package/dist/chunks/{chunk-ZOAG2C6V.js → chunk-HIAK2GCI.js} +9 -2
- package/dist/chunks/{chunk-6TKFISG4.js → chunk-I7DXXGNZ.js} +42 -9
- package/dist/chunks/{chunk-BK5SLY32.js → chunk-JRL3QRBS.js} +264 -76
- package/dist/chunks/{chunk-EHSJGQ5K.js → chunk-KTYTE2BU.js} +4 -3
- package/dist/chunks/{chunk-JWGSB7PT.js → chunk-LD6F46UT.js} +2 -2
- package/dist/chunks/{chunk-2D42TQFU.js → chunk-LVZGIKNF.js} +2 -2
- package/dist/chunks/{chunk-PQSTQKRD.js → chunk-M2VXGLLZ.js} +35 -2
- package/dist/chunks/{chunk-5J7GGV62.js → chunk-MW4C6LTN.js} +2 -2
- package/dist/chunks/chunk-OK3GAZMT.js +51 -0
- package/dist/chunks/{chunk-BOWXGMN3.js → chunk-POBAY3TI.js} +80 -4
- package/dist/chunks/{chunk-J7DDZ4C2.js → chunk-QFC4ZHD3.js} +1 -1
- package/dist/chunks/{chunk-GFDNRWR3.js → chunk-UFQ4WMLU.js} +1 -1
- package/dist/chunks/{chunk-WGW3ROLY.js → chunk-Y7KECJAV.js} +1 -1
- package/dist/chunks/{chunk-QAKJ76HB.js → chunk-YW6FFVSZ.js} +1 -1
- package/dist/chunks/{chunk-X4RDBD4J.js → chunk-ZJCVLBAE.js} +445 -119
- package/dist/cli/bin.js +14 -14
- package/dist/cli/by-name.d.ts +28 -0
- package/dist/cli/commands.d.ts +2 -1
- package/dist/cli/config.d.ts +3 -2
- package/dist/cli/envelope.d.ts +50 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.js +13 -13
- package/dist/cli/listing.d.ts +13 -0
- package/dist/cli/native.d.ts +4 -0
- package/dist/cli/options.d.ts +88 -0
- package/dist/cli/output.d.ts +21 -0
- package/dist/cli/suggest.d.ts +10 -0
- package/dist/clients/index.js +6 -6
- package/dist/combine/index.js +7 -7
- package/dist/emailbison/capabilities.d.ts +1 -0
- package/dist/emailbison/index.js +38 -13
- package/dist/emailbison/map-stats.d.ts +10 -0
- package/dist/exporter/index.js +2 -2
- package/dist/failover/index.js +2 -2
- package/dist/fixtures/index.js +4 -4
- package/dist/heyreach/capabilities.d.ts +3 -0
- package/dist/heyreach/index.js +36 -12
- package/dist/heyreach/map-account.d.ts +2 -2
- package/dist/identity/index.js +2 -2
- package/dist/index.js +9 -7
- package/dist/insights/copy/audit-samples.d.ts +24 -0
- package/dist/insights/copy/audit-variant.d.ts +34 -0
- package/dist/insights/copy/copy-audit.d.ts +26 -12
- package/dist/insights/copy/copy-preview.d.ts +71 -0
- package/dist/insights/copy/copy-reuse.d.ts +0 -13
- package/dist/insights/copy/index.d.ts +15 -0
- package/dist/insights/copy/reply-timing.d.ts +4 -0
- package/dist/insights/copy/reuse-base.d.ts +0 -2
- package/dist/insights/copy/shared.d.ts +7 -9
- package/dist/insights/copy/step-funnel.d.ts +21 -18
- package/dist/insights/copy/variant-test.d.ts +2 -8
- package/dist/insights/index.js +1357 -717
- package/dist/insights/inputs.generated.d.ts +67 -34
- package/dist/insights/ops/campaign-diagnosis.d.ts +2 -2
- package/dist/insights/ops/client-report.d.ts +0 -2
- package/dist/insights/ops/diagnosis-checks.d.ts +20 -1
- package/dist/insights/ops/index.d.ts +2 -4
- package/dist/insights/ops/pipeline-forecast.d.ts +17 -6
- package/dist/insights/ops/shared.d.ts +0 -2
- package/dist/insights/people/account-summary.d.ts +14 -1
- package/dist/insights/people/auto-replies.d.ts +14 -0
- package/dist/insights/people/dropped-replies.d.ts +1 -1
- package/dist/insights/people/hot-leads.d.ts +5 -1
- package/dist/insights/people/index.d.ts +4 -0
- package/dist/insights/people/lead-collisions.d.ts +11 -2
- package/dist/insights/people/person-summary.d.ts +19 -3
- package/dist/insights/people/personalization-gaps.d.ts +14 -8
- package/dist/insights/people/suppression-check.d.ts +9 -0
- package/dist/insights/registry.d.ts +20 -8
- package/dist/insights/senders/bounce-watch.d.ts +0 -11
- package/dist/insights/senders/domain-health.d.ts +0 -7
- package/dist/insights/senders/index.d.ts +0 -4
- package/dist/insights/senders/sender-load.d.ts +0 -2
- package/dist/insights/step.d.ts +15 -0
- package/dist/insights/types.d.ts +1 -1
- package/dist/insights/variables.d.ts +35 -0
- package/dist/instantly/capabilities.d.ts +4 -0
- package/dist/instantly/index.js +265 -53
- package/dist/instantly/map-stats.d.ts +4 -0
- package/dist/instantly/stats-tracking.d.ts +19 -0
- package/dist/instantly/thread.d.ts +9 -0
- package/dist/internal/adapter.d.ts +5 -0
- package/dist/internal/auto-reply.d.ts +20 -0
- package/dist/internal/capabilities.d.ts +2 -0
- package/dist/internal/entities-account.d.ts +1 -0
- package/dist/internal/entities.d.ts +79 -2
- package/dist/internal/fields.d.ts +37 -1
- package/dist/internal/metrics.d.ts +23 -1
- package/dist/internal/outbound/api.d.ts +2 -0
- package/dist/internal/records.d.ts +2 -2
- package/dist/internal/reply-people.d.ts +37 -0
- package/dist/internal/runway.d.ts +42 -0
- package/dist/internal/sender-screen.d.ts +9 -0
- package/dist/internal/tracking.d.ts +33 -0
- package/dist/loader/index.js +4 -4
- package/dist/memory/data.d.ts +2 -1
- package/dist/memory/index.js +23 -12
- package/dist/redact/index.js +3 -3
- package/dist/smartlead/capabilities.d.ts +4 -0
- package/dist/smartlead/index.js +154 -38
- package/dist/smartlead/map-account.d.ts +3 -0
- package/dist/smartlead/stats-tracking.d.ts +22 -0
- package/dist/sync/index.js +2 -2
- package/dist/tools/ai-sdk.js +8 -7
- package/dist/tools/by-name.d.ts +18 -0
- package/dist/tools/campaign-tools.d.ts +6 -2
- package/dist/tools/claude-agent.js +8 -7
- package/dist/tools/index.js +9 -8
- package/dist/tools/shared.d.ts +7 -0
- package/dist/tracing/index.js +2 -2
- package/dist/webhooks/index.js +12 -10
- package/package.json +1 -1
- package/dist/chunks/chunk-HWHI4LFY.js +0 -102
- package/dist/internal/renamed.d.ts +0 -28
|
@@ -19,6 +19,7 @@ export interface SuppressionCampaign {
|
|
|
19
19
|
readonly campaign: string;
|
|
20
20
|
readonly campaignName: string;
|
|
21
21
|
readonly leadsRead: number;
|
|
22
|
+
/** Leads whose status is in `lead_statuses` that are on the block list. */
|
|
22
23
|
readonly violations: number;
|
|
23
24
|
}
|
|
24
25
|
export interface SuppressionCheck {
|
|
@@ -28,6 +29,12 @@ export interface SuppressionCheck {
|
|
|
28
29
|
readonly byCampaign: readonly SuppressionCampaign[];
|
|
29
30
|
readonly totals: {
|
|
30
31
|
readonly violations: number;
|
|
32
|
+
/**
|
|
33
|
+
* Leads on the block list whose status is not in `lead_statuses`, so not
|
|
34
|
+
* counted as violations: most often they unsubscribed (which is why they
|
|
35
|
+
* are on the list), bounced or finished the sequence.
|
|
36
|
+
*/
|
|
37
|
+
readonly alreadyStopped: number;
|
|
31
38
|
readonly byMatch: {
|
|
32
39
|
readonly email: number;
|
|
33
40
|
readonly domain: number;
|
|
@@ -50,11 +57,13 @@ export interface SuppressionCheck {
|
|
|
50
57
|
};
|
|
51
58
|
}
|
|
52
59
|
export declare const suppressionCheck: import("../define.ts").InsightDefinition<"suppressionCheck", {
|
|
60
|
+
lead_statuses: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[];
|
|
53
61
|
max_block_entries: number;
|
|
54
62
|
max_campaigns: number;
|
|
55
63
|
max_leads_per_campaign: number;
|
|
56
64
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
57
65
|
}, SuppressionCheck, {
|
|
66
|
+
lead_statuses?: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[] | undefined;
|
|
58
67
|
max_block_entries?: number | undefined;
|
|
59
68
|
max_campaigns?: number | undefined;
|
|
60
69
|
max_leads_per_campaign?: number | undefined;
|
|
@@ -18,19 +18,23 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
18
18
|
max_leads?: number | undefined;
|
|
19
19
|
positive_labels?: string[] | undefined;
|
|
20
20
|
}>, import("./define.ts").InsightDefinition<"leadCollisions", {
|
|
21
|
+
include_past: boolean;
|
|
21
22
|
max_campaigns: number;
|
|
22
23
|
max_leads_per_campaign: number;
|
|
23
24
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
24
25
|
}, import("./people/lead-collisions.ts").LeadCollisions, {
|
|
26
|
+
include_past?: boolean | undefined;
|
|
25
27
|
max_campaigns?: number | undefined;
|
|
26
28
|
max_leads_per_campaign?: number | undefined;
|
|
27
29
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
28
30
|
}>, import("./define.ts").InsightDefinition<"suppressionCheck", {
|
|
31
|
+
lead_statuses: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[];
|
|
29
32
|
max_block_entries: number;
|
|
30
33
|
max_campaigns: number;
|
|
31
34
|
max_leads_per_campaign: number;
|
|
32
35
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
33
36
|
}, import("./people/suppression-check.ts").SuppressionCheck, {
|
|
37
|
+
lead_statuses?: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[] | undefined;
|
|
34
38
|
max_block_entries?: number | undefined;
|
|
35
39
|
max_campaigns?: number | undefined;
|
|
36
40
|
max_leads_per_campaign?: number | undefined;
|
|
@@ -110,7 +114,9 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
110
114
|
max_connection_chars: number;
|
|
111
115
|
max_exclamations: number;
|
|
112
116
|
max_links: number;
|
|
117
|
+
max_leads: number;
|
|
113
118
|
max_subject_chars: number;
|
|
119
|
+
samples: number;
|
|
114
120
|
spam_words: string[];
|
|
115
121
|
}, import("./copy/copy-audit.ts").CopyAudit, {
|
|
116
122
|
campaign: string;
|
|
@@ -119,8 +125,18 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
119
125
|
max_connection_chars?: number | undefined;
|
|
120
126
|
max_exclamations?: number | undefined;
|
|
121
127
|
max_links?: number | undefined;
|
|
128
|
+
max_leads?: number | undefined;
|
|
122
129
|
max_subject_chars?: number | undefined;
|
|
130
|
+
samples?: number | undefined;
|
|
123
131
|
spam_words?: string[] | undefined;
|
|
132
|
+
}>, import("./define.ts").InsightDefinition<"copyPreview", {
|
|
133
|
+
campaign: string;
|
|
134
|
+
lead: string | null;
|
|
135
|
+
max_leads: number;
|
|
136
|
+
}, import("./copy/copy-preview.ts").CopyPreview, {
|
|
137
|
+
campaign: string;
|
|
138
|
+
lead?: string | null | undefined;
|
|
139
|
+
max_leads?: number | undefined;
|
|
124
140
|
}>, import("./define.ts").InsightDefinition<"copyReuse", {
|
|
125
141
|
max_campaigns: number;
|
|
126
142
|
min_sent: number;
|
|
@@ -131,22 +147,22 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
131
147
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
132
148
|
}>, import("./define.ts").InsightDefinition<"replyTiming", {
|
|
133
149
|
campaign: string | null;
|
|
150
|
+
include_auto: boolean;
|
|
134
151
|
max_messages: number;
|
|
135
152
|
since: string | null;
|
|
136
153
|
timezone_offset_minutes: number;
|
|
137
154
|
}, import("./copy/reply-timing.ts").ReplyTiming, {
|
|
138
155
|
campaign?: string | null | undefined;
|
|
156
|
+
include_auto?: boolean | undefined;
|
|
139
157
|
max_messages?: number | undefined;
|
|
140
158
|
since?: string | null | undefined;
|
|
141
159
|
timezone_offset_minutes?: number | undefined;
|
|
142
160
|
}>, import("./define.ts").InsightDefinition<"domainHealth", {
|
|
143
161
|
max_senders: number;
|
|
144
162
|
max_spam_rate: number;
|
|
145
|
-
spam_rate_threshold?: number | undefined;
|
|
146
163
|
}, import("./senders/domain-health.ts").DomainHealth, {
|
|
147
164
|
max_senders?: number | undefined;
|
|
148
165
|
max_spam_rate?: number | undefined;
|
|
149
|
-
spam_rate_threshold?: number | undefined;
|
|
150
166
|
}>, import("./define.ts").InsightDefinition<"senderCapacity", {
|
|
151
167
|
days: number;
|
|
152
168
|
max_campaigns: number;
|
|
@@ -166,14 +182,12 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
166
182
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
167
183
|
from: string | null;
|
|
168
184
|
to: string | null;
|
|
169
|
-
threshold?: number | undefined;
|
|
170
185
|
}, import("./senders/bounce-watch.ts").BounceWatch, {
|
|
171
186
|
include_senders?: boolean | undefined;
|
|
172
187
|
max_bounce_rate?: number | undefined;
|
|
173
188
|
max_campaigns?: number | undefined;
|
|
174
189
|
max_senders_per_campaign?: number | undefined;
|
|
175
190
|
min_sent?: number | undefined;
|
|
176
|
-
threshold?: number | undefined;
|
|
177
191
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
178
192
|
from?: string | null | undefined;
|
|
179
193
|
to?: string | null | undefined;
|
|
@@ -219,6 +233,7 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
219
233
|
daily_limit_share: number;
|
|
220
234
|
max_bounce_rate: number;
|
|
221
235
|
max_send_drop: number;
|
|
236
|
+
max_leads: number;
|
|
222
237
|
max_senders: number;
|
|
223
238
|
min_positive_share: number;
|
|
224
239
|
min_reply_rate: number;
|
|
@@ -226,19 +241,18 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
226
241
|
min_weekly_hours: number;
|
|
227
242
|
from: string | null;
|
|
228
243
|
to: string | null;
|
|
229
|
-
recent_days?: number | undefined;
|
|
230
244
|
}, import("./ops/campaign-diagnosis.ts").CampaignDiagnosis, {
|
|
231
245
|
campaign: string;
|
|
232
246
|
days?: number | undefined;
|
|
233
247
|
daily_limit_share?: number | undefined;
|
|
234
248
|
max_bounce_rate?: number | undefined;
|
|
235
249
|
max_send_drop?: number | undefined;
|
|
250
|
+
max_leads?: number | undefined;
|
|
236
251
|
max_senders?: number | undefined;
|
|
237
252
|
min_positive_share?: number | undefined;
|
|
238
253
|
min_reply_rate?: number | undefined;
|
|
239
254
|
min_sent?: number | undefined;
|
|
240
255
|
min_weekly_hours?: number | undefined;
|
|
241
|
-
recent_days?: number | undefined;
|
|
242
256
|
from?: string | null | undefined;
|
|
243
257
|
to?: string | null | undefined;
|
|
244
258
|
}>, import("./define.ts").InsightDefinition<"pipelineForecast", {
|
|
@@ -326,7 +340,6 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
326
340
|
runway_days: number;
|
|
327
341
|
max_campaigns: number;
|
|
328
342
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
329
|
-
top?: number | undefined;
|
|
330
343
|
}, import("./ops/client-report.ts").ClientReport, {
|
|
331
344
|
alpha?: number | undefined;
|
|
332
345
|
anomaly_threshold?: number | undefined;
|
|
@@ -338,7 +351,6 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
338
351
|
min_baseline_points?: number | undefined;
|
|
339
352
|
min_sent?: number | undefined;
|
|
340
353
|
runway_days?: number | undefined;
|
|
341
|
-
top?: number | undefined;
|
|
342
354
|
max_campaigns?: number | undefined;
|
|
343
355
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
344
356
|
}>];
|
|
@@ -1,12 +1,9 @@
|
|
|
1
1
|
import type { Measured } from "../ops/shared.ts";
|
|
2
|
-
import type { Interval } from "../stats.ts";
|
|
3
2
|
export interface BounceCounts extends Measured {
|
|
4
3
|
readonly bounced: number;
|
|
5
4
|
readonly sent: number;
|
|
6
5
|
/** Bounced (`count`) divided by sent (`of`). `null` when nothing was sent. */
|
|
7
6
|
readonly rate: number | null;
|
|
8
|
-
/** @deprecated Use `low` and `high`, the Wilson interval of the rate. Removed in 0.6.0. */
|
|
9
|
-
readonly interval: Interval | null;
|
|
10
7
|
}
|
|
11
8
|
export interface BounceSender extends BounceCounts {
|
|
12
9
|
readonly sender: string;
|
|
@@ -16,8 +13,6 @@ export interface BounceSender extends BounceCounts {
|
|
|
16
13
|
export interface BounceCampaign extends BounceCounts {
|
|
17
14
|
readonly campaign: string;
|
|
18
15
|
readonly campaignName: string;
|
|
19
|
-
/** @deprecated Use `campaignName`. Removed in 0.6.0. */
|
|
20
|
-
readonly name: string;
|
|
21
16
|
readonly status: string;
|
|
22
17
|
readonly finding: string;
|
|
23
18
|
/**
|
|
@@ -30,8 +25,6 @@ export interface BounceCampaign extends BounceCounts {
|
|
|
30
25
|
export interface BounceUnknown {
|
|
31
26
|
readonly campaign: string;
|
|
32
27
|
readonly campaignName: string;
|
|
33
|
-
/** @deprecated Use `campaignName`. Removed in 0.6.0. */
|
|
34
|
-
readonly name: string;
|
|
35
28
|
readonly status: string;
|
|
36
29
|
readonly reason: string;
|
|
37
30
|
}
|
|
@@ -55,8 +48,6 @@ export interface BounceWatch {
|
|
|
55
48
|
};
|
|
56
49
|
/** The `max_bounce_rate` the campaigns were held to. */
|
|
57
50
|
readonly maxBounceRate: number;
|
|
58
|
-
/** @deprecated Use `maxBounceRate`. Removed in 0.6.0. */
|
|
59
|
-
readonly threshold: number;
|
|
60
51
|
readonly minSent: number;
|
|
61
52
|
/**
|
|
62
53
|
* Senders whose sent and bounce counts were read. `null` when senders were
|
|
@@ -73,14 +64,12 @@ export declare const bounceWatch: import("../define.ts").InsightDefinition<"boun
|
|
|
73
64
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
74
65
|
from: string | null;
|
|
75
66
|
to: string | null;
|
|
76
|
-
threshold?: number | undefined;
|
|
77
67
|
}, BounceWatch, {
|
|
78
68
|
include_senders?: boolean | undefined;
|
|
79
69
|
max_bounce_rate?: number | undefined;
|
|
80
70
|
max_campaigns?: number | undefined;
|
|
81
71
|
max_senders_per_campaign?: number | undefined;
|
|
82
72
|
min_sent?: number | undefined;
|
|
83
|
-
threshold?: number | undefined;
|
|
84
73
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
85
74
|
from?: string | null | undefined;
|
|
86
75
|
to?: string | null | undefined;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { Measured } from "../ops/shared.ts";
|
|
2
|
-
import type { Interval } from "../stats.ts";
|
|
3
2
|
import type { DnsRecord } from "./read.ts";
|
|
4
3
|
export type DomainRisk = "high" | "low" | "medium" | "unknown";
|
|
5
4
|
export interface DomainMailbox {
|
|
@@ -18,10 +17,6 @@ export interface DomainWarmup extends Measured {
|
|
|
18
17
|
readonly mailboxes: number;
|
|
19
18
|
readonly sent: number | null;
|
|
20
19
|
readonly spam: number | null;
|
|
21
|
-
/** @deprecated Use `rate`: warmup emails in spam (`count`) over those sent (`of`). Removed in 0.6.0. */
|
|
22
|
-
readonly spamRate: number | null;
|
|
23
|
-
/** @deprecated Use `low` and `high`. Removed in 0.6.0. */
|
|
24
|
-
readonly interval: Interval | null;
|
|
25
20
|
}
|
|
26
21
|
export interface DomainReport {
|
|
27
22
|
readonly domain: string;
|
|
@@ -67,9 +62,7 @@ export interface DomainHealth {
|
|
|
67
62
|
export declare const domainHealth: import("../define.ts").InsightDefinition<"domainHealth", {
|
|
68
63
|
max_senders: number;
|
|
69
64
|
max_spam_rate: number;
|
|
70
|
-
spam_rate_threshold?: number | undefined;
|
|
71
65
|
}, DomainHealth, {
|
|
72
66
|
max_senders?: number | undefined;
|
|
73
67
|
max_spam_rate?: number | undefined;
|
|
74
|
-
spam_rate_threshold?: number | undefined;
|
|
75
68
|
}>;
|
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
export declare const SENDERS_INSIGHTS: readonly [import("../define.ts").InsightDefinition<"domainHealth", {
|
|
2
2
|
max_senders: number;
|
|
3
3
|
max_spam_rate: number;
|
|
4
|
-
spam_rate_threshold?: number | undefined;
|
|
5
4
|
}, import("./domain-health.ts").DomainHealth, {
|
|
6
5
|
max_senders?: number | undefined;
|
|
7
6
|
max_spam_rate?: number | undefined;
|
|
8
|
-
spam_rate_threshold?: number | undefined;
|
|
9
7
|
}>, import("../define.ts").InsightDefinition<"senderCapacity", {
|
|
10
8
|
days: number;
|
|
11
9
|
max_campaigns: number;
|
|
@@ -25,14 +23,12 @@ export declare const SENDERS_INSIGHTS: readonly [import("../define.ts").InsightD
|
|
|
25
23
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
26
24
|
from: string | null;
|
|
27
25
|
to: string | null;
|
|
28
|
-
threshold?: number | undefined;
|
|
29
26
|
}, import("./bounce-watch.ts").BounceWatch, {
|
|
30
27
|
include_senders?: boolean | undefined;
|
|
31
28
|
max_bounce_rate?: number | undefined;
|
|
32
29
|
max_campaigns?: number | undefined;
|
|
33
30
|
max_senders_per_campaign?: number | undefined;
|
|
34
31
|
min_sent?: number | undefined;
|
|
35
|
-
threshold?: number | undefined;
|
|
36
32
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
37
33
|
from?: string | null | undefined;
|
|
38
34
|
to?: string | null | undefined;
|
|
@@ -16,8 +16,6 @@ export type CampaignSenderIssue = "inactive_sender" | "no_sender" | "single_send
|
|
|
16
16
|
export interface CampaignSenderRisk {
|
|
17
17
|
readonly campaign: string;
|
|
18
18
|
readonly campaignName: string;
|
|
19
|
-
/** @deprecated Use `campaignName`. Removed in 0.6.0. */
|
|
20
|
-
readonly name: string;
|
|
21
19
|
readonly senders: number;
|
|
22
20
|
readonly issues: readonly CampaignSenderIssue[];
|
|
23
21
|
/** The campaign's senders whose status is not active. */
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where a step sits in its sequence, counted both ways. Data compares
|
|
3
|
+
* `stepIndex`; prose and anything shown to a person uses `stepNumber`.
|
|
4
|
+
*/
|
|
5
|
+
export interface StepPosition {
|
|
6
|
+
/** Counted from 0, as the vendor and `Message.stepIndex` count: the first email is 0. */
|
|
7
|
+
readonly stepIndex: number;
|
|
8
|
+
/** Counted from 1, as a person counts: the first email is step 1. */
|
|
9
|
+
readonly stepNumber: number;
|
|
10
|
+
/** @deprecated Use `stepIndex` (the same value, counted from 0) or `stepNumber` (counted from 1). Removed in 0.8.0. */
|
|
11
|
+
readonly step: number;
|
|
12
|
+
}
|
|
13
|
+
export declare const stepAt: (index: number) => StepPosition;
|
|
14
|
+
/** A step for a sentence, from 1: `step 2 (of 4)`, or `step 2` when the length is unknown. */
|
|
15
|
+
export declare const stepLabel: (index: number, of?: number | null) => string;
|
package/dist/insights/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type { CheckCount, CheckName, CopyAudit, CopyFinding, CopyPiece, CopyReuse, CopyUse, FunnelStep, FunnelVariant, HourCount, ReplyTiming, ReusedCopy, Severity, StepFunnel, TestedVariant, TimeTable, VariantStepTest, VariantTest, VariantVerdict, WeekdayCount, } from "./copy/index.ts";
|
|
1
|
+
export type { CheckCount, CheckName, CopyAudit, CopyFinding, CopyPiece, CopyPreview, CopyText, CopyReuse, CopyUse, FunnelStep, FunnelVariant, HourCount, PreviewLead, PreviewStep, PreviewVariant, RenderedCopy, ReplyTiming, ReusedCopy, Severity, StepFunnel, TestedVariant, TimeTable, VariantStepTest, VariantTest, VariantVerdict, WeekdayCount, } from "./copy/index.ts";
|
|
2
2
|
export type { ActionItem, Anomalies, Anomaly, AnomalyMetric, BounceProblem, CampaignComparison, CampaignDiagnosis, CampaignLabel, CampaignRanking, ChannelComparison, ChannelGroup, ChannelMix, ClientReport, Comparison, DayRange, DiagnosisCode, DiagnosisFinding, Estimate, LeadRunway, Measured, MetricCoverage, OpenRange, PeriodComparison, PeriodNumbers, PipelineForecast, ProviderGroup, RankedCampaign, RankingGap, RankingMetric, Rates, TagGroup, TagRollup, ThinCampaign, Totals, UnrankedCampaign, } from "./ops/index.ts";
|
|
3
3
|
export type { AccountPerson, AccountRecord, AccountSummary, CollisionCampaign, CopyVariable, DroppedReplies, DroppedReply, GapLead, HotLead, HotLeadParts, HotLeads, LeadCollision, LeadCollisions, PersonCampaign, PersonSummary, PersonalizationGaps, SuppressionCampaign, SuppressionCheck, SuppressionMatch, SuppressionViolation, VariableUse, } from "./people/index.ts";
|
|
4
4
|
export type { AuditedCampaign, BounceCampaign, BounceCounts, BounceSender, BounceUnknown, BounceWatch, CampaignSenderIssue, CampaignSenderRisk, CapacityAsk, CapacitySends, CapacityTotals, DnsRecord, DomainHealth, DomainMailbox, DomainReport, DomainRisk, DomainWarmup, LinkedinSeat, LoadedSender, OverusedSender, ReadinessCounts, ReadinessReason, SenderCapacity, SenderLoad, SettingsAudit, SettingsCheck, SettingsCheckCounts, SettingsFinding, SettingsSeverity, ShortCampaign, UnreadySender, WarmupReadiness, } from "./senders/index.ts";
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Lead } from "../internal/entities.ts";
|
|
2
|
+
/** A variable's name lowercased, without spaces, underscores and hyphens. */
|
|
3
|
+
export declare const keyOf: (name: string) => string;
|
|
4
|
+
export declare const isBuiltin: (key: string) => boolean;
|
|
5
|
+
/** Whether the provider fills this variable from the sending account, not the lead. */
|
|
6
|
+
export declare const isSender: (provider: string, key: string) => boolean;
|
|
7
|
+
export interface VariableMatch {
|
|
8
|
+
/** The name as the copy writes it. */
|
|
9
|
+
readonly name: string;
|
|
10
|
+
/** The text after the `|`, or `null` when the variable has no fallback. */
|
|
11
|
+
readonly fallback: string | null;
|
|
12
|
+
/** The variable exactly as it appears in the copy. */
|
|
13
|
+
readonly raw: string;
|
|
14
|
+
readonly index: number;
|
|
15
|
+
}
|
|
16
|
+
/** Every variable in one text, in the order the patterns find them. */
|
|
17
|
+
export declare const variablesIn: (text: string) => VariableMatch[];
|
|
18
|
+
/**
|
|
19
|
+
* The lead's value for a variable: a built-in field, or a custom field of
|
|
20
|
+
* the same name without regard to case, spaces, underscores or hyphens.
|
|
21
|
+
* `null` when the lead has none or it is blank.
|
|
22
|
+
*/
|
|
23
|
+
export declare const valueOf: (lead: Lead, key: string) => string | null;
|
|
24
|
+
/** Every variable key a lead has a non-empty value for. */
|
|
25
|
+
export declare const keysWithValue: (lead: Lead) => Set<string>;
|
|
26
|
+
export interface Filled {
|
|
27
|
+
readonly text: string;
|
|
28
|
+
/** Variables left as written: no value and no fallback, as the copy writes them. */
|
|
29
|
+
readonly unfilled: readonly string[];
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* `text` with each variable replaced by the lead's value, or its fallback
|
|
33
|
+
* when the lead has none. A variable with neither is left as written.
|
|
34
|
+
*/
|
|
35
|
+
export declare const fillVariables: (text: string, lead: Lead) => Filled;
|
|
@@ -30,6 +30,9 @@ export declare const costs: {
|
|
|
30
30
|
perPage: number;
|
|
31
31
|
perWalk: number;
|
|
32
32
|
};
|
|
33
|
+
"campaigns.progress": {
|
|
34
|
+
perPage: number;
|
|
35
|
+
};
|
|
33
36
|
"campaigns.settings": {
|
|
34
37
|
perPage: number;
|
|
35
38
|
};
|
|
@@ -80,6 +83,7 @@ export declare const costs: {
|
|
|
80
83
|
};
|
|
81
84
|
stats: {
|
|
82
85
|
perPage: number;
|
|
86
|
+
perPageAtMost: number;
|
|
83
87
|
};
|
|
84
88
|
"tags.list": {
|
|
85
89
|
pageSize: number;
|