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.
Files changed (271) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +121 -2
  3. package/dist/alerts/index.d.ts +2 -0
  4. package/dist/alerts/index.js +136 -0
  5. package/dist/alerts/plugin.d.ts +58 -0
  6. package/dist/audit/index.d.ts +33 -0
  7. package/dist/audit/index.js +60 -0
  8. package/dist/benchmarks/index.d.ts +29 -0
  9. package/dist/benchmarks/index.js +70 -0
  10. package/dist/budget/index.d.ts +21 -0
  11. package/dist/budget/index.js +50 -0
  12. package/dist/cache/index.d.ts +31 -0
  13. package/dist/cache/index.js +11 -0
  14. package/dist/cards/content.d.ts +43 -0
  15. package/dist/cards/copy-cards.d.ts +2 -0
  16. package/dist/cards/format.d.ts +39 -0
  17. package/dist/cards/index.d.ts +9 -0
  18. package/dist/cards/index.js +2070 -0
  19. package/dist/cards/notify-cards.d.ts +14 -0
  20. package/dist/cards/ops-cards.d.ts +2 -0
  21. package/dist/cards/parts.d.ts +22 -0
  22. package/dist/cards/people-cards.d.ts +2 -0
  23. package/dist/cards/render.d.ts +28 -0
  24. package/dist/cards/sender-cards.d.ts +2 -0
  25. package/dist/cards/slack-rich.d.ts +19 -0
  26. package/dist/cards/slack-text.d.ts +10 -0
  27. package/dist/cards/slack.d.ts +21 -0
  28. package/dist/cards/spec.d.ts +86 -0
  29. package/dist/cards/tool-cards.d.ts +4 -0
  30. package/dist/chunks/chunk-4O2HRTTI.js +75 -0
  31. package/dist/chunks/chunk-7BCYLIDG.js +483 -0
  32. package/dist/chunks/chunk-B7V6EOAC.js +2273 -0
  33. package/dist/chunks/chunk-CMQ5ZHLZ.js +25 -0
  34. package/dist/chunks/chunk-F7MKFVIG.js +43 -0
  35. package/dist/chunks/chunk-FZF6CLPX.js +232 -0
  36. package/dist/chunks/chunk-GPEJG34O.js +53 -0
  37. package/dist/chunks/chunk-HEC7XFFH.js +65 -0
  38. package/dist/chunks/chunk-IBC52BX3.js +24 -0
  39. package/dist/chunks/chunk-LNCOGBMI.js +144 -0
  40. package/dist/chunks/chunk-LOXBLQ3I.js +180 -0
  41. package/dist/chunks/chunk-NAWZ73QS.js +22 -0
  42. package/dist/chunks/chunk-OCV66TS2.js +705 -0
  43. package/dist/chunks/chunk-Q465X22Y.js +548 -0
  44. package/dist/chunks/chunk-QTB747K4.js +100 -0
  45. package/dist/chunks/chunk-QZNNCXXD.js +92 -0
  46. package/dist/chunks/chunk-R6AM4GJR.js +105 -0
  47. package/dist/chunks/chunk-TIJKJJDW.js +6 -0
  48. package/dist/chunks/chunk-VURTOVGI.js +61 -0
  49. package/dist/chunks/chunk-WAM6N4OF.js +269 -0
  50. package/dist/chunks/chunk-WW746NJF.js +94 -0
  51. package/dist/chunks/chunk-XC6CZP73.js +80 -0
  52. package/dist/chunks/chunk-ZGHQYZEH.js +45 -0
  53. package/dist/cli/bin.d.ts +2 -0
  54. package/dist/cli/bin.js +34 -0
  55. package/dist/cli/commands.d.ts +16 -0
  56. package/dist/cli/index.d.ts +13 -0
  57. package/dist/cli/index.js +25 -0
  58. package/dist/cli/mcp.d.ts +14 -0
  59. package/dist/clients/index.d.ts +2 -0
  60. package/dist/clients/index.js +107 -0
  61. package/dist/clients/plugin.d.ts +42 -0
  62. package/dist/combine/account.d.ts +4 -0
  63. package/dist/combine/adapter.d.ts +9 -0
  64. package/dist/combine/index.d.ts +2 -0
  65. package/dist/combine/index.js +345 -0
  66. package/dist/combine/route.d.ts +17 -0
  67. package/dist/exporter/index.d.ts +29 -0
  68. package/dist/exporter/index.js +77 -0
  69. package/dist/failover/index.d.ts +11 -0
  70. package/dist/failover/index.js +45 -0
  71. package/dist/fixtures/index.d.ts +27 -0
  72. package/dist/fixtures/index.js +241 -0
  73. package/dist/fixtures/scrub.d.ts +5 -0
  74. package/dist/heyreach/account.d.ts +11 -0
  75. package/dist/heyreach/adapter.d.ts +5 -0
  76. package/dist/heyreach/capabilities.d.ts +68 -0
  77. package/dist/heyreach/client.d.ts +20 -0
  78. package/dist/heyreach/inbox.d.ts +7 -0
  79. package/dist/heyreach/index.d.ts +18 -0
  80. package/dist/heyreach/index.js +1708 -0
  81. package/dist/heyreach/lookup.d.ts +15 -0
  82. package/dist/heyreach/map-account.d.ts +25 -0
  83. package/dist/heyreach/map-sequence.d.ts +5 -0
  84. package/dist/heyreach/map-stats.d.ts +10 -0
  85. package/dist/heyreach/map.d.ts +35 -0
  86. package/dist/heyreach/native-organization.d.ts +128 -0
  87. package/dist/heyreach/native-voice.d.ts +106 -0
  88. package/dist/heyreach/native.d.ts +496 -0
  89. package/dist/heyreach/paging.d.ts +7 -0
  90. package/dist/heyreach/webhooks.d.ts +2 -0
  91. package/dist/identity/index.d.ts +3 -0
  92. package/dist/identity/index.js +148 -0
  93. package/dist/identity/keys.d.ts +9 -0
  94. package/dist/identity/plugin.d.ts +34 -0
  95. package/dist/index.d.ts +36 -0
  96. package/dist/index.js +119 -0
  97. package/dist/insights/copy/copy-audit.d.ts +55 -0
  98. package/dist/insights/copy/copy-checks.d.ts +44 -0
  99. package/dist/insights/copy/copy-reuse.d.ts +59 -0
  100. package/dist/insights/copy/index.d.ts +67 -0
  101. package/dist/insights/copy/reply-timing.d.ts +63 -0
  102. package/dist/insights/copy/shared.d.ts +53 -0
  103. package/dist/insights/copy/step-funnel.d.ts +66 -0
  104. package/dist/insights/copy/variant-test.d.ts +64 -0
  105. package/dist/insights/define.d.ts +98 -0
  106. package/dist/insights/index.d.ts +10 -0
  107. package/dist/insights/index.js +4873 -0
  108. package/dist/insights/ops/anomalies.d.ts +80 -0
  109. package/dist/insights/ops/campaign-diagnosis.d.ts +39 -0
  110. package/dist/insights/ops/campaign-ranking.d.ts +56 -0
  111. package/dist/insights/ops/channel-mix.d.ts +44 -0
  112. package/dist/insights/ops/client-report.d.ts +76 -0
  113. package/dist/insights/ops/diagnosis-checks.d.ts +48 -0
  114. package/dist/insights/ops/index.d.ts +135 -0
  115. package/dist/insights/ops/period-comparison.d.ts +86 -0
  116. package/dist/insights/ops/pipeline-forecast.d.ts +44 -0
  117. package/dist/insights/ops/shared.d.ts +149 -0
  118. package/dist/insights/ops/tag-rollup.d.ts +32 -0
  119. package/dist/insights/people/account-summary.d.ts +68 -0
  120. package/dist/insights/people/dropped-replies.d.ts +51 -0
  121. package/dist/insights/people/find.d.ts +18 -0
  122. package/dist/insights/people/hot-leads.d.ts +67 -0
  123. package/dist/insights/people/index.d.ts +88 -0
  124. package/dist/insights/people/lead-collisions.d.ts +43 -0
  125. package/dist/insights/people/person-summary.d.ts +46 -0
  126. package/dist/insights/people/personalization-gaps.d.ts +60 -0
  127. package/dist/insights/people/read.d.ts +40 -0
  128. package/dist/insights/people/suppression-check.d.ts +53 -0
  129. package/dist/insights/plugin.d.ts +40 -0
  130. package/dist/insights/registry.d.ts +335 -0
  131. package/dist/insights/senders/bounce-watch.d.ts +70 -0
  132. package/dist/insights/senders/domain-health.d.ts +69 -0
  133. package/dist/insights/senders/index.d.ts +74 -0
  134. package/dist/insights/senders/read.d.ts +37 -0
  135. package/dist/insights/senders/sender-capacity.d.ts +67 -0
  136. package/dist/insights/senders/sender-load.d.ts +52 -0
  137. package/dist/insights/senders/settings-audit.d.ts +48 -0
  138. package/dist/insights/senders/warmup-readiness.d.ts +39 -0
  139. package/dist/insights/stats.d.ts +45 -0
  140. package/dist/insights/tools.d.ts +16 -0
  141. package/dist/insights/types.d.ts +4 -0
  142. package/dist/instantly/adapter-account.d.ts +5 -0
  143. package/dist/instantly/adapter-mail.d.ts +3 -0
  144. package/dist/instantly/adapter.d.ts +7 -0
  145. package/dist/instantly/capabilities.d.ts +83 -0
  146. package/dist/instantly/client.d.ts +29 -0
  147. package/dist/instantly/index.d.ts +20 -0
  148. package/dist/instantly/index.js +2372 -0
  149. package/dist/instantly/map-account.d.ts +23 -0
  150. package/dist/instantly/map-lead.d.ts +18 -0
  151. package/dist/instantly/map-stats.d.ts +22 -0
  152. package/dist/instantly/map.d.ts +24 -0
  153. package/dist/instantly/native-agents-sales.d.ts +161 -0
  154. package/dist/instantly/native-agents.d.ts +156 -0
  155. package/dist/instantly/native-campaigns.d.ts +101 -0
  156. package/dist/instantly/native-leads.d.ts +93 -0
  157. package/dist/instantly/native-params.d.ts +24 -0
  158. package/dist/instantly/native-search.d.ts +82 -0
  159. package/dist/instantly/native-senders.d.ts +182 -0
  160. package/dist/instantly/native-supersearch.d.ts +149 -0
  161. package/dist/instantly/native-workspace.d.ts +170 -0
  162. package/dist/instantly/native.d.ts +1081 -0
  163. package/dist/instantly/pages.d.ts +29 -0
  164. package/dist/instantly/stats.d.ts +5 -0
  165. package/dist/instantly/webhooks.d.ts +2 -0
  166. package/dist/internal/adapter.d.ts +189 -0
  167. package/dist/internal/capabilities.d.ts +86 -0
  168. package/dist/internal/cursor.d.ts +10 -0
  169. package/dist/internal/engine/budget.d.ts +44 -0
  170. package/dist/internal/engine/engine.d.ts +45 -0
  171. package/dist/internal/engine/rate-store.d.ts +25 -0
  172. package/dist/internal/engine/request.d.ts +27 -0
  173. package/dist/internal/engine/retry.d.ts +21 -0
  174. package/dist/internal/engine/runtime.d.ts +13 -0
  175. package/dist/internal/entities-account.d.ts +135 -0
  176. package/dist/internal/entities.d.ts +389 -0
  177. package/dist/internal/env.d.ts +4 -0
  178. package/dist/internal/errors.d.ts +57 -0
  179. package/dist/internal/hooks.d.ts +55 -0
  180. package/dist/internal/json.d.ts +40 -0
  181. package/dist/internal/limits.d.ts +34 -0
  182. package/dist/internal/metrics.d.ts +52 -0
  183. package/dist/internal/native.d.ts +66 -0
  184. package/dist/internal/outbound/api.d.ts +267 -0
  185. package/dist/internal/outbound/collections.d.ts +31 -0
  186. package/dist/internal/outbound/core.d.ts +36 -0
  187. package/dist/internal/outbound/create.d.ts +16 -0
  188. package/dist/internal/outbound/handles.d.ts +7 -0
  189. package/dist/internal/outbound/native.d.ts +4 -0
  190. package/dist/internal/outbound/operation-shared.d.ts +28 -0
  191. package/dist/internal/outbound/operations-account.d.ts +29 -0
  192. package/dist/internal/outbound/operations.d.ts +42 -0
  193. package/dist/internal/outbound/outbound.d.ts +64 -0
  194. package/dist/internal/outbound/plugins.d.ts +40 -0
  195. package/dist/internal/outbound/raw.d.ts +9 -0
  196. package/dist/internal/outbound/specs-account.d.ts +16 -0
  197. package/dist/internal/outbound/specs.d.ts +14 -0
  198. package/dist/internal/outbound/stats.d.ts +7 -0
  199. package/dist/internal/outbound/validate.d.ts +5 -0
  200. package/dist/internal/outbound/walker.d.ts +22 -0
  201. package/dist/internal/record.d.ts +19 -0
  202. package/dist/internal/redact.d.ts +18 -0
  203. package/dist/internal/ref.d.ts +16 -0
  204. package/dist/internal/sha256.d.ts +4 -0
  205. package/dist/internal/text.d.ts +11 -0
  206. package/dist/internal/url.d.ts +9 -0
  207. package/dist/loader/index.d.ts +12 -0
  208. package/dist/loader/index.js +12 -0
  209. package/dist/memory/account-reads.d.ts +5 -0
  210. package/dist/memory/account.d.ts +67 -0
  211. package/dist/memory/adapter.d.ts +16 -0
  212. package/dist/memory/data.d.ts +122 -0
  213. package/dist/memory/demo.d.ts +7 -0
  214. package/dist/memory/index.d.ts +5 -0
  215. package/dist/memory/index.js +792 -0
  216. package/dist/memory/stats.d.ts +6 -0
  217. package/dist/memory/store.d.ts +18 -0
  218. package/dist/providers/index.d.ts +22 -0
  219. package/dist/providers/index.js +10 -0
  220. package/dist/reconcile/index.d.ts +2 -0
  221. package/dist/reconcile/index.js +72 -0
  222. package/dist/reconcile/plugin.d.ts +55 -0
  223. package/dist/redact/index.d.ts +2 -0
  224. package/dist/redact/index.js +192 -0
  225. package/dist/redact/plugin.d.ts +22 -0
  226. package/dist/redis/index.d.ts +41 -0
  227. package/dist/redis/index.js +114 -0
  228. package/dist/smartlead/account.d.ts +5 -0
  229. package/dist/smartlead/adapter.d.ts +5 -0
  230. package/dist/smartlead/capabilities.d.ts +85 -0
  231. package/dist/smartlead/client.d.ts +23 -0
  232. package/dist/smartlead/hmac.d.ts +9 -0
  233. package/dist/smartlead/index.d.ts +17 -0
  234. package/dist/smartlead/index.js +2170 -0
  235. package/dist/smartlead/leads.d.ts +6 -0
  236. package/dist/smartlead/lookup.d.ts +8 -0
  237. package/dist/smartlead/mail.d.ts +5 -0
  238. package/dist/smartlead/map-account.d.ts +22 -0
  239. package/dist/smartlead/map-messages.d.ts +31 -0
  240. package/dist/smartlead/map-stats.d.ts +37 -0
  241. package/dist/smartlead/map.d.ts +52 -0
  242. package/dist/smartlead/native-analytics.d.ts +242 -0
  243. package/dist/smartlead/native-campaigns.d.ts +211 -0
  244. package/dist/smartlead/native-inbox.d.ts +141 -0
  245. package/dist/smartlead/native-params.d.ts +33 -0
  246. package/dist/smartlead/native-services.d.ts +204 -0
  247. package/dist/smartlead/native.d.ts +785 -0
  248. package/dist/smartlead/shared.d.ts +28 -0
  249. package/dist/smartlead/stats.d.ts +5 -0
  250. package/dist/smartlead/webhooks.d.ts +2 -0
  251. package/dist/sync/index.d.ts +2 -0
  252. package/dist/sync/index.js +158 -0
  253. package/dist/sync/plugin.d.ts +58 -0
  254. package/dist/tools/account-tools.d.ts +21 -0
  255. package/dist/tools/ai-sdk.d.ts +8 -0
  256. package/dist/tools/ai-sdk.js +26 -0
  257. package/dist/tools/campaign-tools.d.ts +59 -0
  258. package/dist/tools/claude-agent.d.ts +18 -0
  259. package/dist/tools/claude-agent.js +40 -0
  260. package/dist/tools/index.d.ts +28 -0
  261. package/dist/tools/index.js +20 -0
  262. package/dist/tools/people-tools.d.ts +19 -0
  263. package/dist/tools/registry.d.ts +34 -0
  264. package/dist/tools/shared.d.ts +75 -0
  265. package/dist/tracing/index.d.ts +25 -0
  266. package/dist/tracing/index.js +69 -0
  267. package/dist/webhooks/index.d.ts +3 -0
  268. package/dist/webhooks/index.js +226 -0
  269. package/dist/webhooks/parse.d.ts +41 -0
  270. package/dist/webhooks/secret.d.ts +4 -0
  271. package/package.json +181 -4
