@knocklabs/node 0.6.19 → 1.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 (860) hide show
  1. package/CHANGELOG.md +48 -7
  2. package/LICENSE +201 -21
  3. package/README.md +338 -129
  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 +223 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +223 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +485 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +481 -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/pagination.d.mts +111 -0
  37. package/core/pagination.d.mts.map +1 -0
  38. package/core/pagination.d.ts +111 -0
  39. package/core/pagination.d.ts.map +1 -0
  40. package/core/pagination.js +173 -0
  41. package/core/pagination.js.map +1 -0
  42. package/core/pagination.mjs +164 -0
  43. package/core/pagination.mjs.map +1 -0
  44. package/core/resource.d.mts +6 -0
  45. package/core/resource.d.mts.map +1 -0
  46. package/core/resource.d.ts +6 -0
  47. package/core/resource.d.ts.map +1 -0
  48. package/core/resource.js +11 -0
  49. package/core/resource.js.map +1 -0
  50. package/core/resource.mjs +7 -0
  51. package/core/resource.mjs.map +1 -0
  52. package/core/uploads.d.mts +3 -0
  53. package/core/uploads.d.mts.map +1 -0
  54. package/core/uploads.d.ts +3 -0
  55. package/core/uploads.d.ts.map +1 -0
  56. package/core/uploads.js +6 -0
  57. package/core/uploads.js.map +1 -0
  58. package/core/uploads.mjs +2 -0
  59. package/core/uploads.mjs.map +1 -0
  60. package/error.d.mts +2 -0
  61. package/error.d.mts.map +1 -0
  62. package/error.d.ts +2 -0
  63. package/error.d.ts.map +1 -0
  64. package/error.js +6 -0
  65. package/error.js.map +1 -0
  66. package/error.mjs +2 -0
  67. package/error.mjs.map +1 -0
  68. package/index.d.mts +7 -0
  69. package/index.d.mts.map +1 -0
  70. package/index.d.ts +7 -0
  71. package/index.d.ts.map +1 -0
  72. package/index.js +32 -0
  73. package/index.js.map +1 -0
  74. package/index.mjs +8 -0
  75. package/index.mjs.map +1 -0
  76. package/internal/builtin-types.d.mts +73 -0
  77. package/internal/builtin-types.d.mts.map +1 -0
  78. package/internal/builtin-types.d.ts +73 -0
  79. package/internal/builtin-types.d.ts.map +1 -0
  80. package/internal/builtin-types.js +4 -0
  81. package/internal/builtin-types.js.map +1 -0
  82. package/internal/builtin-types.mjs +3 -0
  83. package/internal/builtin-types.mjs.map +1 -0
  84. package/internal/detect-platform.d.mts +15 -0
  85. package/internal/detect-platform.d.mts.map +1 -0
  86. package/internal/detect-platform.d.ts +15 -0
  87. package/internal/detect-platform.d.ts.map +1 -0
  88. package/internal/detect-platform.js +162 -0
  89. package/internal/detect-platform.js.map +1 -0
  90. package/internal/detect-platform.mjs +157 -0
  91. package/internal/detect-platform.mjs.map +1 -0
  92. package/internal/errors.d.mts +3 -0
  93. package/internal/errors.d.mts.map +1 -0
  94. package/internal/errors.d.ts +3 -0
  95. package/internal/errors.d.ts.map +1 -0
  96. package/internal/errors.js +41 -0
  97. package/internal/errors.js.map +1 -0
  98. package/internal/errors.mjs +36 -0
  99. package/internal/errors.mjs.map +1 -0
  100. package/internal/headers.d.mts +20 -0
  101. package/internal/headers.d.mts.map +1 -0
  102. package/internal/headers.d.ts +20 -0
  103. package/internal/headers.d.ts.map +1 -0
  104. package/internal/headers.js +79 -0
  105. package/internal/headers.js.map +1 -0
  106. package/internal/headers.mjs +74 -0
  107. package/internal/headers.mjs.map +1 -0
  108. package/internal/parse.d.mts +12 -0
  109. package/internal/parse.d.mts.map +1 -0
  110. package/internal/parse.d.ts +12 -0
  111. package/internal/parse.d.ts.map +1 -0
  112. package/internal/parse.js +35 -0
  113. package/internal/parse.js.map +1 -0
  114. package/internal/parse.mjs +32 -0
  115. package/internal/parse.mjs.map +1 -0
  116. package/internal/qs/formats.d.mts +6 -0
  117. package/internal/qs/formats.d.mts.map +1 -0
  118. package/internal/qs/formats.d.ts +6 -0
  119. package/internal/qs/formats.d.ts.map +1 -0
  120. package/internal/qs/formats.js +11 -0
  121. package/internal/qs/formats.js.map +1 -0
  122. package/internal/qs/formats.mjs +8 -0
  123. package/internal/qs/formats.mjs.map +1 -0
  124. package/internal/qs/index.d.mts +10 -0
  125. package/internal/qs/index.d.mts.map +1 -0
  126. package/internal/qs/index.d.ts +10 -0
  127. package/internal/qs/index.d.ts.map +1 -0
  128. package/internal/qs/index.js +14 -0
  129. package/internal/qs/index.js.map +1 -0
  130. package/internal/qs/index.mjs +10 -0
  131. package/internal/qs/index.mjs.map +1 -0
  132. package/internal/qs/stringify.d.mts +3 -0
  133. package/internal/qs/stringify.d.mts.map +1 -0
  134. package/internal/qs/stringify.d.ts +3 -0
  135. package/internal/qs/stringify.d.ts.map +1 -0
  136. package/internal/qs/stringify.js +279 -0
  137. package/internal/qs/stringify.js.map +1 -0
  138. package/internal/qs/stringify.mjs +276 -0
  139. package/internal/qs/stringify.mjs.map +1 -0
  140. package/internal/qs/types.d.mts +57 -0
  141. package/internal/qs/types.d.mts.map +1 -0
  142. package/internal/qs/types.d.ts +57 -0
  143. package/internal/qs/types.d.ts.map +1 -0
  144. package/{dist/src/common/interfaces.js → internal/qs/types.js} +1 -0
  145. package/internal/qs/types.js.map +1 -0
  146. package/internal/qs/types.mjs +2 -0
  147. package/internal/qs/types.mjs.map +1 -0
  148. package/internal/qs/utils.d.mts +14 -0
  149. package/internal/qs/utils.d.mts.map +1 -0
  150. package/internal/qs/utils.d.ts +14 -0
  151. package/internal/qs/utils.d.ts.map +1 -0
  152. package/internal/qs/utils.js +229 -0
  153. package/internal/qs/utils.js.map +1 -0
  154. package/internal/qs/utils.mjs +217 -0
  155. package/internal/qs/utils.mjs.map +1 -0
  156. package/internal/request-options.d.mts +32 -0
  157. package/internal/request-options.d.mts.map +1 -0
  158. package/internal/request-options.d.ts +32 -0
  159. package/internal/request-options.d.ts.map +1 -0
  160. package/internal/request-options.js +14 -0
  161. package/internal/request-options.js.map +1 -0
  162. package/internal/request-options.mjs +10 -0
  163. package/internal/request-options.mjs.map +1 -0
  164. package/internal/shim-types.d.mts +28 -0
  165. package/internal/shim-types.d.ts +28 -0
  166. package/internal/shims.d.mts +20 -0
  167. package/internal/shims.d.mts.map +1 -0
  168. package/internal/shims.d.ts +20 -0
  169. package/internal/shims.d.ts.map +1 -0
  170. package/internal/shims.js +92 -0
  171. package/internal/shims.js.map +1 -0
  172. package/internal/shims.mjs +85 -0
  173. package/internal/shims.mjs.map +1 -0
  174. package/internal/to-file.d.mts +45 -0
  175. package/internal/to-file.d.mts.map +1 -0
  176. package/internal/to-file.d.ts +45 -0
  177. package/internal/to-file.d.ts.map +1 -0
  178. package/internal/to-file.js +91 -0
  179. package/internal/to-file.js.map +1 -0
  180. package/internal/to-file.mjs +88 -0
  181. package/internal/to-file.mjs.map +1 -0
  182. package/internal/tslib.js +81 -0
  183. package/internal/tslib.mjs +17 -0
  184. package/internal/types.d.mts +67 -0
  185. package/internal/types.d.mts.map +1 -0
  186. package/internal/types.d.ts +67 -0
  187. package/internal/types.d.ts.map +1 -0
  188. package/internal/types.js +4 -0
  189. package/internal/types.js.map +1 -0
  190. package/internal/types.mjs +3 -0
  191. package/internal/types.mjs.map +1 -0
  192. package/internal/uploads.d.mts +42 -0
  193. package/internal/uploads.d.mts.map +1 -0
  194. package/internal/uploads.d.ts +42 -0
  195. package/internal/uploads.d.ts.map +1 -0
  196. package/internal/uploads.js +141 -0
  197. package/internal/uploads.js.map +1 -0
  198. package/internal/uploads.mjs +131 -0
  199. package/internal/uploads.mjs.map +1 -0
  200. package/internal/utils/base64.d.mts +3 -0
  201. package/internal/utils/base64.d.mts.map +1 -0
  202. package/internal/utils/base64.d.ts +3 -0
  203. package/internal/utils/base64.d.ts.map +1 -0
  204. package/internal/utils/base64.js +38 -0
  205. package/internal/utils/base64.js.map +1 -0
  206. package/internal/utils/base64.mjs +33 -0
  207. package/internal/utils/base64.mjs.map +1 -0
  208. package/internal/utils/bytes.d.mts +4 -0
  209. package/internal/utils/bytes.d.mts.map +1 -0
  210. package/internal/utils/bytes.d.ts +4 -0
  211. package/internal/utils/bytes.d.ts.map +1 -0
  212. package/internal/utils/bytes.js +31 -0
  213. package/internal/utils/bytes.js.map +1 -0
  214. package/internal/utils/bytes.mjs +26 -0
  215. package/internal/utils/bytes.mjs.map +1 -0
  216. package/internal/utils/env.d.mts +9 -0
  217. package/internal/utils/env.d.mts.map +1 -0
  218. package/internal/utils/env.d.ts +9 -0
  219. package/internal/utils/env.d.ts.map +1 -0
  220. package/internal/utils/env.js +22 -0
  221. package/internal/utils/env.js.map +1 -0
  222. package/internal/utils/env.mjs +18 -0
  223. package/internal/utils/env.mjs.map +1 -0
  224. package/internal/utils/log.d.mts +37 -0
  225. package/internal/utils/log.d.mts.map +1 -0
  226. package/internal/utils/log.d.ts +37 -0
  227. package/internal/utils/log.d.ts.map +1 -0
  228. package/internal/utils/log.js +85 -0
  229. package/internal/utils/log.js.map +1 -0
  230. package/internal/utils/log.mjs +79 -0
  231. package/internal/utils/log.mjs.map +1 -0
  232. package/internal/utils/path.d.mts +15 -0
  233. package/internal/utils/path.d.mts.map +1 -0
  234. package/internal/utils/path.d.ts +15 -0
  235. package/internal/utils/path.d.ts.map +1 -0
  236. package/internal/utils/path.js +58 -0
  237. package/internal/utils/path.js.map +1 -0
  238. package/internal/utils/path.mjs +53 -0
  239. package/internal/utils/path.mjs.map +1 -0
  240. package/internal/utils/sleep.d.mts +2 -0
  241. package/internal/utils/sleep.d.mts.map +1 -0
  242. package/internal/utils/sleep.d.ts +2 -0
  243. package/internal/utils/sleep.d.ts.map +1 -0
  244. package/internal/utils/sleep.js +7 -0
  245. package/internal/utils/sleep.js.map +1 -0
  246. package/internal/utils/sleep.mjs +3 -0
  247. package/internal/utils/sleep.mjs.map +1 -0
  248. package/internal/utils/uuid.d.mts +5 -0
  249. package/internal/utils/uuid.d.mts.map +1 -0
  250. package/internal/utils/uuid.d.ts +5 -0
  251. package/internal/utils/uuid.d.ts.map +1 -0
  252. package/internal/utils/uuid.js +19 -0
  253. package/internal/utils/uuid.js.map +1 -0
  254. package/internal/utils/uuid.mjs +15 -0
  255. package/internal/utils/uuid.mjs.map +1 -0
  256. package/internal/utils/values.d.mts +16 -0
  257. package/internal/utils/values.d.mts.map +1 -0
  258. package/internal/utils/values.d.ts +16 -0
  259. package/internal/utils/values.d.ts.map +1 -0
  260. package/internal/utils/values.js +109 -0
  261. package/internal/utils/values.js.map +1 -0
  262. package/internal/utils/values.mjs +92 -0
  263. package/internal/utils/values.mjs.map +1 -0
  264. package/internal/utils.d.mts +7 -0
  265. package/internal/utils.d.mts.map +1 -0
  266. package/internal/utils.d.ts +7 -0
  267. package/internal/utils.d.ts.map +1 -0
  268. package/internal/utils.js +11 -0
  269. package/internal/utils.js.map +1 -0
  270. package/internal/utils.mjs +8 -0
  271. package/internal/utils.mjs.map +1 -0
  272. package/lib/index.d.mts +6 -0
  273. package/lib/index.d.mts.map +1 -0
  274. package/lib/index.d.ts +6 -0
  275. package/lib/index.d.ts.map +1 -0
  276. package/lib/index.js +9 -0
  277. package/lib/index.js.map +1 -0
  278. package/lib/index.mjs +6 -0
  279. package/lib/index.mjs.map +1 -0
  280. package/lib/tokenSigner.d.mts +46 -0
  281. package/lib/tokenSigner.d.mts.map +1 -0
  282. package/lib/tokenSigner.d.ts +46 -0
  283. package/lib/tokenSigner.d.ts.map +1 -0
  284. package/lib/tokenSigner.js +131 -0
  285. package/lib/tokenSigner.js.map +1 -0
  286. package/lib/tokenSigner.mjs +125 -0
  287. package/lib/tokenSigner.mjs.map +1 -0
  288. package/lib/userTokens.d.mts +32 -0
  289. package/lib/userTokens.d.mts.map +1 -0
  290. package/{dist/src/common → lib}/userTokens.d.ts +7 -3
  291. package/lib/userTokens.d.ts.map +1 -0
  292. package/{dist/src/common → lib}/userTokens.js +4 -0
  293. package/lib/userTokens.js.map +1 -0
  294. package/lib/userTokens.mjs +12 -0
  295. package/lib/userTokens.mjs.map +1 -0
  296. package/package.json +155 -38
  297. package/pagination.d.mts +2 -0
  298. package/pagination.d.mts.map +1 -0
  299. package/pagination.d.ts +2 -0
  300. package/pagination.d.ts.map +1 -0
  301. package/pagination.js +6 -0
  302. package/pagination.js.map +1 -0
  303. package/pagination.mjs +2 -0
  304. package/pagination.mjs.map +1 -0
  305. package/resource.d.mts +2 -0
  306. package/resource.d.mts.map +1 -0
  307. package/resource.d.ts +2 -0
  308. package/resource.d.ts.map +1 -0
  309. package/resource.js +6 -0
  310. package/resource.js.map +1 -0
  311. package/resource.mjs +2 -0
  312. package/resource.mjs.map +1 -0
  313. package/resources/audiences.d.mts +160 -0
  314. package/resources/audiences.d.mts.map +1 -0
  315. package/resources/audiences.d.ts +160 -0
  316. package/resources/audiences.d.ts.map +1 -0
  317. package/resources/audiences.js +53 -0
  318. package/resources/audiences.js.map +1 -0
  319. package/resources/audiences.mjs +49 -0
  320. package/resources/audiences.mjs.map +1 -0
  321. package/resources/bulk-operations.d.mts +97 -0
  322. package/resources/bulk-operations.d.mts.map +1 -0
  323. package/resources/bulk-operations.d.ts +97 -0
  324. package/resources/bulk-operations.d.ts.map +1 -0
  325. package/resources/bulk-operations.js +23 -0
  326. package/resources/bulk-operations.js.map +1 -0
  327. package/resources/bulk-operations.mjs +19 -0
  328. package/resources/bulk-operations.mjs.map +1 -0
  329. package/resources/channels/bulk.d.mts +82 -0
  330. package/resources/channels/bulk.d.mts.map +1 -0
  331. package/resources/channels/bulk.d.ts +82 -0
  332. package/resources/channels/bulk.d.ts.map +1 -0
  333. package/resources/channels/bulk.js +40 -0
  334. package/resources/channels/bulk.js.map +1 -0
  335. package/resources/channels/bulk.mjs +36 -0
  336. package/resources/channels/bulk.mjs.map +1 -0
  337. package/resources/channels/channels.d.mts +10 -0
  338. package/resources/channels/channels.d.mts.map +1 -0
  339. package/resources/channels/channels.d.ts +10 -0
  340. package/resources/channels/channels.d.ts.map +1 -0
  341. package/resources/channels/channels.js +17 -0
  342. package/resources/channels/channels.js.map +1 -0
  343. package/resources/channels/channels.mjs +12 -0
  344. package/resources/channels/channels.mjs.map +1 -0
  345. package/resources/channels/index.d.mts +3 -0
  346. package/resources/channels/index.d.mts.map +1 -0
  347. package/resources/channels/index.d.ts +3 -0
  348. package/resources/channels/index.d.ts.map +1 -0
  349. package/resources/channels/index.js +9 -0
  350. package/resources/channels/index.js.map +1 -0
  351. package/resources/channels/index.mjs +4 -0
  352. package/resources/channels/index.mjs.map +1 -0
  353. package/resources/channels.d.mts +2 -0
  354. package/resources/channels.d.mts.map +1 -0
  355. package/resources/channels.d.ts +2 -0
  356. package/resources/channels.d.ts.map +1 -0
  357. package/resources/channels.js +6 -0
  358. package/resources/channels.js.map +1 -0
  359. package/resources/channels.mjs +3 -0
  360. package/resources/channels.mjs.map +1 -0
  361. package/resources/index.d.mts +14 -0
  362. package/resources/index.d.mts.map +1 -0
  363. package/resources/index.d.ts +14 -0
  364. package/resources/index.d.ts.map +1 -0
  365. package/resources/index.js +31 -0
  366. package/resources/index.js.map +1 -0
  367. package/resources/index.mjs +15 -0
  368. package/resources/index.mjs.map +1 -0
  369. package/resources/integrations/census.d.mts +41 -0
  370. package/resources/integrations/census.d.mts.map +1 -0
  371. package/resources/integrations/census.d.ts +41 -0
  372. package/resources/integrations/census.d.ts.map +1 -0
  373. package/resources/integrations/census.js +15 -0
  374. package/resources/integrations/census.js.map +1 -0
  375. package/resources/integrations/census.mjs +11 -0
  376. package/resources/integrations/census.mjs.map +1 -0
  377. package/resources/integrations/hightouch.d.mts +41 -0
  378. package/resources/integrations/hightouch.d.mts.map +1 -0
  379. package/resources/integrations/hightouch.d.ts +41 -0
  380. package/resources/integrations/hightouch.d.ts.map +1 -0
  381. package/resources/integrations/hightouch.js +15 -0
  382. package/resources/integrations/hightouch.js.map +1 -0
  383. package/resources/integrations/hightouch.mjs +11 -0
  384. package/resources/integrations/hightouch.mjs.map +1 -0
  385. package/resources/integrations/index.d.mts +4 -0
  386. package/resources/integrations/index.d.mts.map +1 -0
  387. package/resources/integrations/index.d.ts +4 -0
  388. package/resources/integrations/index.d.ts.map +1 -0
  389. package/resources/integrations/index.js +11 -0
  390. package/resources/integrations/index.js.map +1 -0
  391. package/resources/integrations/index.mjs +5 -0
  392. package/resources/integrations/index.mjs.map +1 -0
  393. package/resources/integrations/integrations.d.mts +14 -0
  394. package/resources/integrations/integrations.d.mts.map +1 -0
  395. package/resources/integrations/integrations.d.ts +14 -0
  396. package/resources/integrations/integrations.d.ts.map +1 -0
  397. package/resources/integrations/integrations.js +21 -0
  398. package/resources/integrations/integrations.js.map +1 -0
  399. package/resources/integrations/integrations.mjs +16 -0
  400. package/resources/integrations/integrations.mjs.map +1 -0
  401. package/resources/integrations.d.mts +2 -0
  402. package/resources/integrations.d.mts.map +1 -0
  403. package/resources/integrations.d.ts +2 -0
  404. package/resources/integrations.d.ts.map +1 -0
  405. package/resources/integrations.js +6 -0
  406. package/resources/integrations.js.map +1 -0
  407. package/resources/integrations.mjs +3 -0
  408. package/resources/integrations.mjs.map +1 -0
  409. package/resources/messages/activities.d.mts +32 -0
  410. package/resources/messages/activities.d.mts.map +1 -0
  411. package/resources/messages/activities.d.ts +32 -0
  412. package/resources/messages/activities.d.ts.map +1 -0
  413. package/resources/messages/activities.js +27 -0
  414. package/resources/messages/activities.js.map +1 -0
  415. package/resources/messages/activities.mjs +23 -0
  416. package/resources/messages/activities.mjs.map +1 -0
  417. package/resources/messages/batch.d.mts +455 -0
  418. package/resources/messages/batch.d.mts.map +1 -0
  419. package/resources/messages/batch.d.ts +455 -0
  420. package/resources/messages/batch.d.ts.map +1 -0
  421. package/resources/messages/batch.js +147 -0
  422. package/resources/messages/batch.js.map +1 -0
  423. package/resources/messages/batch.mjs +143 -0
  424. package/resources/messages/batch.mjs.map +1 -0
  425. package/resources/messages/index.d.mts +4 -0
  426. package/resources/messages/index.d.mts.map +1 -0
  427. package/resources/messages/index.d.ts +4 -0
  428. package/resources/messages/index.d.ts.map +1 -0
  429. package/resources/messages/index.js +11 -0
  430. package/resources/messages/index.js.map +1 -0
  431. package/resources/messages/index.mjs +5 -0
  432. package/resources/messages/index.mjs.map +1 -0
  433. package/resources/messages/messages.d.mts +778 -0
  434. package/resources/messages/messages.d.mts.map +1 -0
  435. package/resources/messages/messages.d.ts +778 -0
  436. package/resources/messages/messages.d.ts.map +1 -0
  437. package/resources/messages/messages.js +223 -0
  438. package/resources/messages/messages.js.map +1 -0
  439. package/resources/messages/messages.mjs +218 -0
  440. package/resources/messages/messages.mjs.map +1 -0
  441. package/resources/messages.d.mts +2 -0
  442. package/resources/messages.d.mts.map +1 -0
  443. package/resources/messages.d.ts +2 -0
  444. package/resources/messages.d.ts.map +1 -0
  445. package/resources/messages.js +6 -0
  446. package/resources/messages.js.map +1 -0
  447. package/resources/messages.mjs +3 -0
  448. package/resources/messages.mjs.map +1 -0
  449. package/resources/objects/bulk.d.mts +108 -0
  450. package/resources/objects/bulk.d.mts.map +1 -0
  451. package/resources/objects/bulk.d.ts +108 -0
  452. package/resources/objects/bulk.d.ts.map +1 -0
  453. package/resources/objects/bulk.js +81 -0
  454. package/resources/objects/bulk.js.map +1 -0
  455. package/resources/objects/bulk.mjs +77 -0
  456. package/resources/objects/bulk.mjs.map +1 -0
  457. package/resources/objects/index.d.mts +3 -0
  458. package/resources/objects/index.d.mts.map +1 -0
  459. package/resources/objects/index.d.ts +3 -0
  460. package/resources/objects/index.d.ts.map +1 -0
  461. package/resources/objects/index.js +9 -0
  462. package/resources/objects/index.js.map +1 -0
  463. package/resources/objects/index.mjs +4 -0
  464. package/resources/objects/index.mjs.map +1 -0
  465. package/resources/objects/objects.d.mts +560 -0
  466. package/resources/objects/objects.d.mts.map +1 -0
  467. package/resources/objects/objects.d.ts +560 -0
  468. package/resources/objects/objects.d.ts.map +1 -0
  469. package/resources/objects/objects.js +312 -0
  470. package/resources/objects/objects.js.map +1 -0
  471. package/resources/objects/objects.mjs +307 -0
  472. package/resources/objects/objects.mjs.map +1 -0
  473. package/resources/objects.d.mts +2 -0
  474. package/resources/objects.d.mts.map +1 -0
  475. package/resources/objects.d.ts +2 -0
  476. package/resources/objects.d.ts.map +1 -0
  477. package/resources/objects.js +6 -0
  478. package/resources/objects.js.map +1 -0
  479. package/resources/objects.mjs +3 -0
  480. package/resources/objects.mjs.map +1 -0
  481. package/resources/providers/index.d.mts +4 -0
  482. package/resources/providers/index.d.mts.map +1 -0
  483. package/resources/providers/index.d.ts +4 -0
  484. package/resources/providers/index.d.ts.map +1 -0
  485. package/resources/providers/index.js +11 -0
  486. package/resources/providers/index.js.map +1 -0
  487. package/resources/providers/index.mjs +5 -0
  488. package/resources/providers/index.mjs.map +1 -0
  489. package/resources/providers/ms-teams.d.mts +223 -0
  490. package/resources/providers/ms-teams.d.mts.map +1 -0
  491. package/resources/providers/ms-teams.d.ts +223 -0
  492. package/resources/providers/ms-teams.d.ts.map +1 -0
  493. package/resources/providers/ms-teams.js +82 -0
  494. package/resources/providers/ms-teams.js.map +1 -0
  495. package/resources/providers/ms-teams.mjs +78 -0
  496. package/resources/providers/ms-teams.mjs.map +1 -0
  497. package/resources/providers/providers.d.mts +14 -0
  498. package/resources/providers/providers.d.mts.map +1 -0
  499. package/resources/providers/providers.d.ts +14 -0
  500. package/resources/providers/providers.d.ts.map +1 -0
  501. package/resources/providers/providers.js +21 -0
  502. package/resources/providers/providers.js.map +1 -0
  503. package/resources/providers/providers.mjs +16 -0
  504. package/resources/providers/providers.mjs.map +1 -0
  505. package/resources/providers/slack.d.mts +154 -0
  506. package/resources/providers/slack.d.mts.map +1 -0
  507. package/resources/providers/slack.d.ts +154 -0
  508. package/resources/providers/slack.d.ts.map +1 -0
  509. package/resources/providers/slack.js +60 -0
  510. package/resources/providers/slack.js.map +1 -0
  511. package/resources/providers/slack.mjs +56 -0
  512. package/resources/providers/slack.mjs.map +1 -0
  513. package/resources/providers.d.mts +2 -0
  514. package/resources/providers.d.mts.map +1 -0
  515. package/resources/providers.d.ts +2 -0
  516. package/resources/providers.d.ts.map +1 -0
  517. package/resources/providers.js +6 -0
  518. package/resources/providers.js.map +1 -0
  519. package/resources/providers.mjs +3 -0
  520. package/resources/providers.mjs.map +1 -0
  521. package/resources/recipients/channel-data.d.mts +205 -0
  522. package/resources/recipients/channel-data.d.mts.map +1 -0
  523. package/resources/recipients/channel-data.d.ts +205 -0
  524. package/resources/recipients/channel-data.d.ts.map +1 -0
  525. package/resources/recipients/channel-data.js +9 -0
  526. package/resources/recipients/channel-data.js.map +1 -0
  527. package/resources/recipients/channel-data.mjs +5 -0
  528. package/resources/recipients/channel-data.mjs.map +1 -0
  529. package/resources/recipients/index.d.mts +5 -0
  530. package/resources/recipients/index.d.mts.map +1 -0
  531. package/resources/recipients/index.d.ts +5 -0
  532. package/resources/recipients/index.d.ts.map +1 -0
  533. package/resources/recipients/index.js +13 -0
  534. package/resources/recipients/index.js.map +1 -0
  535. package/resources/recipients/index.mjs +6 -0
  536. package/resources/recipients/index.mjs.map +1 -0
  537. package/resources/recipients/preferences.d.mts +155 -0
  538. package/resources/recipients/preferences.d.mts.map +1 -0
  539. package/resources/recipients/preferences.d.ts +155 -0
  540. package/resources/recipients/preferences.d.ts.map +1 -0
  541. package/resources/recipients/preferences.js +9 -0
  542. package/resources/recipients/preferences.js.map +1 -0
  543. package/resources/recipients/preferences.mjs +5 -0
  544. package/resources/recipients/preferences.mjs.map +1 -0
  545. package/resources/recipients/recipients.d.mts +51 -0
  546. package/resources/recipients/recipients.d.mts.map +1 -0
  547. package/resources/recipients/recipients.d.ts +51 -0
  548. package/resources/recipients/recipients.d.ts.map +1 -0
  549. package/resources/recipients/recipients.js +23 -0
  550. package/resources/recipients/recipients.js.map +1 -0
  551. package/resources/recipients/recipients.mjs +18 -0
  552. package/resources/recipients/recipients.mjs.map +1 -0
  553. package/resources/recipients/subscriptions.d.mts +40 -0
  554. package/resources/recipients/subscriptions.d.mts.map +1 -0
  555. package/resources/recipients/subscriptions.d.ts +40 -0
  556. package/resources/recipients/subscriptions.d.ts.map +1 -0
  557. package/resources/recipients/subscriptions.js +9 -0
  558. package/resources/recipients/subscriptions.js.map +1 -0
  559. package/resources/recipients/subscriptions.mjs +5 -0
  560. package/resources/recipients/subscriptions.mjs.map +1 -0
  561. package/resources/recipients.d.mts +2 -0
  562. package/resources/recipients.d.mts.map +1 -0
  563. package/resources/recipients.d.ts +2 -0
  564. package/resources/recipients.d.ts.map +1 -0
  565. package/resources/recipients.js +6 -0
  566. package/resources/recipients.js.map +1 -0
  567. package/resources/recipients.mjs +3 -0
  568. package/resources/recipients.mjs.map +1 -0
  569. package/resources/schedules/bulk.d.mts +98 -0
  570. package/resources/schedules/bulk.d.mts.map +1 -0
  571. package/resources/schedules/bulk.d.ts +98 -0
  572. package/resources/schedules/bulk.d.ts.map +1 -0
  573. package/resources/schedules/bulk.js +47 -0
  574. package/resources/schedules/bulk.js.map +1 -0
  575. package/resources/schedules/bulk.mjs +43 -0
  576. package/resources/schedules/bulk.mjs.map +1 -0
  577. package/resources/schedules/index.d.mts +3 -0
  578. package/resources/schedules/index.d.mts.map +1 -0
  579. package/resources/schedules/index.d.ts +3 -0
  580. package/resources/schedules/index.d.ts.map +1 -0
  581. package/resources/schedules/index.js +9 -0
  582. package/resources/schedules/index.js.map +1 -0
  583. package/resources/schedules/index.mjs +4 -0
  584. package/resources/schedules/index.mjs.map +1 -0
  585. package/resources/schedules/schedules.d.mts +299 -0
  586. package/resources/schedules/schedules.d.mts.map +1 -0
  587. package/resources/schedules/schedules.d.ts +299 -0
  588. package/resources/schedules/schedules.d.ts.map +1 -0
  589. package/resources/schedules/schedules.js +126 -0
  590. package/resources/schedules/schedules.js.map +1 -0
  591. package/resources/schedules/schedules.mjs +121 -0
  592. package/resources/schedules/schedules.mjs.map +1 -0
  593. package/resources/schedules.d.mts +2 -0
  594. package/resources/schedules.d.mts.map +1 -0
  595. package/resources/schedules.d.ts +2 -0
  596. package/resources/schedules.d.ts.map +1 -0
  597. package/resources/schedules.js +6 -0
  598. package/resources/schedules.js.map +1 -0
  599. package/resources/schedules.mjs +3 -0
  600. package/resources/schedules.mjs.map +1 -0
  601. package/resources/shared.d.mts +45 -0
  602. package/resources/shared.d.mts.map +1 -0
  603. package/resources/shared.d.ts +45 -0
  604. package/resources/shared.d.ts.map +1 -0
  605. package/resources/shared.js +9 -0
  606. package/resources/shared.js.map +1 -0
  607. package/resources/shared.mjs +5 -0
  608. package/resources/shared.mjs.map +1 -0
  609. package/resources/tenants/bulk.d.mts +45 -0
  610. package/resources/tenants/bulk.d.mts.map +1 -0
  611. package/resources/tenants/bulk.d.ts +45 -0
  612. package/resources/tenants/bulk.d.ts.map +1 -0
  613. package/resources/tenants/bulk.js +36 -0
  614. package/resources/tenants/bulk.js.map +1 -0
  615. package/resources/tenants/bulk.mjs +32 -0
  616. package/resources/tenants/bulk.mjs.map +1 -0
  617. package/resources/tenants/index.d.mts +3 -0
  618. package/resources/tenants/index.d.mts.map +1 -0
  619. package/resources/tenants/index.d.ts +3 -0
  620. package/resources/tenants/index.d.ts.map +1 -0
  621. package/resources/tenants/index.js +9 -0
  622. package/resources/tenants/index.js.map +1 -0
  623. package/resources/tenants/index.mjs +4 -0
  624. package/resources/tenants/index.mjs.map +1 -0
  625. package/resources/tenants/tenants.d.mts +266 -0
  626. package/resources/tenants/tenants.d.mts.map +1 -0
  627. package/resources/tenants/tenants.d.ts +266 -0
  628. package/resources/tenants/tenants.d.ts.map +1 -0
  629. package/resources/tenants/tenants.js +77 -0
  630. package/resources/tenants/tenants.js.map +1 -0
  631. package/resources/tenants/tenants.mjs +72 -0
  632. package/resources/tenants/tenants.mjs.map +1 -0
  633. package/resources/tenants.d.mts +2 -0
  634. package/resources/tenants.d.mts.map +1 -0
  635. package/resources/tenants.d.ts +2 -0
  636. package/resources/tenants.d.ts.map +1 -0
  637. package/resources/tenants.js +6 -0
  638. package/resources/tenants.js.map +1 -0
  639. package/resources/tenants.mjs +3 -0
  640. package/resources/tenants.mjs.map +1 -0
  641. package/resources/users/bulk.d.mts +92 -0
  642. package/resources/users/bulk.d.mts.map +1 -0
  643. package/resources/users/bulk.d.ts +92 -0
  644. package/resources/users/bulk.d.ts.map +1 -0
  645. package/resources/users/bulk.js +73 -0
  646. package/resources/users/bulk.js.map +1 -0
  647. package/resources/users/bulk.mjs +69 -0
  648. package/resources/users/bulk.mjs.map +1 -0
  649. package/resources/users/feeds.d.mts +248 -0
  650. package/resources/users/feeds.d.mts.map +1 -0
  651. package/resources/users/feeds.d.ts +248 -0
  652. package/resources/users/feeds.d.ts.map +1 -0
  653. package/resources/users/feeds.js +43 -0
  654. package/resources/users/feeds.js.map +1 -0
  655. package/resources/users/feeds.mjs +39 -0
  656. package/resources/users/feeds.mjs.map +1 -0
  657. package/resources/users/guides.d.mts +293 -0
  658. package/resources/users/guides.d.mts.map +1 -0
  659. package/resources/users/guides.d.ts +293 -0
  660. package/resources/users/guides.d.ts.map +1 -0
  661. package/resources/users/guides.js +114 -0
  662. package/resources/users/guides.js.map +1 -0
  663. package/resources/users/guides.mjs +110 -0
  664. package/resources/users/guides.mjs.map +1 -0
  665. package/resources/users/index.d.mts +5 -0
  666. package/resources/users/index.d.mts.map +1 -0
  667. package/resources/users/index.d.ts +5 -0
  668. package/resources/users/index.d.ts.map +1 -0
  669. package/resources/users/index.js +13 -0
  670. package/resources/users/index.js.map +1 -0
  671. package/resources/users/index.mjs +6 -0
  672. package/resources/users/index.mjs.map +1 -0
  673. package/resources/users/users.d.mts +585 -0
  674. package/resources/users/users.d.mts.map +1 -0
  675. package/resources/users/users.d.ts +585 -0
  676. package/resources/users/users.d.ts.map +1 -0
  677. package/resources/users/users.js +262 -0
  678. package/resources/users/users.js.map +1 -0
  679. package/resources/users/users.mjs +257 -0
  680. package/resources/users/users.mjs.map +1 -0
  681. package/resources/users.d.mts +2 -0
  682. package/resources/users.d.mts.map +1 -0
  683. package/resources/users.d.ts +2 -0
  684. package/resources/users.d.ts.map +1 -0
  685. package/resources/users.js +6 -0
  686. package/resources/users.js.map +1 -0
  687. package/resources/users.mjs +3 -0
  688. package/resources/users.mjs.map +1 -0
  689. package/resources/workflows.d.mts +113 -0
  690. package/resources/workflows.d.mts.map +1 -0
  691. package/resources/workflows.d.ts +113 -0
  692. package/resources/workflows.d.ts.map +1 -0
  693. package/resources/workflows.js +58 -0
  694. package/resources/workflows.js.map +1 -0
  695. package/resources/workflows.mjs +54 -0
  696. package/resources/workflows.mjs.map +1 -0
  697. package/resources.d.mts +2 -0
  698. package/resources.d.mts.map +1 -0
  699. package/resources.d.ts +2 -0
  700. package/resources.d.ts.map +1 -0
  701. package/resources.js +5 -0
  702. package/resources.js.map +1 -0
  703. package/resources.mjs +2 -0
  704. package/resources.mjs.map +1 -0
  705. package/src/api-promise.ts +2 -0
  706. package/src/client.ts +984 -0
  707. package/src/core/README.md +3 -0
  708. package/src/core/api-promise.ts +92 -0
  709. package/src/core/error.ts +130 -0
  710. package/src/core/pagination.ts +323 -0
  711. package/src/core/resource.ts +11 -0
  712. package/src/core/uploads.ts +2 -0
  713. package/src/error.ts +2 -0
  714. package/src/index.ts +23 -0
  715. package/src/internal/README.md +3 -0
  716. package/src/internal/builtin-types.ts +93 -0
  717. package/src/internal/detect-platform.ts +196 -0
  718. package/src/internal/errors.ts +33 -0
  719. package/src/internal/headers.ts +97 -0
  720. package/src/internal/parse.ts +50 -0
  721. package/src/internal/qs/LICENSE.md +13 -0
  722. package/src/internal/qs/README.md +3 -0
  723. package/src/internal/qs/formats.ts +9 -0
  724. package/src/internal/qs/index.ts +13 -0
  725. package/src/internal/qs/stringify.ts +388 -0
  726. package/src/internal/qs/types.ts +71 -0
  727. package/src/internal/qs/utils.ts +265 -0
  728. package/src/internal/request-options.ts +37 -0
  729. package/src/internal/shim-types.d.ts +28 -0
  730. package/src/internal/shims.ts +107 -0
  731. package/src/internal/to-file.ts +154 -0
  732. package/src/internal/types.ts +92 -0
  733. package/src/internal/uploads.ts +187 -0
  734. package/src/internal/utils/base64.ts +40 -0
  735. package/src/internal/utils/bytes.ts +32 -0
  736. package/src/internal/utils/env.ts +18 -0
  737. package/src/internal/utils/log.ts +126 -0
  738. package/src/internal/utils/path.ts +63 -0
  739. package/src/internal/utils/sleep.ts +3 -0
  740. package/src/internal/utils/uuid.ts +17 -0
  741. package/src/internal/utils/values.ts +102 -0
  742. package/src/internal/utils.ts +8 -0
  743. package/src/lib/.keep +4 -0
  744. package/src/lib/index.ts +6 -0
  745. package/src/lib/tokenSigner.ts +170 -0
  746. package/src/lib/userTokens.ts +38 -0
  747. package/src/pagination.ts +2 -0
  748. package/src/resource.ts +2 -0
  749. package/src/resources/audiences.ts +200 -0
  750. package/src/resources/bulk-operations.ts +120 -0
  751. package/src/resources/channels/bulk.ts +128 -0
  752. package/src/resources/channels/channels.ts +15 -0
  753. package/src/resources/channels/index.ts +4 -0
  754. package/src/resources/channels.ts +3 -0
  755. package/src/resources/index.ts +108 -0
  756. package/src/resources/integrations/census.ts +58 -0
  757. package/src/resources/integrations/hightouch.ts +58 -0
  758. package/src/resources/integrations/index.ts +9 -0
  759. package/src/resources/integrations/integrations.ts +33 -0
  760. package/src/resources/integrations.ts +3 -0
  761. package/src/resources/messages/activities.ts +48 -0
  762. package/src/resources/messages/batch.ts +575 -0
  763. package/src/resources/messages/index.ts +39 -0
  764. package/src/resources/messages/messages.ts +1055 -0
  765. package/src/resources/messages.ts +3 -0
  766. package/src/resources/objects/bulk.ts +141 -0
  767. package/src/resources/objects/index.ts +23 -0
  768. package/src/resources/objects/objects.ts +794 -0
  769. package/src/resources/objects.ts +3 -0
  770. package/src/resources/providers/index.ts +25 -0
  771. package/src/resources/providers/ms-teams.ts +300 -0
  772. package/src/resources/providers/providers.ts +61 -0
  773. package/src/resources/providers/slack.ts +213 -0
  774. package/src/resources/providers.ts +3 -0
  775. package/src/resources/recipients/channel-data.ts +255 -0
  776. package/src/resources/recipients/index.ts +22 -0
  777. package/src/resources/recipients/preferences.ts +192 -0
  778. package/src/resources/recipients/recipients.ts +101 -0
  779. package/src/resources/recipients/subscriptions.ts +49 -0
  780. package/src/resources/recipients.ts +3 -0
  781. package/src/resources/schedules/bulk.ts +112 -0
  782. package/src/resources/schedules/index.ts +16 -0
  783. package/src/resources/schedules/schedules.ts +369 -0
  784. package/src/resources/schedules.ts +3 -0
  785. package/src/resources/shared.ts +72 -0
  786. package/src/resources/tenants/bulk.ts +56 -0
  787. package/src/resources/tenants/index.ts +13 -0
  788. package/src/resources/tenants/tenants.ts +333 -0
  789. package/src/resources/tenants.ts +3 -0
  790. package/src/resources/users/bulk.ts +114 -0
  791. package/src/resources/users/feeds.ts +315 -0
  792. package/src/resources/users/guides.ts +386 -0
  793. package/src/resources/users/index.ts +40 -0
  794. package/src/resources/users/users.ts +823 -0
  795. package/src/resources/users.ts +3 -0
  796. package/src/resources/workflows.ts +140 -0
  797. package/src/resources.ts +1 -0
  798. package/src/tsconfig.json +11 -0
  799. package/src/uploads.ts +2 -0
  800. package/src/version.ts +1 -0
  801. package/uploads.d.mts +2 -0
  802. package/uploads.d.mts.map +1 -0
  803. package/uploads.d.ts +2 -0
  804. package/uploads.d.ts.map +1 -0
  805. package/uploads.js +6 -0
  806. package/uploads.js.map +1 -0
  807. package/uploads.mjs +2 -0
  808. package/uploads.mjs.map +1 -0
  809. package/version.d.mts +2 -0
  810. package/version.d.mts.map +1 -0
  811. package/version.d.ts +2 -0
  812. package/version.d.ts.map +1 -0
  813. package/version.js +5 -0
  814. package/version.js.map +1 -0
  815. package/version.mjs +2 -0
  816. package/version.mjs.map +1 -0
  817. package/dist/package.json +0 -48
  818. package/dist/src/common/exceptions.d.ts +0 -48
  819. package/dist/src/common/exceptions.js +0 -78
  820. package/dist/src/common/fetchClient.d.ts +0 -28
  821. package/dist/src/common/fetchClient.js +0 -148
  822. package/dist/src/common/interfaces.d.ts +0 -70
  823. package/dist/src/index.d.ts +0 -8
  824. package/dist/src/index.js +0 -26
  825. package/dist/src/knock.d.ts +0 -57
  826. package/dist/src/knock.js +0 -241
  827. package/dist/src/resources/activities/interfaces.d.ts +0 -11
  828. package/dist/src/resources/activities/interfaces.js +0 -2
  829. package/dist/src/resources/bulk_operations/index.d.ts +0 -7
  830. package/dist/src/resources/bulk_operations/index.js +0 -24
  831. package/dist/src/resources/bulk_operations/interfaces.d.ts +0 -12
  832. package/dist/src/resources/bulk_operations/interfaces.js +0 -2
  833. package/dist/src/resources/messages/index.d.ts +0 -16
  834. package/dist/src/resources/messages/index.js +0 -93
  835. package/dist/src/resources/messages/interfaces.d.ts +0 -58
  836. package/dist/src/resources/messages/interfaces.js +0 -2
  837. package/dist/src/resources/objects/index.d.ts +0 -36
  838. package/dist/src/resources/objects/index.js +0 -203
  839. package/dist/src/resources/objects/interfaces.d.ts +0 -51
  840. package/dist/src/resources/objects/interfaces.js +0 -2
  841. package/dist/src/resources/preferences/helpers.d.ts +0 -7
  842. package/dist/src/resources/preferences/helpers.js +0 -11
  843. package/dist/src/resources/preferences/interfaces.d.ts +0 -30
  844. package/dist/src/resources/preferences/interfaces.js +0 -2
  845. package/dist/src/resources/slack/index.d.ts +0 -9
  846. package/dist/src/resources/slack/index.js +0 -75
  847. package/dist/src/resources/slack/interfaces.d.ts +0 -30
  848. package/dist/src/resources/slack/interfaces.js +0 -2
  849. package/dist/src/resources/tenants/index.d.ts +0 -11
  850. package/dist/src/resources/tenants/index.js +0 -42
  851. package/dist/src/resources/tenants/interfaces.d.ts +0 -32
  852. package/dist/src/resources/tenants/interfaces.js +0 -2
  853. package/dist/src/resources/users/index.d.ts +0 -36
  854. package/dist/src/resources/users/index.js +0 -232
  855. package/dist/src/resources/users/interfaces.d.ts +0 -34
  856. package/dist/src/resources/users/interfaces.js +0 -2
  857. package/dist/src/resources/workflows/index.d.ts +0 -13
  858. package/dist/src/resources/workflows/index.js +0 -72
  859. package/dist/src/resources/workflows/interfaces.d.ts +0 -90
  860. package/dist/src/resources/workflows/interfaces.js +0 -20
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ var _APIPromise_client;
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.APIPromise = void 0;
6
+ const tslib_1 = require("../internal/tslib.js");
7
+ const parse_1 = require("../internal/parse.js");
8
+ /**
9
+ * A subclass of `Promise` providing additional helper methods
10
+ * for interacting with the SDK.
11
+ */
12
+ class APIPromise extends Promise {
13
+ constructor(client, responsePromise, parseResponse = parse_1.defaultParseResponse) {
14
+ super((resolve) => {
15
+ // this is maybe a bit weird but this has to be a no-op to not implicitly
16
+ // parse the response body; instead .then, .catch, .finally are overridden
17
+ // to parse the response
18
+ resolve(null);
19
+ });
20
+ this.responsePromise = responsePromise;
21
+ this.parseResponse = parseResponse;
22
+ _APIPromise_client.set(this, void 0);
23
+ tslib_1.__classPrivateFieldSet(this, _APIPromise_client, client, "f");
24
+ }
25
+ _thenUnwrap(transform) {
26
+ return new APIPromise(tslib_1.__classPrivateFieldGet(this, _APIPromise_client, "f"), this.responsePromise, async (client, props) => transform(await this.parseResponse(client, props), props));
27
+ }
28
+ /**
29
+ * Gets the raw `Response` instance instead of parsing the response
30
+ * data.
31
+ *
32
+ * If you want to parse the response body but still get the `Response`
33
+ * instance, you can use {@link withResponse()}.
34
+ *
35
+ * 👋 Getting the wrong TypeScript type for `Response`?
36
+ * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
37
+ * to your `tsconfig.json`.
38
+ */
39
+ asResponse() {
40
+ return this.responsePromise.then((p) => p.response);
41
+ }
42
+ /**
43
+ * Gets the parsed response data and the raw `Response` instance.
44
+ *
45
+ * If you just want to get the raw `Response` instance without parsing it,
46
+ * you can use {@link asResponse()}.
47
+ *
48
+ * 👋 Getting the wrong TypeScript type for `Response`?
49
+ * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
50
+ * to your `tsconfig.json`.
51
+ */
52
+ async withResponse() {
53
+ const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
54
+ return { data, response };
55
+ }
56
+ parse() {
57
+ if (!this.parsedPromise) {
58
+ this.parsedPromise = this.responsePromise.then((data) => this.parseResponse(tslib_1.__classPrivateFieldGet(this, _APIPromise_client, "f"), data));
59
+ }
60
+ return this.parsedPromise;
61
+ }
62
+ then(onfulfilled, onrejected) {
63
+ return this.parse().then(onfulfilled, onrejected);
64
+ }
65
+ catch(onrejected) {
66
+ return this.parse().catch(onrejected);
67
+ }
68
+ finally(onfinally) {
69
+ return this.parse().finally(onfinally);
70
+ }
71
+ }
72
+ exports.APIPromise = APIPromise;
73
+ _APIPromise_client = new WeakMap();
74
+ //# sourceMappingURL=api-promise.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.js","sourceRoot":"","sources":["../src/core/api-promise.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;AAKtF,gDAA2E;AAE3E;;;GAGG;AACH,MAAa,UAAc,SAAQ,OAAU;IAI3C,YACE,MAAa,EACL,eAA0C,EAC1C,gBAGiB,4BAAoB;QAE7C,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YAChB,yEAAyE;YACzE,0EAA0E;YAC1E,wBAAwB;YACxB,OAAO,CAAC,IAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAXK,oBAAe,GAAf,eAAe,CAA2B;QAC1C,kBAAa,GAAb,aAAa,CAGwB;QAR/C,qCAAe;QAgBb,+BAAA,IAAI,sBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,WAAW,CAAI,SAAkD;QAC/D,OAAO,IAAI,UAAU,CAAC,+BAAA,IAAI,0BAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAChF,SAAS,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9E,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,+BAAA,IAAI,0BAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEQ,IAAI,CACX,WAAiF,EACjF,UAAmF;QAEnF,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAEQ,KAAK,CACZ,UAAiF;QAEjF,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAEQ,OAAO,CAAC,SAA2C;QAC1D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;CACF;AAhFD,gCAgFC"}
@@ -0,0 +1,70 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ var _APIPromise_client;
3
+ import { __classPrivateFieldGet, __classPrivateFieldSet } from "../internal/tslib.mjs";
4
+ import { defaultParseResponse } from "../internal/parse.mjs";
5
+ /**
6
+ * A subclass of `Promise` providing additional helper methods
7
+ * for interacting with the SDK.
8
+ */
9
+ export class APIPromise extends Promise {
10
+ constructor(client, responsePromise, parseResponse = defaultParseResponse) {
11
+ super((resolve) => {
12
+ // this is maybe a bit weird but this has to be a no-op to not implicitly
13
+ // parse the response body; instead .then, .catch, .finally are overridden
14
+ // to parse the response
15
+ resolve(null);
16
+ });
17
+ this.responsePromise = responsePromise;
18
+ this.parseResponse = parseResponse;
19
+ _APIPromise_client.set(this, void 0);
20
+ __classPrivateFieldSet(this, _APIPromise_client, client, "f");
21
+ }
22
+ _thenUnwrap(transform) {
23
+ return new APIPromise(__classPrivateFieldGet(this, _APIPromise_client, "f"), this.responsePromise, async (client, props) => transform(await this.parseResponse(client, props), props));
24
+ }
25
+ /**
26
+ * Gets the raw `Response` instance instead of parsing the response
27
+ * data.
28
+ *
29
+ * If you want to parse the response body but still get the `Response`
30
+ * instance, you can use {@link withResponse()}.
31
+ *
32
+ * 👋 Getting the wrong TypeScript type for `Response`?
33
+ * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
34
+ * to your `tsconfig.json`.
35
+ */
36
+ asResponse() {
37
+ return this.responsePromise.then((p) => p.response);
38
+ }
39
+ /**
40
+ * Gets the parsed response data and the raw `Response` instance.
41
+ *
42
+ * If you just want to get the raw `Response` instance without parsing it,
43
+ * you can use {@link asResponse()}.
44
+ *
45
+ * 👋 Getting the wrong TypeScript type for `Response`?
46
+ * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
47
+ * to your `tsconfig.json`.
48
+ */
49
+ async withResponse() {
50
+ const [data, response] = await Promise.all([this.parse(), this.asResponse()]);
51
+ return { data, response };
52
+ }
53
+ parse() {
54
+ if (!this.parsedPromise) {
55
+ this.parsedPromise = this.responsePromise.then((data) => this.parseResponse(__classPrivateFieldGet(this, _APIPromise_client, "f"), data));
56
+ }
57
+ return this.parsedPromise;
58
+ }
59
+ then(onfulfilled, onrejected) {
60
+ return this.parse().then(onfulfilled, onrejected);
61
+ }
62
+ catch(onrejected) {
63
+ return this.parse().catch(onrejected);
64
+ }
65
+ finally(onfinally) {
66
+ return this.parse().finally(onfinally);
67
+ }
68
+ }
69
+ _APIPromise_client = new WeakMap();
70
+ //# sourceMappingURL=api-promise.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["../src/core/api-promise.ts"],"names":[],"mappings":"AAAA,sFAAsF;;;OAK/E,EAAoB,oBAAoB,EAAE;AAEjD;;;GAGG;AACH,MAAM,OAAO,UAAc,SAAQ,OAAU;IAI3C,YACE,MAAa,EACL,eAA0C,EAC1C,gBAGiB,oBAAoB;QAE7C,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YAChB,yEAAyE;YACzE,0EAA0E;YAC1E,wBAAwB;YACxB,OAAO,CAAC,IAAW,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAXK,oBAAe,GAAf,eAAe,CAA2B;QAC1C,kBAAa,GAAb,aAAa,CAGwB;QAR/C,qCAAe;QAgBb,uBAAA,IAAI,sBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,WAAW,CAAI,SAAkD;QAC/D,OAAO,IAAI,UAAU,CAAC,uBAAA,IAAI,0BAAQ,EAAE,IAAI,CAAC,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAChF,SAAS,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC9E,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,uBAAA,IAAI,0BAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEQ,IAAI,CACX,WAAiF,EACjF,UAAmF;QAEnF,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAEQ,KAAK,CACZ,UAAiF;QAEjF,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAEQ,OAAO,CAAC,SAA2C;QAC1D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;CACF"}
@@ -0,0 +1,46 @@
1
+ export declare class KnockError extends Error {
2
+ }
3
+ export declare class APIError<TStatus extends number | undefined = number | undefined, THeaders extends Headers | undefined = Headers | undefined, TError extends Object | undefined = Object | undefined> extends KnockError {
4
+ /** HTTP status for the response that caused the error */
5
+ readonly status: TStatus;
6
+ /** HTTP headers for the response that caused the error */
7
+ readonly headers: THeaders;
8
+ /** JSON body of the response that caused the error */
9
+ readonly error: TError;
10
+ constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders);
11
+ private static makeMessage;
12
+ static generate(status: number | undefined, errorResponse: Object | undefined, message: string | undefined, headers: Headers | undefined): APIError;
13
+ }
14
+ export declare class APIUserAbortError extends APIError<undefined, undefined, undefined> {
15
+ constructor({ message }?: {
16
+ message?: string;
17
+ });
18
+ }
19
+ export declare class APIConnectionError extends APIError<undefined, undefined, undefined> {
20
+ constructor({ message, cause }: {
21
+ message?: string | undefined;
22
+ cause?: Error | undefined;
23
+ });
24
+ }
25
+ export declare class APIConnectionTimeoutError extends APIConnectionError {
26
+ constructor({ message }?: {
27
+ message?: string;
28
+ });
29
+ }
30
+ export declare class BadRequestError extends APIError<400, Headers> {
31
+ }
32
+ export declare class AuthenticationError extends APIError<401, Headers> {
33
+ }
34
+ export declare class PermissionDeniedError extends APIError<403, Headers> {
35
+ }
36
+ export declare class NotFoundError extends APIError<404, Headers> {
37
+ }
38
+ export declare class ConflictError extends APIError<409, Headers> {
39
+ }
40
+ export declare class UnprocessableEntityError extends APIError<422, Headers> {
41
+ }
42
+ export declare class RateLimitError extends APIError<429, Headers> {
43
+ }
44
+ export declare class InternalServerError extends APIError<number, Headers> {
45
+ }
46
+ //# sourceMappingURL=error.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.d.mts","sourceRoot":"","sources":["../src/core/error.ts"],"names":[],"mappings":"AAIA,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC,qBAAa,QAAQ,CACnB,OAAO,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACvD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CACtD,SAAQ,UAAU;IAClB,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAEX,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,QAAQ;IAO1F,OAAO,CAAC,MAAM,CAAC,WAAW;IAqB1B,MAAM,CAAC,QAAQ,CACb,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GAAG,SAAS,GAC3B,QAAQ;CAyCZ;AAED,qBAAa,iBAAkB,SAAQ,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;gBAClE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAGnD;AAED,qBAAa,kBAAmB,SAAQ,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;gBACnE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KAAE;CAM5F;AAED,qBAAa,yBAA0B,SAAQ,kBAAkB;gBACnD,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAGnD;AAED,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE9D,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAElE,qBAAa,qBAAsB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAEpE,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE5D,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE5D,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAEvE,qBAAa,cAAe,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE7D,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAAG"}
@@ -0,0 +1,46 @@
1
+ export declare class KnockError extends Error {
2
+ }
3
+ export declare class APIError<TStatus extends number | undefined = number | undefined, THeaders extends Headers | undefined = Headers | undefined, TError extends Object | undefined = Object | undefined> extends KnockError {
4
+ /** HTTP status for the response that caused the error */
5
+ readonly status: TStatus;
6
+ /** HTTP headers for the response that caused the error */
7
+ readonly headers: THeaders;
8
+ /** JSON body of the response that caused the error */
9
+ readonly error: TError;
10
+ constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders);
11
+ private static makeMessage;
12
+ static generate(status: number | undefined, errorResponse: Object | undefined, message: string | undefined, headers: Headers | undefined): APIError;
13
+ }
14
+ export declare class APIUserAbortError extends APIError<undefined, undefined, undefined> {
15
+ constructor({ message }?: {
16
+ message?: string;
17
+ });
18
+ }
19
+ export declare class APIConnectionError extends APIError<undefined, undefined, undefined> {
20
+ constructor({ message, cause }: {
21
+ message?: string | undefined;
22
+ cause?: Error | undefined;
23
+ });
24
+ }
25
+ export declare class APIConnectionTimeoutError extends APIConnectionError {
26
+ constructor({ message }?: {
27
+ message?: string;
28
+ });
29
+ }
30
+ export declare class BadRequestError extends APIError<400, Headers> {
31
+ }
32
+ export declare class AuthenticationError extends APIError<401, Headers> {
33
+ }
34
+ export declare class PermissionDeniedError extends APIError<403, Headers> {
35
+ }
36
+ export declare class NotFoundError extends APIError<404, Headers> {
37
+ }
38
+ export declare class ConflictError extends APIError<409, Headers> {
39
+ }
40
+ export declare class UnprocessableEntityError extends APIError<422, Headers> {
41
+ }
42
+ export declare class RateLimitError extends APIError<429, Headers> {
43
+ }
44
+ export declare class InternalServerError extends APIError<number, Headers> {
45
+ }
46
+ //# sourceMappingURL=error.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/core/error.ts"],"names":[],"mappings":"AAIA,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC,qBAAa,QAAQ,CACnB,OAAO,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACvD,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CACtD,SAAQ,UAAU;IAClB,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBAEX,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,QAAQ;IAO1F,OAAO,CAAC,MAAM,CAAC,WAAW;IAqB1B,MAAM,CAAC,QAAQ,CACb,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GAAG,SAAS,GAC3B,QAAQ;CAyCZ;AAED,qBAAa,iBAAkB,SAAQ,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;gBAClE,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAGnD;AAED,qBAAa,kBAAmB,SAAQ,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;gBACnE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KAAE;CAM5F;AAED,qBAAa,yBAA0B,SAAQ,kBAAkB;gBACnD,EAAE,OAAO,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAGnD;AAED,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE9D,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAElE,qBAAa,qBAAsB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAEpE,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE5D,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE5D,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAEvE,qBAAa,cAAe,SAAQ,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CAAG;AAE7D,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAAG"}
package/core/error.js ADDED
@@ -0,0 +1,113 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.InternalServerError = exports.RateLimitError = exports.UnprocessableEntityError = exports.ConflictError = exports.NotFoundError = exports.PermissionDeniedError = exports.AuthenticationError = exports.BadRequestError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.APIUserAbortError = exports.APIError = exports.KnockError = void 0;
5
+ const errors_1 = require("../internal/errors.js");
6
+ class KnockError extends Error {
7
+ }
8
+ exports.KnockError = KnockError;
9
+ class APIError extends KnockError {
10
+ constructor(status, error, message, headers) {
11
+ super(`${APIError.makeMessage(status, error, message)}`);
12
+ this.status = status;
13
+ this.headers = headers;
14
+ this.error = error;
15
+ }
16
+ static makeMessage(status, error, message) {
17
+ const msg = error?.message ?
18
+ typeof error.message === 'string' ?
19
+ error.message
20
+ : JSON.stringify(error.message)
21
+ : error ? JSON.stringify(error)
22
+ : message;
23
+ if (status && msg) {
24
+ return `${status} ${msg}`;
25
+ }
26
+ if (status) {
27
+ return `${status} status code (no body)`;
28
+ }
29
+ if (msg) {
30
+ return msg;
31
+ }
32
+ return '(no status code or body)';
33
+ }
34
+ static generate(status, errorResponse, message, headers) {
35
+ if (!status || !headers) {
36
+ return new APIConnectionError({ message, cause: (0, errors_1.castToError)(errorResponse) });
37
+ }
38
+ const error = errorResponse;
39
+ if (status === 400) {
40
+ return new BadRequestError(status, error, message, headers);
41
+ }
42
+ if (status === 401) {
43
+ return new AuthenticationError(status, error, message, headers);
44
+ }
45
+ if (status === 403) {
46
+ return new PermissionDeniedError(status, error, message, headers);
47
+ }
48
+ if (status === 404) {
49
+ return new NotFoundError(status, error, message, headers);
50
+ }
51
+ if (status === 409) {
52
+ return new ConflictError(status, error, message, headers);
53
+ }
54
+ if (status === 422) {
55
+ return new UnprocessableEntityError(status, error, message, headers);
56
+ }
57
+ if (status === 429) {
58
+ return new RateLimitError(status, error, message, headers);
59
+ }
60
+ if (status >= 500) {
61
+ return new InternalServerError(status, error, message, headers);
62
+ }
63
+ return new APIError(status, error, message, headers);
64
+ }
65
+ }
66
+ exports.APIError = APIError;
67
+ class APIUserAbortError extends APIError {
68
+ constructor({ message } = {}) {
69
+ super(undefined, undefined, message || 'Request was aborted.', undefined);
70
+ }
71
+ }
72
+ exports.APIUserAbortError = APIUserAbortError;
73
+ class APIConnectionError extends APIError {
74
+ constructor({ message, cause }) {
75
+ super(undefined, undefined, message || 'Connection error.', undefined);
76
+ // in some environments the 'cause' property is already declared
77
+ // @ts-ignore
78
+ if (cause)
79
+ this.cause = cause;
80
+ }
81
+ }
82
+ exports.APIConnectionError = APIConnectionError;
83
+ class APIConnectionTimeoutError extends APIConnectionError {
84
+ constructor({ message } = {}) {
85
+ super({ message: message ?? 'Request timed out.' });
86
+ }
87
+ }
88
+ exports.APIConnectionTimeoutError = APIConnectionTimeoutError;
89
+ class BadRequestError extends APIError {
90
+ }
91
+ exports.BadRequestError = BadRequestError;
92
+ class AuthenticationError extends APIError {
93
+ }
94
+ exports.AuthenticationError = AuthenticationError;
95
+ class PermissionDeniedError extends APIError {
96
+ }
97
+ exports.PermissionDeniedError = PermissionDeniedError;
98
+ class NotFoundError extends APIError {
99
+ }
100
+ exports.NotFoundError = NotFoundError;
101
+ class ConflictError extends APIError {
102
+ }
103
+ exports.ConflictError = ConflictError;
104
+ class UnprocessableEntityError extends APIError {
105
+ }
106
+ exports.UnprocessableEntityError = UnprocessableEntityError;
107
+ class RateLimitError extends APIError {
108
+ }
109
+ exports.RateLimitError = RateLimitError;
110
+ class InternalServerError extends APIError {
111
+ }
112
+ exports.InternalServerError = InternalServerError;
113
+ //# sourceMappingURL=error.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.js","sourceRoot":"","sources":["../src/core/error.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAAiD;AAEjD,MAAa,UAAW,SAAQ,KAAK;CAAG;AAAxC,gCAAwC;AAExC,MAAa,QAIX,SAAQ,UAAU;IAQlB,YAAY,MAAe,EAAE,KAAa,EAAE,OAA2B,EAAE,OAAiB;QACxF,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAA0B,EAAE,KAAU,EAAE,OAA2B;QAC5F,MAAM,GAAG,GACP,KAAK,EAAE,OAAO,CAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;gBACjC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC;QAEZ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,GAAG,MAAM,wBAAwB,CAAC;QAC3C,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,IAAI,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAA,oBAAW,EAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,KAAK,GAAG,aAAoC,CAAC;QAEnD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAtFD,4BAsFC;AAED,MAAa,iBAAkB,SAAQ,QAAyC;IAC9E,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,kBAAmB,SAAQ,QAAyC;IAC/E,YAAY,EAAE,OAAO,EAAE,KAAK,EAA+D;QACzF,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACvE,gEAAgE;QAChE,aAAa;QACb,IAAI,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;CACF;AAPD,gDAOC;AAED,MAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAJD,8DAIC;AAED,MAAa,eAAgB,SAAQ,QAAsB;CAAG;AAA9D,0CAA8D;AAE9D,MAAa,mBAAoB,SAAQ,QAAsB;CAAG;AAAlE,kDAAkE;AAElE,MAAa,qBAAsB,SAAQ,QAAsB;CAAG;AAApE,sDAAoE;AAEpE,MAAa,aAAc,SAAQ,QAAsB;CAAG;AAA5D,sCAA4D;AAE5D,MAAa,aAAc,SAAQ,QAAsB;CAAG;AAA5D,sCAA4D;AAE5D,MAAa,wBAAyB,SAAQ,QAAsB;CAAG;AAAvE,4DAAuE;AAEvE,MAAa,cAAe,SAAQ,QAAsB;CAAG;AAA7D,wCAA6D;AAE7D,MAAa,mBAAoB,SAAQ,QAAyB;CAAG;AAArE,kDAAqE"}
package/core/error.mjs ADDED
@@ -0,0 +1,97 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { castToError } from "../internal/errors.mjs";
3
+ export class KnockError extends Error {
4
+ }
5
+ export class APIError extends KnockError {
6
+ constructor(status, error, message, headers) {
7
+ super(`${APIError.makeMessage(status, error, message)}`);
8
+ this.status = status;
9
+ this.headers = headers;
10
+ this.error = error;
11
+ }
12
+ static makeMessage(status, error, message) {
13
+ const msg = error?.message ?
14
+ typeof error.message === 'string' ?
15
+ error.message
16
+ : JSON.stringify(error.message)
17
+ : error ? JSON.stringify(error)
18
+ : message;
19
+ if (status && msg) {
20
+ return `${status} ${msg}`;
21
+ }
22
+ if (status) {
23
+ return `${status} status code (no body)`;
24
+ }
25
+ if (msg) {
26
+ return msg;
27
+ }
28
+ return '(no status code or body)';
29
+ }
30
+ static generate(status, errorResponse, message, headers) {
31
+ if (!status || !headers) {
32
+ return new APIConnectionError({ message, cause: castToError(errorResponse) });
33
+ }
34
+ const error = errorResponse;
35
+ if (status === 400) {
36
+ return new BadRequestError(status, error, message, headers);
37
+ }
38
+ if (status === 401) {
39
+ return new AuthenticationError(status, error, message, headers);
40
+ }
41
+ if (status === 403) {
42
+ return new PermissionDeniedError(status, error, message, headers);
43
+ }
44
+ if (status === 404) {
45
+ return new NotFoundError(status, error, message, headers);
46
+ }
47
+ if (status === 409) {
48
+ return new ConflictError(status, error, message, headers);
49
+ }
50
+ if (status === 422) {
51
+ return new UnprocessableEntityError(status, error, message, headers);
52
+ }
53
+ if (status === 429) {
54
+ return new RateLimitError(status, error, message, headers);
55
+ }
56
+ if (status >= 500) {
57
+ return new InternalServerError(status, error, message, headers);
58
+ }
59
+ return new APIError(status, error, message, headers);
60
+ }
61
+ }
62
+ export class APIUserAbortError extends APIError {
63
+ constructor({ message } = {}) {
64
+ super(undefined, undefined, message || 'Request was aborted.', undefined);
65
+ }
66
+ }
67
+ export class APIConnectionError extends APIError {
68
+ constructor({ message, cause }) {
69
+ super(undefined, undefined, message || 'Connection error.', undefined);
70
+ // in some environments the 'cause' property is already declared
71
+ // @ts-ignore
72
+ if (cause)
73
+ this.cause = cause;
74
+ }
75
+ }
76
+ export class APIConnectionTimeoutError extends APIConnectionError {
77
+ constructor({ message } = {}) {
78
+ super({ message: message ?? 'Request timed out.' });
79
+ }
80
+ }
81
+ export class BadRequestError extends APIError {
82
+ }
83
+ export class AuthenticationError extends APIError {
84
+ }
85
+ export class PermissionDeniedError extends APIError {
86
+ }
87
+ export class NotFoundError extends APIError {
88
+ }
89
+ export class ConflictError extends APIError {
90
+ }
91
+ export class UnprocessableEntityError extends APIError {
92
+ }
93
+ export class RateLimitError extends APIError {
94
+ }
95
+ export class InternalServerError extends APIError {
96
+ }
97
+ //# sourceMappingURL=error.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"error.mjs","sourceRoot":"","sources":["../src/core/error.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAEtB,MAAM,OAAO,UAAW,SAAQ,KAAK;CAAG;AAExC,MAAM,OAAO,QAIX,SAAQ,UAAU;IAQlB,YAAY,MAAe,EAAE,KAAa,EAAE,OAA2B,EAAE,OAAiB;QACxF,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAA0B,EAAE,KAAU,EAAE,OAA2B;QAC5F,MAAM,GAAG,GACP,KAAK,EAAE,OAAO,CAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;gBACjC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC;QAEZ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,GAAG,MAAM,wBAAwB,CAAC;QAC3C,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,IAAI,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,KAAK,GAAG,aAAoC,CAAC;QAEnD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;YAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,QAAyC;IAC9E,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,QAAyC;IAC/E,YAAY,EAAE,OAAO,EAAE,KAAK,EAA+D;QACzF,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACvE,gEAAgE;QAChE,aAAa;QACb,IAAI,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,kBAAkB;IAC/D,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,QAAsB;CAAG;AAE9D,MAAM,OAAO,mBAAoB,SAAQ,QAAsB;CAAG;AAElE,MAAM,OAAO,qBAAsB,SAAQ,QAAsB;CAAG;AAEpE,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,wBAAyB,SAAQ,QAAsB;CAAG;AAEvE,MAAM,OAAO,cAAe,SAAQ,QAAsB;CAAG;AAE7D,MAAM,OAAO,mBAAoB,SAAQ,QAAyB;CAAG"}
@@ -0,0 +1,111 @@
1
+ import { FinalRequestOptions } from "../internal/request-options.mjs";
2
+ import { type Knock } from "../client.mjs";
3
+ import { APIPromise } from "./api-promise.mjs";
4
+ import { type APIResponseProps } from "../internal/parse.mjs";
5
+ export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
6
+ export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
7
+ #private;
8
+ protected options: FinalRequestOptions;
9
+ protected response: Response;
10
+ protected body: unknown;
11
+ constructor(client: Knock, response: Response, body: unknown, options: FinalRequestOptions);
12
+ abstract nextPageRequestOptions(): PageRequestOptions | null;
13
+ abstract getPaginatedItems(): Item[];
14
+ hasNextPage(): boolean;
15
+ getNextPage(): Promise<this>;
16
+ iterPages(): AsyncGenerator<this>;
17
+ [Symbol.asyncIterator](): AsyncGenerator<Item>;
18
+ }
19
+ /**
20
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
21
+ *
22
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
23
+ *
24
+ * for await (const item of client.items.list()) {
25
+ * console.log(item)
26
+ * }
27
+ */
28
+ export declare class PagePromise<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
29
+ constructor(client: Knock, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass);
30
+ /**
31
+ * Allow auto-paginating iteration on an unawaited list call, eg:
32
+ *
33
+ * for await (const item of client.items.list()) {
34
+ * console.log(item)
35
+ * }
36
+ */
37
+ [Symbol.asyncIterator](): AsyncGenerator<Awaited<Item>, void, unknown>;
38
+ }
39
+ export interface EntriesCursorResponse<Item> {
40
+ entries: Array<Item>;
41
+ page_info: EntriesCursorResponse.PageInfo;
42
+ }
43
+ export declare namespace EntriesCursorResponse {
44
+ interface PageInfo {
45
+ after?: string;
46
+ }
47
+ }
48
+ export interface EntriesCursorParams {
49
+ after?: string;
50
+ before?: string;
51
+ page_size?: number;
52
+ }
53
+ export declare class EntriesCursor<Item> extends AbstractPage<Item> implements EntriesCursorResponse<Item> {
54
+ entries: Array<Item>;
55
+ page_info: EntriesCursorResponse.PageInfo;
56
+ constructor(client: Knock, response: Response, body: EntriesCursorResponse<Item>, options: FinalRequestOptions);
57
+ getPaginatedItems(): Item[];
58
+ nextPageRequestOptions(): PageRequestOptions | null;
59
+ }
60
+ export interface ItemsCursorResponse<Item> {
61
+ items: Array<Item>;
62
+ page_info: ItemsCursorResponse.PageInfo;
63
+ }
64
+ export declare namespace ItemsCursorResponse {
65
+ interface PageInfo {
66
+ after?: string;
67
+ }
68
+ }
69
+ export interface ItemsCursorParams {
70
+ after?: string;
71
+ before?: string;
72
+ page_size?: number;
73
+ }
74
+ export declare class ItemsCursor<Item> extends AbstractPage<Item> implements ItemsCursorResponse<Item> {
75
+ items: Array<Item>;
76
+ page_info: ItemsCursorResponse.PageInfo;
77
+ constructor(client: Knock, response: Response, body: ItemsCursorResponse<Item>, options: FinalRequestOptions);
78
+ getPaginatedItems(): Item[];
79
+ nextPageRequestOptions(): PageRequestOptions | null;
80
+ }
81
+ export interface SlackChannelsCursorResponse<Item> {
82
+ next_cursor: string;
83
+ slack_channels: Array<Item>;
84
+ }
85
+ export interface SlackChannelsCursorParams {
86
+ 'query_options.cursor'?: string;
87
+ 'query_options.limit'?: number;
88
+ }
89
+ export declare class SlackChannelsCursor<Item> extends AbstractPage<Item> implements SlackChannelsCursorResponse<Item> {
90
+ next_cursor: string;
91
+ slack_channels: Array<Item>;
92
+ constructor(client: Knock, response: Response, body: SlackChannelsCursorResponse<Item>, options: FinalRequestOptions);
93
+ getPaginatedItems(): Item[];
94
+ nextPageRequestOptions(): PageRequestOptions | null;
95
+ }
96
+ export interface MsTeamsPaginationResponse<Item> {
97
+ skip_token: string;
98
+ ms_teams_teams: Array<Item>;
99
+ }
100
+ export interface MsTeamsPaginationParams {
101
+ 'query_options.$skiptoken'?: string;
102
+ 'query_options.$top'?: number;
103
+ }
104
+ export declare class MsTeamsPagination<Item> extends AbstractPage<Item> implements MsTeamsPaginationResponse<Item> {
105
+ skip_token: string;
106
+ ms_teams_teams: Array<Item>;
107
+ constructor(client: Knock, response: Response, body: MsTeamsPaginationResponse<Item>, options: FinalRequestOptions);
108
+ getPaginatedItems(): Item[];
109
+ nextPageRequestOptions(): PageRequestOptions | null;
110
+ }
111
+ //# sourceMappingURL=pagination.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pagination.d.mts","sourceRoot":"","sources":["../src/core/pagination.ts"],"names":[],"mappings":"OAGO,EAAE,mBAAmB,EAAE;OAEvB,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,gBAAgB,EAAE;AAGhC,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC;AAE7G,8BAAsB,YAAY,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;;IAErE,SAAS,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAEvC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC7B,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEZ,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB;IAO1F,QAAQ,CAAC,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;IAE5D,QAAQ,CAAC,iBAAiB,IAAI,IAAI,EAAE;IAEpC,WAAW,IAAI,OAAO;IAMhB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAW3B,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC;IASjC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;CAOtD;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAW,CACpB,SAAS,SAAS,YAAY,CAAC,IAAI,CAAC,EACpC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAE3D,SAAQ,UAAU,CAAC,SAAS,CAC5B,YAAW,aAAa,CAAC,IAAI,CAAC;gBAG5B,MAAM,EAAE,KAAK,EACb,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,YAAY,CAAC,KAAK,SAAS;IAU9E;;;;;;OAMG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC;CAM9B;AAED,MAAM,WAAW,qBAAqB,CAAC,IAAI;IACzC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,qBAAqB,CAAC,QAAQ,CAAC;CAC3C;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,aAAa,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,qBAAqB,CAAC,IAAI,CAAC;IAChG,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAErB,SAAS,EAAE,qBAAqB,CAAC,QAAQ,CAAC;gBAGxC,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EACjC,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAcpD;AAED,MAAM,WAAW,mBAAmB,CAAC,IAAI;IACvC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnB,SAAS,EAAE,mBAAmB,CAAC,QAAQ,CAAC;CACzC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,QAAQ;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,WAAW,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,mBAAmB,CAAC,IAAI,CAAC;IAC5F,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnB,SAAS,EAAE,mBAAmB,CAAC,QAAQ,CAAC;gBAGtC,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC,EAC/B,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAcpD;AAED,MAAM,WAAW,2BAA2B,CAAC,IAAI;IAC/C,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB;IACxC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,qBAAa,mBAAmB,CAAC,IAAI,CACnC,SAAQ,YAAY,CAAC,IAAI,CACzB,YAAW,2BAA2B,CAAC,IAAI,CAAC;IAE5C,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAG1B,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC,EACvC,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAcpD;AAED,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC7C,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,qBAAa,iBAAiB,CAAC,IAAI,CAAE,SAAQ,YAAY,CAAC,IAAI,CAAE,YAAW,yBAAyB,CAAC,IAAI,CAAC;IACxG,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAG1B,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC,EACrC,OAAO,EAAE,mBAAmB;IAQ9B,iBAAiB,IAAI,IAAI,EAAE;IAI3B,sBAAsB,IAAI,kBAAkB,GAAG,IAAI;CAcpD"}