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,785 @@
1
+ export declare const NATIVE: {
2
+ readonly prospectContacts: {
3
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
4
+ readonly description: "Contacts already saved from SmartProspect, by search filter or by id. Takes filter_id or id, not both.";
5
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/get-contacts";
6
+ readonly method: "POST";
7
+ readonly params: {
8
+ readonly catch_all_status: import("./native-params.ts").Placed<"body", "string">;
9
+ readonly filter_id: import("./native-params.ts").Placed<"body", "number">;
10
+ readonly id: import("./native-params.ts").Placed<"body", "json">;
11
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
12
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
13
+ readonly search: import("./native-params.ts").Placed<"body", "string">;
14
+ readonly verification_status: import("./native-params.ts").Placed<"body", "string">;
15
+ };
16
+ readonly path: "/search-email-leads/get-contacts";
17
+ };
18
+ readonly prospectFetchedSearches: import("./native-services.ts").ServiceRead<{
19
+ limit: import("./native-params.ts").Placed<"query", "string">;
20
+ offset: import("./native-params.ts").Placed<"query", "string">;
21
+ }>;
22
+ readonly prospectRecentSearches: import("./native-services.ts").ServiceRead<{
23
+ limit: import("./native-params.ts").Placed<"query", "string">;
24
+ offset: import("./native-params.ts").Placed<"query", "string">;
25
+ }>;
26
+ readonly prospectReplyAnalytics: {
27
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
28
+ readonly description: "Replies from SmartProspect contacts this month against last month.";
29
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/reply-analytics";
30
+ readonly method: "GET";
31
+ readonly path: "/search-email-leads/reply-analytics";
32
+ };
33
+ readonly prospectSavedSearches: import("./native-services.ts").ServiceRead<{
34
+ limit: import("./native-params.ts").Placed<"query", "string">;
35
+ offset: import("./native-params.ts").Placed<"query", "string">;
36
+ }>;
37
+ readonly prospectSearchAnalytics: {
38
+ readonly baseUrl: "https://prospect-api.smartlead.ai/api/v1";
39
+ readonly description: "SmartProspect leads found, emails fetched and credits left, with the monthly trend.";
40
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-prospect/search-analytics";
41
+ readonly method: "GET";
42
+ readonly params: {
43
+ readonly filter_id: import("./native-params.ts").Placed<"query", "string">;
44
+ };
45
+ readonly path: "/search-email-leads/search-analytics";
46
+ };
47
+ readonly smartSendersDomains: {
48
+ readonly baseUrl: "https://smart-senders.smartlead.ai/api/v1";
49
+ readonly description: "The sending domains bought through SmartSenders.";
50
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-senders/domain-list";
51
+ readonly method: "GET";
52
+ readonly path: "/smart-senders/get-domain-list";
53
+ };
54
+ readonly smartServers: {
55
+ readonly baseUrl: "https://smartservers.smartlead.ai/api/v1";
56
+ readonly description: "The account's dedicated sending IPs, with the campaigns on each on request.";
57
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-servers/list-servers";
58
+ readonly method: "GET";
59
+ readonly params: {
60
+ readonly unmapped: import("./native-params.ts").Placed<"query", "string">;
61
+ readonly withCampaignData: import("./native-params.ts").Placed<"query", "string">;
62
+ };
63
+ readonly path: "/smart-server/";
64
+ };
65
+ readonly smartServersForCampaign: {
66
+ readonly baseUrl: "https://smartservers.smartlead.ai/api/v1";
67
+ readonly description: "The dedicated IP attached to a campaign; only one is returned when it has several.";
68
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-servers/get-campaign-servers";
69
+ readonly method: "GET";
70
+ readonly params: {
71
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
72
+ };
73
+ readonly path: "/smart-server/all/campaign/{campaign_id}";
74
+ };
75
+ readonly deliveryDkimDetails: import("./native-services.ts").ServiceRead<{
76
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
77
+ }>;
78
+ readonly deliveryDomainBlacklist: import("./native-services.ts").ServiceRead<{
79
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
80
+ }>;
81
+ readonly deliveryEmailContent: import("./native-services.ts").ServiceRead<{
82
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
83
+ }>;
84
+ readonly deliveryFolder: {
85
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
86
+ readonly description: "One folder of placement tests.";
87
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/get-folder-by-id";
88
+ readonly method: "GET";
89
+ readonly params: {
90
+ readonly folderId: import("./native-params.ts").Placed<"path", "string">;
91
+ };
92
+ readonly path: "/spam-test/folder/{folderId}";
93
+ };
94
+ readonly deliveryFolders: {
95
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
96
+ readonly description: "The folders that organize placement tests.";
97
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/get-folders";
98
+ readonly method: "GET";
99
+ readonly path: "/spam-test/folder";
100
+ };
101
+ readonly deliveryGeoReport: {
102
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
103
+ readonly description: "A placement test's inbox and spam rates per region.";
104
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/geo-report";
105
+ readonly method: "POST";
106
+ readonly params: {
107
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
108
+ };
109
+ readonly path: "/spam-test/report/{spamTestId}/groupwise";
110
+ };
111
+ readonly deliveryIpBlacklist: import("./native-services.ts").ServiceRead<{
112
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
113
+ }>;
114
+ readonly deliveryIpDetails: import("./native-services.ts").ServiceRead<{
115
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
116
+ }>;
117
+ readonly deliveryMailboxCount: {
118
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
119
+ readonly description: "How many test mailboxes there are per provider.";
120
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/mailbox-count";
121
+ readonly method: "GET";
122
+ readonly path: "/spam-test/report/mailboxes-count";
123
+ };
124
+ readonly deliveryMailboxSummary: {
125
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
126
+ readonly description: "A summary of every test mailbox.";
127
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/mailbox-summary";
128
+ readonly method: "GET";
129
+ readonly path: "/spam-test/report/mailboxes-summary";
130
+ };
131
+ readonly deliveryProviderReport: {
132
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
133
+ readonly description: "A placement test's inbox, spam and bounce rates per mailbox provider.";
134
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/provider-report";
135
+ readonly method: "POST";
136
+ readonly params: {
137
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
138
+ };
139
+ readonly path: "/spam-test/report/{spamTestId}/providerwise";
140
+ };
141
+ readonly deliveryRdnsDetails: import("./native-services.ts").ServiceRead<{
142
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
143
+ }>;
144
+ readonly deliveryReplyHeaders: {
145
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
146
+ readonly description: "The headers of one email a placement test received.";
147
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/reply-headers";
148
+ readonly method: "GET";
149
+ readonly params: {
150
+ readonly replyId: import("./native-params.ts").Placed<"path", "string">;
151
+ readonly spamTestId: import("./native-params.ts").Placed<"path", "string">;
152
+ };
153
+ readonly path: "/spam-test/report/{spamTestId}/sender-account-wise/{replyId}/email-headers";
154
+ };
155
+ readonly deliveryScheduleHistory: import("./native-services.ts").ServiceRead<{
156
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
157
+ }>;
158
+ readonly deliverySeedProviders: {
159
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
160
+ readonly description: "The mailbox provider ids per region that placement tests refer to.";
161
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/provider-ids";
162
+ readonly method: "GET";
163
+ readonly path: "/spam-test/seed/providers";
164
+ };
165
+ readonly deliverySenderAccounts: import("./native-services.ts").ServiceRead<{
166
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
167
+ }>;
168
+ readonly deliverySenderReport: import("./native-services.ts").ServiceRead<{
169
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
170
+ }>;
171
+ readonly deliverySpamFilterDetails: import("./native-services.ts").ServiceRead<{
172
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
173
+ }>;
174
+ readonly deliverySpfDetails: import("./native-services.ts").ServiceRead<{
175
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
176
+ }>;
177
+ readonly deliveryTest: {
178
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
179
+ readonly description: "One placement test: its type, campaign, step and provider.";
180
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/test-details";
181
+ readonly method: "GET";
182
+ readonly params: {
183
+ spamTestId: import("./native-params.ts").Placed<"path", "string">;
184
+ };
185
+ readonly path: "/spam-test/{spamTestId}";
186
+ };
187
+ readonly deliveryTests: {
188
+ readonly baseUrl: "https://smartdelivery.smartlead.ai/api/v1";
189
+ readonly description: "Every placement test, with its status and schedule.";
190
+ readonly docs: "https://api.smartlead.ai/api-reference/smart-delivery/list-tests";
191
+ readonly method: "POST";
192
+ readonly path: "/spam-test/report";
193
+ };
194
+ readonly inboxArchived: {
195
+ readonly description: "Archived threads of the master inbox.";
196
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-archived";
197
+ readonly method: "POST";
198
+ readonly params: {
199
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
200
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
201
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
202
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
203
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
204
+ };
205
+ readonly path: "/master-inbox/archived";
206
+ };
207
+ readonly inboxAssignedToMe: {
208
+ readonly description: "Threads assigned to the key's own user.";
209
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-assigned";
210
+ readonly method: "POST";
211
+ readonly params: {
212
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
213
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
214
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
215
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
216
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
217
+ };
218
+ readonly path: "/master-inbox/assigned-me";
219
+ };
220
+ readonly inboxImportant: {
221
+ readonly description: "Threads marked as important.";
222
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-important";
223
+ readonly method: "POST";
224
+ readonly params: {
225
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
226
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
227
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
228
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
229
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
230
+ };
231
+ readonly path: "/master-inbox/important";
232
+ };
233
+ readonly inboxReminders: {
234
+ readonly description: "Threads with a reminder, with its time and message.";
235
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-reminders";
236
+ readonly method: "POST";
237
+ readonly params: {
238
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
239
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
240
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
241
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
242
+ };
243
+ readonly path: "/master-inbox/reminders";
244
+ };
245
+ readonly inboxScheduled: {
246
+ readonly description: "Emails queued to be sent later, with their scheduled time.";
247
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-scheduled";
248
+ readonly method: "POST";
249
+ readonly params: {
250
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
251
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
252
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
253
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
254
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
255
+ };
256
+ readonly path: "/master-inbox/scheduled";
257
+ };
258
+ readonly inboxSent: {
259
+ readonly description: "Sent emails across every campaign, one thread per row.";
260
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-sent";
261
+ readonly method: "POST";
262
+ readonly params: {
263
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
264
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
265
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
266
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
267
+ };
268
+ readonly path: "/master-inbox/sent";
269
+ };
270
+ readonly inboxSnoozed: {
271
+ readonly description: "Threads snoozed for later.";
272
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-snoozed";
273
+ readonly method: "POST";
274
+ readonly params: {
275
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
276
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
277
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
278
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
279
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
280
+ };
281
+ readonly path: "/master-inbox/snoozed";
282
+ };
283
+ readonly inboxUnread: {
284
+ readonly description: "Threads with an unread reply.";
285
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-unread";
286
+ readonly method: "POST";
287
+ readonly params: {
288
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
289
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
290
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
291
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
292
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
293
+ };
294
+ readonly path: "/master-inbox/unread-replies";
295
+ };
296
+ readonly inboxUntrackedReplies: {
297
+ readonly description: "Replies that reached a connected mailbox but belong to no campaign.";
298
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-untracked";
299
+ readonly method: "GET";
300
+ readonly params: {
301
+ readonly fetchAttachments: import("./native-params.ts").Placed<"query", "boolean">;
302
+ readonly fetchBody: import("./native-params.ts").Placed<"query", "boolean">;
303
+ readonly from_email: import("./native-params.ts").Placed<"query", "string">;
304
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
305
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
306
+ readonly subject_line: import("./native-params.ts").Placed<"query", "string">;
307
+ readonly to_email: import("./native-params.ts").Placed<"query", "string">;
308
+ };
309
+ readonly path: "/master-inbox/untracked-replies";
310
+ };
311
+ readonly inboxView: {
312
+ readonly description: "Threads matching a custom view: the inbox filters plus a subsequence.";
313
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/get-views";
314
+ readonly method: "POST";
315
+ readonly params: {
316
+ readonly sortBy: import("./native-params.ts").Placed<"body", "string">;
317
+ readonly filters: import("./native-params.ts").Placed<"body", "json">;
318
+ readonly fetch_message_history: import("./native-params.ts").Placed<"query", "boolean">;
319
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
320
+ readonly offset: import("./native-params.ts").Placed<"body", "number">;
321
+ };
322
+ readonly path: "/master-inbox/views";
323
+ };
324
+ readonly replyStatus: {
325
+ readonly description: "Whether a reply sent from the master inbox was delivered, and when.";
326
+ readonly docs: "https://api.smartlead.ai/api-reference/inbox/reply-status";
327
+ readonly method: "GET";
328
+ readonly params: {
329
+ readonly message_id: import("./native-params.ts").Needed<"query", "string">;
330
+ };
331
+ readonly path: "/master-inbox/reply-status";
332
+ };
333
+ readonly campaignEmailStatistics: {
334
+ readonly description: "One row per email a campaign sent: the lead, the step, and when it was sent, opened, clicked, replied to or bounced.";
335
+ readonly docs: "https://api.smartlead.ai/api-reference/campaign-statistics/get-by-id";
336
+ readonly method: "GET";
337
+ readonly params: {
338
+ readonly email_sequence_number: import("./native-params.ts").Placed<"query", "number">;
339
+ readonly email_status: import("./native-params.ts").Placed<"query", "string">;
340
+ readonly sent_time_end_date: import("./native-params.ts").Placed<"query", "string">;
341
+ readonly sent_time_start_date: import("./native-params.ts").Placed<"query", "string">;
342
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
343
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
344
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
345
+ };
346
+ readonly path: "/campaigns/{campaign_id}/statistics";
347
+ };
348
+ readonly campaignLeadSearch: {
349
+ readonly description: "A campaign's leads filtered by text, status, category, mailbox or step. Refuses client-level keys.";
350
+ readonly docs: "https://api.smartlead.ai/api-reference/campaigns/search-leads";
351
+ readonly method: "POST";
352
+ readonly params: {
353
+ readonly campaignId: import("./native-params.ts").Placed<"path", "string">;
354
+ readonly deletedEmailAddresses: import("./native-params.ts").Placed<"body", "json">;
355
+ readonly emailAccountIds: import("./native-params.ts").Placed<"body", "json">;
356
+ readonly emailStatuses: import("./native-params.ts").Placed<"body", "json">;
357
+ readonly espDomainTypes: import("./native-params.ts").Placed<"body", "json">;
358
+ readonly fieldSet: import("./native-params.ts").Placed<"body", "string">;
359
+ readonly filterLeadsForManualCompletion: import("./native-params.ts").Placed<"body", "boolean">;
360
+ readonly filterManualSeqIds: import("./native-params.ts").Placed<"body", "json">;
361
+ readonly includeSenderBounce: import("./native-params.ts").Placed<"body", "boolean">;
362
+ readonly lastSeenLeadId: import("./native-params.ts").Placed<"body", "number">;
363
+ readonly lastSeenReplyTime: import("./native-params.ts").Placed<"body", "string">;
364
+ readonly leadCategoryIds: import("./native-params.ts").Placed<"body", "json">;
365
+ readonly leadCategoryIsNull: import("./native-params.ts").Placed<"body", "boolean">;
366
+ readonly leadStatuses: import("./native-params.ts").Placed<"body", "json">;
367
+ readonly limit: import("./native-params.ts").Placed<"body", "number">;
368
+ readonly searchText: import("./native-params.ts").Placed<"body", "string">;
369
+ readonly segTypes: import("./native-params.ts").Placed<"body", "json">;
370
+ readonly seqScheduleType: import("./native-params.ts").Placed<"body", "string">;
371
+ readonly seqVariantIds: import("./native-params.ts").Placed<"body", "json">;
372
+ readonly sequenceIds: import("./native-params.ts").Placed<"body", "json">;
373
+ readonly sequenceNumbers: import("./native-params.ts").Placed<"body", "json">;
374
+ readonly statusFilter: import("./native-params.ts").Placed<"body", "string">;
375
+ };
376
+ readonly path: "/campaigns/{campaignId}/leads/filter";
377
+ };
378
+ readonly campaignLeadStatistics: {
379
+ readonly description: "Per-lead statistics of a campaign. The response is documented nowhere.";
380
+ readonly docs: "https://api.smartlead.ai/api-reference/campaign-statistics/lead-statistics";
381
+ readonly lane: "leads-statistics";
382
+ readonly method: "GET";
383
+ readonly params: {
384
+ readonly event_time_gt: import("./native-params.ts").Placed<"query", "string">;
385
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
386
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
387
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
388
+ };
389
+ readonly path: "/campaigns/{campaign_id}/leads-statistics";
390
+ };
391
+ readonly campaignLeadsExport: {
392
+ readonly description: "Every lead of a campaign as CSV text, with open, click and reply counts per lead.";
393
+ readonly docs: "https://api.smartlead.ai/api-reference/leads/export";
394
+ readonly method: "GET";
395
+ readonly params: {
396
+ campaign_id: import("./native-params.ts").Placed<"path", "string">;
397
+ };
398
+ readonly path: "/campaigns/{campaign_id}/leads-export";
399
+ };
400
+ readonly campaignMailboxStatistics: {
401
+ readonly description: "A campaign's results per mailbox. The response is documented nowhere.";
402
+ readonly docs: "https://api.smartlead.ai/api-reference/campaign-statistics/mailbox-statistics";
403
+ readonly method: "GET";
404
+ readonly params: {
405
+ readonly client_id: import("./native-params.ts").Placed<"query", "number">;
406
+ readonly end_date: import("./native-params.ts").Placed<"query", "string">;
407
+ readonly start_date: import("./native-params.ts").Placed<"query", "string">;
408
+ readonly time_zone: import("./native-params.ts").Placed<"query", "string">;
409
+ readonly limit: import("./native-params.ts").Placed<"query", "number">;
410
+ readonly offset: import("./native-params.ts").Placed<"query", "number">;
411
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
412
+ };
413
+ readonly path: "/campaigns/{campaign_id}/mailbox-statistics";
414
+ };
415
+ readonly campaignMessageHistoryBulk: {
416
+ readonly description: "The message history of many of a campaign's leads at once.";
417
+ readonly docs: "https://api.smartlead.ai/api-reference/campaigns/get-leads-history-bulk";
418
+ readonly method: "POST";
419
+ readonly params: {
420
+ readonly event_time_gt: import("./native-params.ts").Placed<"query", "string">;
421
+ readonly lead_ids: import("./native-params.ts").Placed<"body", "json">;
422
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
423
+ };
424
+ readonly path: "/campaigns/{campaign_id}/message-history-for-leads/bbfbdsFGHlBr76ruhjvh6fhHL";
425
+ };
426
+ readonly campaignPromptTemplate: {
427
+ readonly description: "The AI prompt that categorises a campaign's replies, and the categories it may assign.";
428
+ readonly docs: "https://api.smartlead.ai/api-reference/campaigns/get-prompt-template";
429
+ readonly method: "GET";
430
+ readonly params: {
431
+ campaign_id: import("./native-params.ts").Placed<"path", "string">;
432
+ };
433
+ readonly path: "/campaigns/{campaign_id}/prompt-template";
434
+ };
435
+ readonly campaignTopLevelAnalyticsByDate: {
436
+ readonly description: "A campaign's top-level totals and rates in a date window, as the vendor computes them.";
437
+ readonly docs: "https://api.smartlead.ai/api-reference/campaign-statistics/top-level-by-date";
438
+ readonly method: "GET";
439
+ readonly params: {
440
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
441
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
442
+ readonly campaign_id: import("./native-params.ts").Placed<"path", "string">;
443
+ };
444
+ readonly path: "/campaigns/{campaign_id}/top-level-analytics-by-date";
445
+ };
446
+ readonly campaignWebhookSummary: {
447
+ readonly description: "How many webhook calls a campaign made in a time window, and how many failed.";
448
+ readonly docs: "https://api.smartlead.ai/api-reference/campaigns/get-webhook-summary";
449
+ readonly method: "GET";
450
+ readonly params: {
451
+ readonly campaignId: import("./native-params.ts").Placed<"path", "string">;
452
+ readonly fromTime: import("./native-params.ts").Needed<"query", "string">;
453
+ readonly toTime: import("./native-params.ts").Needed<"query", "string">;
454
+ };
455
+ readonly path: "/campaigns/{campaignId}/webhooks/summary";
456
+ };
457
+ readonly client: {
458
+ readonly description: "One client, with its permissions, credits and code snippets on request. Refuses client-level keys.";
459
+ readonly docs: "https://api.smartlead.ai/api-reference/clients/get-by-id";
460
+ readonly method: "GET";
461
+ readonly params: {
462
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
463
+ readonly includeCodeIntegrations: import("./native-params.ts").Placed<"query", "boolean">;
464
+ readonly includeCredits: import("./native-params.ts").Placed<"query", "boolean">;
465
+ readonly includePermissions: import("./native-params.ts").Placed<"query", "boolean">;
466
+ };
467
+ readonly path: "/client/{id}";
468
+ };
469
+ readonly leadByEmail: {
470
+ readonly description: "The lead with an email address and every campaign it is in. An unknown address returns an empty object.";
471
+ readonly docs: "https://api.smartlead.ai/api-reference/leads/get-by-email";
472
+ readonly method: "GET";
473
+ readonly params: {
474
+ readonly email: import("./native-params.ts").Needed<"query", "string">;
475
+ };
476
+ readonly path: "/leads/";
477
+ };
478
+ readonly leadCampaignOverview: {
479
+ readonly description: "A lead's status, category, revenue and current step in each of its campaigns. Refuses client-level keys.";
480
+ readonly docs: "https://api.smartlead.ai/api-reference/leads/campaign-overview";
481
+ readonly method: "GET";
482
+ readonly params: {
483
+ readonly leadId: import("./native-params.ts").Placed<"path", "string">;
484
+ };
485
+ readonly path: "/leads/{leadId}/campaign-overview";
486
+ };
487
+ readonly leadList: {
488
+ readonly description: "One lead list: its name, lead count and dates.";
489
+ readonly docs: "https://api.smartlead.ai/api-reference/lead-lists/get-by-id";
490
+ readonly method: "GET";
491
+ readonly params: {
492
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
493
+ };
494
+ readonly path: "/lead-list/{id}";
495
+ };
496
+ readonly leadNotes: {
497
+ readonly description: "The notes written on a lead.";
498
+ readonly docs: "https://api.smartlead.ai/api-reference/lead-notes/get-all";
499
+ readonly method: "GET";
500
+ readonly params: {
501
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
502
+ };
503
+ readonly path: "/crm/leads/notes/{id}";
504
+ };
505
+ readonly leadSequenceDetails: {
506
+ readonly description: "The send status of every step for a lead in a campaign. Refuses client-level keys.";
507
+ readonly docs: "https://api.smartlead.ai/api-reference/leads/sequence-details";
508
+ readonly method: "GET";
509
+ readonly params: {
510
+ readonly campaignId: import("./native-params.ts").Placed<"query", "number">;
511
+ readonly leadMapId: import("./native-params.ts").Placed<"path", "string">;
512
+ };
513
+ readonly path: "/leads/{leadMapId}/sequence-details";
514
+ };
515
+ readonly leadTasks: {
516
+ readonly description: "The tasks created for a lead.";
517
+ readonly docs: "https://api.smartlead.ai/api-reference/lead-tasks/get-all";
518
+ readonly method: "GET";
519
+ readonly params: {
520
+ readonly id: import("./native-params.ts").Placed<"path", "string">;
521
+ };
522
+ readonly path: "/crm/leads/tasks/{id}";
523
+ };
524
+ readonly senderTagsByEmail: {
525
+ readonly description: "The tags of the mailboxes with the given addresses.";
526
+ readonly docs: "https://api.smartlead.ai/api-reference/email-account-tags/get-all";
527
+ readonly method: "POST";
528
+ readonly params: {
529
+ readonly email_ids: import("./native-params.ts").Needed<"body", "json">;
530
+ };
531
+ readonly path: "/email-accounts/tag-list";
532
+ };
533
+ readonly webhook: {
534
+ readonly description: "One webhook: its URL, events, categories and campaign.";
535
+ readonly docs: "https://api.smartlead.ai/api-reference/webhooks/get";
536
+ readonly method: "GET";
537
+ readonly params: {
538
+ readonly webhook_id: import("./native-params.ts").Placed<"path", "string">;
539
+ };
540
+ readonly path: "/webhook/{webhook_id}";
541
+ };
542
+ readonly analyticsCampaignFollowUpReplyRate: {
543
+ readonly description: "The reply rate of follow-up steps (second email onwards).";
544
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/followup-reply-rate";
545
+ readonly method: "GET";
546
+ readonly params: {
547
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
548
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
549
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
550
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
551
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
552
+ };
553
+ readonly path: "/analytics/campaign/follow-up-reply-rate";
554
+ };
555
+ readonly analyticsCampaignLeadToReplyTime: {
556
+ readonly description: "The average time from a lead's first email to its reply.";
557
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/lead-to-reply-time";
558
+ readonly method: "GET";
559
+ readonly params: {
560
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
561
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
562
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
563
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
564
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
565
+ };
566
+ readonly path: "/analytics/campaign/lead-to-reply-time";
567
+ };
568
+ readonly analyticsCampaignLeadsForFirstReply: {
569
+ readonly description: "How many leads are contacted, on average, per first reply.";
570
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/leads-for-first-reply";
571
+ readonly method: "GET";
572
+ readonly params: {
573
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
574
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
575
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
576
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
577
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
578
+ };
579
+ readonly path: "/analytics/campaign/leads-take-for-first-reply";
580
+ };
581
+ readonly analyticsCampaignList: {
582
+ readonly description: "The id and name of every campaign, for analytics filters.";
583
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/campaign-list";
584
+ readonly method: "GET";
585
+ readonly params: {
586
+ client_ids: import("./native-params.ts").Placed<"query", "string">;
587
+ };
588
+ readonly path: "/analytics/campaign/list";
589
+ };
590
+ readonly analyticsCampaignPerformance: {
591
+ readonly description: "One row per campaign in a date window: counts, rates and lead totals.";
592
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/campaign-performance";
593
+ readonly method: "GET";
594
+ readonly params: {
595
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
596
+ readonly limit: import("./native-params.ts").Placed<"query", "string">;
597
+ readonly offset: import("./native-params.ts").Placed<"query", "string">;
598
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
599
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
600
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
601
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
602
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
603
+ };
604
+ readonly path: "/analytics/campaign/overall-stats";
605
+ };
606
+ readonly analyticsCampaignResponseStats: {
607
+ readonly description: "Replies per campaign in a date window, split by reply sentiment.";
608
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/campaign-response-stats";
609
+ readonly method: "GET";
610
+ readonly params: {
611
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
612
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
613
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
614
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
615
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
616
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
617
+ };
618
+ readonly path: "/analytics/campaign/response-stats";
619
+ };
620
+ readonly analyticsCampaignStatusStats: {
621
+ readonly description: "How many campaigns are in each status.";
622
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/campaign-status-stats";
623
+ readonly method: "GET";
624
+ readonly params: {
625
+ client_ids: import("./native-params.ts").Placed<"query", "string">;
626
+ };
627
+ readonly path: "/analytics/campaign/status-stats";
628
+ };
629
+ readonly analyticsClientList: {
630
+ readonly description: "The id and name of every client, for analytics filters.";
631
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/client-list";
632
+ readonly method: "GET";
633
+ readonly params: {
634
+ client_ids: import("./native-params.ts").Placed<"query", "string">;
635
+ };
636
+ readonly path: "/analytics/client/list";
637
+ };
638
+ readonly analyticsClientMonthlyCount: {
639
+ readonly description: "How many clients the account had, month by month.";
640
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/month-wise-client-count";
641
+ readonly method: "GET";
642
+ readonly params: {
643
+ client_ids: import("./native-params.ts").Placed<"query", "string">;
644
+ };
645
+ readonly path: "/analytics/client/month-wise-count";
646
+ };
647
+ readonly analyticsClientPerformance: {
648
+ readonly description: "One row per client in a date window, with that client's campaign totals.";
649
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/client-performance";
650
+ readonly method: "GET";
651
+ readonly params: {
652
+ readonly filter: import("./native-params.ts").Placed<"query", "string">;
653
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
654
+ readonly limit: import("./native-params.ts").Placed<"query", "string">;
655
+ readonly offset: import("./native-params.ts").Placed<"query", "string">;
656
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
657
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
658
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
659
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
660
+ };
661
+ readonly path: "/analytics/client/overall-stats";
662
+ };
663
+ readonly analyticsDailyBySentTime: {
664
+ readonly description: "Daily sent, opened, replied and bounced counts, each counted on the day its email was sent. The only daily read that reports bounces.";
665
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/day-wise-sent-time";
666
+ readonly method: "GET";
667
+ readonly params: {
668
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
669
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
670
+ readonly timezone: import("./native-params.ts").Needed<"query", "string">;
671
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
672
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
673
+ };
674
+ readonly path: "/analytics/day-wise-overall-stats-by-sent-time";
675
+ };
676
+ readonly analyticsDailyPositiveReplies: {
677
+ readonly description: "Positive replies per day, counted on the day of the reply.";
678
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/day-wise-positive-reply";
679
+ readonly method: "GET";
680
+ readonly params: {
681
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
682
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
683
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
684
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
685
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
686
+ };
687
+ readonly path: "/analytics/day-wise-positive-reply-stats";
688
+ };
689
+ readonly analyticsDailyPositiveRepliesBySentTime: {
690
+ readonly description: "Positive replies per day, counted on the day the replied-to email was sent.";
691
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/day-wise-positive-sent-time";
692
+ readonly method: "GET";
693
+ readonly params: {
694
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
695
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
696
+ readonly timezone: import("./native-params.ts").Needed<"query", "string">;
697
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
698
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
699
+ };
700
+ readonly path: "/analytics/day-wise-positive-reply-stats-by-sent-time";
701
+ };
702
+ readonly analyticsLeadCategoryResponses: {
703
+ readonly description: "Replies in a date window by lead category, with each one's share.";
704
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/lead-category-response";
705
+ readonly method: "GET";
706
+ readonly params: {
707
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
708
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
709
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
710
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
711
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
712
+ };
713
+ readonly path: "/analytics/lead/category-wise-response";
714
+ };
715
+ readonly analyticsLeadStats: {
716
+ readonly description: "Leads reached in a date window: the total, new leads and follow-ups.";
717
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/lead-stats";
718
+ readonly method: "GET";
719
+ readonly params: {
720
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
721
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
722
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
723
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
724
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
725
+ };
726
+ readonly path: "/analytics/lead/overall-stats";
727
+ };
728
+ readonly analyticsMailboxDomainHealth: {
729
+ readonly description: "Sent, opened, replied and bounced counts per sending domain in a date window.";
730
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/domain-wise-health";
731
+ readonly lane: "domain-wise-health";
732
+ readonly method: "GET";
733
+ readonly params: {
734
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
735
+ readonly limit: import("./native-params.ts").Placed<"query", "string">;
736
+ readonly offset: import("./native-params.ts").Placed<"query", "string">;
737
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
738
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
739
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
740
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
741
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
742
+ };
743
+ readonly path: "/analytics/mailbox/domain-wise-health-metrics";
744
+ };
745
+ readonly analyticsMailboxOverall: {
746
+ readonly description: "How many mailboxes are connected, in use, disconnected, or enabled without warmup.";
747
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/mailbox-health";
748
+ readonly method: "GET";
749
+ readonly params: {
750
+ client_ids: import("./native-params.ts").Placed<"query", "string">;
751
+ };
752
+ readonly path: "/analytics/mailbox/overall-stats";
753
+ };
754
+ readonly analyticsMailboxProviderPerformance: {
755
+ readonly description: "Counts and rates in a date window per mailbox provider (Gmail, Outlook, SMTP).";
756
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/provider-performance";
757
+ readonly method: "GET";
758
+ readonly params: {
759
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
760
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
761
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
762
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
763
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
764
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
765
+ };
766
+ readonly path: "/analytics/mailbox/provider-wise-overall-performance";
767
+ };
768
+ readonly analyticsTeamBoard: {
769
+ readonly description: "Results in a date window per team member.";
770
+ readonly docs: "https://api.smartlead.ai/api-reference/analytics/team-board-stats";
771
+ readonly method: "GET";
772
+ readonly params: {
773
+ readonly full_data: import("./native-params.ts").Placed<"query", "string">;
774
+ readonly campaign_ids: import("./native-params.ts").Placed<"query", "string">;
775
+ readonly client_ids: import("./native-params.ts").Placed<"query", "string">;
776
+ readonly end_date: import("./native-params.ts").Needed<"query", "string">;
777
+ readonly start_date: import("./native-params.ts").Needed<"query", "string">;
778
+ readonly timezone: import("./native-params.ts").Placed<"query", "string">;
779
+ };
780
+ readonly path: "/analytics/team-board/overall-stats";
781
+ };
782
+ };
783
+ export type SmartleadNative = typeof NATIVE;
784
+ /** The catalogued reads Smartlead serves over POST, as path patterns. */
785
+ export declare const NATIVE_READ_POSTS: readonly RegExp[];