@@ -0,0 +1,82 @@
1
+ export declare const SEARCH_READS: {
2
+ readonly creatorOutreachBatch: {
3
+ readonly description: "A creator list and the progress of its last conversion into leads.";
4
+ readonly docs: string;
5
+ readonly method: "GET";
6
+ readonly params: {
7
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
8
+ };
9
+ readonly path: "/creator-search/outreach-batches/{id}";
10
+ };
11
+ readonly creatorSearchAllowance: {
12
+ readonly description: "The free creator search pages left today and the price after them.";
13
+ readonly docs: string;
14
+ readonly method: "GET";
15
+ readonly path: "/creator-search/search-allowance";
16
+ };
17
+ readonly creatorSearchCapabilities: {
18
+ readonly description: "What creator search supports and what enrichment costs.";
19
+ readonly docs: string;
20
+ readonly method: "GET";
21
+ readonly path: "/creator-search/capabilities";
22
+ };
23
+ readonly creatorSearchDictionaries: {
24
+ readonly description: "The ids of the languages, interests, brands and audiences a creator search can filter on.";
25
+ readonly docs: string;
26
+ readonly method: "GET";
27
+ readonly params: {
28
+ readonly platform: import("./native-params.ts").Needed<"query", "string">;
29
+ readonly query: import("./native-params.ts").Placed<"query", "string">;
30
+ };
31
+ readonly path: "/creator-search/dictionaries";
32
+ };
33
+ readonly creatorSearchLocations: {
34
+ readonly description: "The places a creator search can filter on.";
35
+ readonly docs: string;
36
+ readonly method: "GET";
37
+ readonly params: {
38
+ readonly platform: import("./native-params.ts").Needed<"query", "string">;
39
+ readonly query: import("./native-params.ts").Needed<"query", "string">;
40
+ };
41
+ readonly path: "/creator-search/locations";
42
+ };
43
+ readonly localBusinessConversion: {
44
+ readonly description: "The progress of a job that turns local businesses into leads.";
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: "/local-business-search/convert/{id}";
51
+ };
52
+ readonly localBusinessFilters: {
53
+ readonly description: "The search filters a sentence such as dentists in Austin stands for.";
54
+ readonly docs: string;
55
+ readonly lane: "localBusinessFilters";
56
+ readonly method: "POST";
57
+ readonly params: {
58
+ readonly input: import("./native-params.ts").Needed<"body", "string">;
59
+ };
60
+ readonly path: "/local-business-search/ai-filters";
61
+ };
62
+ readonly localBusinessPlaces: {
63
+ readonly description: "The cities a local business search can use as its location.";
64
+ readonly docs: string;
65
+ readonly method: "GET";
66
+ readonly params: {
67
+ readonly q: import("./native-params.ts").Needed<"query", "string">;
68
+ };
69
+ readonly path: "/local-business-search/places";
70
+ };
71
+ readonly localBusinessSearch: {
72
+ readonly description: "Local businesses by category and place. Searching is free; emails are not shown.";
73
+ readonly docs: string;
74
+ readonly lane: "localBusinessSearch";
75
+ readonly method: "POST";
76
+ readonly params: {
77
+ readonly filters: import("./native-params.ts").Needed<"body", "json">;
78
+ readonly page_size: import("./native-params.ts").Placed<"body", "number">;
79
+ };
80
+ readonly path: "/local-business-search/search";
81
+ };
82
+ };
@@ -0,0 +1,182 @@
1
+ export declare const SENDER_READS: {
2
+ readonly crmPhoneNumbers: {
3
+ readonly description: "The phone numbers the workspace rents for calls and texts.";
4
+ readonly docs: string;
5
+ readonly method: "GET";
6
+ readonly path: "/crm-actions/phone-numbers";
7
+ };
8
+ readonly dfyAccounts: {
9
+ readonly description: "The done-for-you mailboxes the workspace ordered. Passwords are never asked for.";
10
+ readonly docs: string;
11
+ readonly method: "GET";
12
+ readonly params: {
13
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
14
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
15
+ };
16
+ readonly path: "/dfy-email-account-orders/accounts";
17
+ };
18
+ readonly dfyOrders: {
19
+ readonly description: "The done-for-you mailbox orders the workspace placed.";
20
+ readonly docs: string;
21
+ readonly method: "GET";
22
+ readonly params: {
23
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
24
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
25
+ };
26
+ readonly path: "/dfy-email-account-orders";
27
+ };
28
+ readonly dfyPreWarmedDomains: {
29
+ readonly description: "The pre-warmed domains Instantly has for sale.";
30
+ readonly docs: string;
31
+ readonly method: "POST";
32
+ readonly params: {
33
+ readonly extensions: import("./native-params.ts").Placed<"body", "json">;
34
+ readonly search: import("./native-params.ts").Placed<"body", "string">;
35
+ };
36
+ readonly path: "/dfy-email-account-orders/domains/pre-warmed-up-list";
37
+ };
38
+ readonly domainForwarding: {
39
+ readonly description: "Where a domain bought through Instantly forwards web visitors.";
40
+ readonly docs: string;
41
+ readonly method: "GET";
42
+ readonly params: {
43
+ readonly domain: import("./native-params.ts").Placed<"path", "string">;
44
+ };
45
+ readonly path: "/domains/{domain}/forwarding";
46
+ };
47
+ readonly inboxPlacementEspOptions: {
48
+ readonly description: "The mail providers an inbox placement test can send to.";
49
+ readonly docs: string;
50
+ readonly method: "GET";
51
+ readonly path: "/inbox-placement-tests/email-service-provider-options";
52
+ };
53
+ readonly inboxPlacementInsights: {
54
+ readonly description: "A test's inbox, spam and category shares, with the earlier period beside them when asked.";
55
+ readonly docs: string;
56
+ readonly method: "POST";
57
+ readonly params: {
58
+ readonly date_from: import("./native-params.ts").Placed<"body", "string">;
59
+ readonly date_to: import("./native-params.ts").Placed<"body", "string">;
60
+ readonly previous_date_from: import("./native-params.ts").Placed<"body", "string">;
61
+ readonly previous_date_to: import("./native-params.ts").Placed<"body", "string">;
62
+ readonly recipient_esp: import("./native-params.ts").Placed<"body", "json">;
63
+ readonly recipient_geo: import("./native-params.ts").Placed<"body", "json">;
64
+ readonly recipient_type: import("./native-params.ts").Placed<"body", "json">;
65
+ readonly show_previous: import("./native-params.ts").Placed<"body", "boolean">;
66
+ readonly test_id: import("./native-params.ts").Needed<"body", "string">;
67
+ };
68
+ readonly path: "/inbox-placement-analytics/deliverability-insights";
69
+ };
70
+ readonly inboxPlacementReport: {
71
+ readonly description: "One blacklist and SpamAssassin report.";
72
+ readonly docs: string;
73
+ readonly method: "GET";
74
+ readonly params: {
75
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
76
+ };
77
+ readonly path: "/inbox-placement-reports/{id}";
78
+ };
79
+ readonly inboxPlacementReports: {
80
+ readonly description: "A test's blacklist and SpamAssassin reports.";
81
+ readonly docs: string;
82
+ readonly method: "GET";
83
+ readonly params: {
84
+ readonly date_from: import("./native-params.ts").Placed<"query", "string">;
85
+ readonly date_to: import("./native-params.ts").Placed<"query", "string">;
86
+ readonly skip_blacklist_report: import("./native-params.ts").Placed<"query", "boolean">;
87
+ readonly skip_spam_assassin_report: import("./native-params.ts").Placed<"query", "boolean">;
88
+ readonly test_id: import("./native-params.ts").Needed<"query", "string">;
89
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
90
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
91
+ };
92
+ readonly path: "/inbox-placement-reports";
93
+ };
94
+ readonly inboxPlacementResult: {
95
+ readonly description: "One test email's placement result.";
96
+ readonly docs: string;
97
+ readonly method: "GET";
98
+ readonly params: {
99
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
100
+ };
101
+ readonly path: "/inbox-placement-analytics/{id}";
102
+ };
103
+ readonly inboxPlacementResults: {
104
+ readonly description: "Where each test email landed: inbox, spam or a category folder, with its SPF, DKIM and DMARC results.";
105
+ readonly docs: string;
106
+ readonly method: "GET";
107
+ readonly params: {
108
+ readonly date_from: import("./native-params.ts").Placed<"query", "string">;
109
+ readonly date_to: import("./native-params.ts").Placed<"query", "string">;
110
+ readonly recipient_esp: import("./native-params.ts").Placed<"query", "string">;
111
+ readonly recipient_geo: import("./native-params.ts").Placed<"query", "string">;
112
+ readonly recipient_type: import("./native-params.ts").Placed<"query", "string">;
113
+ readonly sender_email: import("./native-params.ts").Placed<"query", "string">;
114
+ readonly test_id: import("./native-params.ts").Needed<"query", "string">;
115
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
116
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
117
+ };
118
+ readonly path: "/inbox-placement-analytics";
119
+ };
120
+ readonly inboxPlacementStatsByDate: {
121
+ readonly description: "A test's inbox, spam and category counts for each day.";
122
+ readonly docs: string;
123
+ readonly method: "POST";
124
+ readonly params: {
125
+ readonly date_from: import("./native-params.ts").Placed<"body", "string">;
126
+ readonly date_to: import("./native-params.ts").Placed<"body", "string">;
127
+ readonly recipient_esp: import("./native-params.ts").Placed<"body", "json">;
128
+ readonly recipient_geo: import("./native-params.ts").Placed<"body", "json">;
129
+ readonly recipient_type: import("./native-params.ts").Placed<"body", "json">;
130
+ readonly sender_email: import("./native-params.ts").Placed<"body", "string">;
131
+ readonly test_id: import("./native-params.ts").Needed<"body", "string">;
132
+ };
133
+ readonly path: "/inbox-placement-analytics/stats-by-date";
134
+ };
135
+ readonly inboxPlacementStatsByTest: {
136
+ readonly description: "Inbox, spam and category counts for each of several tests.";
137
+ readonly docs: string;
138
+ readonly method: "POST";
139
+ readonly params: {
140
+ readonly date_from: import("./native-params.ts").Placed<"body", "string">;
141
+ readonly date_to: import("./native-params.ts").Placed<"body", "string">;
142
+ readonly recipient_esp: import("./native-params.ts").Placed<"body", "json">;
143
+ readonly recipient_geo: import("./native-params.ts").Placed<"body", "json">;
144
+ readonly recipient_type: import("./native-params.ts").Placed<"body", "json">;
145
+ readonly sender_email: import("./native-params.ts").Placed<"body", "string">;
146
+ readonly test_ids: import("./native-params.ts").Needed<"body", "json">;
147
+ };
148
+ readonly path: "/inbox-placement-analytics/stats-by-test-id";
149
+ };
150
+ readonly inboxPlacementTest: {
151
+ readonly description: "One inbox placement test.";
152
+ readonly docs: string;
153
+ readonly method: "GET";
154
+ readonly params: {
155
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
156
+ readonly with_metadata: import("./native-params.ts").Placed<"query", "boolean">;
157
+ };
158
+ readonly path: "/inbox-placement-tests/{id}";
159
+ };
160
+ readonly inboxPlacementTests: {
161
+ readonly description: "The workspace's inbox placement tests.";
162
+ readonly docs: string;
163
+ readonly method: "GET";
164
+ readonly params: {
165
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
166
+ readonly sort_order: import("./native-params.ts").Placed<"query", "string">;
167
+ readonly status: import("./native-params.ts").Placed<"query", "number">;
168
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
169
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
170
+ };
171
+ readonly path: "/inbox-placement-tests";
172
+ };
173
+ readonly trackingDomainStatus: {
174
+ readonly description: "Whether a custom tracking domain's CNAME and SSL are in place.";
175
+ readonly docs: string;
176
+ readonly method: "GET";
177
+ readonly params: {
178
+ readonly host: import("./native-params.ts").Needed<"query", "string">;
179
+ };
180
+ readonly path: "/accounts/ctd/status";
181
+ };
182
+ };
@@ -0,0 +1,149 @@
1
+ export declare const SUPERSEARCH_READS: {
2
+ readonly aiEnrichmentsInProgress: {
3
+ readonly description: "The AI enrichment jobs still running for a list or campaign.";
4
+ readonly docs: string;
5
+ readonly method: "GET";
6
+ readonly params: {
7
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
8
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
9
+ readonly resource_id: import("./native-params.ts").Placed<"path", "string">;
10
+ };
11
+ readonly path: "/supersearch-enrichment/ai/{resource_id}/in-progress";
12
+ };
13
+ readonly companyList: {
14
+ readonly description: "One company list and how far its build is.";
15
+ readonly docs: string;
16
+ readonly method: "GET";
17
+ readonly params: {
18
+ readonly company_list_id: import("./native-params.ts").Placed<"path", "string">;
19
+ };
20
+ readonly path: "/supersearch-enrichment/company-lists/{company_list_id}";
21
+ };
22
+ readonly companyListCompanies: {
23
+ readonly description: "The companies in a company list.";
24
+ readonly docs: string;
25
+ readonly method: "GET";
26
+ readonly params: {
27
+ readonly company_list_id: import("./native-params.ts").Placed<"path", "string">;
28
+ readonly cursor: import("./native-params.ts").Placed<"query", "string">;
29
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
30
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
31
+ };
32
+ readonly path: "/supersearch-enrichment/company-lists/{company_list_id}/companies";
33
+ };
34
+ readonly companyListFilterOptions: {
35
+ readonly description: "The values a company-list filter accepts.";
36
+ readonly docs: string;
37
+ readonly method: "GET";
38
+ readonly params: {
39
+ readonly catalog_id: import("./native-params.ts").Needed<"query", "string">;
40
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
41
+ readonly q: import("./native-params.ts").Placed<"query", "string">;
42
+ };
43
+ readonly path: "/supersearch-enrichment/company-lists/filter-options";
44
+ };
45
+ readonly companyListRecipes: {
46
+ readonly description: "The ready-made recipes for building a company list.";
47
+ readonly docs: string;
48
+ readonly method: "GET";
49
+ readonly path: "/supersearch-enrichment/company-lists/recipes";
50
+ };
51
+ readonly companyListSources: {
52
+ readonly description: "The sources a company list can be built from.";
53
+ readonly docs: string;
54
+ readonly method: "GET";
55
+ readonly path: "/supersearch-enrichment/company-lists/sources";
56
+ };
57
+ readonly companyLists: {
58
+ readonly description: "The company lists the workspace built.";
59
+ readonly docs: string;
60
+ readonly method: "GET";
61
+ readonly params: {
62
+ readonly cursor: import("./native-params.ts").Placed<"query", "string">;
63
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
64
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
65
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
66
+ };
67
+ readonly path: "/supersearch-enrichment/company-lists";
68
+ };
69
+ readonly enrichment: {
70
+ readonly description: "The enrichment settings and progress of a list or campaign.";
71
+ readonly docs: string;
72
+ readonly method: "GET";
73
+ readonly params: {
74
+ readonly resource_id: import("./native-params.ts").Placed<"path", "string">;
75
+ };
76
+ readonly path: "/supersearch-enrichment/{resource_id}";
77
+ };
78
+ readonly enrichmentHistory: {
79
+ readonly description: "The enrichment runs of a list or campaign, newest first.";
80
+ readonly docs: string;
81
+ readonly method: "GET";
82
+ readonly params: {
83
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
84
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
85
+ readonly resource_id: import("./native-params.ts").Placed<"path", "string">;
86
+ };
87
+ readonly path: "/supersearch-enrichment/history/{resource_id}";
88
+ };
89
+ readonly enrichmentProviders: {
90
+ readonly description: "Every data provider an enrichment can call, with its actions and credit cost.";
91
+ readonly docs: string;
92
+ readonly method: "GET";
93
+ readonly path: "/supersearch-enrichment/integrations/providers";
94
+ };
95
+ readonly savedSearch: {
96
+ readonly description: "One saved SuperSearch query.";
97
+ readonly docs: string;
98
+ readonly method: "GET";
99
+ readonly params: {
100
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
101
+ };
102
+ readonly path: "/supersearch-enrichment/saved-searches/{id}";
103
+ };
104
+ readonly savedSearches: {
105
+ readonly description: "The workspace's saved SuperSearch queries, newest first.";
106
+ readonly docs: string;
107
+ readonly method: "GET";
108
+ readonly params: {
109
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
110
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
111
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
112
+ };
113
+ readonly path: "/supersearch-enrichment/saved-searches";
114
+ };
115
+ readonly superSearchLeadCount: {
116
+ readonly description: "How many leads match a SuperSearch query. Nothing is enriched.";
117
+ readonly docs: string;
118
+ readonly method: "POST";
119
+ readonly params: {
120
+ readonly search_filters: import("./native-params.ts").Needed<"body", "json">;
121
+ readonly show_one_lead_per_company: import("./native-params.ts").Placed<"body", "boolean">;
122
+ readonly skip_owned_leads: import("./native-params.ts").Placed<"body", "boolean">;
123
+ };
124
+ readonly path: "/supersearch-enrichment/count-leads-from-supersearch";
125
+ };
126
+ readonly superSearchLeadPreview: {
127
+ readonly description: "A sample of the leads that match a SuperSearch query. Nothing is enriched.";
128
+ readonly docs: string;
129
+ readonly method: "POST";
130
+ readonly params: {
131
+ readonly search_filters: import("./native-params.ts").Needed<"body", "json">;
132
+ readonly show_one_lead_per_company: import("./native-params.ts").Placed<"body", "boolean">;
133
+ readonly skip_owned_leads: import("./native-params.ts").Placed<"body", "boolean">;
134
+ };
135
+ readonly path: "/supersearch-enrichment/preview-leads-from-supersearch";
136
+ };
137
+ readonly superSearchSignalKeywords: {
138
+ readonly description: "The most common keywords of a signal category over the last 90 days.";
139
+ readonly docs: string;
140
+ readonly method: "POST";
141
+ readonly params: {
142
+ readonly category: import("./native-params.ts").Needed<"body", "string">;
143
+ readonly field: import("./native-params.ts").Needed<"body", "string">;
144
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
145
+ readonly prefix: import("./native-params.ts").Placed<"body", "string">;
146
+ };
147
+ readonly path: "/supersearch-enrichment/signal-keywords-facet";
148
+ };
149
+ };
@@ -0,0 +1,170 @@
1
+ export declare const WORKSPACE_READS: {
2
+ readonly agentItems: {
3
+ readonly description: "Every AI agent and automation in the workspace, in one list.";
4
+ readonly docs: string;
5
+ readonly method: "GET";
6
+ readonly params: {
7
+ readonly ai_agent_type: import("./native-params.ts").Placed<"query", "number">;
8
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
9
+ readonly status: import("./native-params.ts").Placed<"query", "string">;
10
+ readonly type: import("./native-params.ts").Placed<"query", "string">;
11
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
12
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
13
+ };
14
+ readonly path: "/agent-items";
15
+ };
16
+ readonly auditLogs: {
17
+ readonly description: "Who did what in the workspace.";
18
+ readonly docs: string;
19
+ readonly method: "GET";
20
+ readonly params: {
21
+ readonly activity_type: import("./native-params.ts").Placed<"query", "number">;
22
+ readonly end_date: import("./native-params.ts").Placed<"query", "string">;
23
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
24
+ readonly start_date: import("./native-params.ts").Placed<"query", "string">;
25
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
26
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
27
+ };
28
+ readonly path: "/audit-logs";
29
+ };
30
+ readonly backgroundJob: {
31
+ readonly description: "One background job and its progress.";
32
+ readonly docs: string;
33
+ readonly method: "GET";
34
+ readonly params: {
35
+ readonly data_fields: import("./native-params.ts").Placed<"query", "string">;
36
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
37
+ };
38
+ readonly path: "/background-jobs/{id}";
39
+ };
40
+ readonly backgroundJobs: {
41
+ readonly description: "Background jobs such as lead moves, imports and exports, with their progress.";
42
+ readonly docs: string;
43
+ readonly method: "GET";
44
+ readonly params: {
45
+ readonly entity_id: import("./native-params.ts").Placed<"query", "string">;
46
+ readonly entity_type: import("./native-params.ts").Placed<"query", "string">;
47
+ readonly excluded_ids: import("./native-params.ts").Placed<"query", "string">;
48
+ readonly ids: import("./native-params.ts").Placed<"query", "string">;
49
+ readonly included_ids: import("./native-params.ts").Placed<"query", "string">;
50
+ readonly sort_column: import("./native-params.ts").Placed<"query", "string">;
51
+ readonly sort_order: import("./native-params.ts").Placed<"query", "string">;
52
+ readonly status: import("./native-params.ts").Placed<"query", "string">;
53
+ readonly type: import("./native-params.ts").Placed<"query", "string">;
54
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
55
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
56
+ };
57
+ readonly path: "/background-jobs";
58
+ };
59
+ readonly webhook: {
60
+ readonly description: "One webhook. Its headers can carry a secret.";
61
+ readonly docs: string;
62
+ readonly method: "GET";
63
+ readonly params: {
64
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
65
+ };
66
+ readonly path: "/webhooks/{id}";
67
+ readonly sensitive: true;
68
+ };
69
+ readonly webhookEvent: {
70
+ readonly description: "One webhook delivery with its payload and response.";
71
+ readonly docs: string;
72
+ readonly method: "GET";
73
+ readonly params: {
74
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
75
+ };
76
+ readonly path: "/webhook-events/{id}";
77
+ };
78
+ readonly webhookEventSummary: {
79
+ readonly description: "How many webhook deliveries worked and failed.";
80
+ readonly docs: string;
81
+ readonly method: "GET";
82
+ readonly params: {
83
+ readonly from: import("./native-params.ts").Placed<"query", "string">;
84
+ readonly to: import("./native-params.ts").Placed<"query", "string">;
85
+ };
86
+ readonly path: "/webhook-events/summary";
87
+ };
88
+ readonly webhookEventSummaryByDate: {
89
+ readonly description: "Webhook deliveries that worked and failed, for each day.";
90
+ readonly docs: string;
91
+ readonly method: "GET";
92
+ readonly params: {
93
+ readonly from: import("./native-params.ts").Placed<"query", "string">;
94
+ readonly to: import("./native-params.ts").Placed<"query", "string">;
95
+ };
96
+ readonly path: "/webhook-events/summary-by-date";
97
+ };
98
+ readonly webhookEventTypes: {
99
+ readonly description: "Every event a webhook can listen for, custom lead labels included.";
100
+ readonly docs: string;
101
+ readonly method: "GET";
102
+ readonly path: "/webhooks/event-types";
103
+ };
104
+ readonly webhookEvents: {
105
+ readonly description: "The delivery log: each webhook call Instantly made and how the receiver answered.";
106
+ readonly docs: string;
107
+ readonly method: "GET";
108
+ readonly params: {
109
+ readonly from: import("./native-params.ts").Placed<"query", "string">;
110
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
111
+ readonly success: import("./native-params.ts").Placed<"query", "boolean">;
112
+ readonly to: import("./native-params.ts").Placed<"query", "string">;
113
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
114
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
115
+ };
116
+ readonly path: "/webhook-events";
117
+ };
118
+ readonly whitelabelDomain: {
119
+ readonly description: "The agency domain verified for the workspace.";
120
+ readonly docs: string;
121
+ readonly method: "GET";
122
+ readonly path: "/workspaces/current/whitelabel-domain";
123
+ };
124
+ readonly workspaceGroupAdmin: {
125
+ readonly description: "The admin workspace this workspace belongs to.";
126
+ readonly docs: string;
127
+ readonly method: "GET";
128
+ readonly path: "/workspace-group-members/admin";
129
+ };
130
+ readonly workspaceGroupMember: {
131
+ readonly description: "One sub workspace of an admin workspace.";
132
+ readonly docs: string;
133
+ readonly method: "GET";
134
+ readonly params: {
135
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
136
+ };
137
+ readonly path: "/workspace-group-members/{id}";
138
+ };
139
+ readonly workspaceGroupMembers: {
140
+ readonly description: "The sub workspaces of an agency's admin workspace.";
141
+ readonly docs: string;
142
+ readonly method: "GET";
143
+ readonly params: {
144
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
145
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
146
+ };
147
+ readonly path: "/workspace-group-members";
148
+ };
149
+ readonly workspaceMember: {
150
+ readonly description: "One workspace member.";
151
+ readonly docs: string;
152
+ readonly method: "GET";
153
+ readonly params: {
154
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
155
+ };
156
+ readonly path: "/workspace-members/{id}";
157
+ };
158
+ readonly workspaceMembers: {
159
+ readonly description: "The people in the workspace and their roles. Leads and emails name them in assigned_to.";
160
+ readonly docs: string;
161
+ readonly method: "GET";
162
+ readonly params: {
163
+ readonly accepted: import("./native-params.ts").Placed<"query", "boolean">;
164
+ readonly search: import("./native-params.ts").Placed<"query", "string">;
165
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
166
+ readonly starting_after: import("./native-params.ts").Placed<"query", "string">;
167
+ };
168
+ readonly path: "/workspace-members";
169
+ };
170
+ };