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,15 @@
|
|
|
1
|
+
import type { AdapterContext, LeadQuery, Page } from "../internal/adapter.ts";
|
|
2
|
+
import type { Lead } from "../internal/entities.ts";
|
|
3
|
+
import type { HeyReachClient } from "./client.ts";
|
|
4
|
+
/**
|
|
5
|
+
* The one form sent to HeyReach. Seen live: it matches a stored profile
|
|
6
|
+
* whatever the scheme, `www.`, trailing slash or query, but not when the
|
|
7
|
+
* letters differ in case, and the stored slug was lowercase.
|
|
8
|
+
*/
|
|
9
|
+
export declare const canonicalProfileUrl: (url: string) => string | null;
|
|
10
|
+
/**
|
|
11
|
+
* One page of the lead records of exactly one person: one per campaign the
|
|
12
|
+
* person is in, or a single record with no campaign for a person HeyReach
|
|
13
|
+
* knows who is in none.
|
|
14
|
+
*/
|
|
15
|
+
export declare const lookupLeads: (client: HeyReachClient, ctx: AdapterContext, query: LeadQuery) => Promise<Page<Lead>>;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { BlockEntry, LeadList, SenderHealth, WebhookSubscription } from "../internal/entities-account.ts";
|
|
2
|
+
import type { JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/** `POST /list/GetAll`: `listType` is `USER_LIST` or `COMPANY_LIST`. */
|
|
5
|
+
export declare const toLeadList: (identity: Identity, raw: JsonObject) => LeadList;
|
|
6
|
+
/**
|
|
7
|
+
* `POST /blacklist/GetLeads`. Leads and companies are numbered separately,
|
|
8
|
+
* so the id says which blacklist the entry is on. An entry with no URL, email
|
|
9
|
+
* or name is skipped.
|
|
10
|
+
*/
|
|
11
|
+
export declare const toBlockedLead: (identity: Identity, raw: JsonObject) => BlockEntry[];
|
|
12
|
+
/** `POST /blacklist/GetCompanies`: a company name, or its LinkedIn page. */
|
|
13
|
+
export declare const toBlockedCompany: (identity: Identity, raw: JsonObject) => BlockEntry[];
|
|
14
|
+
/** The campaigns a webhook is limited to. Empty means every campaign. */
|
|
15
|
+
export declare const webhookCampaigns: (raw: JsonObject) => string[];
|
|
16
|
+
/**
|
|
17
|
+
* `POST /webhooks/GetAllWebhooks`. A webhook listens to one event type. It can
|
|
18
|
+
* be limited to several campaigns; an empty `campaignRefs` is every campaign.
|
|
19
|
+
*/
|
|
20
|
+
export declare const toWebhook: (identity: Identity, raw: JsonObject) => WebhookSubscription;
|
|
21
|
+
/**
|
|
22
|
+
* `GET /li_account/GetAccountStatus/{accountId}`. A LinkedIn seat has no
|
|
23
|
+
* domain, DNS records, block lists or warmup, so those are null.
|
|
24
|
+
*/
|
|
25
|
+
export declare const toSenderHealth: (identity: Identity, senderId: string, raw: JsonObject) => SenderHealth;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { Sequence } from "../internal/entities.ts";
|
|
2
|
+
import type { Json } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/** An empty response (`null`) is a campaign with no sequence. */
|
|
5
|
+
export declare const toSequence: (identity: Identity, campaignId: string, raw: Json) => Sequence;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { MetricRow, MetricScope } from "../internal/entities.ts";
|
|
2
|
+
import type { Json } 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
|
+
export declare const totalRow: (scope: RowScope, body: Json) => MetricRow;
|
|
9
|
+
/** One row per key of `byDayStats`, oldest first. */
|
|
10
|
+
export declare const dailyRows: (scope: RowScope, body: Json) => MetricRow[];
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Campaign, CampaignStatus, Lead, Sender } from "../internal/entities.ts";
|
|
2
|
+
import type { Json, JsonObject } from "../internal/json.ts";
|
|
3
|
+
import type { Identity } from "../internal/record.ts";
|
|
4
|
+
/** The HeyReach statuses behind one of ours, for the `statuses` filter. */
|
|
5
|
+
export declare const vendorStatuses: (status: CampaignStatus) => string[];
|
|
6
|
+
export declare const toCampaign: (identity: Identity, raw: JsonObject) => Campaign;
|
|
7
|
+
/** A LinkedIn account. Its limits (`connectioRequestLimit` and so on) stay in raw. */
|
|
8
|
+
export declare const toSender: (identity: Identity, raw: JsonObject) => Sender;
|
|
9
|
+
/** A lead's manual tags: `tags` is an array of names. */
|
|
10
|
+
export declare const tagNames: (value: Json | undefined) => string[];
|
|
11
|
+
/**
|
|
12
|
+
* `POST /lead/GetLead` and a row of `POST /list/GetLeadsFromList`: a profile
|
|
13
|
+
* with no campaign and no status. GetLead carries no tags, so they are read
|
|
14
|
+
* from `POST /lead/GetTags` and passed in.
|
|
15
|
+
*/
|
|
16
|
+
export declare const toLead: (identity: Identity, raw: JsonObject, tags?: Json | undefined) => Lead;
|
|
17
|
+
/** `POST /campaign/GetLeadsFromCampaign`: the profile is nested in the row. */
|
|
18
|
+
export declare const toCampaignLead: (identity: Identity, raw: JsonObject, campaignId: string) => Lead;
|
|
19
|
+
/** Every address a `POST /lead/GetLead` profile carries, lowercased. */
|
|
20
|
+
export declare const profileEmails: (profile: JsonObject) => string[];
|
|
21
|
+
/**
|
|
22
|
+
* A `POST /lead/GetLead` profile beside one row of
|
|
23
|
+
* `POST /campaign/GetCampaignsForLead`, or beside `null` for a person who is
|
|
24
|
+
* in no campaign. The row's `creationTime` is the campaign's, so the lead has
|
|
25
|
+
* none. `email` is the address the lead was looked up by, which the profile
|
|
26
|
+
* may hold in any of its email fields.
|
|
27
|
+
*/
|
|
28
|
+
export declare const toLookupLead: (identity: Identity, profile: JsonObject, campaign: JsonObject | null, email?: string | undefined) => Lead;
|
|
29
|
+
export interface ListEnvelope {
|
|
30
|
+
readonly items: JsonObject[];
|
|
31
|
+
/** The offset of the next page, when there is one. */
|
|
32
|
+
readonly next: number | undefined;
|
|
33
|
+
}
|
|
34
|
+
/** `{ totalCount, items }`: there is no next marker, so it is computed. */
|
|
35
|
+
export declare const listEnvelope: (body: Json, offset: number) => ListEnvelope;
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
export declare const ORGANIZATION_LANE = "organization";
|
|
2
|
+
export declare const ORGANIZATION_NATIVE: {
|
|
3
|
+
readonly organizationLinkedInAccounts: {
|
|
4
|
+
readonly description: "LinkedIn accounts across every workspace of the organization, each with its workspace, connection state and count of active campaigns. Needs the organization API key.";
|
|
5
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/organization/linked-in-accounts/get-linked-in-accounts";
|
|
6
|
+
readonly lane: "organization";
|
|
7
|
+
readonly method: "POST";
|
|
8
|
+
readonly params: {
|
|
9
|
+
readonly keyword: {
|
|
10
|
+
readonly description: "Search text.";
|
|
11
|
+
readonly in: "body";
|
|
12
|
+
readonly type: "string";
|
|
13
|
+
};
|
|
14
|
+
readonly limit: {
|
|
15
|
+
readonly description: "How many accounts to return.";
|
|
16
|
+
readonly in: "body";
|
|
17
|
+
readonly type: "number";
|
|
18
|
+
};
|
|
19
|
+
readonly offset: {
|
|
20
|
+
readonly description: "How many accounts to skip.";
|
|
21
|
+
readonly in: "body";
|
|
22
|
+
readonly type: "number";
|
|
23
|
+
};
|
|
24
|
+
readonly workspaceIds: {
|
|
25
|
+
readonly description: "Only accounts in these workspaces, as an array of ids. Empty or left out means every workspace.";
|
|
26
|
+
readonly in: "body";
|
|
27
|
+
readonly type: "json";
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
readonly path: "/management/organizations/linkedin-accounts";
|
|
31
|
+
};
|
|
32
|
+
readonly organizationUser: {
|
|
33
|
+
readonly description: "One user of the organization: name, email, roles and permissions. Needs the organization API key.";
|
|
34
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-user-by-id";
|
|
35
|
+
readonly lane: "organization";
|
|
36
|
+
readonly method: "GET";
|
|
37
|
+
readonly params: {
|
|
38
|
+
readonly userId: {
|
|
39
|
+
readonly description: "The user's id.";
|
|
40
|
+
readonly in: "path";
|
|
41
|
+
readonly type: "number";
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
readonly path: "/management/organizations/users/{userId}";
|
|
45
|
+
};
|
|
46
|
+
readonly organizationUsers: {
|
|
47
|
+
readonly description: "Every existing and invited user of the organization, with roles, invitation state and permissions per workspace. Needs the organization API key.";
|
|
48
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-all-users";
|
|
49
|
+
readonly lane: "organization";
|
|
50
|
+
readonly method: "POST";
|
|
51
|
+
readonly params: {
|
|
52
|
+
readonly invitationStatus: {
|
|
53
|
+
readonly description: "Only users whose invitation has one of these statuses, as an array of names.";
|
|
54
|
+
readonly in: "body";
|
|
55
|
+
readonly type: "json";
|
|
56
|
+
};
|
|
57
|
+
readonly limit: {
|
|
58
|
+
readonly description: "How many users to return.";
|
|
59
|
+
readonly in: "body";
|
|
60
|
+
readonly type: "number";
|
|
61
|
+
};
|
|
62
|
+
readonly offset: {
|
|
63
|
+
readonly description: "How many users to skip.";
|
|
64
|
+
readonly in: "body";
|
|
65
|
+
readonly type: "number";
|
|
66
|
+
};
|
|
67
|
+
readonly role: {
|
|
68
|
+
readonly description: "Only users with this role.";
|
|
69
|
+
readonly in: "body";
|
|
70
|
+
readonly type: "string";
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
readonly path: "/management/organizations/users";
|
|
74
|
+
};
|
|
75
|
+
readonly organizationWorkspaces: {
|
|
76
|
+
readonly description: "The organization's workspaces, each with its name, seat limit and seats used. Needs the organization API key.";
|
|
77
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/organization/workspaces/get-all-workspaces";
|
|
78
|
+
readonly lane: "organization";
|
|
79
|
+
readonly method: "GET";
|
|
80
|
+
readonly params: {
|
|
81
|
+
readonly Limit: {
|
|
82
|
+
readonly description: "How many workspaces to return.";
|
|
83
|
+
readonly in: "query";
|
|
84
|
+
readonly type: "number";
|
|
85
|
+
};
|
|
86
|
+
readonly Offset: {
|
|
87
|
+
readonly description: "How many workspaces to skip.";
|
|
88
|
+
readonly in: "query";
|
|
89
|
+
readonly type: "number";
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
readonly path: "/management/organizations/workspaces";
|
|
93
|
+
};
|
|
94
|
+
readonly workspaceUsers: {
|
|
95
|
+
readonly description: "The users of one workspace, with their role and permissions. Needs the organization API key.";
|
|
96
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/organization/workspace-users/get-workspace-users";
|
|
97
|
+
readonly lane: "organization";
|
|
98
|
+
readonly method: "POST";
|
|
99
|
+
readonly params: {
|
|
100
|
+
readonly workspaceId: {
|
|
101
|
+
readonly description: "The workspace's id.";
|
|
102
|
+
readonly in: "path";
|
|
103
|
+
readonly type: "number";
|
|
104
|
+
};
|
|
105
|
+
readonly invitationStatus: {
|
|
106
|
+
readonly description: "Only users whose invitation has one of these statuses, as an array of names.";
|
|
107
|
+
readonly in: "body";
|
|
108
|
+
readonly type: "json";
|
|
109
|
+
};
|
|
110
|
+
readonly limit: {
|
|
111
|
+
readonly description: "How many users to return.";
|
|
112
|
+
readonly in: "body";
|
|
113
|
+
readonly type: "number";
|
|
114
|
+
};
|
|
115
|
+
readonly offset: {
|
|
116
|
+
readonly description: "How many users to skip.";
|
|
117
|
+
readonly in: "body";
|
|
118
|
+
readonly type: "number";
|
|
119
|
+
};
|
|
120
|
+
readonly role: {
|
|
121
|
+
readonly description: "Only users with this role.";
|
|
122
|
+
readonly in: "body";
|
|
123
|
+
readonly type: "string";
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
readonly path: "/management/organizations/users/workspaces/{workspaceId}";
|
|
127
|
+
};
|
|
128
|
+
};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
export declare const VOICE_NATIVE: {
|
|
2
|
+
readonly elevenLabsConnection: {
|
|
3
|
+
readonly description: "The workspace's ElevenLabs connection: whether a key is connected, its status, the last four characters of the key, the last library sync and how many imported voices it offers. The key itself is never returned.";
|
|
4
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-eleven-labs-connection";
|
|
5
|
+
readonly method: "GET";
|
|
6
|
+
readonly path: "/voice/GetElevenLabsConnection";
|
|
7
|
+
};
|
|
8
|
+
readonly elevenLabsVoices: {
|
|
9
|
+
readonly description: "The ElevenLabs voices imported into the workspace, ordered by name, as the last library sync stored them.";
|
|
10
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-eleven-labs-voices";
|
|
11
|
+
readonly method: "GET";
|
|
12
|
+
readonly params: {
|
|
13
|
+
readonly limit: {
|
|
14
|
+
readonly description: "How many voices to return, 1 to 500. Defaults to 100.";
|
|
15
|
+
readonly in: "query";
|
|
16
|
+
readonly type: "number";
|
|
17
|
+
};
|
|
18
|
+
readonly offset: {
|
|
19
|
+
readonly description: "How many voices to skip. Defaults to 0.";
|
|
20
|
+
readonly in: "query";
|
|
21
|
+
readonly type: "number";
|
|
22
|
+
};
|
|
23
|
+
readonly search: {
|
|
24
|
+
readonly description: "Case-insensitive match on the voice name.";
|
|
25
|
+
readonly in: "query";
|
|
26
|
+
readonly type: "string";
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
readonly path: "/voice/GetElevenLabsVoices";
|
|
30
|
+
};
|
|
31
|
+
readonly senderVoice: {
|
|
32
|
+
readonly description: "The voice assigned to one LinkedIn account. Answers 404 SENDER_VOICE_NOT_ASSIGNED when the account has none.";
|
|
33
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-sender-voice";
|
|
34
|
+
readonly method: "GET";
|
|
35
|
+
readonly params: {
|
|
36
|
+
readonly accountId: {
|
|
37
|
+
readonly description: "The LinkedIn account's id.";
|
|
38
|
+
readonly in: "path";
|
|
39
|
+
readonly type: "number";
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
readonly path: "/voice/GetSenderVoice/{accountId}";
|
|
43
|
+
};
|
|
44
|
+
readonly staticClip: {
|
|
45
|
+
readonly description: "One uploaded voice clip: its duration, its transcript and why a transcript is absent. Metadata only; the audio is not returned.";
|
|
46
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-static-clip";
|
|
47
|
+
readonly method: "GET";
|
|
48
|
+
readonly params: {
|
|
49
|
+
readonly clipId: {
|
|
50
|
+
readonly description: "The clip's id, as staticClips lists it.";
|
|
51
|
+
readonly in: "path";
|
|
52
|
+
readonly type: "number";
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
readonly path: "/voice/GetStaticClip/{clipId}";
|
|
56
|
+
};
|
|
57
|
+
readonly staticClips: {
|
|
58
|
+
readonly description: "The workspace's uploaded voice clips, newest first, with duration and transcript. Metadata only.";
|
|
59
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-static-clips";
|
|
60
|
+
readonly method: "GET";
|
|
61
|
+
readonly params: {
|
|
62
|
+
readonly limit: {
|
|
63
|
+
readonly description: "How many clips to return, 1 to 100. Defaults to 50.";
|
|
64
|
+
readonly in: "query";
|
|
65
|
+
readonly type: "number";
|
|
66
|
+
};
|
|
67
|
+
readonly offset: {
|
|
68
|
+
readonly description: "How many clips to skip. Defaults to 0.";
|
|
69
|
+
readonly in: "query";
|
|
70
|
+
readonly type: "number";
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
readonly path: "/voice/GetStaticClips";
|
|
74
|
+
};
|
|
75
|
+
readonly voiceUsage: {
|
|
76
|
+
readonly description: "Where one voice is in use: the LinkedIn accounts it is assigned to and whether any of them is in a running campaign.";
|
|
77
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-voice-usage";
|
|
78
|
+
readonly method: "GET";
|
|
79
|
+
readonly params: {
|
|
80
|
+
readonly id: {
|
|
81
|
+
readonly description: "The voice's id, as voices lists it.";
|
|
82
|
+
readonly in: "path";
|
|
83
|
+
readonly type: "number";
|
|
84
|
+
};
|
|
85
|
+
readonly kind: {
|
|
86
|
+
readonly description: "PREDEFINED or CUSTOM. Defaults to CUSTOM.";
|
|
87
|
+
readonly in: "query";
|
|
88
|
+
readonly type: "string";
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
readonly path: "/voice/GetVoiceUsage/{id}";
|
|
92
|
+
};
|
|
93
|
+
readonly voices: {
|
|
94
|
+
readonly description: "The workspace's voice library: every predefined voice and the workspace's own cloned voices, each with the LinkedIn accounts it is assigned to.";
|
|
95
|
+
readonly docs: "https://docs.heyreach.io/hey-reach-api/voice/get-voices";
|
|
96
|
+
readonly method: "GET";
|
|
97
|
+
readonly params: {
|
|
98
|
+
readonly gender: {
|
|
99
|
+
readonly description: "Only voices of this gender: MALE or FEMALE.";
|
|
100
|
+
readonly in: "query";
|
|
101
|
+
readonly type: "string";
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
readonly path: "/voice/GetVoices";
|
|
105
|
+
};
|
|
106
|
+
};
|