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,141 @@
1
+ export declare const INBOX: {
2
+ readonly inboxArchived: {
3
+ readonly description: "Archived threads of the master inbox.";
4
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-archived";
5
+ readonly method: "POST";
6
+ readonly params: {
7
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
8
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
9
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
10
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
11
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
12
+ };
13
+ readonly path: "/master-inbox/archived";
14
+ };
15
+ readonly inboxAssignedToMe: {
16
+ readonly description: "Threads assigned to the key's own user.";
17
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-assigned";
18
+ readonly method: "POST";
19
+ readonly params: {
20
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
21
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
22
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
23
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
24
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
25
+ };
26
+ readonly path: "/master-inbox/assigned-me";
27
+ };
28
+ readonly inboxImportant: {
29
+ readonly description: "Threads marked as important.";
30
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-important";
31
+ readonly method: "POST";
32
+ readonly params: {
33
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
34
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
35
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
36
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
37
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
38
+ };
39
+ readonly path: "/master-inbox/important";
40
+ };
41
+ readonly inboxReminders: {
42
+ readonly description: "Threads with a reminder, with its time and message.";
43
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-reminders";
44
+ readonly method: "POST";
45
+ readonly params: {
46
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
47
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
48
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
49
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
50
+ };
51
+ readonly path: "/master-inbox/reminders";
52
+ };
53
+ readonly inboxScheduled: {
54
+ readonly description: "Emails queued to be sent later, with their scheduled time.";
55
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-scheduled";
56
+ readonly method: "POST";
57
+ readonly params: {
58
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
59
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
60
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
61
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
62
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
63
+ };
64
+ readonly path: "/master-inbox/scheduled";
65
+ };
66
+ readonly inboxSent: {
67
+ readonly description: "Sent emails across every campaign, one thread per row.";
68
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-sent";
69
+ readonly method: "POST";
70
+ readonly params: {
71
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
72
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
73
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
74
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
75
+ };
76
+ readonly path: "/master-inbox/sent";
77
+ };
78
+ readonly inboxSnoozed: {
79
+ readonly description: "Threads snoozed for later.";
80
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-snoozed";
81
+ readonly method: "POST";
82
+ readonly params: {
83
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
84
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
85
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
86
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
87
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
88
+ };
89
+ readonly path: "/master-inbox/snoozed";
90
+ };
91
+ readonly inboxUnread: {
92
+ readonly description: "Threads with an unread reply.";
93
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-unread";
94
+ readonly method: "POST";
95
+ readonly params: {
96
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
97
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
98
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
99
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
100
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
101
+ };
102
+ readonly path: "/master-inbox/unread-replies";
103
+ };
104
+ readonly inboxUntrackedReplies: {
105
+ readonly description: "Replies that reached a connected mailbox but belong to no campaign.";
106
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-untracked";
107
+ readonly method: "GET";
108
+ readonly params: {
109
+ readonly fetchAttachments: import("./native-params.ts").Placed<"query", "boolean">;
110
+ readonly fetchBody: import("./native-params.ts").Placed<"query", "boolean">;
111
+ readonly from_email: import("./native-params.ts").Placed<"query", "string">;
112
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
113
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
114
+ readonly subject_line: import("./native-params.ts").Placed<"query", "string">;
115
+ readonly to_email: import("./native-params.ts").Placed<"query", "string">;
116
+ };
117
+ readonly path: "/master-inbox/untracked-replies";
118
+ };
119
+ readonly inboxView: {
120
+ readonly description: "Threads matching a custom view: the inbox filters plus a subsequence.";
121
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-views";
122
+ readonly method: "POST";
123
+ readonly params: {
124
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
125
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
126
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
127
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
128
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
129
+ };
130
+ readonly path: "/master-inbox/views";
131
+ };
132
+ readonly replyStatus: {
133
+ readonly description: "Whether a reply sent from the master inbox was delivered, and when.";
134
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/reply-status";
135
+ readonly method: "GET";
136
+ readonly params: {
137
+ readonly message_id: import("./native-params.ts").Needed<"query", "string">;
138
+ };
139
+ readonly path: "/master-inbox/reply-status";
140
+ };
141
+ };
@@ -0,0 +1,33 @@
1
+ import type { NativeParam } from "../internal/native.ts";
2
+ type ParamType = NativeParam["type"];
3
+ /** A parameter and where it goes. Exported so the catalog's type can be named. */
4
+ export interface Placed<Where extends NativeParam["in"], Type extends ParamType> {
5
+ readonly description: string;
6
+ readonly in: Where;
7
+ readonly type: Type;
8
+ }
9
+ export interface Needed<Where extends NativeParam["in"], Type extends ParamType> extends Placed<Where, Type> {
10
+ readonly required: true;
11
+ }
12
+ /** Smartlead's reference pages. */
13
+ export declare const DOCS = "https://api.smartlead.ai/api-reference";
14
+ /** The sister services, each on its own host with the same `api_key`. */
15
+ export declare const DELIVERY_URL = "https://smartdelivery.smartlead.ai/api/v1";
16
+ export declare const PROSPECT_URL = "https://prospect-api.smartlead.ai/api/v1";
17
+ export declare const SENDERS_URL = "https://smart-senders.smartlead.ai/api/v1";
18
+ export declare const SERVERS_URL = "https://smartservers.smartlead.ai/api/v1";
19
+ export declare const query: <const Type extends ParamType>(type: Type, description: string) => Placed<"query", Type>;
20
+ export declare const queryRequired: <const Type extends ParamType>(type: Type, description: string) => Needed<"query", Type>;
21
+ export declare const body: <const Type extends ParamType>(type: Type, description: string) => Placed<"body", Type>;
22
+ export declare const bodyRequired: <const Type extends ParamType>(type: Type, description: string) => Needed<"body", Type>;
23
+ /**
24
+ * A path parameter. Smartlead's ids are numbers, but the SDK's ids are
25
+ * strings, so an id from a normalized record can be passed as it is.
26
+ */
27
+ export declare const path: (description: string) => Placed<"path", "string">;
28
+ /** `limit` and `offset` in the query, for the offset-paged lists. */
29
+ export declare const paged: (limit: string) => {
30
+ limit: Placed<"query", "number">;
31
+ offset: Placed<"query", "number">;
32
+ };
33
+ export {};
@@ -0,0 +1,204 @@
1
+ export interface ServiceRead<Params> {
2
+ readonly baseUrl: string;
3
+ readonly description: string;
4
+ readonly docs: string;
5
+ readonly method: "GET";
6
+ readonly params: Params;
7
+ readonly path: string;
8
+ }
9
+ export declare const DELIVERY: {
10
+ readonly deliveryDkimDetails: ServiceRead<{
11
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
12
+ }>;
13
+ readonly deliveryDomainBlacklist: ServiceRead<{
14
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
15
+ }>;
16
+ readonly deliveryEmailContent: ServiceRead<{
17
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
18
+ }>;
19
+ readonly deliveryFolder: {
20
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
21
+ readonly description: "One folder of placement tests.";
22
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/get-folder-by-id";
23
+ readonly method: "GET";
24
+ readonly params: {
25
+ readonly folderId: import("./native-params.ts").Placed<"path", "string">;
26
+ };
27
+ readonly path: "/spam-test/folder/{folderId}";
28
+ };
29
+ readonly deliveryFolders: {
30
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
31
+ readonly description: "The folders that organize placement tests.";
32
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/get-folders";
33
+ readonly method: "GET";
34
+ readonly path: "/spam-test/folder";
35
+ };
36
+ readonly deliveryGeoReport: {
37
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
38
+ readonly description: "A placement test's inbox and spam rates per region.";
39
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/geo-report";
40
+ readonly method: "POST";
41
+ readonly params: {
42
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
43
+ };
44
+ readonly path: "/spam-test/report/{spamTestId}/groupwise";
45
+ };
46
+ readonly deliveryIpBlacklist: ServiceRead<{
47
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
48
+ }>;
49
+ readonly deliveryIpDetails: ServiceRead<{
50
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
51
+ }>;
52
+ readonly deliveryMailboxCount: {
53
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
54
+ readonly description: "How many test mailboxes there are per provider.";
55
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/mailbox-count";
56
+ readonly method: "GET";
57
+ readonly path: "/spam-test/report/mailboxes-count";
58
+ };
59
+ readonly deliveryMailboxSummary: {
60
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
61
+ readonly description: "A summary of every test mailbox.";
62
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/mailbox-summary";
63
+ readonly method: "GET";
64
+ readonly path: "/spam-test/report/mailboxes-summary";
65
+ };
66
+ readonly deliveryProviderReport: {
67
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
68
+ readonly description: "A placement test's inbox, spam and bounce rates per mailbox provider.";
69
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/provider-report";
70
+ readonly method: "POST";
71
+ readonly params: {
72
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
73
+ };
74
+ readonly path: "/spam-test/report/{spamTestId}/providerwise";
75
+ };
76
+ readonly deliveryRdnsDetails: ServiceRead<{
77
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
78
+ }>;
79
+ readonly deliveryReplyHeaders: {
80
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
81
+ readonly description: "The headers of one email a placement test received.";
82
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/reply-headers";
83
+ readonly method: "GET";
84
+ readonly params: {
85
+ readonly replyId: import("./native-params.ts").Placed<"path", "string">;
86
+ readonly spamTestId: import("./native-params.ts").Placed<"path", "string">;
87
+ };
88
+ readonly path: "/spam-test/report/{spamTestId}/sender-account-wise/{replyId}/email-headers";
89
+ };
90
+ readonly deliveryScheduleHistory: ServiceRead<{
91
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
92
+ }>;
93
+ readonly deliverySeedProviders: {
94
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
95
+ readonly description: "The mailbox provider ids per region that placement tests refer to.";
96
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/provider-ids";
97
+ readonly method: "GET";
98
+ readonly path: "/spam-test/seed/providers";
99
+ };
100
+ readonly deliverySenderAccounts: ServiceRead<{
101
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
102
+ }>;
103
+ readonly deliverySenderReport: ServiceRead<{
104
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
105
+ }>;
106
+ readonly deliverySpamFilterDetails: ServiceRead<{
107
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
108
+ }>;
109
+ readonly deliverySpfDetails: ServiceRead<{
110
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
111
+ }>;
112
+ readonly deliveryTest: {
113
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
114
+ readonly description: "One placement test: its type, campaign, step and provider.";
115
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/test-details";
116
+ readonly method: "GET";
117
+ readonly params: {
118
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
119
+ };
120
+ readonly path: "/spam-test/{spamTestId}";
121
+ };
122
+ readonly deliveryTests: {
123
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
124
+ readonly description: "Every placement test, with its status and schedule.";
125
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/list-tests";
126
+ readonly method: "POST";
127
+ readonly path: "/spam-test/report";
128
+ };
129
+ };
130
+ export declare const SERVICES: {
131
+ readonly prospectContacts: {
132
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
133
+ readonly description: "Contacts already saved from SmartProspect, by search filter or by id. Takes filter_id or id, not both.";
134
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/get-contacts";
135
+ readonly method: "POST";
136
+ readonly params: {
137
+ readonly catch_all_status: import("./native-params.ts").Placed<"body", "string">;
138
+ readonly filter_id: import("./native-params.ts").Placed<"body", "number">;
139
+ readonly id: import("./native-params.ts").Placed<"body", "json">;
140
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
141
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
142
+ readonly search: import("./native-params.ts").Placed<"body", "string">;
143
+ readonly verification_status: import("./native-params.ts").Placed<"body", "string">;
144
+ };
145
+ readonly path: "/search-email-leads/get-contacts";
146
+ };
147
+ readonly prospectFetchedSearches: ServiceRead<{
148
+ limit: import("./native-params.ts").Placed<"query", "string">;
149
+ offset: import("./native-params.ts").Placed<"query", "string">;
150
+ }>;
151
+ readonly prospectRecentSearches: ServiceRead<{
152
+ limit: import("./native-params.ts").Placed<"query", "string">;
153
+ offset: import("./native-params.ts").Placed<"query", "string">;
154
+ }>;
155
+ readonly prospectReplyAnalytics: {
156
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
157
+ readonly description: "Replies from SmartProspect contacts this month against last month.";
158
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/reply-analytics";
159
+ readonly method: "GET";
160
+ readonly path: "/search-email-leads/reply-analytics";
161
+ };
162
+ readonly prospectSavedSearches: ServiceRead<{
163
+ limit: import("./native-params.ts").Placed<"query", "string">;
164
+ offset: import("./native-params.ts").Placed<"query", "string">;
165
+ }>;
166
+ readonly prospectSearchAnalytics: {
167
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
168
+ readonly description: "SmartProspect leads found, emails fetched and credits left, with the monthly trend.";
169
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/search-analytics";
170
+ readonly method: "GET";
171
+ readonly params: {
172
+ readonly filter_id: import("./native-params.ts").Placed<"query", "string">;
173
+ };
174
+ readonly path: "/search-email-leads/search-analytics";
175
+ };
176
+ readonly smartSendersDomains: {
177
+ readonly baseUrl: "https://smart-senders.smartlead.ai/api/v1";
178
+ readonly description: "The sending domains bought through SmartSenders.";
179
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-senders/domain-list";
180
+ readonly method: "GET";
181
+ readonly path: "/smart-senders/get-domain-list";
182
+ };
183
+ readonly smartServers: {
184
+ readonly baseUrl: "https://smartservers.smartlead.ai/api/v1";
185
+ readonly description: "The account's dedicated sending IPs, with the campaigns on each on request.";
186
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-servers/list-servers";
187
+ readonly method: "GET";
188
+ readonly params: {
189
+ readonly unmapped: import("./native-params.ts").Placed<"query", "string">;
190
+ readonly withCampaignData: import("./native-params.ts").Placed<"query", "string">;
191
+ };
192
+ readonly path: "/smart-server/";
193
+ };
194
+ readonly smartServersForCampaign: {
195
+ readonly baseUrl: "https://smartservers.smartlead.ai/api/v1";
196
+ readonly description: "The dedicated IP attached to a campaign; only one is returned when it has several.";
197
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-servers/get-campaign-servers";
198
+ readonly method: "GET";
199
+ readonly params: {
200
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
201
+ };
202
+ readonly path: "/smart-server/all/campaign/{campaign_id}";
203
+ };
204
+ };