outbound-sdk 0.6.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/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/index.js +54 -44
- 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-3JOC5DGD.js → chunk-6NSCPTOY.js} +488 -127
- package/dist/chunks/{chunk-W22SDX6S.js → chunk-7I3EPR23.js} +3 -3
- package/dist/chunks/{chunk-MGR6HREO.js → chunk-BNDHEDHD.js} +2 -2
- package/dist/chunks/chunk-DNPNTD5W.js +81 -0
- package/dist/chunks/{chunk-53DCVFUB.js → chunk-FALWG5U3.js} +1 -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-SXGCKCAR.js → chunk-I7DXXGNZ.js} +40 -9
- package/dist/chunks/{chunk-BK5SLY32.js → chunk-JRL3QRBS.js} +264 -76
- package/dist/chunks/{chunk-PHNQ3WC2.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-UWUPUMM2.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-TFICTGM2.js → chunk-T5MJMW3R.js} +1 -1
- package/dist/chunks/{chunk-GFDNRWR3.js → chunk-UFQ4WMLU.js} +1 -1
- package/dist/chunks/{chunk-QAKJ76HB.js → chunk-YW6FFVSZ.js} +1 -1
- 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 +5 -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 +13 -1
- package/dist/cli/suggest.d.ts +10 -0
- package/dist/cli/update.d.ts +25 -2
- 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 -14
- 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 +34 -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 +16 -3
- package/dist/insights/copy/index.d.ts +6 -0
- package/dist/insights/copy/reply-timing.d.ts +4 -0
- package/dist/insights/copy/shared.d.ts +4 -1
- package/dist/insights/copy/step-funnel.d.ts +20 -6
- package/dist/insights/copy/variant-test.d.ts +2 -3
- package/dist/insights/index.js +1138 -589
- package/dist/insights/inputs.generated.d.ts +47 -11
- package/dist/insights/ops/campaign-diagnosis.d.ts +2 -0
- package/dist/insights/ops/diagnosis-checks.d.ts +20 -1
- package/dist/insights/ops/index.d.ts +2 -0
- package/dist/insights/ops/pipeline-forecast.d.ts +17 -6
- 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 +12 -0
- package/dist/insights/step.d.ts +15 -0
- package/dist/insights/variables.d.ts +2 -0
- package/dist/instantly/capabilities.d.ts +4 -0
- package/dist/instantly/index.js +263 -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 +152 -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 -11
- package/package.json +1 -1
- package/dist/chunks/chunk-HWHI4LFY.js +0 -102
|
@@ -50,6 +50,12 @@ export interface InsightInputs {
|
|
|
50
50
|
};
|
|
51
51
|
/** The input of `leadCollisions` (the `lead_collisions` tool). */
|
|
52
52
|
readonly leadCollisions: {
|
|
53
|
+
/**
|
|
54
|
+
* Also report a person in two or more campaigns of whom fewer than two memberships are still active, for example one who completed one campaign and is now in another. By default only people active in two or more campaigns at once are reported.
|
|
55
|
+
*
|
|
56
|
+
* Defaults to `false`.
|
|
57
|
+
*/
|
|
58
|
+
readonly include_past?: boolean | undefined;
|
|
53
59
|
/**
|
|
54
60
|
* The most campaigns to read. Each costs one request per page of its leads.
|
|
55
61
|
*
|
|
@@ -71,6 +77,12 @@ export interface InsightInputs {
|
|
|
71
77
|
};
|
|
72
78
|
/** The input of `suppressionCheck` (the `suppression_check` tool). */
|
|
73
79
|
readonly suppressionCheck: {
|
|
80
|
+
/**
|
|
81
|
+
* Only a matching lead in one of these states is a violation: active, paused, unknown (not yet started, or the tool does not say), completed, skipped (the tool decided never to send), replied, bounced or unsubscribed. Other matches are counted in totals.alreadyStopped. Defaults to the leads still being sent to.
|
|
82
|
+
*
|
|
83
|
+
* At least 1 item. Each one of `active`, `bounced`, `completed`, `paused`, `replied`, `skipped`, `unknown`, `unsubscribed`. Defaults to `["active","paused","unknown"]`.
|
|
84
|
+
*/
|
|
85
|
+
readonly lead_statuses?: ("active" | "bounced" | "completed" | "paused" | "replied" | "skipped" | "unknown" | "unsubscribed")[] | undefined;
|
|
74
86
|
/**
|
|
75
87
|
* The most block list entries to read. A vendor request returns about 50 to 100.
|
|
76
88
|
*
|
|
@@ -105,7 +117,7 @@ export interface InsightInputs {
|
|
|
105
117
|
*/
|
|
106
118
|
readonly categories?: ("bounce" | "negative" | "neutral" | "ooo" | "positive" | "unknown" | "unsubscribe")[] | undefined;
|
|
107
119
|
/**
|
|
108
|
-
* Set to true to also check replies the vendor
|
|
120
|
+
* Set to true to also check replies flagged automatic, by the vendor or by a fixed rule
|
|
109
121
|
*
|
|
110
122
|
* Defaults to `false`.
|
|
111
123
|
*/
|
|
@@ -201,7 +213,7 @@ export interface InsightInputs {
|
|
|
201
213
|
/** The input of `personalizationGaps` (the `personalization_gaps` tool). */
|
|
202
214
|
readonly personalizationGaps: {
|
|
203
215
|
/**
|
|
204
|
-
* The campaign's ref (provider:workspace:id)
|
|
216
|
+
* The campaign's ref (provider:workspace:id) or name
|
|
205
217
|
*
|
|
206
218
|
* Not empty. Required.
|
|
207
219
|
*/
|
|
@@ -222,7 +234,7 @@ export interface InsightInputs {
|
|
|
222
234
|
/** The input of `stepFunnel` (the `step_funnel` tool). */
|
|
223
235
|
readonly stepFunnel: {
|
|
224
236
|
/**
|
|
225
|
-
* The campaign's ref, for example `instantly:acme:abc123
|
|
237
|
+
* The campaign's ref, for example `instantly:acme:abc123`, or its name
|
|
226
238
|
*
|
|
227
239
|
* Not empty. Required.
|
|
228
240
|
*/
|
|
@@ -240,7 +252,7 @@ export interface InsightInputs {
|
|
|
240
252
|
*/
|
|
241
253
|
readonly to?: string | null | undefined;
|
|
242
254
|
/**
|
|
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.
|
|
255
|
+
* A step earns its place when the low end of its reply rate interval is above this and it has at least 5 replies. 0 asks only that the rate is reliably above zero.
|
|
244
256
|
*
|
|
245
257
|
* A number from 0 to 1. Defaults to `0`.
|
|
246
258
|
*/
|
|
@@ -255,7 +267,7 @@ export interface InsightInputs {
|
|
|
255
267
|
*/
|
|
256
268
|
readonly alpha?: number | undefined;
|
|
257
269
|
/**
|
|
258
|
-
* The campaign's ref, for example `instantly:acme:abc123
|
|
270
|
+
* The campaign's ref, for example `instantly:acme:abc123`, or its name
|
|
259
271
|
*
|
|
260
272
|
* Not empty. Required.
|
|
261
273
|
*/
|
|
@@ -288,7 +300,7 @@ export interface InsightInputs {
|
|
|
288
300
|
/** The input of `copyAudit` (the `copy_audit` tool). */
|
|
289
301
|
readonly copyAudit: {
|
|
290
302
|
/**
|
|
291
|
-
* The campaign's ref, for example `instantly:acme:abc123
|
|
303
|
+
* The campaign's ref, for example `instantly:acme:abc123`, or its name
|
|
292
304
|
*
|
|
293
305
|
* Not empty. Required.
|
|
294
306
|
*/
|
|
@@ -323,12 +335,24 @@ export interface InsightInputs {
|
|
|
323
335
|
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `1`.
|
|
324
336
|
*/
|
|
325
337
|
readonly max_links?: number | undefined;
|
|
338
|
+
/**
|
|
339
|
+
* The most leads to read when picking the samples. Read only when copy is written per lead.
|
|
340
|
+
*
|
|
341
|
+
* A whole number from 1 to 1000. Defaults to `100`.
|
|
342
|
+
*/
|
|
343
|
+
readonly max_leads?: number | undefined;
|
|
326
344
|
/**
|
|
327
345
|
* The most characters a subject may have.
|
|
328
346
|
*
|
|
329
347
|
* A whole number from 0 to 9,007,199,254,740,991. Defaults to `60`.
|
|
330
348
|
*/
|
|
331
349
|
readonly max_subject_chars?: number | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* How many leads' rendered copy to audit when a subject or body is mostly variables, such as {{body_1}} filled from a custom field. The leads that fill the most of those variables are used. 0 audits the copy as stored only.
|
|
352
|
+
*
|
|
353
|
+
* A whole number from 0 to 20. Defaults to `3`.
|
|
354
|
+
*/
|
|
355
|
+
readonly samples?: number | undefined;
|
|
332
356
|
/**
|
|
333
357
|
* Words and phrases to flag in email copy, matched whole and without case. Replaces the default list.
|
|
334
358
|
*
|
|
@@ -339,7 +363,7 @@ export interface InsightInputs {
|
|
|
339
363
|
/** The input of `copyPreview` (the `copy_preview` tool). */
|
|
340
364
|
readonly copyPreview: {
|
|
341
365
|
/**
|
|
342
|
-
* The campaign's ref, for example `instantly:acme:abc123
|
|
366
|
+
* The campaign's ref, for example `instantly:acme:abc123`, or its name
|
|
343
367
|
*
|
|
344
368
|
* Not empty. Required.
|
|
345
369
|
*/
|
|
@@ -386,6 +410,12 @@ export interface InsightInputs {
|
|
|
386
410
|
* Not empty. Defaults to `null`.
|
|
387
411
|
*/
|
|
388
412
|
readonly campaign?: string | null | undefined;
|
|
413
|
+
/**
|
|
414
|
+
* Count replies flagged automatic (isAuto true), such as out-of-office messages and autoresponders. false leaves them out of every figure and counts them in counts.autoReplies.
|
|
415
|
+
*
|
|
416
|
+
* Defaults to `false`.
|
|
417
|
+
*/
|
|
418
|
+
readonly include_auto?: boolean | undefined;
|
|
389
419
|
/**
|
|
390
420
|
* The most messages to read, sent and received together. A page of messages costs 1 request.
|
|
391
421
|
*
|
|
@@ -612,7 +642,7 @@ export interface InsightInputs {
|
|
|
612
642
|
*/
|
|
613
643
|
readonly to?: string | null | undefined;
|
|
614
644
|
/**
|
|
615
|
-
* The campaign's ref
|
|
645
|
+
* The campaign's ref or name
|
|
616
646
|
*
|
|
617
647
|
* At least 3 characters. Required.
|
|
618
648
|
*/
|
|
@@ -642,9 +672,15 @@ export interface InsightInputs {
|
|
|
642
672
|
*/
|
|
643
673
|
readonly max_send_drop?: number | undefined;
|
|
644
674
|
/**
|
|
645
|
-
* The most
|
|
675
|
+
* The most leads to read when sends fell or stopped, to tell lead runout from a fault. A page of leads is one request.
|
|
646
676
|
*
|
|
647
|
-
* A whole number from 1 to
|
|
677
|
+
* A whole number from 1 to 50,000. Defaults to `2000`.
|
|
678
|
+
*/
|
|
679
|
+
readonly max_leads?: number | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* The most of the campaign's own senders to read and screen for a status that is not active or a warmup score of 0
|
|
682
|
+
*
|
|
683
|
+
* A whole number from 1 to 500. Defaults to `500`.
|
|
648
684
|
*/
|
|
649
685
|
readonly max_senders?: number | undefined;
|
|
650
686
|
/**
|
|
@@ -675,7 +711,7 @@ export interface InsightInputs {
|
|
|
675
711
|
/** The input of `pipelineForecast` (the `pipeline_forecast` tool). */
|
|
676
712
|
readonly pipelineForecast: {
|
|
677
713
|
/**
|
|
678
|
-
* The campaign's ref
|
|
714
|
+
* The campaign's ref or name
|
|
679
715
|
*
|
|
680
716
|
* At least 3 characters. Required.
|
|
681
717
|
*/
|
|
@@ -16,6 +16,7 @@ export declare const campaignDiagnosis: import("../define.ts").InsightDefinition
|
|
|
16
16
|
daily_limit_share: number;
|
|
17
17
|
max_bounce_rate: number;
|
|
18
18
|
max_send_drop: number;
|
|
19
|
+
max_leads: number;
|
|
19
20
|
max_senders: number;
|
|
20
21
|
min_positive_share: number;
|
|
21
22
|
min_reply_rate: number;
|
|
@@ -29,6 +30,7 @@ export declare const campaignDiagnosis: import("../define.ts").InsightDefinition
|
|
|
29
30
|
daily_limit_share?: number | undefined;
|
|
30
31
|
max_bounce_rate?: number | undefined;
|
|
31
32
|
max_send_drop?: number | undefined;
|
|
33
|
+
max_leads?: number | undefined;
|
|
32
34
|
max_senders?: number | undefined;
|
|
33
35
|
min_positive_share?: number | undefined;
|
|
34
36
|
min_reply_rate?: number | undefined;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { CampaignSettings } from "../../internal/entities-account.ts";
|
|
2
2
|
import type { Campaign, Sender } from "../../internal/entities.ts";
|
|
3
3
|
import type { Rates, Totals } from "./shared.ts";
|
|
4
|
-
export type DiagnosisCode = "falling_sends" | "few_positive_replies" | "high_bounce_rate" | "inactive_sender" | "low_reply_rate" | "no_recent_sends" | "schedule_limits_volume" | "short_sequence" | "too_little_volume" | "tracking_off";
|
|
4
|
+
export type DiagnosisCode = "contacted_exceeds_leads" | "falling_sends" | "few_positive_replies" | "high_bounce_rate" | "inactive_sender" | "low_reply_rate" | "no_recent_sends" | "out_of_leads" | "schedule_limits_volume" | "short_sequence" | "too_little_volume" | "tracking_off";
|
|
5
5
|
export interface DiagnosisFinding {
|
|
6
6
|
readonly code: DiagnosisCode;
|
|
7
7
|
readonly severity: "high" | "low" | "medium";
|
|
@@ -20,6 +20,19 @@ export interface RecentSends {
|
|
|
20
20
|
readonly before: number | null;
|
|
21
21
|
/** Days in the recent window the vendor reports a send count for. */
|
|
22
22
|
readonly daysWithData: number;
|
|
23
|
+
/** New leads started per day in the last `days`. `null` when the vendor reports no daily contacted count. */
|
|
24
|
+
readonly startedPerDay: number | null;
|
|
25
|
+
}
|
|
26
|
+
/** The campaign's leads, read only when its sends fell or stopped. */
|
|
27
|
+
export interface LeadsLeft {
|
|
28
|
+
/** Active leads: not replied, bounced, unsubscribed, paused or finished. */
|
|
29
|
+
readonly active: number;
|
|
30
|
+
/** Active leads whose sequence has not started, or every active lead when the vendor does not say. */
|
|
31
|
+
readonly toStart: number;
|
|
32
|
+
/** Active leads partway through the sequence. `null` when the vendor does not say. */
|
|
33
|
+
readonly inSequence: number | null;
|
|
34
|
+
/** Days until no lead is left to start, at `startedPerDay`. `null` when it cannot be known. */
|
|
35
|
+
readonly daysLeft: number | null;
|
|
23
36
|
}
|
|
24
37
|
/** What was read about the campaign. A part that could not be read is `null`. */
|
|
25
38
|
export interface Facts {
|
|
@@ -32,6 +45,10 @@ export interface Facts {
|
|
|
32
45
|
readonly steps: number | null;
|
|
33
46
|
readonly senders: readonly Sender[] | null;
|
|
34
47
|
readonly recent: RecentSends | null;
|
|
48
|
+
/** Read only when sends fell or stopped, every lead was read and the vendor listed some. */
|
|
49
|
+
readonly leads: LeadsLeft | null;
|
|
50
|
+
/** Every lead in the campaign, from its progress. `null` when not read. */
|
|
51
|
+
readonly campaignLeads: number | null;
|
|
35
52
|
}
|
|
36
53
|
export interface Limits {
|
|
37
54
|
readonly minReplyRate: number;
|
|
@@ -42,6 +59,8 @@ export interface Limits {
|
|
|
42
59
|
readonly minWeeklyHours: number;
|
|
43
60
|
readonly dailyLimitShare: number;
|
|
44
61
|
}
|
|
62
|
+
/** Whether the recent sends fell or stopped enough to be a finding, so the leads left are worth reading. */
|
|
63
|
+
export declare const sendsFellOrStopped: (campaign: Campaign, recent: RecentSends | null, limits: Pick<Limits, "maxSendDrop">) => boolean;
|
|
45
64
|
/** Every finding, most serious first. */
|
|
46
65
|
export declare const diagnose: (facts: Facts, limits: Limits) => DiagnosisFinding[];
|
|
47
66
|
/** Rates that could not be judged because the vendor reports no count for them. */
|
|
@@ -4,6 +4,7 @@ export declare const OPS_INSIGHTS: readonly [import("../define.ts").InsightDefin
|
|
|
4
4
|
daily_limit_share: number;
|
|
5
5
|
max_bounce_rate: number;
|
|
6
6
|
max_send_drop: number;
|
|
7
|
+
max_leads: number;
|
|
7
8
|
max_senders: number;
|
|
8
9
|
min_positive_share: number;
|
|
9
10
|
min_reply_rate: number;
|
|
@@ -17,6 +18,7 @@ export declare const OPS_INSIGHTS: readonly [import("../define.ts").InsightDefin
|
|
|
17
18
|
daily_limit_share?: number | undefined;
|
|
18
19
|
max_bounce_rate?: number | undefined;
|
|
19
20
|
max_send_drop?: number | undefined;
|
|
21
|
+
max_leads?: number | undefined;
|
|
20
22
|
max_senders?: number | undefined;
|
|
21
23
|
min_positive_share?: number | undefined;
|
|
22
24
|
min_reply_rate?: number | undefined;
|
|
@@ -14,15 +14,26 @@ export interface PipelineForecast extends CampaignLabel {
|
|
|
14
14
|
/** `false` when `max_leads` stopped the read, so `remaining` is a minimum. */
|
|
15
15
|
readonly leadsComplete: boolean;
|
|
16
16
|
readonly byStatus: Readonly<Record<LeadStatus, number>>;
|
|
17
|
-
/** Leads still active in the campaign: not replied, bounced, unsubscribed, paused or finished. */
|
|
17
|
+
/** Leads still active in the campaign: not replied, bounced, unsubscribed, paused, skipped or finished. */
|
|
18
18
|
readonly remaining: number;
|
|
19
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Active leads whose sequence has not started: no step sent, no contact.
|
|
21
|
+
* `null` when the vendor reports neither for any lead read.
|
|
22
|
+
*/
|
|
23
|
+
readonly notStarted: number | null;
|
|
24
|
+
/** Active leads partway through the sequence. `null` with `notStarted`. */
|
|
25
|
+
readonly inSequence: number | null;
|
|
26
|
+
/**
|
|
27
|
+
* New leads started per day over the last `days`: the daily `contacted`
|
|
28
|
+
* count, never emails sent. `null` when the vendor has no daily contacted count.
|
|
29
|
+
*/
|
|
20
30
|
readonly dailyContactRate: number | null;
|
|
21
31
|
/**
|
|
22
|
-
* `remaining`
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* no
|
|
32
|
+
* `notStarted` (or `remaining` when that is `null`) divided by
|
|
33
|
+
* `dailyContactRate`, and `0` when every lead was read and none is left to
|
|
34
|
+
* start. `null` when the leads left are unknown (the cap stopped the read,
|
|
35
|
+
* or a lead's status is unknown) or some are left with no pace to divide by.
|
|
36
|
+
* `lead_runway` returns the same figure as `runway_days`.
|
|
26
37
|
*/
|
|
27
38
|
readonly daysLeft: number | null;
|
|
28
39
|
/** The campaign's reply rate so far, over its whole history. */
|
|
@@ -39,6 +39,16 @@ export interface AccountPerson {
|
|
|
39
39
|
}
|
|
40
40
|
export interface AccountSummary {
|
|
41
41
|
readonly domain: string;
|
|
42
|
+
/**
|
|
43
|
+
* `search` when the tool found the domain's leads itself (`leads.byDomain`),
|
|
44
|
+
* `scan` when leads were read in order and matched here, up to `max_leads`.
|
|
45
|
+
*/
|
|
46
|
+
readonly foundBy: "scan" | "search";
|
|
47
|
+
/**
|
|
48
|
+
* One sentence on who was found. When a scan stopped with leads unread, it
|
|
49
|
+
* says that nobody matching does not mean nobody at the company is there.
|
|
50
|
+
*/
|
|
51
|
+
readonly finding: string;
|
|
42
52
|
/** Sorted by most recent reply, then people who replied at an unknown time, then the rest by email. */
|
|
43
53
|
readonly people: readonly AccountPerson[];
|
|
44
54
|
readonly totals: {
|
|
@@ -49,7 +59,10 @@ export interface AccountSummary {
|
|
|
49
59
|
readonly interested: number;
|
|
50
60
|
/** Leads looked at to find them. */
|
|
51
61
|
readonly leadsRead: number;
|
|
52
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* Leads with no email address, which a domain cannot match. A search by
|
|
64
|
+
* domain never returns them, so it is then 0.
|
|
65
|
+
*/
|
|
53
66
|
readonly leadsWithoutEmail: number;
|
|
54
67
|
/**
|
|
55
68
|
* `true` when `max_leads` or `max_campaigns` stopped the read with more
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Lead } from "../../internal/entities.ts";
|
|
2
|
+
import type { InsightContext } from "../define.ts";
|
|
3
|
+
/** The most replies read to find leads whose replies were all automatic. */
|
|
4
|
+
export declare const AUTO_CHECK_REPLIES = 200;
|
|
5
|
+
/** A lead's own ref and, when it has an address, the ref a reply may name it by. */
|
|
6
|
+
export declare const refsOf: (lead: Lead) => string[];
|
|
7
|
+
/**
|
|
8
|
+
* The refs of leads whose every reply read is flagged automatic, by the
|
|
9
|
+
* vendor or by a fixed rule. A lead with one reply not flagged is not in it,
|
|
10
|
+
* nor is a lead none of whose replies were read. Reads at most
|
|
11
|
+
* `AUTO_CHECK_REPLIES` replies, newest first, and nothing when no lead
|
|
12
|
+
* counted replies or the tool cannot list replies.
|
|
13
|
+
*/
|
|
14
|
+
export declare const autoOnlyRefs: (context: InsightContext, campaign: string | null, leads: readonly Lead[]) => Promise<ReadonlySet<string>>;
|
|
@@ -28,7 +28,7 @@ export interface DroppedReplies {
|
|
|
28
28
|
readonly repliesRead: number;
|
|
29
29
|
/** Left out for a category that needs no answer. */
|
|
30
30
|
readonly skippedByCategory: number;
|
|
31
|
-
/** Left out because the vendor
|
|
31
|
+
/** Left out because they are flagged automatic, by the vendor or by a fixed rule. */
|
|
32
32
|
readonly skippedAuto: number;
|
|
33
33
|
/** Conversations the remaining replies belong to. */
|
|
34
34
|
readonly conversations: number;
|
|
@@ -49,7 +49,11 @@ export interface HotLeads {
|
|
|
49
49
|
readonly moreLeadsExist: boolean;
|
|
50
50
|
/** Leads past the cap, read because they replied within `recency_days`. Counted in `leadsRead`. */
|
|
51
51
|
readonly fromReplies: number;
|
|
52
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* Leads with replies that earned no points because they were automatic:
|
|
54
|
+
* the vendor labels the lead out-of-office or bounced, or every reply of
|
|
55
|
+
* the lead read was flagged automatic.
|
|
56
|
+
*/
|
|
53
57
|
readonly autoReplied: number;
|
|
54
58
|
/** Leads the vendor labels negative, such as not interested or wrong person, which earn no points at all and are listed after every lead with a score above 0. A label in `positive_labels` is not counted here. */
|
|
55
59
|
readonly negative: number;
|
|
@@ -17,19 +17,23 @@ export declare const PEOPLE_INSIGHTS: readonly [import("../define.ts").InsightDe
|
|
|
17
17
|
max_leads?: number | undefined;
|
|
18
18
|
positive_labels?: string[] | undefined;
|
|
19
19
|
}>, import("../define.ts").InsightDefinition<"leadCollisions", {
|
|
20
|
+
include_past: boolean;
|
|
20
21
|
max_campaigns: number;
|
|
21
22
|
max_leads_per_campaign: number;
|
|
22
23
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
23
24
|
}, import("./lead-collisions.ts").LeadCollisions, {
|
|
25
|
+
include_past?: boolean | undefined;
|
|
24
26
|
max_campaigns?: number | undefined;
|
|
25
27
|
max_leads_per_campaign?: number | undefined;
|
|
26
28
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
27
29
|
}>, import("../define.ts").InsightDefinition<"suppressionCheck", {
|
|
30
|
+
lead_statuses: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[];
|
|
28
31
|
max_block_entries: number;
|
|
29
32
|
max_campaigns: number;
|
|
30
33
|
max_leads_per_campaign: number;
|
|
31
34
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
32
35
|
}, import("./suppression-check.ts").SuppressionCheck, {
|
|
36
|
+
lead_statuses?: ("active" | "completed" | "paused" | "unknown" | "bounced" | "replied" | "skipped" | "unsubscribed")[] | undefined;
|
|
33
37
|
max_block_entries?: number | undefined;
|
|
34
38
|
max_campaigns?: number | undefined;
|
|
35
39
|
max_leads_per_campaign?: number | undefined;
|
|
@@ -10,7 +10,7 @@ export interface LeadCollision {
|
|
|
10
10
|
/** Every exact identifier the person's records carry, as `email:` or `linkedin:` keys. */
|
|
11
11
|
readonly identifiers: readonly string[];
|
|
12
12
|
readonly campaignCount: number;
|
|
13
|
-
/** Campaigns in which the lead's own status is still `active`. */
|
|
13
|
+
/** Campaigns in which the lead's own status is still `active`. Two or more means the outreach overlaps now. */
|
|
14
14
|
readonly stillActive: number;
|
|
15
15
|
/** `across_tools` when the campaigns are in more than one tool, otherwise `within_tool`. */
|
|
16
16
|
readonly scope: "across_tools" | "within_tool";
|
|
@@ -20,10 +20,17 @@ export interface LeadCollision {
|
|
|
20
20
|
readonly finding: string;
|
|
21
21
|
}
|
|
22
22
|
export interface LeadCollisions {
|
|
23
|
-
/** Most campaigns first, then collisions across tools, then by identifier. */
|
|
23
|
+
/** Most active campaigns first, then most campaigns, then collisions across tools, then by identifier. */
|
|
24
24
|
readonly collisions: readonly LeadCollision[];
|
|
25
25
|
readonly totals: {
|
|
26
26
|
readonly collisions: number;
|
|
27
|
+
/** Collisions returned in which two or more memberships are still active. */
|
|
28
|
+
readonly concurrent: number;
|
|
29
|
+
/**
|
|
30
|
+
* People in two or more campaigns of whom fewer than two memberships are
|
|
31
|
+
* still active. They are in `collisions` only with `include_past`.
|
|
32
|
+
*/
|
|
33
|
+
readonly pastOverlaps: number;
|
|
27
34
|
readonly acrossTools: number;
|
|
28
35
|
readonly withinTool: number;
|
|
29
36
|
readonly campaignsRead: number;
|
|
@@ -33,10 +40,12 @@ export interface LeadCollisions {
|
|
|
33
40
|
};
|
|
34
41
|
}
|
|
35
42
|
export declare const leadCollisions: import("../define.ts").InsightDefinition<"leadCollisions", {
|
|
43
|
+
include_past: boolean;
|
|
36
44
|
max_campaigns: number;
|
|
37
45
|
max_leads_per_campaign: number;
|
|
38
46
|
statuses: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[];
|
|
39
47
|
}, LeadCollisions, {
|
|
48
|
+
include_past?: boolean | undefined;
|
|
40
49
|
max_campaigns?: number | undefined;
|
|
41
50
|
max_leads_per_campaign?: number | undefined;
|
|
42
51
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
@@ -5,21 +5,37 @@ export interface PersonCampaign {
|
|
|
5
5
|
readonly channel: "email" | "linkedin";
|
|
6
6
|
readonly provider: string;
|
|
7
7
|
readonly lead: string;
|
|
8
|
+
/**
|
|
9
|
+
* The lead's status, agreeing with `replied`: when the vendor says
|
|
10
|
+
* `replied` only because of automatic replies, this is where the lead is in
|
|
11
|
+
* the sequence instead, and `vendorLeadStatus` keeps the vendor's word.
|
|
12
|
+
*/
|
|
8
13
|
readonly leadStatus: string;
|
|
14
|
+
/** The lead's status as the vendor's record gives it, before automatic replies are set aside. */
|
|
15
|
+
readonly vendorLeadStatus: string;
|
|
9
16
|
/** The vendor's own label, for example `Interested`. */
|
|
10
17
|
readonly interest: string | null;
|
|
11
18
|
readonly messagesSent: number;
|
|
12
|
-
/** Replies from the person
|
|
19
|
+
/** Replies from the person, not counting replies flagged automatic. 0 when `autoReplied`. */
|
|
13
20
|
readonly replies: number;
|
|
14
21
|
readonly replied: boolean;
|
|
15
22
|
/**
|
|
16
|
-
* `true` when the vendor labels the lead out-of-office or bounced
|
|
17
|
-
*
|
|
23
|
+
* `true` when the vendor labels the lead out-of-office or bounced, or when
|
|
24
|
+
* every reply in the thread is flagged automatic (by the vendor or a fixed
|
|
25
|
+
* rule): its replies are not counted as the person replying.
|
|
18
26
|
*/
|
|
19
27
|
readonly autoReplied: boolean;
|
|
20
28
|
/** Steps the person replied to, counted from 0. Empty when the vendor does not tie a reply to a step. */
|
|
29
|
+
readonly repliedStepIndexes: readonly number[];
|
|
30
|
+
/** `repliedStepIndexes` counted from 1, as a person counts: `[2]` is the second email. */
|
|
31
|
+
readonly repliedStepNumbers: readonly number[];
|
|
32
|
+
/** @deprecated Use `repliedStepIndexes` (the same values, counted from 0) or `repliedStepNumbers`. Removed in 0.8.0. */
|
|
21
33
|
readonly repliedSteps: readonly number[];
|
|
22
34
|
/** The last step sent, counted from 0. */
|
|
35
|
+
readonly lastStepIndex: number | null;
|
|
36
|
+
/** `lastStepIndex` counted from 1, as a person counts. */
|
|
37
|
+
readonly lastStepNumber: number | null;
|
|
38
|
+
/** @deprecated Use `lastStepIndex` (the same value, counted from 0) or `lastStepNumber`. Removed in 0.8.0. */
|
|
23
39
|
readonly lastStep: number | null;
|
|
24
40
|
readonly firstContactedAt: string | null;
|
|
25
41
|
readonly lastContactedAt: string | null;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
readonly step: number;
|
|
1
|
+
import type { StepPosition } from "../step.ts";
|
|
2
|
+
export interface VariableUse extends StepPosition {
|
|
4
3
|
readonly variant: string;
|
|
5
4
|
readonly field: "body" | "subject";
|
|
6
5
|
readonly fallback: boolean;
|
|
@@ -12,16 +11,23 @@ export interface CopyVariable {
|
|
|
12
11
|
* `builtin` for first name, last name, company, title and email; `custom`
|
|
13
12
|
* when a lead read has a custom field of that name; `unknown` when no
|
|
14
13
|
* lead read has it, which is a sender or system variable the tool fills
|
|
15
|
-
* itself, or a field nobody has.
|
|
14
|
+
* itself, or a field nobody has. A sender variable also has `sender: true`.
|
|
16
15
|
*/
|
|
17
16
|
readonly source: "builtin" | "custom" | "unknown";
|
|
18
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* `true` when the tool fills it from the sending account at send time,
|
|
19
|
+
* such as Instantly's `{{accountSignature}}`: not a lead field, and not
|
|
20
|
+
* listed in `unknownVariables`. Its `source` is `unknown`. Always set;
|
|
21
|
+
* optional in the type so a variable built by hand still fits.
|
|
22
|
+
*/
|
|
23
|
+
readonly sender?: boolean;
|
|
24
|
+
/** `true` when at least one lead read gets broken copy from it, so `leadsAffected` is above 0. */
|
|
19
25
|
readonly gap: boolean;
|
|
20
26
|
readonly steps: readonly number[];
|
|
21
27
|
readonly uses: readonly VariableUse[];
|
|
22
|
-
/** Leads read with no value for it. `null` for
|
|
28
|
+
/** Leads read with no value for it. `null` for a sender or unknown variable. */
|
|
23
29
|
readonly leadsWithoutValue: number | null;
|
|
24
|
-
/** Leads who get broken copy from it: 0 when every use has a fallback. `null` for
|
|
30
|
+
/** Leads who get broken copy from it: 0 when every use has a fallback. `null` for a sender or unknown variable. */
|
|
25
31
|
readonly leadsAffected: number | null;
|
|
26
32
|
}
|
|
27
33
|
export interface GapLead {
|
|
@@ -38,7 +44,7 @@ export interface PersonalizationGaps {
|
|
|
38
44
|
readonly variables: readonly CopyVariable[];
|
|
39
45
|
/** Leads missing at least one variable, most missing first, up to `limit`. */
|
|
40
46
|
readonly leads: readonly GapLead[];
|
|
41
|
-
/** Variables no lead read has a value for and that are
|
|
47
|
+
/** Variables no lead read has a value for and that are neither built in nor filled from the sender. Check them by hand. */
|
|
42
48
|
readonly unknownVariables: readonly string[];
|
|
43
49
|
readonly totals: {
|
|
44
50
|
readonly steps: number;
|
|
@@ -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,7 +125,9 @@ 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;
|
|
124
132
|
}>, import("./define.ts").InsightDefinition<"copyPreview", {
|
|
125
133
|
campaign: string;
|
|
@@ -139,11 +147,13 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
139
147
|
statuses?: ("active" | "archived" | "completed" | "draft" | "paused" | "unknown")[] | undefined;
|
|
140
148
|
}>, import("./define.ts").InsightDefinition<"replyTiming", {
|
|
141
149
|
campaign: string | null;
|
|
150
|
+
include_auto: boolean;
|
|
142
151
|
max_messages: number;
|
|
143
152
|
since: string | null;
|
|
144
153
|
timezone_offset_minutes: number;
|
|
145
154
|
}, import("./copy/reply-timing.ts").ReplyTiming, {
|
|
146
155
|
campaign?: string | null | undefined;
|
|
156
|
+
include_auto?: boolean | undefined;
|
|
147
157
|
max_messages?: number | undefined;
|
|
148
158
|
since?: string | null | undefined;
|
|
149
159
|
timezone_offset_minutes?: number | undefined;
|
|
@@ -223,6 +233,7 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
223
233
|
daily_limit_share: number;
|
|
224
234
|
max_bounce_rate: number;
|
|
225
235
|
max_send_drop: number;
|
|
236
|
+
max_leads: number;
|
|
226
237
|
max_senders: number;
|
|
227
238
|
min_positive_share: number;
|
|
228
239
|
min_reply_rate: number;
|
|
@@ -236,6 +247,7 @@ export declare const INSIGHTS: readonly [import("./define.ts").InsightDefinition
|
|
|
236
247
|
daily_limit_share?: number | undefined;
|
|
237
248
|
max_bounce_rate?: number | undefined;
|
|
238
249
|
max_send_drop?: number | undefined;
|
|
250
|
+
max_leads?: number | undefined;
|
|
239
251
|
max_senders?: number | undefined;
|
|
240
252
|
min_positive_share?: number | undefined;
|
|
241
253
|
min_reply_rate?: number | undefined;
|
|
@@ -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;
|
|
@@ -2,6 +2,8 @@ import type { Lead } from "../internal/entities.ts";
|
|
|
2
2
|
/** A variable's name lowercased, without spaces, underscores and hyphens. */
|
|
3
3
|
export declare const keyOf: (name: string) => string;
|
|
4
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;
|
|
5
7
|
export interface VariableMatch {
|
|
6
8
|
/** The name as the copy writes it. */
|
|
7
9
|
readonly name: string;
|