sendblue 1.1.9 → 2.0.1

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 (407) hide show
  1. package/CHANGELOG.md +83 -0
  2. package/LICENSE +201 -21
  3. package/README.md +349 -38
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +203 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +203 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +489 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +485 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -78
  63. package/index.d.ts.map +1 -0
  64. package/index.js +28 -104
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +87 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +81 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +129 -39
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +2 -0
  234. package/resource.d.ts.map +1 -0
  235. package/resource.js +6 -0
  236. package/resource.js.map +1 -0
  237. package/resource.mjs +2 -0
  238. package/resource.mjs.map +1 -0
  239. package/resources/contacts/bulk.d.mts +61 -0
  240. package/resources/contacts/bulk.d.mts.map +1 -0
  241. package/resources/contacts/bulk.d.ts +61 -0
  242. package/resources/contacts/bulk.d.ts.map +1 -0
  243. package/resources/contacts/bulk.js +35 -0
  244. package/resources/contacts/bulk.js.map +1 -0
  245. package/resources/contacts/bulk.mjs +31 -0
  246. package/resources/contacts/bulk.mjs.map +1 -0
  247. package/resources/contacts/contacts.d.mts +239 -0
  248. package/resources/contacts/contacts.d.mts.map +1 -0
  249. package/resources/contacts/contacts.d.ts +239 -0
  250. package/resources/contacts/contacts.d.ts.map +1 -0
  251. package/resources/contacts/contacts.js +101 -0
  252. package/resources/contacts/contacts.js.map +1 -0
  253. package/resources/contacts/contacts.mjs +96 -0
  254. package/resources/contacts/contacts.mjs.map +1 -0
  255. package/resources/contacts/index.d.mts +3 -0
  256. package/resources/contacts/index.d.mts.map +1 -0
  257. package/resources/contacts/index.d.ts +3 -0
  258. package/resources/contacts/index.d.ts.map +1 -0
  259. package/resources/contacts/index.js +9 -0
  260. package/resources/contacts/index.js.map +1 -0
  261. package/resources/contacts/index.mjs +4 -0
  262. package/resources/contacts/index.mjs.map +1 -0
  263. package/resources/contacts.d.mts +2 -0
  264. package/resources/contacts.d.mts.map +1 -0
  265. package/resources/contacts.d.ts +2 -0
  266. package/resources/contacts.d.ts.map +1 -0
  267. package/resources/contacts.js +6 -0
  268. package/resources/contacts.js.map +1 -0
  269. package/resources/contacts.mjs +3 -0
  270. package/resources/contacts.mjs.map +1 -0
  271. package/resources/groups.d.mts +77 -0
  272. package/resources/groups.d.mts.map +1 -0
  273. package/resources/groups.d.ts +77 -0
  274. package/resources/groups.d.ts.map +1 -0
  275. package/resources/groups.js +38 -0
  276. package/resources/groups.js.map +1 -0
  277. package/resources/groups.mjs +34 -0
  278. package/resources/groups.mjs.map +1 -0
  279. package/resources/index.d.mts +7 -0
  280. package/resources/index.d.mts.map +1 -0
  281. package/resources/index.d.ts +7 -0
  282. package/resources/index.d.ts.map +1 -0
  283. package/resources/index.js +17 -0
  284. package/resources/index.js.map +1 -0
  285. package/resources/index.mjs +8 -0
  286. package/resources/index.mjs.map +1 -0
  287. package/resources/lookups.d.mts +30 -0
  288. package/resources/lookups.d.mts.map +1 -0
  289. package/resources/lookups.d.ts +30 -0
  290. package/resources/lookups.d.ts.map +1 -0
  291. package/resources/lookups.js +16 -0
  292. package/resources/lookups.js.map +1 -0
  293. package/resources/lookups.mjs +12 -0
  294. package/resources/lookups.mjs.map +1 -0
  295. package/resources/media-objects.d.mts +31 -0
  296. package/resources/media-objects.d.mts.map +1 -0
  297. package/resources/media-objects.d.ts +31 -0
  298. package/resources/media-objects.d.ts.map +1 -0
  299. package/resources/media-objects.js +22 -0
  300. package/resources/media-objects.js.map +1 -0
  301. package/resources/media-objects.mjs +18 -0
  302. package/resources/media-objects.mjs.map +1 -0
  303. package/resources/messages.d.mts +487 -0
  304. package/resources/messages.d.mts.map +1 -0
  305. package/resources/messages.d.ts +487 -0
  306. package/resources/messages.d.ts.map +1 -0
  307. package/resources/messages.js +64 -0
  308. package/resources/messages.js.map +1 -0
  309. package/resources/messages.mjs +60 -0
  310. package/resources/messages.mjs.map +1 -0
  311. package/resources/typing-indicators.d.mts +42 -0
  312. package/resources/typing-indicators.d.mts.map +1 -0
  313. package/resources/typing-indicators.d.ts +42 -0
  314. package/resources/typing-indicators.d.ts.map +1 -0
  315. package/resources/typing-indicators.js +24 -0
  316. package/resources/typing-indicators.js.map +1 -0
  317. package/resources/typing-indicators.mjs +20 -0
  318. package/resources/typing-indicators.mjs.map +1 -0
  319. package/resources.d.mts +2 -0
  320. package/resources.d.mts.map +1 -0
  321. package/resources.d.ts +2 -0
  322. package/resources.d.ts.map +1 -0
  323. package/resources.js +5 -0
  324. package/resources.js.map +1 -0
  325. package/resources.mjs +2 -0
  326. package/resources.mjs.map +1 -0
  327. package/src/api-promise.ts +2 -0
  328. package/src/client.ts +840 -0
  329. package/src/core/README.md +3 -0
  330. package/src/core/api-promise.ts +92 -0
  331. package/src/core/error.ts +130 -0
  332. package/src/core/resource.ts +11 -0
  333. package/src/core/uploads.ts +2 -0
  334. package/src/error.ts +2 -0
  335. package/src/index.ts +22 -0
  336. package/src/internal/README.md +3 -0
  337. package/src/internal/builtin-types.ts +93 -0
  338. package/src/internal/detect-platform.ts +196 -0
  339. package/src/internal/errors.ts +33 -0
  340. package/src/internal/headers.ts +97 -0
  341. package/src/internal/parse.ts +50 -0
  342. package/src/internal/request-options.ts +91 -0
  343. package/src/internal/shim-types.ts +26 -0
  344. package/src/internal/shims.ts +107 -0
  345. package/src/internal/to-file.ts +154 -0
  346. package/src/internal/types.ts +95 -0
  347. package/src/internal/uploads.ts +187 -0
  348. package/src/internal/utils/base64.ts +40 -0
  349. package/src/internal/utils/bytes.ts +32 -0
  350. package/src/internal/utils/env.ts +18 -0
  351. package/src/internal/utils/log.ts +128 -0
  352. package/src/internal/utils/path.ts +88 -0
  353. package/src/internal/utils/sleep.ts +3 -0
  354. package/src/internal/utils/uuid.ts +17 -0
  355. package/src/internal/utils/values.ts +105 -0
  356. package/src/internal/utils.ts +8 -0
  357. package/src/lib/.keep +4 -0
  358. package/src/resource.ts +2 -0
  359. package/src/resources/contacts/bulk.ts +85 -0
  360. package/src/resources/contacts/contacts.ts +338 -0
  361. package/src/resources/contacts/index.ts +24 -0
  362. package/src/resources/contacts.ts +3 -0
  363. package/src/resources/groups.ts +102 -0
  364. package/src/resources/index.ts +40 -0
  365. package/src/resources/lookups.ts +44 -0
  366. package/src/resources/media-objects.ts +43 -0
  367. package/src/resources/messages.ts +720 -0
  368. package/src/resources/typing-indicators.ts +54 -0
  369. package/src/resources.ts +1 -0
  370. package/src/tsconfig.json +11 -0
  371. package/src/uploads.ts +2 -0
  372. package/src/version.ts +1 -0
  373. package/uploads.d.mts +2 -0
  374. package/uploads.d.mts.map +1 -0
  375. package/uploads.d.ts +2 -0
  376. package/uploads.d.ts.map +1 -0
  377. package/uploads.js +6 -0
  378. package/uploads.js.map +1 -0
  379. package/uploads.mjs +2 -0
  380. package/uploads.mjs.map +1 -0
  381. package/version.d.mts +2 -0
  382. package/version.d.mts.map +1 -0
  383. package/version.d.ts +2 -0
  384. package/version.d.ts.map +1 -0
  385. package/version.js +5 -0
  386. package/version.js.map +1 -0
  387. package/version.mjs +2 -0
  388. package/version.mjs.map +1 -0
  389. package/.env +0 -5
  390. package/.prettierrc +0 -1
  391. package/config.js +0 -31
  392. package/dist/base/Message.d.ts +0 -43
  393. package/dist/base/Message.js +0 -30
  394. package/dist/base/RequestClient.d.ts +0 -27
  395. package/dist/base/RequestClient.js +0 -138
  396. package/dist/base/SendblueClient.d.ts +0 -18
  397. package/dist/base/SendblueClient.js +0 -33
  398. package/dist/index.d.ts +0 -2
  399. package/dist/index.js +0 -4
  400. package/dist/rest/group-message/index.d.ts +0 -23
  401. package/dist/rest/group-message/index.js +0 -73
  402. package/dist/rest/message/index.d.ts +0 -14
  403. package/dist/rest/message/index.js +0 -66
  404. package/dist/types.d.ts +0 -1
  405. package/dist/types.js +0 -2
  406. package/test/basic.test.js +0 -47
  407. package/tsconfig.json +0 -10
