outbound-sdk 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +121 -2
- package/dist/alerts/index.d.ts +2 -0
- package/dist/alerts/index.js +136 -0
- package/dist/alerts/plugin.d.ts +58 -0
- package/dist/audit/index.d.ts +33 -0
- package/dist/audit/index.js +60 -0
- package/dist/benchmarks/index.d.ts +29 -0
- package/dist/benchmarks/index.js +70 -0
- package/dist/budget/index.d.ts +21 -0
- package/dist/budget/index.js +50 -0
- package/dist/cache/index.d.ts +31 -0
- package/dist/cache/index.js +11 -0
- package/dist/cards/content.d.ts +43 -0
- package/dist/cards/copy-cards.d.ts +2 -0
- package/dist/cards/format.d.ts +39 -0
- package/dist/cards/index.d.ts +9 -0
- package/dist/cards/index.js +2070 -0
- package/dist/cards/notify-cards.d.ts +14 -0
- package/dist/cards/ops-cards.d.ts +2 -0
- package/dist/cards/parts.d.ts +22 -0
- package/dist/cards/people-cards.d.ts +2 -0
- package/dist/cards/render.d.ts +28 -0
- package/dist/cards/sender-cards.d.ts +2 -0
- package/dist/cards/slack-rich.d.ts +19 -0
- package/dist/cards/slack-text.d.ts +10 -0
- package/dist/cards/slack.d.ts +21 -0
- package/dist/cards/spec.d.ts +86 -0
- package/dist/cards/tool-cards.d.ts +4 -0
- package/dist/chunks/chunk-4O2HRTTI.js +75 -0
- package/dist/chunks/chunk-7BCYLIDG.js +483 -0
- package/dist/chunks/chunk-B7V6EOAC.js +2273 -0
- package/dist/chunks/chunk-CMQ5ZHLZ.js +25 -0
- package/dist/chunks/chunk-F7MKFVIG.js +43 -0
- package/dist/chunks/chunk-FZF6CLPX.js +232 -0
- package/dist/chunks/chunk-GPEJG34O.js +53 -0
- package/dist/chunks/chunk-HEC7XFFH.js +65 -0
- package/dist/chunks/chunk-IBC52BX3.js +24 -0
- package/dist/chunks/chunk-LNCOGBMI.js +144 -0
- package/dist/chunks/chunk-LOXBLQ3I.js +180 -0
- package/dist/chunks/chunk-NAWZ73QS.js +22 -0
- package/dist/chunks/chunk-OCV66TS2.js +705 -0
- package/dist/chunks/chunk-Q465X22Y.js +548 -0
- package/dist/chunks/chunk-QTB747K4.js +100 -0
- package/dist/chunks/chunk-QZNNCXXD.js +92 -0
- package/dist/chunks/chunk-R6AM4GJR.js +105 -0
- package/dist/chunks/chunk-TIJKJJDW.js +6 -0
- package/dist/chunks/chunk-VURTOVGI.js +61 -0
- package/dist/chunks/chunk-WAM6N4OF.js +269 -0
- package/dist/chunks/chunk-WW746NJF.js +94 -0
- package/dist/chunks/chunk-XC6CZP73.js +80 -0
- package/dist/chunks/chunk-ZGHQYZEH.js +45 -0
- package/dist/cli/bin.d.ts +2 -0
- package/dist/cli/bin.js +34 -0
- package/dist/cli/commands.d.ts +16 -0
- package/dist/cli/index.d.ts +13 -0
- package/dist/cli/index.js +25 -0
- package/dist/cli/mcp.d.ts +14 -0
- package/dist/clients/index.d.ts +2 -0
- package/dist/clients/index.js +107 -0
- package/dist/clients/plugin.d.ts +42 -0
- package/dist/combine/account.d.ts +4 -0
- package/dist/combine/adapter.d.ts +9 -0
- package/dist/combine/index.d.ts +2 -0
- package/dist/combine/index.js +345 -0
- package/dist/combine/route.d.ts +17 -0
- package/dist/exporter/index.d.ts +29 -0
- package/dist/exporter/index.js +77 -0
- package/dist/failover/index.d.ts +11 -0
- package/dist/failover/index.js +45 -0
- package/dist/fixtures/index.d.ts +27 -0
- package/dist/fixtures/index.js +241 -0
- package/dist/fixtures/scrub.d.ts +5 -0
- package/dist/heyreach/account.d.ts +11 -0
- package/dist/heyreach/adapter.d.ts +5 -0
- package/dist/heyreach/capabilities.d.ts +68 -0
- package/dist/heyreach/client.d.ts +20 -0
- package/dist/heyreach/inbox.d.ts +7 -0
- package/dist/heyreach/index.d.ts +18 -0
- package/dist/heyreach/index.js +1708 -0
- package/dist/heyreach/lookup.d.ts +15 -0
- package/dist/heyreach/map-account.d.ts +25 -0
- package/dist/heyreach/map-sequence.d.ts +5 -0
- package/dist/heyreach/map-stats.d.ts +10 -0
- package/dist/heyreach/map.d.ts +35 -0
- package/dist/heyreach/native-organization.d.ts +128 -0
- package/dist/heyreach/native-voice.d.ts +106 -0
- package/dist/heyreach/native.d.ts +496 -0
- package/dist/heyreach/paging.d.ts +7 -0
- package/dist/heyreach/webhooks.d.ts +2 -0
- package/dist/identity/index.d.ts +3 -0
- package/dist/identity/index.js +148 -0
- package/dist/identity/keys.d.ts +9 -0
- package/dist/identity/plugin.d.ts +34 -0
- package/dist/index.d.ts +36 -0
- package/dist/index.js +119 -0
- package/dist/insights/copy/copy-audit.d.ts +55 -0
- package/dist/insights/copy/copy-checks.d.ts +44 -0
- package/dist/insights/copy/copy-reuse.d.ts +59 -0
- package/dist/insights/copy/index.d.ts +67 -0
- package/dist/insights/copy/reply-timing.d.ts +63 -0
- package/dist/insights/copy/shared.d.ts +53 -0
- package/dist/insights/copy/step-funnel.d.ts +66 -0
- package/dist/insights/copy/variant-test.d.ts +64 -0
- package/dist/insights/define.d.ts +98 -0
- package/dist/insights/index.d.ts +10 -0
- package/dist/insights/index.js +4873 -0
- package/dist/insights/ops/anomalies.d.ts +80 -0
- package/dist/insights/ops/campaign-diagnosis.d.ts +39 -0
- package/dist/insights/ops/campaign-ranking.d.ts +56 -0
- package/dist/insights/ops/channel-mix.d.ts +44 -0
- package/dist/insights/ops/client-report.d.ts +76 -0
- package/dist/insights/ops/diagnosis-checks.d.ts +48 -0
- package/dist/insights/ops/index.d.ts +135 -0
- package/dist/insights/ops/period-comparison.d.ts +86 -0
- package/dist/insights/ops/pipeline-forecast.d.ts +44 -0
- package/dist/insights/ops/shared.d.ts +149 -0
- package/dist/insights/ops/tag-rollup.d.ts +32 -0
- package/dist/insights/people/account-summary.d.ts +68 -0
- package/dist/insights/people/dropped-replies.d.ts +51 -0
- package/dist/insights/people/find.d.ts +18 -0
- package/dist/insights/people/hot-leads.d.ts +67 -0
- package/dist/insights/people/index.d.ts +88 -0
- package/dist/insights/people/lead-collisions.d.ts +43 -0
- package/dist/insights/people/person-summary.d.ts +46 -0
- package/dist/insights/people/personalization-gaps.d.ts +60 -0
- package/dist/insights/people/read.d.ts +40 -0
- package/dist/insights/people/suppression-check.d.ts +53 -0
- package/dist/insights/plugin.d.ts +40 -0
- package/dist/insights/registry.d.ts +335 -0
- package/dist/insights/senders/bounce-watch.d.ts +70 -0
- package/dist/insights/senders/domain-health.d.ts +69 -0
- package/dist/insights/senders/index.d.ts +74 -0
- package/dist/insights/senders/read.d.ts +37 -0
- package/dist/insights/senders/sender-capacity.d.ts +67 -0
- package/dist/insights/senders/sender-load.d.ts +52 -0
- package/dist/insights/senders/settings-audit.d.ts +48 -0
- package/dist/insights/senders/warmup-readiness.d.ts +39 -0
- package/dist/insights/stats.d.ts +45 -0
- package/dist/insights/tools.d.ts +16 -0
- package/dist/insights/types.d.ts +4 -0
- package/dist/instantly/adapter-account.d.ts +5 -0
- package/dist/instantly/adapter-mail.d.ts +3 -0
- package/dist/instantly/adapter.d.ts +7 -0
- package/dist/instantly/capabilities.d.ts +83 -0
- package/dist/instantly/client.d.ts +29 -0
- package/dist/instantly/index.d.ts +20 -0
- package/dist/instantly/index.js +2372 -0
- package/dist/instantly/map-account.d.ts +23 -0
- package/dist/instantly/map-lead.d.ts +18 -0
- package/dist/instantly/map-stats.d.ts +22 -0
- package/dist/instantly/map.d.ts +24 -0
- package/dist/instantly/native-agents-sales.d.ts +161 -0
- package/dist/instantly/native-agents.d.ts +156 -0
- package/dist/instantly/native-campaigns.d.ts +101 -0
- package/dist/instantly/native-leads.d.ts +93 -0
- package/dist/instantly/native-params.d.ts +24 -0
- package/dist/instantly/native-search.d.ts +82 -0
- package/dist/instantly/native-senders.d.ts +182 -0
- package/dist/instantly/native-supersearch.d.ts +149 -0
- package/dist/instantly/native-workspace.d.ts +170 -0
- package/dist/instantly/native.d.ts +1081 -0
- package/dist/instantly/pages.d.ts +29 -0
- package/dist/instantly/stats.d.ts +5 -0
- package/dist/instantly/webhooks.d.ts +2 -0
- package/dist/internal/adapter.d.ts +189 -0
- package/dist/internal/capabilities.d.ts +86 -0
- package/dist/internal/cursor.d.ts +10 -0
- package/dist/internal/engine/budget.d.ts +44 -0
- package/dist/internal/engine/engine.d.ts +45 -0
- package/dist/internal/engine/rate-store.d.ts +25 -0
- package/dist/internal/engine/request.d.ts +27 -0
- package/dist/internal/engine/retry.d.ts +21 -0
- package/dist/internal/engine/runtime.d.ts +13 -0
- package/dist/internal/entities-account.d.ts +135 -0
- package/dist/internal/entities.d.ts +389 -0
- package/dist/internal/env.d.ts +4 -0
- package/dist/internal/errors.d.ts +57 -0
- package/dist/internal/hooks.d.ts +55 -0
- package/dist/internal/json.d.ts +40 -0
- package/dist/internal/limits.d.ts +34 -0
- package/dist/internal/metrics.d.ts +52 -0
- package/dist/internal/native.d.ts +66 -0
- package/dist/internal/outbound/api.d.ts +267 -0
- package/dist/internal/outbound/collections.d.ts +31 -0
- package/dist/internal/outbound/core.d.ts +36 -0
- package/dist/internal/outbound/create.d.ts +16 -0
- package/dist/internal/outbound/handles.d.ts +7 -0
- package/dist/internal/outbound/native.d.ts +4 -0
- package/dist/internal/outbound/operation-shared.d.ts +28 -0
- package/dist/internal/outbound/operations-account.d.ts +29 -0
- package/dist/internal/outbound/operations.d.ts +42 -0
- package/dist/internal/outbound/outbound.d.ts +64 -0
- package/dist/internal/outbound/plugins.d.ts +40 -0
- package/dist/internal/outbound/raw.d.ts +9 -0
- package/dist/internal/outbound/specs-account.d.ts +16 -0
- package/dist/internal/outbound/specs.d.ts +14 -0
- package/dist/internal/outbound/stats.d.ts +7 -0
- package/dist/internal/outbound/validate.d.ts +5 -0
- package/dist/internal/outbound/walker.d.ts +22 -0
- package/dist/internal/record.d.ts +19 -0
- package/dist/internal/redact.d.ts +18 -0
- package/dist/internal/ref.d.ts +16 -0
- package/dist/internal/sha256.d.ts +4 -0
- package/dist/internal/text.d.ts +11 -0
- package/dist/internal/url.d.ts +9 -0
- package/dist/loader/index.d.ts +12 -0
- package/dist/loader/index.js +12 -0
- package/dist/memory/account-reads.d.ts +5 -0
- package/dist/memory/account.d.ts +67 -0
- package/dist/memory/adapter.d.ts +16 -0
- package/dist/memory/data.d.ts +122 -0
- package/dist/memory/demo.d.ts +7 -0
- package/dist/memory/index.d.ts +5 -0
- package/dist/memory/index.js +792 -0
- package/dist/memory/stats.d.ts +6 -0
- package/dist/memory/store.d.ts +18 -0
- package/dist/providers/index.d.ts +22 -0
- package/dist/providers/index.js +10 -0
- package/dist/reconcile/index.d.ts +2 -0
- package/dist/reconcile/index.js +72 -0
- package/dist/reconcile/plugin.d.ts +55 -0
- package/dist/redact/index.d.ts +2 -0
- package/dist/redact/index.js +192 -0
- package/dist/redact/plugin.d.ts +22 -0
- package/dist/redis/index.d.ts +41 -0
- package/dist/redis/index.js +114 -0
- package/dist/smartlead/account.d.ts +5 -0
- package/dist/smartlead/adapter.d.ts +5 -0
- package/dist/smartlead/capabilities.d.ts +85 -0
- package/dist/smartlead/client.d.ts +23 -0
- package/dist/smartlead/hmac.d.ts +9 -0
- package/dist/smartlead/index.d.ts +17 -0
- package/dist/smartlead/index.js +2170 -0
- package/dist/smartlead/leads.d.ts +6 -0
- package/dist/smartlead/lookup.d.ts +8 -0
- package/dist/smartlead/mail.d.ts +5 -0
- package/dist/smartlead/map-account.d.ts +22 -0
- package/dist/smartlead/map-messages.d.ts +31 -0
- package/dist/smartlead/map-stats.d.ts +37 -0
- package/dist/smartlead/map.d.ts +52 -0
- package/dist/smartlead/native-analytics.d.ts +242 -0
- package/dist/smartlead/native-campaigns.d.ts +211 -0
- package/dist/smartlead/native-inbox.d.ts +141 -0
- package/dist/smartlead/native-params.d.ts +33 -0
- package/dist/smartlead/native-services.d.ts +204 -0
- package/dist/smartlead/native.d.ts +785 -0
- package/dist/smartlead/shared.d.ts +28 -0
- package/dist/smartlead/stats.d.ts +5 -0
- package/dist/smartlead/webhooks.d.ts +2 -0
- package/dist/sync/index.d.ts +2 -0
- package/dist/sync/index.js +158 -0
- package/dist/sync/plugin.d.ts +58 -0
- package/dist/tools/account-tools.d.ts +21 -0
- package/dist/tools/ai-sdk.d.ts +8 -0
- package/dist/tools/ai-sdk.js +26 -0
- package/dist/tools/campaign-tools.d.ts +59 -0
- package/dist/tools/claude-agent.d.ts +18 -0
- package/dist/tools/claude-agent.js +40 -0
- package/dist/tools/index.d.ts +28 -0
- package/dist/tools/index.js +20 -0
- package/dist/tools/people-tools.d.ts +19 -0
- package/dist/tools/registry.d.ts +34 -0
- package/dist/tools/shared.d.ts +75 -0
- package/dist/tracing/index.d.ts +25 -0
- package/dist/tracing/index.js +69 -0
- package/dist/webhooks/index.d.ts +3 -0
- package/dist/webhooks/index.js +226 -0
- package/dist/webhooks/parse.d.ts +41 -0
- package/dist/webhooks/secret.d.ts +4 -0
- package/package.json +181 -4
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { BlockEntry, CampaignSettings, LeadList, SenderHealth, Tag, WebhookSubscription } from "../internal/entities-account.ts";
|
|
2
|
+
import type { Json, JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/** The settings are fields of the campaign object itself. */
|
|
5
|
+
export declare const toCampaignSettings: (identity: Identity, raw: JsonObject) => CampaignSettings;
|
|
6
|
+
/** The three responses a mailbox's health is read from. */
|
|
7
|
+
export interface HealthParts {
|
|
8
|
+
/** `GET /accounts/{email}`. */
|
|
9
|
+
readonly account: JsonObject;
|
|
10
|
+
/** `POST /accounts/test/vitals`. */
|
|
11
|
+
readonly vitals: Json;
|
|
12
|
+
/** `POST /accounts/warmup-analytics`. */
|
|
13
|
+
readonly warmup: Json;
|
|
14
|
+
}
|
|
15
|
+
export declare const toSenderHealth: (identity: Identity, id: string, parts: HealthParts) => SenderHealth;
|
|
16
|
+
/** `GET /lead-lists`. The list object carries no count of its leads. */
|
|
17
|
+
export declare const toLeadList: (identity: Identity, raw: JsonObject) => LeadList;
|
|
18
|
+
/** `GET /block-lists-entries`: an address or a whole domain. */
|
|
19
|
+
export declare const toBlockEntry: (identity: Identity, raw: JsonObject) => BlockEntry;
|
|
20
|
+
/** `GET /custom-tags`: a tag for mailboxes and campaigns. */
|
|
21
|
+
export declare const toTag: (identity: Identity, raw: JsonObject) => Tag;
|
|
22
|
+
/** `GET /webhooks`: one webhook listens for one event type, or `all_events`. */
|
|
23
|
+
export declare const toWebhook: (identity: Identity, raw: JsonObject) => WebhookSubscription;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { Lead, Message, Reply } from "../internal/entities.ts";
|
|
2
|
+
import type { Json, JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/** A workspace's custom lead labels, by the interest status each one owns. */
|
|
5
|
+
export type Labels = ReadonlyMap<number, JsonObject>;
|
|
6
|
+
export declare const NO_LABELS: Labels;
|
|
7
|
+
/** `true` for an interest status that only a custom label can explain. */
|
|
8
|
+
export declare const isCustomInterest: (value: Json | undefined) => boolean;
|
|
9
|
+
/** `GET /lead-labels` items, keyed by `interest_status`. */
|
|
10
|
+
export declare const toLabels: (items: readonly JsonObject[]) => Labels;
|
|
11
|
+
export declare const toLead: (identity: Identity, raw: JsonObject, labels?: Labels) => Lead;
|
|
12
|
+
/** `ue_type`: 1 sent from a campaign, 2 received, 3 sent by hand, 4 scheduled. */
|
|
13
|
+
export declare const SCHEDULED = 4;
|
|
14
|
+
export declare const isScheduled: (raw: JsonObject) => boolean;
|
|
15
|
+
/** `true` when a list response holds an excerpt instead of the whole body. */
|
|
16
|
+
export declare const isTruncated: (raw: JsonObject) => boolean;
|
|
17
|
+
export declare const toMessage: (identity: Identity, raw: JsonObject, includeBody: boolean) => Message;
|
|
18
|
+
export declare const toReply: (identity: Identity, raw: JsonObject, includeBody: boolean, labels?: Labels) => Reply;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { MetricRow, MetricScope } from "../internal/entities.ts";
|
|
2
|
+
import type { JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
export interface RowScope extends Identity {
|
|
5
|
+
readonly scope: MetricScope;
|
|
6
|
+
readonly scopeId: string;
|
|
7
|
+
}
|
|
8
|
+
/** `GET /campaigns/analytics/overview`: totals, including interested leads. */
|
|
9
|
+
export declare const overviewRow: (scope: RowScope, raw: JsonObject) => MetricRow;
|
|
10
|
+
/** `GET /campaigns/analytics/daily` and `GET /accounts/analytics/daily`. */
|
|
11
|
+
export declare const dailyRow: (scope: RowScope, raw: JsonObject) => MetricRow;
|
|
12
|
+
/**
|
|
13
|
+
* A total built by adding daily rows. Unique counts are summed across days,
|
|
14
|
+
* which over-counts a person seen on more than one day, so it is `derived`.
|
|
15
|
+
*/
|
|
16
|
+
export declare const summedRow: (scope: RowScope, days: readonly JsonObject[]) => MetricRow;
|
|
17
|
+
/**
|
|
18
|
+
* `GET /campaigns/analytics/steps`. Step and variant are both counted from 0
|
|
19
|
+
* (seen live: a seven-step campaign reports steps "0" to "6"). A row whose
|
|
20
|
+
* step is null or `\N` holds counts Instantly could not tie to a step.
|
|
21
|
+
*/
|
|
22
|
+
export declare const stepRow: (scope: RowScope, raw: JsonObject) => MetricRow;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Campaign, CampaignStatus, Sender, Sequence, Workspace } from "../internal/entities.ts";
|
|
2
|
+
import type { Json, JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/**
|
|
5
|
+
* The status Instantly can filter for us. Active and paused each cover
|
|
6
|
+
* several Instantly statuses, so they have no single number.
|
|
7
|
+
*/
|
|
8
|
+
export declare const campaignStatusCode: (status: CampaignStatus) => number | undefined;
|
|
9
|
+
export declare const toCampaign: (identity: Identity, raw: JsonObject, tags?: readonly string[]) => Campaign;
|
|
10
|
+
/** Variants are positional: Instantly gives them no ids. 0 is "A". */
|
|
11
|
+
export declare const variantKey: (index: number) => string;
|
|
12
|
+
/** A campaign's steps live inside the campaign object; there is no sequence endpoint. */
|
|
13
|
+
export declare const toSequence: (identity: Identity, raw: JsonObject) => Sequence;
|
|
14
|
+
/** `GET /subsequences`: a follow-up path a lead enters when its conditions are met. */
|
|
15
|
+
export declare const toSubsequence: (identity: Identity, raw: JsonObject, campaignId: string) => Sequence;
|
|
16
|
+
/** A mailbox. Instantly keys accounts by email address, not by an id. */
|
|
17
|
+
export declare const toSender: (identity: Identity, raw: JsonObject) => Sender;
|
|
18
|
+
export declare const toWorkspace: (identity: Identity, raw: JsonObject) => Workspace;
|
|
19
|
+
export interface ListEnvelope {
|
|
20
|
+
readonly items: JsonObject[];
|
|
21
|
+
readonly next: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
/** `{ items, next_starting_after }`: the shape of every Instantly list. */
|
|
24
|
+
export declare const listEnvelope: (body: Json) => ListEnvelope;
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
export declare const SALES_AGENT_READS: {
|
|
2
|
+
readonly leadFinderActivities: {
|
|
3
|
+
readonly description: "What a Lead Finder Agent did, newest first.";
|
|
4
|
+
readonly docs: string;
|
|
5
|
+
readonly method: "GET";
|
|
6
|
+
readonly params: {
|
|
7
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
8
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
9
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
10
|
+
};
|
|
11
|
+
readonly path: "/ai-agents/lead-finder/{id}/activities";
|
|
12
|
+
};
|
|
13
|
+
readonly leadFinderAgent: {
|
|
14
|
+
readonly description: "One Lead Finder Agent with its configuration.";
|
|
15
|
+
readonly docs: string;
|
|
16
|
+
readonly method: "GET";
|
|
17
|
+
readonly params: {
|
|
18
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
19
|
+
};
|
|
20
|
+
readonly path: "/ai-agents/lead-finder/{id}";
|
|
21
|
+
};
|
|
22
|
+
readonly leadFinderAgents: {
|
|
23
|
+
readonly description: "The AI Lead Finder Agents that keep campaigns stocked with leads.";
|
|
24
|
+
readonly docs: string;
|
|
25
|
+
readonly method: "GET";
|
|
26
|
+
readonly params: {
|
|
27
|
+
readonly campaign_id: import("./native-params.ts").Placed<"query", "string">;
|
|
28
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
29
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
30
|
+
};
|
|
31
|
+
readonly path: "/ai-agents/lead-finder";
|
|
32
|
+
};
|
|
33
|
+
readonly leadFinderAudienceSuggestions: {
|
|
34
|
+
readonly description: "SuperSearch audiences that match the leads already in a campaign. Nothing is saved.";
|
|
35
|
+
readonly docs: string;
|
|
36
|
+
readonly method: "POST";
|
|
37
|
+
readonly params: {
|
|
38
|
+
readonly campaign_id: import("./native-params.ts").Needed<"body", "string">;
|
|
39
|
+
readonly count: import("./native-params.ts").Placed<"body", "number">;
|
|
40
|
+
};
|
|
41
|
+
readonly path: "/ai-agents/lead-finder/suggest-audience";
|
|
42
|
+
};
|
|
43
|
+
readonly leadFinderStats: {
|
|
44
|
+
readonly description: "A Lead Finder Agent's lifetime totals.";
|
|
45
|
+
readonly docs: string;
|
|
46
|
+
readonly method: "GET";
|
|
47
|
+
readonly params: {
|
|
48
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
49
|
+
};
|
|
50
|
+
readonly path: "/ai-agents/lead-finder/{id}/stats";
|
|
51
|
+
};
|
|
52
|
+
readonly leadFinderWorkflows: {
|
|
53
|
+
readonly description: "The enrichment workflows saved for Lead Finder Agents.";
|
|
54
|
+
readonly docs: string;
|
|
55
|
+
readonly method: "GET";
|
|
56
|
+
readonly path: "/ai-agents/lead-finder/enrichment-workflows";
|
|
57
|
+
};
|
|
58
|
+
readonly salesAgent: {
|
|
59
|
+
readonly description: "One AI Sales Agent with its configuration.";
|
|
60
|
+
readonly docs: string;
|
|
61
|
+
readonly method: "GET";
|
|
62
|
+
readonly params: {
|
|
63
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
64
|
+
};
|
|
65
|
+
readonly path: "/ai-agents/sales/{id}";
|
|
66
|
+
};
|
|
67
|
+
readonly salesAgentActivities: {
|
|
68
|
+
readonly description: "What an AI Sales Agent did or proposes to do.";
|
|
69
|
+
readonly docs: string;
|
|
70
|
+
readonly method: "GET";
|
|
71
|
+
readonly params: {
|
|
72
|
+
readonly action_status: import("./native-params.ts").Placed<"query", "list">;
|
|
73
|
+
readonly action_type: import("./native-params.ts").Placed<"query", "list">;
|
|
74
|
+
readonly exclude_live_feed_hidden: import("./native-params.ts").Placed<"query", "boolean">;
|
|
75
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
76
|
+
readonly lead_email: import("./native-params.ts").Placed<"query", "string">;
|
|
77
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
78
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
79
|
+
};
|
|
80
|
+
readonly path: "/ai-agents/sales/{id}/activities";
|
|
81
|
+
};
|
|
82
|
+
readonly salesAgentAnalytics: {
|
|
83
|
+
readonly description: "Leads found, emails sent, replies and opportunities per day across an AI Sales Agent's campaigns.";
|
|
84
|
+
readonly docs: string;
|
|
85
|
+
readonly method: "GET";
|
|
86
|
+
readonly params: {
|
|
87
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
88
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
89
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
90
|
+
};
|
|
91
|
+
readonly path: "/ai-agents/sales/{id}/analytics";
|
|
92
|
+
};
|
|
93
|
+
readonly salesAgentGuidanceRules: {
|
|
94
|
+
readonly description: "The rules an AI Sales Agent follows when it writes.";
|
|
95
|
+
readonly docs: string;
|
|
96
|
+
readonly method: "GET";
|
|
97
|
+
readonly params: {
|
|
98
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
99
|
+
};
|
|
100
|
+
readonly path: "/ai-agents/sales/{id}/guidance-rules";
|
|
101
|
+
};
|
|
102
|
+
readonly salesAgentLeadActivity: {
|
|
103
|
+
readonly description: "Each lead's history across an AI Sales Agent's campaigns: sends, opens, replies, clicks, bounces and opportunity status.";
|
|
104
|
+
readonly docs: string;
|
|
105
|
+
readonly method: "GET";
|
|
106
|
+
readonly params: {
|
|
107
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
108
|
+
readonly filter: import("./native-params.ts").Placed<"query", "string">;
|
|
109
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
110
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
111
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
112
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
113
|
+
};
|
|
114
|
+
readonly path: "/ai-agents/sales/{id}/leads/activity";
|
|
115
|
+
};
|
|
116
|
+
readonly salesAgentLeadActivitySummary: {
|
|
117
|
+
readonly description: "Lead activity counts and rates across an AI Sales Agent's campaigns.";
|
|
118
|
+
readonly docs: string;
|
|
119
|
+
readonly method: "GET";
|
|
120
|
+
readonly params: {
|
|
121
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
122
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
123
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
124
|
+
};
|
|
125
|
+
readonly path: "/ai-agents/sales/{id}/leads/activity/summary";
|
|
126
|
+
};
|
|
127
|
+
readonly salesAgentLeadResearch: {
|
|
128
|
+
readonly description: "The sources an AI Sales Agent used to research one lead.";
|
|
129
|
+
readonly docs: string;
|
|
130
|
+
readonly method: "GET";
|
|
131
|
+
readonly params: {
|
|
132
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
133
|
+
readonly lead_id: import("./native-params.ts").Placed<"path", "string">;
|
|
134
|
+
};
|
|
135
|
+
readonly path: "/ai-agents/sales/{id}/leads/{lead_id}/research";
|
|
136
|
+
};
|
|
137
|
+
readonly salesAgentOpportunities: {
|
|
138
|
+
readonly description: "Opportunities by status and by campaign for an AI Sales Agent.";
|
|
139
|
+
readonly docs: string;
|
|
140
|
+
readonly method: "GET";
|
|
141
|
+
readonly params: {
|
|
142
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
143
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
144
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
145
|
+
};
|
|
146
|
+
readonly path: "/ai-agents/sales/{id}/opportunities/summary";
|
|
147
|
+
};
|
|
148
|
+
readonly salesAgents: {
|
|
149
|
+
readonly description: "The workspace's AI Sales Agents, newest first.";
|
|
150
|
+
readonly docs: string;
|
|
151
|
+
readonly method: "GET";
|
|
152
|
+
readonly params: {
|
|
153
|
+
readonly agent_type: import("./native-params.ts").Placed<"query", "number">;
|
|
154
|
+
readonly search: import("./native-params.ts").Placed<"query", "string">;
|
|
155
|
+
readonly status: import("./native-params.ts").Placed<"query", "number">;
|
|
156
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
157
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
158
|
+
};
|
|
159
|
+
readonly path: "/ai-agents/sales";
|
|
160
|
+
};
|
|
161
|
+
};
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
export declare const AGENT_READS: {
|
|
2
|
+
readonly deliverabilityAgent: {
|
|
3
|
+
readonly description: "The workspace's default AI Deliverability Agent, or null when none is deployed.";
|
|
4
|
+
readonly docs: string;
|
|
5
|
+
readonly method: "GET";
|
|
6
|
+
readonly path: "/ai-agents/deliverability";
|
|
7
|
+
};
|
|
8
|
+
readonly deliverabilityAgentById: {
|
|
9
|
+
readonly description: "One AI Deliverability Agent.";
|
|
10
|
+
readonly docs: string;
|
|
11
|
+
readonly method: "GET";
|
|
12
|
+
readonly params: {
|
|
13
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
14
|
+
};
|
|
15
|
+
readonly path: "/ai-agents/deliverability/{id}";
|
|
16
|
+
};
|
|
17
|
+
readonly deliverabilityAgentFeed: {
|
|
18
|
+
readonly description: "A Deliverability Agent's findings and recommendations, newest first.";
|
|
19
|
+
readonly docs: string;
|
|
20
|
+
readonly method: "GET";
|
|
21
|
+
readonly params: {
|
|
22
|
+
readonly feed_filter: import("./native-params.ts").Placed<"query", "string">;
|
|
23
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
24
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
25
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
26
|
+
};
|
|
27
|
+
readonly path: "/ai-agents/deliverability/{id}/feed-items";
|
|
28
|
+
};
|
|
29
|
+
readonly deliverabilityAgentState: {
|
|
30
|
+
readonly description: "What the default Deliverability Agent is doing: activity, schedule, last run and feed.";
|
|
31
|
+
readonly docs: string;
|
|
32
|
+
readonly method: "GET";
|
|
33
|
+
readonly params: {
|
|
34
|
+
readonly feed_filter: import("./native-params.ts").Placed<"query", "string">;
|
|
35
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
36
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
37
|
+
};
|
|
38
|
+
readonly path: "/ai-agents/deliverability/state";
|
|
39
|
+
};
|
|
40
|
+
readonly deliverabilityAgentStateById: {
|
|
41
|
+
readonly description: "What one Deliverability Agent is doing: activity, schedule, last run and feed.";
|
|
42
|
+
readonly docs: string;
|
|
43
|
+
readonly method: "GET";
|
|
44
|
+
readonly params: {
|
|
45
|
+
readonly feed_filter: import("./native-params.ts").Placed<"query", "string">;
|
|
46
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
47
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
48
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
49
|
+
};
|
|
50
|
+
readonly path: "/ai-agents/deliverability/{id}/state";
|
|
51
|
+
};
|
|
52
|
+
readonly inboxManager: {
|
|
53
|
+
readonly description: "One AI Inbox Manager with its configuration.";
|
|
54
|
+
readonly docs: string;
|
|
55
|
+
readonly method: "GET";
|
|
56
|
+
readonly params: {
|
|
57
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
58
|
+
readonly with_metadata: import("./native-params.ts").Placed<"query", "boolean">;
|
|
59
|
+
};
|
|
60
|
+
readonly path: "/ai-agents/inbox-manager/{id}";
|
|
61
|
+
};
|
|
62
|
+
readonly inboxManagerActivity: {
|
|
63
|
+
readonly description: "An Inbox Manager's replies, follow-ups and no-show recoveries, newest first.";
|
|
64
|
+
readonly docs: string;
|
|
65
|
+
readonly method: "GET";
|
|
66
|
+
readonly params: {
|
|
67
|
+
readonly action_pending: import("./native-params.ts").Placed<"query", "boolean">;
|
|
68
|
+
readonly activity_type: import("./native-params.ts").Placed<"query", "string">;
|
|
69
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
70
|
+
readonly job_type: import("./native-params.ts").Placed<"query", "number">;
|
|
71
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
72
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
73
|
+
};
|
|
74
|
+
readonly path: "/ai-agents/inbox-manager/{id}/analytics/activity";
|
|
75
|
+
};
|
|
76
|
+
readonly inboxManagerGuidance: {
|
|
77
|
+
readonly description: "One guidance of an Inbox Manager.";
|
|
78
|
+
readonly docs: string;
|
|
79
|
+
readonly method: "GET";
|
|
80
|
+
readonly params: {
|
|
81
|
+
readonly guidance_id: import("./native-params.ts").Placed<"path", "string">;
|
|
82
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
83
|
+
};
|
|
84
|
+
readonly path: "/ai-agents/inbox-manager/{id}/guidances/{guidance_id}";
|
|
85
|
+
};
|
|
86
|
+
readonly inboxManagerGuidances: {
|
|
87
|
+
readonly description: "The guidance an Inbox Manager follows.";
|
|
88
|
+
readonly docs: string;
|
|
89
|
+
readonly method: "GET";
|
|
90
|
+
readonly params: {
|
|
91
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
92
|
+
readonly status: import("./native-params.ts").Placed<"query", "number">;
|
|
93
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
94
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
95
|
+
};
|
|
96
|
+
readonly path: "/ai-agents/inbox-manager/{id}/guidances";
|
|
97
|
+
};
|
|
98
|
+
readonly inboxManagerReplies: {
|
|
99
|
+
readonly description: "The replies and follow-ups an Inbox Manager wrote, newest first.";
|
|
100
|
+
readonly docs: string;
|
|
101
|
+
readonly method: "GET";
|
|
102
|
+
readonly params: {
|
|
103
|
+
readonly action_pending: import("./native-params.ts").Placed<"query", "boolean">;
|
|
104
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
105
|
+
readonly information_requested: import("./native-params.ts").Placed<"query", "boolean">;
|
|
106
|
+
readonly requires_hitl: import("./native-params.ts").Placed<"query", "boolean">;
|
|
107
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
108
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
109
|
+
};
|
|
110
|
+
readonly path: "/ai-agents/inbox-manager/{id}/replies";
|
|
111
|
+
};
|
|
112
|
+
readonly inboxManagerReply: {
|
|
113
|
+
readonly description: "One reply an Inbox Manager wrote, with its HTML body.";
|
|
114
|
+
readonly docs: string;
|
|
115
|
+
readonly method: "GET";
|
|
116
|
+
readonly params: {
|
|
117
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
118
|
+
readonly reply_id: import("./native-params.ts").Placed<"path", "string">;
|
|
119
|
+
};
|
|
120
|
+
readonly path: "/ai-agents/inbox-manager/{id}/replies/{reply_id}";
|
|
121
|
+
};
|
|
122
|
+
readonly inboxManagerSummary: {
|
|
123
|
+
readonly description: "An Inbox Manager's totals over a window.";
|
|
124
|
+
readonly docs: string;
|
|
125
|
+
readonly method: "GET";
|
|
126
|
+
readonly params: {
|
|
127
|
+
readonly from: import("./native-params.ts").Placed<"query", "string">;
|
|
128
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
129
|
+
readonly to: import("./native-params.ts").Placed<"query", "string">;
|
|
130
|
+
};
|
|
131
|
+
readonly path: "/ai-agents/inbox-manager/{id}/analytics/summary";
|
|
132
|
+
};
|
|
133
|
+
readonly inboxManagerSummaryByDate: {
|
|
134
|
+
readonly description: "An Inbox Manager's totals for each day.";
|
|
135
|
+
readonly docs: string;
|
|
136
|
+
readonly method: "GET";
|
|
137
|
+
readonly params: {
|
|
138
|
+
readonly from: import("./native-params.ts").Placed<"query", "string">;
|
|
139
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
140
|
+
readonly to: import("./native-params.ts").Placed<"query", "string">;
|
|
141
|
+
};
|
|
142
|
+
readonly path: "/ai-agents/inbox-manager/{id}/analytics/summary-by-date";
|
|
143
|
+
};
|
|
144
|
+
readonly inboxManagers: {
|
|
145
|
+
readonly description: "The workspace's AI Inbox Managers, newest first.";
|
|
146
|
+
readonly docs: string;
|
|
147
|
+
readonly method: "GET";
|
|
148
|
+
readonly params: {
|
|
149
|
+
readonly search: import("./native-params.ts").Placed<"query", "string">;
|
|
150
|
+
readonly status: import("./native-params.ts").Placed<"query", "number">;
|
|
151
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
152
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
153
|
+
};
|
|
154
|
+
readonly path: "/ai-agents/inbox-manager";
|
|
155
|
+
};
|
|
156
|
+
};
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
export declare const CAMPAIGN_READS: {
|
|
2
|
+
readonly campaignAnalytics: {
|
|
3
|
+
readonly description: "Totals for one campaign or for every campaign, one row per campaign.";
|
|
4
|
+
readonly docs: string;
|
|
5
|
+
readonly method: "GET";
|
|
6
|
+
readonly params: {
|
|
7
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
8
|
+
readonly exclude_total_leads_count: import("./native-params.ts").Placed<"query", "boolean">;
|
|
9
|
+
readonly id: import("./native-params.ts").Placed<"query", "string">;
|
|
10
|
+
readonly ids: import("./native-params.ts").Placed<"query", "list">;
|
|
11
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
12
|
+
};
|
|
13
|
+
readonly path: "/campaigns/analytics";
|
|
14
|
+
};
|
|
15
|
+
readonly campaignExport: {
|
|
16
|
+
readonly description: "One campaign as the JSON Instantly exports: schedule, sequences and settings.";
|
|
17
|
+
readonly docs: string;
|
|
18
|
+
readonly method: "POST";
|
|
19
|
+
readonly params: {
|
|
20
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
21
|
+
};
|
|
22
|
+
readonly path: "/campaigns/{id}/export";
|
|
23
|
+
};
|
|
24
|
+
readonly campaignSendingStatus: {
|
|
25
|
+
readonly description: "Why a campaign is not sending, or is sending slower than expected.";
|
|
26
|
+
readonly docs: string;
|
|
27
|
+
readonly method: "GET";
|
|
28
|
+
readonly params: {
|
|
29
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
30
|
+
readonly with_ai_summary: import("./native-params.ts").Placed<"query", "boolean">;
|
|
31
|
+
};
|
|
32
|
+
readonly path: "/campaigns/{id}/sending-status";
|
|
33
|
+
};
|
|
34
|
+
readonly campaignsByLeadEmail: {
|
|
35
|
+
readonly description: "The campaigns a lead's email address is in.";
|
|
36
|
+
readonly docs: string;
|
|
37
|
+
readonly method: "GET";
|
|
38
|
+
readonly params: {
|
|
39
|
+
readonly search: import("./native-params.ts").Placed<"query", "string">;
|
|
40
|
+
readonly sort_column: import("./native-params.ts").Placed<"query", "string">;
|
|
41
|
+
readonly sort_order: import("./native-params.ts").Placed<"query", "string">;
|
|
42
|
+
};
|
|
43
|
+
readonly path: "/campaigns/search-by-contact";
|
|
44
|
+
};
|
|
45
|
+
readonly launchedCampaignCount: {
|
|
46
|
+
readonly description: "How many campaigns the workspace has launched.";
|
|
47
|
+
readonly docs: string;
|
|
48
|
+
readonly method: "GET";
|
|
49
|
+
readonly path: "/campaigns/count-launched";
|
|
50
|
+
};
|
|
51
|
+
readonly senderCampaigns: {
|
|
52
|
+
readonly description: "The campaigns one mailbox sends for.";
|
|
53
|
+
readonly docs: string;
|
|
54
|
+
readonly method: "GET";
|
|
55
|
+
readonly params: {
|
|
56
|
+
readonly email: import("./native-params.ts").Placed<"path", "string">;
|
|
57
|
+
readonly limit: import("./native-params.ts").Placed<"query", "number">;
|
|
58
|
+
readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
|
|
59
|
+
};
|
|
60
|
+
readonly path: "/account-campaign-mappings/{email}";
|
|
61
|
+
};
|
|
62
|
+
readonly subsequence: {
|
|
63
|
+
readonly description: "One subsequence: its trigger conditions, status, schedule and steps.";
|
|
64
|
+
readonly docs: string;
|
|
65
|
+
readonly method: "GET";
|
|
66
|
+
readonly params: {
|
|
67
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
68
|
+
};
|
|
69
|
+
readonly path: "/subsequences/{id}";
|
|
70
|
+
};
|
|
71
|
+
readonly subsequenceAnalytics: {
|
|
72
|
+
readonly description: "Sent, unique opens and unique replies for each subsequence of a campaign.";
|
|
73
|
+
readonly docs: string;
|
|
74
|
+
readonly method: "GET";
|
|
75
|
+
readonly params: {
|
|
76
|
+
readonly campaign_id: import("./native-params.ts").Needed<"query", "string">;
|
|
77
|
+
};
|
|
78
|
+
readonly path: "/subsequences/analytics";
|
|
79
|
+
};
|
|
80
|
+
readonly subsequenceSendingStatus: {
|
|
81
|
+
readonly description: "Why a subsequence is not sending, or is sending slower than expected.";
|
|
82
|
+
readonly docs: string;
|
|
83
|
+
readonly method: "GET";
|
|
84
|
+
readonly params: {
|
|
85
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
86
|
+
readonly with_ai_summary: import("./native-params.ts").Placed<"query", "boolean">;
|
|
87
|
+
};
|
|
88
|
+
readonly path: "/subsequences/{id}/sending-status";
|
|
89
|
+
};
|
|
90
|
+
readonly subsequenceStepAnalytics: {
|
|
91
|
+
readonly description: "One subsequence's numbers by step and variant, without its parent campaign.";
|
|
92
|
+
readonly docs: string;
|
|
93
|
+
readonly method: "GET";
|
|
94
|
+
readonly params: {
|
|
95
|
+
readonly end_date: import("./native-params.ts").Placed<"query", "string">;
|
|
96
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
97
|
+
readonly start_date: import("./native-params.ts").Placed<"query", "string">;
|
|
98
|
+
};
|
|
99
|
+
readonly path: "/subsequences/{id}/analytics/steps";
|
|
100
|
+
};
|
|
101
|
+
};
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
export declare const LEAD_READS: {
|
|
2
|
+
readonly blocklistCsv: {
|
|
3
|
+
readonly description: "The whole block list as CSV text.";
|
|
4
|
+
readonly docs: string;
|
|
5
|
+
readonly method: "GET";
|
|
6
|
+
readonly params: {
|
|
7
|
+
readonly domains_only: import("./native-params.ts").Placed<"query", "boolean">;
|
|
8
|
+
readonly search: import("./native-params.ts").Placed<"query", "string">;
|
|
9
|
+
};
|
|
10
|
+
readonly path: "/block-lists-entries/download";
|
|
11
|
+
};
|
|
12
|
+
readonly blocklistEntry: {
|
|
13
|
+
readonly description: "One block list entry.";
|
|
14
|
+
readonly docs: string;
|
|
15
|
+
readonly method: "GET";
|
|
16
|
+
readonly params: {
|
|
17
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
18
|
+
};
|
|
19
|
+
readonly path: "/block-lists-entries/{id}";
|
|
20
|
+
};
|
|
21
|
+
readonly emailVerification: {
|
|
22
|
+
readonly description: "The result of an email verification that was started earlier.";
|
|
23
|
+
readonly docs: string;
|
|
24
|
+
readonly method: "GET";
|
|
25
|
+
readonly params: {
|
|
26
|
+
readonly email: import("./native-params.ts").Placed<"path", "string">;
|
|
27
|
+
};
|
|
28
|
+
readonly path: "/email-verification/{email}";
|
|
29
|
+
};
|
|
30
|
+
readonly inboxUnreadCount: {
|
|
31
|
+
readonly description: "How many emails in the Unibox are unread.";
|
|
32
|
+
readonly docs: string;
|
|
33
|
+
readonly method: "GET";
|
|
34
|
+
readonly path: "/emails/unread/count";
|
|
35
|
+
};
|
|
36
|
+
readonly leadLabel: {
|
|
37
|
+
readonly description: "One custom lead label and the interest status it stands for.";
|
|
38
|
+
readonly docs: string;
|
|
39
|
+
readonly method: "GET";
|
|
40
|
+
readonly params: {
|
|
41
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
42
|
+
};
|
|
43
|
+
readonly path: "/lead-labels/{id}";
|
|
44
|
+
};
|
|
45
|
+
readonly leadLabelPrediction: {
|
|
46
|
+
readonly description: "The label Instantly's AI would give a reply text. Nothing is saved.";
|
|
47
|
+
readonly docs: string;
|
|
48
|
+
readonly lane: "labelPrediction";
|
|
49
|
+
readonly method: "POST";
|
|
50
|
+
readonly params: {
|
|
51
|
+
readonly reply_text: import("./native-params.ts").Needed<"body", "string">;
|
|
52
|
+
};
|
|
53
|
+
readonly path: "/lead-labels/ai-reply-label";
|
|
54
|
+
};
|
|
55
|
+
readonly leadList: {
|
|
56
|
+
readonly description: "One lead list.";
|
|
57
|
+
readonly docs: string;
|
|
58
|
+
readonly method: "GET";
|
|
59
|
+
readonly params: {
|
|
60
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
61
|
+
};
|
|
62
|
+
readonly path: "/lead-lists/{id}";
|
|
63
|
+
};
|
|
64
|
+
readonly leadListVerificationStats: {
|
|
65
|
+
readonly description: "How many leads a list holds and how their email verification came out.";
|
|
66
|
+
readonly docs: string;
|
|
67
|
+
readonly method: "GET";
|
|
68
|
+
readonly params: {
|
|
69
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
70
|
+
};
|
|
71
|
+
readonly path: "/lead-lists/{id}/verification-stats";
|
|
72
|
+
};
|
|
73
|
+
readonly tag: {
|
|
74
|
+
readonly description: "One custom tag.";
|
|
75
|
+
readonly docs: string;
|
|
76
|
+
readonly method: "GET";
|
|
77
|
+
readonly params: {
|
|
78
|
+
readonly id: import("./native-params.ts").Placed<"path", "string">;
|
|
79
|
+
};
|
|
80
|
+
readonly path: "/custom-tags/{id}";
|
|
81
|
+
};
|
|
82
|
+
readonly tagsOfResources: {
|
|
83
|
+
readonly description: "The custom tags assigned to any of the given campaigns or mailboxes.";
|
|
84
|
+
readonly docs: string;
|
|
85
|
+
readonly method: "POST";
|
|
86
|
+
readonly params: {
|
|
87
|
+
readonly limit: import("./native-params.ts").Placed<"body", "number">;
|
|
88
|
+
readonly resource_ids: import("./native-params.ts").Needed<"body", "json">;
|
|
89
|
+
readonly starting_after: import("./native-params.ts").Placed<"body", "string">;
|
|
90
|
+
};
|
|
91
|
+
readonly path: "/custom-tags/search";
|
|
92
|
+
};
|
|
93
|
+
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { NativeParam } from "../internal/native.ts";
|
|
2
|
+
type Kind = NativeParam["type"];
|
|
3
|
+
export interface Placed<Place extends NativeParam["in"], Type extends Kind> {
|
|
4
|
+
readonly description: string;
|
|
5
|
+
readonly in: Place;
|
|
6
|
+
readonly type: Type;
|
|
7
|
+
}
|
|
8
|
+
export interface Needed<Place extends NativeParam["in"], Type extends Kind> extends Placed<Place, Type> {
|
|
9
|
+
readonly required: true;
|
|
10
|
+
}
|
|
11
|
+
export declare const inQuery: <Type extends Kind>(type: Type, description: string) => Placed<"query", Type>;
|
|
12
|
+
export declare const inQueryRequired: <Type extends Kind>(type: Type, description: string) => Needed<"query", Type>;
|
|
13
|
+
export declare const inBody: <Type extends Kind>(type: Type, description: string) => Placed<"body", Type>;
|
|
14
|
+
export declare const inBodyRequired: <Type extends Kind>(type: Type, description: string) => Needed<"body", Type>;
|
|
15
|
+
/** Every path parameter Instantly documents is a string. */
|
|
16
|
+
export declare const inPath: (description: string) => Placed<"path", "string">;
|
|
17
|
+
/** The cursor paging every Instantly list shares. */
|
|
18
|
+
export declare const PAGE: {
|
|
19
|
+
limit: Placed<"query", "number">;
|
|
20
|
+
starting_after: Placed<"query", "string">;
|
|
21
|
+
};
|
|
22
|
+
/** The reference page of one endpoint, from its path under `api-reference/`. */
|
|
23
|
+
export declare const docs: (page: string) => string;
|
|
24
|
+
export {};
|