package/client.d.ts ADDED
@@ -0,0 +1,203 @@
1
+ import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
2
+ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
3
+ export type { Logger, LogLevel } from "./internal/utils/log.js";
4
+ import * as Opts from "./internal/request-options.js";
5
+ import * as Errors from "./core/error.js";
6
+ import * as Uploads from "./core/uploads.js";
7
+ import * as API from "./resources/index.js";
8
+ import { APIPromise } from "./core/api-promise.js";
9
+ import { GroupModifyParams, GroupModifyResponse, GroupSendMessageParams, Groups } from "./resources/groups.js";
10
+ import { LookupLookupNumberParams, LookupLookupNumberResponse, Lookups } from "./resources/lookups.js";
11
+ import { MediaObjectUploadParams, MediaObjectUploadResponse, MediaObjects } from "./resources/media-objects.js";
12
+ import { MessageContent, MessageGetStatusParams, MessageListParams, MessageListResponse, MessageResponse, MessageRetrieveResponse, MessageSendParams, Messages } from "./resources/messages.js";
13
+ import { TypingIndicatorSendParams, TypingIndicatorSendResponse, TypingIndicators } from "./resources/typing-indicators.js";
14
+ import { Contact, ContactCountResponse, ContactCreateParams, ContactCreateResponse, ContactDeleteResponse, ContactListParams, ContactListResponse, ContactRetrieveResponse, ContactUpdateParams, ContactUpdateResponse, ContactVerifyParams, ContactVerifyResponse, Contacts } from "./resources/contacts/contacts.js";
15
+ import { type Fetch } from "./internal/builtin-types.js";
16
+ import { HeadersLike, NullableHeaders } from "./internal/headers.js";
17
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
18
+ import { type LogLevel, type Logger } from "./internal/utils/log.js";
19
+ export interface ClientOptions {
20
+ /**
21
+ * API Key ID
22
+ */
23
+ apiKey?: string | undefined;
24
+ /**
25
+ * API Secret Key
26
+ */
27
+ apiSecret?: string | undefined;
28
+ /**
29
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
30
+ *
31
+ * Defaults to process.env['SENDBLUE_API_BASE_URL'].
32
+ */
33
+ baseURL?: string | null | undefined;
34
+ /**
35
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
36
+ * from the server before timing out a single request.
37
+ *
38
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
39
+ * much longer than this timeout before the promise succeeds or fails.
40
+ *
41
+ * @unit milliseconds
42
+ */
43
+ timeout?: number | undefined;
44
+ /**
45
+ * Additional `RequestInit` options to be passed to `fetch` calls.
46
+ * Properties will be overridden by per-request `fetchOptions`.
47
+ */
48
+ fetchOptions?: MergedRequestInit | undefined;
49
+ /**
50
+ * Specify a custom `fetch` function implementation.
51
+ *
52
+ * If not provided, we expect that `fetch` is defined globally.
53
+ */
54
+ fetch?: Fetch | undefined;
55
+ /**
56
+ * The maximum number of times that the client will retry a request in case of a
57
+ * temporary failure, like a network error or a 5XX error from the server.
58
+ *
59
+ * @default 2
60
+ */
61
+ maxRetries?: number | undefined;
62
+ /**
63
+ * Default headers to include with every request to the API.
64
+ *
65
+ * These can be removed in individual requests by explicitly setting the
66
+ * header to `null` in request options.
67
+ */
68
+ defaultHeaders?: HeadersLike | undefined;
69
+ /**
70
+ * Default query parameters to include with every request to the API.
71
+ *
72
+ * These can be removed in individual requests by explicitly setting the
73
+ * param to `undefined` in request options.
74
+ */
75
+ defaultQuery?: Record<string, string | undefined> | undefined;
76
+ /**
77
+ * Set the log level.
78
+ *
79
+ * Defaults to process.env['SENDBLUE_API_LOG'] or 'warn' if it isn't set.
80
+ */
81
+ logLevel?: LogLevel | undefined;
82
+ /**
83
+ * Set the logger.
84
+ *
85
+ * Defaults to globalThis.console.
86
+ */
87
+ logger?: Logger | undefined;
88
+ }
89
+ /**
90
+ * API Client for interfacing with the Sendblue API API.
91
+ */
92
+ export declare class SendblueAPI {
93
+ #private;
94
+ apiKey: string;
95
+ apiSecret: string;
96
+ baseURL: string;
97
+ maxRetries: number;
98
+ timeout: number;
99
+ logger: Logger | undefined;
100
+ logLevel: LogLevel | undefined;
101
+ fetchOptions: MergedRequestInit | undefined;
102
+ private fetch;
103
+ protected idempotencyHeader?: string;
104
+ private _options;
105
+ /**
106
+ * API Client for interfacing with the Sendblue API API.
107
+ *
108
+ * @param {string | undefined} [opts.apiKey=process.env['SENDBLUE_API_API_KEY'] ?? undefined]
109
+ * @param {string | undefined} [opts.apiSecret=process.env['SENDBLUE_API_API_SECRET'] ?? undefined]
110
+ * @param {string} [opts.baseURL=process.env['SENDBLUE_API_BASE_URL'] ?? https://api.sendblue.co] - Override the default base URL for the API.
111
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
112
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
113
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
114
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
115
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
116
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
117
+ */
118
+ constructor({ baseURL, apiKey, apiSecret, ...opts }?: ClientOptions);
119
+ /**
120
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
121
+ */
122
+ withOptions(options: Partial<ClientOptions>): this;
123
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
124
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
125
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
126
+ protected apiKeyAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
127
+ protected apiSecretAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
128
+ /**
129
+ * Basic re-implementation of `qs.stringify` for primitive types.
130
+ */
131
+ protected stringifyQuery(query: Record<string, unknown>): string;
132
+ private getUserAgent;
133
+ protected defaultIdempotencyKey(): string;
134
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
135
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
136
+ /**
137
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
138
+ */
139
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
140
+ /**
141
+ * Used as a callback for mutating the given `RequestInit` object.
142
+ *
143
+ * This is useful for cases where you want to add certain headers based off of
144
+ * the request properties, e.g. `method` or `url`.
145
+ */
146
+ protected prepareRequest(request: RequestInit, { url, options }: {
147
+ url: string;
148
+ options: FinalRequestOptions;
149
+ }): Promise<void>;
150
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
151
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
152
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
153
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
154
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
155
+ private methodRequest;
156
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
157
+ private makeRequest;
158
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
159
+ private shouldRetry;
160
+ private retryRequest;
161
+ private calculateDefaultRetryTimeoutMillis;
162
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
163
+ retryCount?: number;
164
+ }): Promise<{
165
+ req: FinalizedRequestInit;
166
+ url: string;
167
+ timeout: number;
168
+ }>;
169
+ private buildHeaders;
170
+ private buildBody;
171
+ static SendblueAPI: typeof SendblueAPI;
172
+ static DEFAULT_TIMEOUT: number;
173
+ static SendblueAPIError: typeof Errors.SendblueAPIError;
174
+ static APIError: typeof Errors.APIError;
175
+ static APIConnectionError: typeof Errors.APIConnectionError;
176
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
177
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
178
+ static NotFoundError: typeof Errors.NotFoundError;
179
+ static ConflictError: typeof Errors.ConflictError;
180
+ static RateLimitError: typeof Errors.RateLimitError;
181
+ static BadRequestError: typeof Errors.BadRequestError;
182
+ static AuthenticationError: typeof Errors.AuthenticationError;
183
+ static InternalServerError: typeof Errors.InternalServerError;
184
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
185
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
186
+ static toFile: typeof Uploads.toFile;
187
+ messages: API.Messages;
188
+ groups: API.Groups;
189
+ mediaObjects: API.MediaObjects;
190
+ lookups: API.Lookups;
191
+ typingIndicators: API.TypingIndicators;
192
+ contacts: API.Contacts;
193
+ }
194
+ export declare namespace SendblueAPI {
195
+ export type RequestOptions = Opts.RequestOptions;
196
+ export { Messages as Messages, type MessageContent as MessageContent, type MessageResponse as MessageResponse, type MessageRetrieveResponse as MessageRetrieveResponse, type MessageListResponse as MessageListResponse, type MessageListParams as MessageListParams, type MessageGetStatusParams as MessageGetStatusParams, type MessageSendParams as MessageSendParams, };
197
+ export { Groups as Groups, type GroupModifyResponse as GroupModifyResponse, type GroupModifyParams as GroupModifyParams, type GroupSendMessageParams as GroupSendMessageParams, };
198
+ export { MediaObjects as MediaObjects, type MediaObjectUploadResponse as MediaObjectUploadResponse, type MediaObjectUploadParams as MediaObjectUploadParams, };
199
+ export { Lookups as Lookups, type LookupLookupNumberResponse as LookupLookupNumberResponse, type LookupLookupNumberParams as LookupLookupNumberParams, };
200
+ export { TypingIndicators as TypingIndicators, type TypingIndicatorSendResponse as TypingIndicatorSendResponse, type TypingIndicatorSendParams as TypingIndicatorSendParams, };
201
+ export { Contacts as Contacts, type Contact as Contact, type ContactCreateResponse as ContactCreateResponse, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactUpdateResponse as ContactUpdateResponse, type ContactListResponse as ContactListResponse, type ContactDeleteResponse as ContactDeleteResponse, type ContactCountResponse as ContactCountResponse, type ContactVerifyResponse as ContactVerifyResponse, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactVerifyParams as ContactVerifyParams, };
202
+ }
203
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAET,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,EAAE;OAC1E,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,OAAO,EAAE;OACjE,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,YAAY,EAAE;OACpE,EACL,cAAc,EACd,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,QAAQ,EACT;OACM,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EACjB;OACM,EACL,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT;OACM,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,WAAW;;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAA0C,EAC1C,MAAwC,EACxC,SAA8C,EAC9C,GAAG,IAAI,EACR,GAAE,aAAkB;IAwCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAwBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAI5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;cAI5E,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;cAI3E,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI9F;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBhE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAmBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JnB,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA8BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,SAAS;IAqCjB,MAAM,CAAC,WAAW,qBAAQ;IAC1B,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,gBAAgB,iCAA2B;IAClD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,gBAAgB,EAAE,GAAG,CAAC,gBAAgB,CAAkC;IACxE,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;CACjD;AAOD,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}