postgrid-node 0.1.0-alpha.5 → 0.3.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 (907) hide show
  1. package/CHANGELOG.md +84 -0
  2. package/LICENSE +1 -1
  3. package/README.md +134 -103
  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 +191 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +191 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +492 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +488 -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 +1 -46
  55. package/error.d.ts.map +1 -1
  56. package/error.js +3 -110
  57. package/error.js.map +1 -1
  58. package/error.mjs +1 -96
  59. package/error.mjs.map +1 -1
  60. package/index.d.mts +6 -157
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +5 -156
  63. package/index.d.ts.map +1 -1
  64. package/index.js +12 -166
  65. package/index.js.map +1 -1
  66. package/index.mjs +5 -139
  67. package/index.mjs.map +1 -1
  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/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +1 -0
  111. package/internal/qs/formats.d.ts.map +1 -1
  112. package/internal/qs/formats.js +4 -2
  113. package/internal/qs/formats.js.map +1 -1
  114. package/internal/qs/formats.mjs +2 -1
  115. package/internal/qs/formats.mjs.map +1 -1
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts.map +1 -1
  119. package/internal/qs/stringify.d.mts +3 -0
  120. package/internal/qs/stringify.d.mts.map +1 -0
  121. package/internal/qs/stringify.d.ts.map +1 -1
  122. package/internal/qs/stringify.js +16 -19
  123. package/internal/qs/stringify.js.map +1 -1
  124. package/internal/qs/stringify.mjs +17 -19
  125. package/internal/qs/stringify.mjs.map +1 -1
  126. package/internal/qs/types.d.mts +57 -0
  127. package/internal/qs/types.d.mts.map +1 -0
  128. package/internal/qs/utils.d.mts +15 -0
  129. package/internal/qs/utils.d.mts.map +1 -0
  130. package/internal/qs/utils.d.ts +1 -0
  131. package/internal/qs/utils.d.ts.map +1 -1
  132. package/internal/qs/utils.js +22 -21
  133. package/internal/qs/utils.js.map +1 -1
  134. package/internal/qs/utils.mjs +12 -12
  135. package/internal/qs/utils.mjs.map +1 -1
  136. package/internal/request-options.d.mts +75 -0
  137. package/internal/request-options.d.mts.map +1 -0
  138. package/internal/request-options.d.ts +75 -0
  139. package/internal/request-options.d.ts.map +1 -0
  140. package/internal/request-options.js +14 -0
  141. package/internal/request-options.js.map +1 -0
  142. package/internal/request-options.mjs +10 -0
  143. package/internal/request-options.mjs.map +1 -0
  144. package/internal/shim-types.d.mts +17 -0
  145. package/internal/shim-types.d.mts.map +1 -0
  146. package/internal/shim-types.d.ts +17 -0
  147. package/internal/shim-types.d.ts.map +1 -0
  148. package/internal/shim-types.js +4 -0
  149. package/internal/shim-types.js.map +1 -0
  150. package/internal/shim-types.mjs +3 -0
  151. package/internal/shim-types.mjs.map +1 -0
  152. package/internal/shims.d.mts +20 -0
  153. package/internal/shims.d.mts.map +1 -0
  154. package/internal/shims.d.ts +20 -0
  155. package/internal/shims.d.ts.map +1 -0
  156. package/internal/shims.js +92 -0
  157. package/internal/shims.js.map +1 -0
  158. package/internal/shims.mjs +85 -0
  159. package/internal/shims.mjs.map +1 -0
  160. package/internal/to-file.d.mts +45 -0
  161. package/internal/to-file.d.mts.map +1 -0
  162. package/internal/to-file.d.ts +45 -0
  163. package/internal/to-file.d.ts.map +1 -0
  164. package/internal/to-file.js +91 -0
  165. package/internal/to-file.js.map +1 -0
  166. package/internal/to-file.mjs +88 -0
  167. package/internal/to-file.mjs.map +1 -0
  168. package/internal/tslib.js +81 -0
  169. package/internal/tslib.mjs +17 -0
  170. package/internal/types.d.mts +69 -0
  171. package/internal/types.d.mts.map +1 -0
  172. package/internal/types.d.ts +69 -0
  173. package/internal/types.d.ts.map +1 -0
  174. package/internal/types.js +4 -0
  175. package/internal/types.js.map +1 -0
  176. package/internal/types.mjs +3 -0
  177. package/internal/types.mjs.map +1 -0
  178. package/internal/uploads.d.mts +42 -0
  179. package/internal/uploads.d.mts.map +1 -0
  180. package/internal/uploads.d.ts +42 -0
  181. package/internal/uploads.d.ts.map +1 -0
  182. package/internal/uploads.js +141 -0
  183. package/internal/uploads.js.map +1 -0
  184. package/internal/uploads.mjs +131 -0
  185. package/internal/uploads.mjs.map +1 -0
  186. package/internal/utils/base64.d.mts +3 -0
  187. package/internal/utils/base64.d.mts.map +1 -0
  188. package/internal/utils/base64.d.ts +3 -0
  189. package/internal/utils/base64.d.ts.map +1 -0
  190. package/internal/utils/base64.js +38 -0
  191. package/internal/utils/base64.js.map +1 -0
  192. package/internal/utils/base64.mjs +33 -0
  193. package/internal/utils/base64.mjs.map +1 -0
  194. package/internal/utils/bytes.d.mts +4 -0
  195. package/internal/utils/bytes.d.mts.map +1 -0
  196. package/internal/utils/bytes.d.ts +4 -0
  197. package/internal/utils/bytes.d.ts.map +1 -0
  198. package/internal/utils/bytes.js +31 -0
  199. package/internal/utils/bytes.js.map +1 -0
  200. package/internal/utils/bytes.mjs +26 -0
  201. package/internal/utils/bytes.mjs.map +1 -0
  202. package/internal/utils/env.d.mts +9 -0
  203. package/internal/utils/env.d.mts.map +1 -0
  204. package/internal/utils/env.d.ts +9 -0
  205. package/internal/utils/env.d.ts.map +1 -0
  206. package/internal/utils/env.js +22 -0
  207. package/internal/utils/env.js.map +1 -0
  208. package/internal/utils/env.mjs +18 -0
  209. package/internal/utils/env.mjs.map +1 -0
  210. package/internal/utils/log.d.mts +37 -0
  211. package/internal/utils/log.d.mts.map +1 -0
  212. package/internal/utils/log.d.ts +37 -0
  213. package/internal/utils/log.d.ts.map +1 -0
  214. package/internal/utils/log.js +86 -0
  215. package/internal/utils/log.js.map +1 -0
  216. package/internal/utils/log.mjs +80 -0
  217. package/internal/utils/log.mjs.map +1 -0
  218. package/internal/utils/path.d.mts +15 -0
  219. package/internal/utils/path.d.mts.map +1 -0
  220. package/internal/utils/path.d.ts +15 -0
  221. package/internal/utils/path.d.ts.map +1 -0
  222. package/internal/utils/path.js +79 -0
  223. package/internal/utils/path.js.map +1 -0
  224. package/internal/utils/path.mjs +74 -0
  225. package/internal/utils/path.mjs.map +1 -0
  226. package/internal/utils/sleep.d.mts +2 -0
  227. package/internal/utils/sleep.d.mts.map +1 -0
  228. package/internal/utils/sleep.d.ts +2 -0
  229. package/internal/utils/sleep.d.ts.map +1 -0
  230. package/internal/utils/sleep.js +7 -0
  231. package/internal/utils/sleep.js.map +1 -0
  232. package/internal/utils/sleep.mjs +3 -0
  233. package/internal/utils/sleep.mjs.map +1 -0
  234. package/internal/utils/uuid.d.mts +5 -0
  235. package/internal/utils/uuid.d.mts.map +1 -0
  236. package/internal/utils/uuid.d.ts +5 -0
  237. package/internal/utils/uuid.d.ts.map +1 -0
  238. package/internal/utils/uuid.js +19 -0
  239. package/internal/utils/uuid.js.map +1 -0
  240. package/internal/utils/uuid.mjs +15 -0
  241. package/internal/utils/uuid.mjs.map +1 -0
  242. package/internal/utils/values.d.mts +18 -0
  243. package/internal/utils/values.d.mts.map +1 -0
  244. package/internal/utils/values.d.ts +18 -0
  245. package/internal/utils/values.d.ts.map +1 -0
  246. package/internal/utils/values.js +112 -0
  247. package/internal/utils/values.js.map +1 -0
  248. package/internal/utils/values.mjs +94 -0
  249. package/internal/utils/values.mjs.map +1 -0
  250. package/internal/utils.d.mts +7 -0
  251. package/internal/utils.d.mts.map +1 -0
  252. package/internal/utils.d.ts +7 -0
  253. package/internal/utils.d.ts.map +1 -0
  254. package/internal/utils.js +11 -0
  255. package/internal/utils.js.map +1 -0
  256. package/internal/utils.mjs +8 -0
  257. package/internal/utils.mjs.map +1 -0
  258. package/package.json +110 -75
  259. package/resource.d.mts +2 -0
  260. package/resource.d.mts.map +1 -0
  261. package/resource.d.ts +1 -5
  262. package/resource.d.ts.map +1 -1
  263. package/resource.js +3 -8
  264. package/resource.js.map +1 -1
  265. package/resource.mjs +1 -6
  266. package/resource.mjs.map +1 -1
  267. package/resources/address-verification.d.mts +425 -0
  268. package/resources/address-verification.d.mts.map +1 -0
  269. package/resources/address-verification.d.ts +425 -0
  270. package/resources/address-verification.d.ts.map +1 -0
  271. package/resources/address-verification.js +36 -0
  272. package/resources/address-verification.js.map +1 -0
  273. package/resources/address-verification.mjs +32 -0
  274. package/resources/address-verification.mjs.map +1 -0
  275. package/resources/index.d.mts +4 -0
  276. package/resources/index.d.mts.map +1 -0
  277. package/resources/index.d.ts +3 -15
  278. package/resources/index.d.ts.map +1 -1
  279. package/resources/index.js +7 -57
  280. package/resources/index.js.map +1 -1
  281. package/resources/index.mjs +3 -15
  282. package/resources/index.mjs.map +1 -1
  283. package/resources/intl-address-verification.d.mts +406 -0
  284. package/resources/intl-address-verification.d.mts.map +1 -0
  285. package/resources/intl-address-verification.d.ts +406 -0
  286. package/resources/intl-address-verification.d.ts.map +1 -0
  287. package/resources/intl-address-verification.js +59 -0
  288. package/resources/intl-address-verification.js.map +1 -0
  289. package/resources/intl-address-verification.mjs +55 -0
  290. package/resources/intl-address-verification.mjs.map +1 -0
  291. package/resources/print-mail/bank-accounts.d.mts +345 -0
  292. package/resources/print-mail/bank-accounts.d.mts.map +1 -0
  293. package/resources/print-mail/bank-accounts.d.ts +345 -0
  294. package/resources/print-mail/bank-accounts.d.ts.map +1 -0
  295. package/resources/print-mail/bank-accounts.js +72 -0
  296. package/resources/print-mail/bank-accounts.js.map +1 -0
  297. package/resources/print-mail/bank-accounts.mjs +68 -0
  298. package/resources/print-mail/bank-accounts.mjs.map +1 -0
  299. package/resources/print-mail/boxes.d.mts +873 -0
  300. package/resources/print-mail/boxes.d.mts.map +1 -0
  301. package/resources/print-mail/boxes.d.ts +873 -0
  302. package/resources/print-mail/boxes.d.ts.map +1 -0
  303. package/resources/print-mail/boxes.js +81 -0
  304. package/resources/print-mail/boxes.js.map +1 -0
  305. package/resources/print-mail/boxes.mjs +77 -0
  306. package/resources/print-mail/boxes.mjs.map +1 -0
  307. package/resources/print-mail/campaigns.d.mts +317 -0
  308. package/resources/print-mail/campaigns.d.mts.map +1 -0
  309. package/resources/print-mail/campaigns.d.ts +317 -0
  310. package/resources/print-mail/campaigns.d.ts.map +1 -0
  311. package/resources/print-mail/campaigns.js +114 -0
  312. package/resources/print-mail/campaigns.js.map +1 -0
  313. package/resources/print-mail/campaigns.mjs +110 -0
  314. package/resources/print-mail/campaigns.mjs.map +1 -0
  315. package/resources/print-mail/cheques.d.mts +817 -0
  316. package/resources/print-mail/cheques.d.mts.map +1 -0
  317. package/resources/print-mail/cheques.d.ts +817 -0
  318. package/resources/print-mail/cheques.d.ts.map +1 -0
  319. package/resources/print-mail/cheques.js +121 -0
  320. package/resources/print-mail/cheques.js.map +1 -0
  321. package/resources/print-mail/cheques.mjs +117 -0
  322. package/resources/print-mail/cheques.mjs.map +1 -0
  323. package/resources/print-mail/contacts.d.mts +475 -0
  324. package/resources/print-mail/contacts.d.mts.map +1 -0
  325. package/resources/print-mail/contacts.d.ts +475 -0
  326. package/resources/print-mail/contacts.d.ts.map +1 -0
  327. package/resources/print-mail/contacts.js +76 -0
  328. package/resources/print-mail/contacts.js.map +1 -0
  329. package/resources/print-mail/contacts.mjs +72 -0
  330. package/resources/print-mail/contacts.mjs.map +1 -0
  331. package/resources/print-mail/index.d.mts +16 -0
  332. package/resources/print-mail/index.d.mts.map +1 -0
  333. package/resources/print-mail/index.d.ts +16 -0
  334. package/resources/print-mail/index.d.ts.map +1 -0
  335. package/resources/print-mail/index.js +35 -0
  336. package/resources/print-mail/index.js.map +1 -0
  337. package/resources/print-mail/index.mjs +17 -0
  338. package/resources/print-mail/index.mjs.map +1 -0
  339. package/resources/print-mail/letters.d.mts +1079 -0
  340. package/resources/print-mail/letters.d.mts.map +1 -0
  341. package/resources/print-mail/letters.d.ts +1079 -0
  342. package/resources/print-mail/letters.d.ts.map +1 -0
  343. package/resources/print-mail/letters.js +83 -0
  344. package/resources/print-mail/letters.js.map +1 -0
  345. package/resources/print-mail/letters.mjs +79 -0
  346. package/resources/print-mail/letters.mjs.map +1 -0
  347. package/resources/print-mail/mailing-list-imports.d.mts +354 -0
  348. package/resources/print-mail/mailing-list-imports.d.mts.map +1 -0
  349. package/resources/print-mail/mailing-list-imports.d.ts +354 -0
  350. package/resources/print-mail/mailing-list-imports.d.ts.map +1 -0
  351. package/resources/print-mail/mailing-list-imports.js +105 -0
  352. package/resources/print-mail/mailing-list-imports.js.map +1 -0
  353. package/resources/print-mail/mailing-list-imports.mjs +101 -0
  354. package/resources/print-mail/mailing-list-imports.mjs.map +1 -0
  355. package/resources/print-mail/mailing-lists.d.mts +247 -0
  356. package/resources/print-mail/mailing-lists.d.mts.map +1 -0
  357. package/resources/print-mail/mailing-lists.d.ts +247 -0
  358. package/resources/print-mail/mailing-lists.d.ts.map +1 -0
  359. package/resources/print-mail/mailing-lists.js +117 -0
  360. package/resources/print-mail/mailing-lists.js.map +1 -0
  361. package/resources/print-mail/mailing-lists.mjs +113 -0
  362. package/resources/print-mail/mailing-lists.mjs.map +1 -0
  363. package/resources/print-mail/order-profiles/cheques.d.mts +398 -0
  364. package/resources/print-mail/order-profiles/cheques.d.mts.map +1 -0
  365. package/resources/print-mail/order-profiles/cheques.d.ts +398 -0
  366. package/resources/print-mail/order-profiles/cheques.d.ts.map +1 -0
  367. package/resources/print-mail/order-profiles/cheques.js +92 -0
  368. package/resources/print-mail/order-profiles/cheques.js.map +1 -0
  369. package/resources/print-mail/order-profiles/cheques.mjs +88 -0
  370. package/resources/print-mail/order-profiles/cheques.mjs.map +1 -0
  371. package/resources/print-mail/order-profiles/index.d.mts +6 -0
  372. package/resources/print-mail/order-profiles/index.d.mts.map +1 -0
  373. package/resources/print-mail/order-profiles/index.d.ts +6 -0
  374. package/resources/print-mail/order-profiles/index.d.ts.map +1 -0
  375. package/resources/print-mail/order-profiles/index.js +15 -0
  376. package/resources/print-mail/order-profiles/index.js.map +1 -0
  377. package/resources/print-mail/order-profiles/index.mjs +7 -0
  378. package/resources/print-mail/order-profiles/index.mjs.map +1 -0
  379. package/resources/print-mail/order-profiles/letters.d.mts +333 -0
  380. package/resources/print-mail/order-profiles/letters.d.mts.map +1 -0
  381. package/resources/print-mail/order-profiles/letters.d.ts +333 -0
  382. package/resources/print-mail/order-profiles/letters.d.ts.map +1 -0
  383. package/resources/print-mail/order-profiles/letters.js +99 -0
  384. package/resources/print-mail/order-profiles/letters.js.map +1 -0
  385. package/resources/print-mail/order-profiles/letters.mjs +95 -0
  386. package/resources/print-mail/order-profiles/letters.mjs.map +1 -0
  387. package/resources/print-mail/order-profiles/order-profiles.d.mts +22 -0
  388. package/resources/print-mail/order-profiles/order-profiles.d.mts.map +1 -0
  389. package/resources/print-mail/order-profiles/order-profiles.d.ts +22 -0
  390. package/resources/print-mail/order-profiles/order-profiles.d.ts.map +1 -0
  391. package/resources/print-mail/order-profiles/order-profiles.js +29 -0
  392. package/resources/print-mail/order-profiles/order-profiles.js.map +1 -0
  393. package/resources/print-mail/order-profiles/order-profiles.mjs +24 -0
  394. package/resources/print-mail/order-profiles/order-profiles.mjs.map +1 -0
  395. package/resources/print-mail/order-profiles/postcards.d.mts +263 -0
  396. package/resources/print-mail/order-profiles/postcards.d.mts.map +1 -0
  397. package/resources/print-mail/order-profiles/postcards.d.ts +263 -0
  398. package/resources/print-mail/order-profiles/postcards.d.ts.map +1 -0
  399. package/resources/print-mail/order-profiles/postcards.js +91 -0
  400. package/resources/print-mail/order-profiles/postcards.js.map +1 -0
  401. package/resources/print-mail/order-profiles/postcards.mjs +87 -0
  402. package/resources/print-mail/order-profiles/postcards.mjs.map +1 -0
  403. package/resources/print-mail/order-profiles/self-mailers.d.mts +268 -0
  404. package/resources/print-mail/order-profiles/self-mailers.d.mts.map +1 -0
  405. package/resources/print-mail/order-profiles/self-mailers.d.ts +268 -0
  406. package/resources/print-mail/order-profiles/self-mailers.d.ts.map +1 -0
  407. package/resources/print-mail/order-profiles/self-mailers.js +92 -0
  408. package/resources/print-mail/order-profiles/self-mailers.js.map +1 -0
  409. package/resources/print-mail/order-profiles/self-mailers.mjs +88 -0
  410. package/resources/print-mail/order-profiles/self-mailers.mjs.map +1 -0
  411. package/resources/print-mail/order-profiles.d.mts +2 -0
  412. package/resources/print-mail/order-profiles.d.mts.map +1 -0
  413. package/resources/print-mail/order-profiles.d.ts.map +1 -0
  414. package/resources/print-mail/order-profiles.js +6 -0
  415. package/resources/print-mail/order-profiles.js.map +1 -0
  416. package/resources/print-mail/order-profiles.mjs.map +1 -0
  417. package/resources/print-mail/postcards.d.mts +1220 -0
  418. package/resources/print-mail/postcards.d.mts.map +1 -0
  419. package/resources/print-mail/postcards.d.ts +1220 -0
  420. package/resources/print-mail/postcards.d.ts.map +1 -0
  421. package/resources/print-mail/postcards.js +87 -0
  422. package/resources/print-mail/postcards.js.map +1 -0
  423. package/resources/print-mail/postcards.mjs +83 -0
  424. package/resources/print-mail/postcards.mjs.map +1 -0
  425. package/resources/print-mail/print-mail.d.mts +62 -0
  426. package/resources/print-mail/print-mail.d.mts.map +1 -0
  427. package/resources/print-mail/print-mail.d.ts +62 -0
  428. package/resources/print-mail/print-mail.d.ts.map +1 -0
  429. package/resources/print-mail/print-mail.js +69 -0
  430. package/resources/print-mail/print-mail.js.map +1 -0
  431. package/resources/print-mail/print-mail.mjs +64 -0
  432. package/resources/print-mail/print-mail.mjs.map +1 -0
  433. package/resources/print-mail/reports/exports.d.mts +165 -0
  434. package/resources/print-mail/reports/exports.d.mts.map +1 -0
  435. package/resources/print-mail/reports/exports.d.ts +165 -0
  436. package/resources/print-mail/reports/exports.d.ts.map +1 -0
  437. package/resources/print-mail/reports/exports.js +66 -0
  438. package/resources/print-mail/reports/exports.js.map +1 -0
  439. package/resources/print-mail/reports/exports.mjs +62 -0
  440. package/resources/print-mail/reports/exports.mjs.map +1 -0
  441. package/resources/print-mail/reports/index.d.mts +4 -0
  442. package/resources/print-mail/reports/index.d.mts.map +1 -0
  443. package/resources/print-mail/reports/index.d.ts +4 -0
  444. package/resources/print-mail/reports/index.d.ts.map +1 -0
  445. package/resources/print-mail/reports/index.js +11 -0
  446. package/resources/print-mail/reports/index.js.map +1 -0
  447. package/resources/print-mail/reports/index.mjs +5 -0
  448. package/resources/print-mail/reports/index.mjs.map +1 -0
  449. package/resources/print-mail/reports/reports.d.mts +214 -0
  450. package/resources/print-mail/reports/reports.d.mts.map +1 -0
  451. package/resources/print-mail/reports/reports.d.ts +214 -0
  452. package/resources/print-mail/reports/reports.d.ts.map +1 -0
  453. package/resources/print-mail/reports/reports.js +110 -0
  454. package/resources/print-mail/reports/reports.js.map +1 -0
  455. package/resources/print-mail/reports/reports.mjs +105 -0
  456. package/resources/print-mail/reports/reports.mjs.map +1 -0
  457. package/resources/print-mail/reports/samples.d.mts +69 -0
  458. package/resources/print-mail/reports/samples.d.mts.map +1 -0
  459. package/resources/print-mail/reports/samples.d.ts +69 -0
  460. package/resources/print-mail/reports/samples.d.ts.map +1 -0
  461. package/resources/print-mail/reports/samples.js +28 -0
  462. package/resources/print-mail/reports/samples.js.map +1 -0
  463. package/resources/print-mail/reports/samples.mjs +24 -0
  464. package/resources/print-mail/reports/samples.mjs.map +1 -0
  465. package/resources/print-mail/reports.d.mts +2 -0
  466. package/resources/print-mail/reports.d.mts.map +1 -0
  467. package/resources/print-mail/reports.d.ts.map +1 -0
  468. package/resources/print-mail/reports.js +6 -0
  469. package/resources/print-mail/reports.js.map +1 -0
  470. package/resources/print-mail/reports.mjs.map +1 -0
  471. package/resources/print-mail/self-mailers.d.mts +1218 -0
  472. package/resources/print-mail/self-mailers.d.mts.map +1 -0
  473. package/resources/print-mail/self-mailers.d.ts +1218 -0
  474. package/resources/print-mail/self-mailers.d.ts.map +1 -0
  475. package/resources/print-mail/self-mailers.js +87 -0
  476. package/resources/print-mail/self-mailers.js.map +1 -0
  477. package/resources/print-mail/self-mailers.mjs +83 -0
  478. package/resources/print-mail/self-mailers.mjs.map +1 -0
  479. package/resources/print-mail/sub-organizations.d.mts +304 -0
  480. package/resources/print-mail/sub-organizations.d.mts.map +1 -0
  481. package/resources/print-mail/sub-organizations.d.ts +304 -0
  482. package/resources/print-mail/sub-organizations.d.ts.map +1 -0
  483. package/resources/print-mail/sub-organizations.js +69 -0
  484. package/resources/print-mail/sub-organizations.js.map +1 -0
  485. package/resources/print-mail/sub-organizations.mjs +65 -0
  486. package/resources/print-mail/sub-organizations.mjs.map +1 -0
  487. package/resources/print-mail/templates.d.mts +169 -0
  488. package/resources/print-mail/templates.d.mts.map +1 -0
  489. package/resources/print-mail/templates.d.ts +169 -0
  490. package/resources/print-mail/templates.d.ts.map +1 -0
  491. package/resources/print-mail/templates.js +79 -0
  492. package/resources/print-mail/templates.js.map +1 -0
  493. package/resources/print-mail/templates.mjs +75 -0
  494. package/resources/print-mail/templates.mjs.map +1 -0
  495. package/resources/print-mail.d.mts +2 -0
  496. package/resources/print-mail.d.mts.map +1 -0
  497. package/resources/print-mail.d.ts +2 -0
  498. package/resources/print-mail.d.ts.map +1 -0
  499. package/resources/print-mail.js +6 -0
  500. package/resources/print-mail.js.map +1 -0
  501. package/resources/print-mail.mjs +3 -0
  502. package/resources/print-mail.mjs.map +1 -0
  503. package/resources.d.mts +2 -0
  504. package/resources.d.mts.map +1 -0
  505. package/resources.d.ts.map +1 -1
  506. package/resources.js +2 -15
  507. package/resources.js.map +1 -1
  508. package/src/api-promise.ts +2 -0
  509. package/src/client.ts +793 -0
  510. package/src/core/README.md +3 -0
  511. package/src/core/api-promise.ts +92 -0
  512. package/src/core/error.ts +130 -0
  513. package/src/core/resource.ts +11 -0
  514. package/src/core/uploads.ts +2 -0
  515. package/src/error.ts +2 -130
  516. package/src/index.ts +5 -520
  517. package/src/internal/README.md +3 -0
  518. package/src/internal/builtin-types.ts +93 -0
  519. package/src/internal/detect-platform.ts +196 -0
  520. package/src/internal/errors.ts +33 -0
  521. package/src/internal/headers.ts +97 -0
  522. package/src/internal/parse.ts +50 -0
  523. package/src/internal/qs/formats.ts +2 -1
  524. package/src/internal/qs/stringify.ts +17 -20
  525. package/src/internal/qs/utils.ts +14 -14
  526. package/src/internal/request-options.ts +91 -0
  527. package/src/internal/shim-types.ts +26 -0
  528. package/src/internal/shims.ts +107 -0
  529. package/src/internal/to-file.ts +154 -0
  530. package/src/internal/types.ts +95 -0
  531. package/src/internal/uploads.ts +187 -0
  532. package/src/internal/utils/base64.ts +40 -0
  533. package/src/internal/utils/bytes.ts +32 -0
  534. package/src/internal/utils/env.ts +18 -0
  535. package/src/internal/utils/log.ts +127 -0
  536. package/src/internal/utils/path.ts +88 -0
  537. package/src/internal/utils/sleep.ts +3 -0
  538. package/src/internal/utils/uuid.ts +17 -0
  539. package/src/internal/utils/values.ts +105 -0
  540. package/src/internal/utils.ts +8 -0
  541. package/src/resource.ts +2 -11
  542. package/src/resources/address-verification.ts +542 -0
  543. package/src/resources/index.ts +12 -142
  544. package/src/resources/intl-address-verification.ts +505 -0
  545. package/src/resources/print-mail/bank-accounts.ts +432 -0
  546. package/src/resources/print-mail/boxes.ts +1079 -0
  547. package/src/resources/print-mail/campaigns.ts +408 -0
  548. package/src/resources/print-mail/cheques.ts +995 -0
  549. package/src/resources/print-mail/contacts.ts +594 -0
  550. package/src/resources/print-mail/index.ts +134 -0
  551. package/src/resources/print-mail/letters.ts +1319 -0
  552. package/src/resources/print-mail/mailing-list-imports.ts +433 -0
  553. package/src/resources/print-mail/mailing-lists.ts +316 -0
  554. package/src/resources/print-mail/order-profiles/cheques.ts +498 -0
  555. package/src/resources/print-mail/order-profiles/index.ts +46 -0
  556. package/src/resources/print-mail/order-profiles/letters.ts +423 -0
  557. package/src/resources/print-mail/order-profiles/order-profiles.ts +111 -0
  558. package/src/resources/print-mail/order-profiles/postcards.ts +338 -0
  559. package/src/resources/print-mail/order-profiles/self-mailers.ts +348 -0
  560. package/src/resources/print-mail/postcards.ts +1483 -0
  561. package/src/resources/print-mail/print-mail.ts +331 -0
  562. package/src/resources/print-mail/reports/exports.ts +209 -0
  563. package/src/resources/print-mail/reports/index.ts +20 -0
  564. package/src/resources/print-mail/reports/reports.ts +290 -0
  565. package/src/resources/print-mail/reports/samples.ts +84 -0
  566. package/src/resources/print-mail/self-mailers.ts +1481 -0
  567. package/src/resources/print-mail/sub-organizations.ts +394 -0
  568. package/src/resources/print-mail/templates.ts +216 -0
  569. package/src/resources/print-mail.ts +3 -0
  570. package/src/tsconfig.json +2 -2
  571. package/src/uploads.ts +2 -255
  572. package/src/version.ts +1 -1
  573. package/uploads.d.mts +2 -0
  574. package/uploads.d.mts.map +1 -0
  575. package/uploads.d.ts +1 -74
  576. package/uploads.d.ts.map +1 -1
  577. package/uploads.js +3 -168
  578. package/uploads.js.map +1 -1
  579. package/uploads.mjs +1 -157
  580. package/uploads.mjs.map +1 -1
  581. package/version.d.mts +2 -0
  582. package/version.d.mts.map +1 -0
  583. package/version.d.ts +1 -1
  584. package/version.d.ts.map +1 -1
  585. package/version.js +1 -1
  586. package/version.js.map +1 -1
  587. package/version.mjs +1 -1
  588. package/version.mjs.map +1 -1
  589. package/_shims/MultipartBody.d.ts +0 -9
  590. package/_shims/MultipartBody.d.ts.map +0 -1
  591. package/_shims/MultipartBody.js +0 -16
  592. package/_shims/MultipartBody.js.map +0 -1
  593. package/_shims/MultipartBody.mjs +0 -12
  594. package/_shims/MultipartBody.mjs.map +0 -1
  595. package/_shims/README.md +0 -46
  596. package/_shims/auto/runtime-bun.d.ts +0 -5
  597. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  598. package/_shims/auto/runtime-bun.js +0 -21
  599. package/_shims/auto/runtime-bun.js.map +0 -1
  600. package/_shims/auto/runtime-bun.mjs +0 -2
  601. package/_shims/auto/runtime-bun.mjs.map +0 -1
  602. package/_shims/auto/runtime-node.d.ts +0 -5
  603. package/_shims/auto/runtime-node.d.ts.map +0 -1
  604. package/_shims/auto/runtime-node.js +0 -21
  605. package/_shims/auto/runtime-node.js.map +0 -1
  606. package/_shims/auto/runtime-node.mjs +0 -2
  607. package/_shims/auto/runtime-node.mjs.map +0 -1
  608. package/_shims/auto/runtime.d.ts +0 -5
  609. package/_shims/auto/runtime.d.ts.map +0 -1
  610. package/_shims/auto/runtime.js +0 -21
  611. package/_shims/auto/runtime.js.map +0 -1
  612. package/_shims/auto/runtime.mjs +0 -2
  613. package/_shims/auto/runtime.mjs.map +0 -1
  614. package/_shims/auto/types-node.d.ts +0 -5
  615. package/_shims/auto/types-node.d.ts.map +0 -1
  616. package/_shims/auto/types-node.js +0 -21
  617. package/_shims/auto/types-node.js.map +0 -1
  618. package/_shims/auto/types-node.mjs +0 -2
  619. package/_shims/auto/types-node.mjs.map +0 -1
  620. package/_shims/auto/types.d.ts +0 -101
  621. package/_shims/auto/types.js +0 -3
  622. package/_shims/auto/types.mjs +0 -3
  623. package/_shims/bun-runtime.d.ts +0 -6
  624. package/_shims/bun-runtime.d.ts.map +0 -1
  625. package/_shims/bun-runtime.js +0 -14
  626. package/_shims/bun-runtime.js.map +0 -1
  627. package/_shims/bun-runtime.mjs +0 -10
  628. package/_shims/bun-runtime.mjs.map +0 -1
  629. package/_shims/index.d.ts +0 -83
  630. package/_shims/index.js +0 -17
  631. package/_shims/index.mjs +0 -11
  632. package/_shims/manual-types.d.ts +0 -12
  633. package/_shims/manual-types.js +0 -3
  634. package/_shims/manual-types.mjs +0 -3
  635. package/_shims/node-runtime.d.ts +0 -3
  636. package/_shims/node-runtime.d.ts.map +0 -1
  637. package/_shims/node-runtime.js +0 -89
  638. package/_shims/node-runtime.js.map +0 -1
  639. package/_shims/node-runtime.mjs +0 -56
  640. package/_shims/node-runtime.mjs.map +0 -1
  641. package/_shims/node-types.d.ts +0 -42
  642. package/_shims/node-types.js +0 -3
  643. package/_shims/node-types.mjs +0 -3
  644. package/_shims/registry.d.ts +0 -37
  645. package/_shims/registry.d.ts.map +0 -1
  646. package/_shims/registry.js +0 -41
  647. package/_shims/registry.js.map +0 -1
  648. package/_shims/registry.mjs +0 -37
  649. package/_shims/registry.mjs.map +0 -1
  650. package/_shims/web-runtime.d.ts +0 -5
  651. package/_shims/web-runtime.d.ts.map +0 -1
  652. package/_shims/web-runtime.js +0 -78
  653. package/_shims/web-runtime.js.map +0 -1
  654. package/_shims/web-runtime.mjs +0 -71
  655. package/_shims/web-runtime.mjs.map +0 -1
  656. package/_shims/web-types.d.ts +0 -83
  657. package/_shims/web-types.js +0 -3
  658. package/_shims/web-types.mjs +0 -3
  659. package/core.d.ts +0 -255
  660. package/core.d.ts.map +0 -1
  661. package/core.js +0 -924
  662. package/core.js.map +0 -1
  663. package/core.mjs +0 -892
  664. package/core.mjs.map +0 -1
  665. package/pagination.d.ts +0 -26
  666. package/pagination.d.ts.map +0 -1
  667. package/pagination.js +0 -46
  668. package/pagination.js.map +0 -1
  669. package/pagination.mjs +0 -42
  670. package/pagination.mjs.map +0 -1
  671. package/resources/bank-accounts.d.ts +0 -342
  672. package/resources/bank-accounts.d.ts.map +0 -1
  673. package/resources/bank-accounts.js +0 -70
  674. package/resources/bank-accounts.js.map +0 -1
  675. package/resources/bank-accounts.mjs +0 -65
  676. package/resources/bank-accounts.mjs.map +0 -1
  677. package/resources/boxes.d.ts +0 -748
  678. package/resources/boxes.d.ts.map +0 -1
  679. package/resources/boxes.js +0 -81
  680. package/resources/boxes.js.map +0 -1
  681. package/resources/boxes.mjs +0 -76
  682. package/resources/boxes.mjs.map +0 -1
  683. package/resources/campaigns.d.ts +0 -658
  684. package/resources/campaigns.d.ts.map +0 -1
  685. package/resources/campaigns.js +0 -67
  686. package/resources/campaigns.js.map +0 -1
  687. package/resources/campaigns.mjs +0 -62
  688. package/resources/campaigns.mjs.map +0 -1
  689. package/resources/cheques/cheques.d.ts +0 -388
  690. package/resources/cheques/cheques.d.ts.map +0 -1
  691. package/resources/cheques/cheques.js +0 -118
  692. package/resources/cheques/cheques.js.map +0 -1
  693. package/resources/cheques/cheques.mjs +0 -90
  694. package/resources/cheques/cheques.mjs.map +0 -1
  695. package/resources/cheques/index.d.ts +0 -4
  696. package/resources/cheques/index.d.ts.map +0 -1
  697. package/resources/cheques/index.js +0 -12
  698. package/resources/cheques/index.js.map +0 -1
  699. package/resources/cheques/index.mjs +0 -5
  700. package/resources/cheques/index.mjs.map +0 -1
  701. package/resources/cheques/url.d.ts +0 -34
  702. package/resources/cheques/url.d.ts.map +0 -1
  703. package/resources/cheques/url.js +0 -25
  704. package/resources/cheques/url.js.map +0 -1
  705. package/resources/cheques/url.mjs +0 -21
  706. package/resources/cheques/url.mjs.map +0 -1
  707. package/resources/cheques/with-deposit-ready-pdf.d.ts +0 -19
  708. package/resources/cheques/with-deposit-ready-pdf.d.ts.map +0 -1
  709. package/resources/cheques/with-deposit-ready-pdf.js +0 -24
  710. package/resources/cheques/with-deposit-ready-pdf.js.map +0 -1
  711. package/resources/cheques/with-deposit-ready-pdf.mjs +0 -20
  712. package/resources/cheques/with-deposit-ready-pdf.mjs.map +0 -1
  713. package/resources/cheques.d.ts +0 -2
  714. package/resources/cheques.d.ts.map +0 -1
  715. package/resources/cheques.js +0 -19
  716. package/resources/cheques.js.map +0 -1
  717. package/resources/cheques.mjs +0 -3
  718. package/resources/cheques.mjs.map +0 -1
  719. package/resources/contacts.d.ts +0 -329
  720. package/resources/contacts.d.ts.map +0 -1
  721. package/resources/contacts.js +0 -72
  722. package/resources/contacts.js.map +0 -1
  723. package/resources/contacts.mjs +0 -67
  724. package/resources/contacts.mjs.map +0 -1
  725. package/resources/letters.d.ts +0 -683
  726. package/resources/letters.d.ts.map +0 -1
  727. package/resources/letters.js +0 -79
  728. package/resources/letters.js.map +0 -1
  729. package/resources/letters.mjs +0 -74
  730. package/resources/letters.mjs.map +0 -1
  731. package/resources/mailing-list-imports.d.ts +0 -919
  732. package/resources/mailing-list-imports.d.ts.map +0 -1
  733. package/resources/mailing-list-imports.js +0 -95
  734. package/resources/mailing-list-imports.js.map +0 -1
  735. package/resources/mailing-list-imports.mjs +0 -90
  736. package/resources/mailing-list-imports.mjs.map +0 -1
  737. package/resources/mailing-lists.d.ts +0 -398
  738. package/resources/mailing-lists.d.ts.map +0 -1
  739. package/resources/mailing-lists.js +0 -101
  740. package/resources/mailing-lists.js.map +0 -1
  741. package/resources/mailing-lists.mjs +0 -96
  742. package/resources/mailing-lists.mjs.map +0 -1
  743. package/resources/order-profiles/cheques.d.ts +0 -588
  744. package/resources/order-profiles/cheques.d.ts.map +0 -1
  745. package/resources/order-profiles/cheques.js +0 -74
  746. package/resources/order-profiles/cheques.js.map +0 -1
  747. package/resources/order-profiles/cheques.mjs +0 -69
  748. package/resources/order-profiles/cheques.mjs.map +0 -1
  749. package/resources/order-profiles/index.d.ts +0 -6
  750. package/resources/order-profiles/index.d.ts.map +0 -1
  751. package/resources/order-profiles/index.js +0 -19
  752. package/resources/order-profiles/index.js.map +0 -1
  753. package/resources/order-profiles/index.mjs +0 -7
  754. package/resources/order-profiles/index.mjs.map +0 -1
  755. package/resources/order-profiles/letters.d.ts +0 -647
  756. package/resources/order-profiles/letters.d.ts.map +0 -1
  757. package/resources/order-profiles/letters.js +0 -80
  758. package/resources/order-profiles/letters.js.map +0 -1
  759. package/resources/order-profiles/letters.mjs +0 -75
  760. package/resources/order-profiles/letters.mjs.map +0 -1
  761. package/resources/order-profiles/order-profiles.d.ts +0 -22
  762. package/resources/order-profiles/order-profiles.d.ts.map +0 -1
  763. package/resources/order-profiles/order-profiles.js +0 -55
  764. package/resources/order-profiles/order-profiles.js.map +0 -1
  765. package/resources/order-profiles/order-profiles.mjs +0 -28
  766. package/resources/order-profiles/order-profiles.mjs.map +0 -1
  767. package/resources/order-profiles/postcards.d.ts +0 -423
  768. package/resources/order-profiles/postcards.d.ts.map +0 -1
  769. package/resources/order-profiles/postcards.js +0 -73
  770. package/resources/order-profiles/postcards.js.map +0 -1
  771. package/resources/order-profiles/postcards.mjs +0 -68
  772. package/resources/order-profiles/postcards.mjs.map +0 -1
  773. package/resources/order-profiles/self-mailers.d.ts +0 -435
  774. package/resources/order-profiles/self-mailers.d.ts.map +0 -1
  775. package/resources/order-profiles/self-mailers.js +0 -75
  776. package/resources/order-profiles/self-mailers.js.map +0 -1
  777. package/resources/order-profiles/self-mailers.mjs +0 -70
  778. package/resources/order-profiles/self-mailers.mjs.map +0 -1
  779. package/resources/order-profiles.d.ts.map +0 -1
  780. package/resources/order-profiles.js +0 -19
  781. package/resources/order-profiles.js.map +0 -1
  782. package/resources/order-profiles.mjs.map +0 -1
  783. package/resources/postcards.d.ts +0 -396
  784. package/resources/postcards.d.ts.map +0 -1
  785. package/resources/postcards.js +0 -82
  786. package/resources/postcards.js.map +0 -1
  787. package/resources/postcards.mjs +0 -77
  788. package/resources/postcards.mjs.map +0 -1
  789. package/resources/reports/exports.d.ts +0 -240
  790. package/resources/reports/exports.d.ts.map +0 -1
  791. package/resources/reports/exports.js +0 -60
  792. package/resources/reports/exports.js.map +0 -1
  793. package/resources/reports/exports.mjs +0 -56
  794. package/resources/reports/exports.mjs.map +0 -1
  795. package/resources/reports/index.d.ts +0 -3
  796. package/resources/reports/index.d.ts.map +0 -1
  797. package/resources/reports/index.js +0 -10
  798. package/resources/reports/index.js.map +0 -1
  799. package/resources/reports/index.mjs +0 -4
  800. package/resources/reports/index.mjs.map +0 -1
  801. package/resources/reports/reports.d.ts +0 -382
  802. package/resources/reports/reports.d.ts.map +0 -1
  803. package/resources/reports/reports.js +0 -142
  804. package/resources/reports/reports.js.map +0 -1
  805. package/resources/reports/reports.mjs +0 -114
  806. package/resources/reports/reports.mjs.map +0 -1
  807. package/resources/reports.d.ts.map +0 -1
  808. package/resources/reports.js +0 -19
  809. package/resources/reports.js.map +0 -1
  810. package/resources/reports.mjs.map +0 -1
  811. package/resources/self-mailers.d.ts +0 -706
  812. package/resources/self-mailers.d.ts.map +0 -1
  813. package/resources/self-mailers.js +0 -83
  814. package/resources/self-mailers.js.map +0 -1
  815. package/resources/self-mailers.mjs +0 -78
  816. package/resources/self-mailers.mjs.map +0 -1
  817. package/resources/shared.d.ts +0 -151
  818. package/resources/shared.d.ts.map +0 -1
  819. package/resources/shared.js +0 -4
  820. package/resources/shared.js.map +0 -1
  821. package/resources/shared.mjs +0 -3
  822. package/resources/shared.mjs.map +0 -1
  823. package/resources/sub-organizations.d.ts +0 -394
  824. package/resources/sub-organizations.d.ts.map +0 -1
  825. package/resources/sub-organizations.js +0 -63
  826. package/resources/sub-organizations.js.map +0 -1
  827. package/resources/sub-organizations.mjs +0 -58
  828. package/resources/sub-organizations.mjs.map +0 -1
  829. package/resources/templates.d.ts +0 -166
  830. package/resources/templates.d.ts.map +0 -1
  831. package/resources/templates.js +0 -72
  832. package/resources/templates.js.map +0 -1
  833. package/resources/templates.mjs +0 -67
  834. package/resources/templates.mjs.map +0 -1
  835. package/shims/node.d.ts +0 -30
  836. package/shims/node.d.ts.map +0 -1
  837. package/shims/node.js +0 -31
  838. package/shims/node.js.map +0 -1
  839. package/shims/node.mjs +0 -5
  840. package/shims/node.mjs.map +0 -1
  841. package/shims/web.d.ts +0 -26
  842. package/shims/web.d.ts.map +0 -1
  843. package/shims/web.js +0 -31
  844. package/shims/web.js.map +0 -1
  845. package/shims/web.mjs +0 -5
  846. package/shims/web.mjs.map +0 -1
  847. package/src/_shims/MultipartBody.ts +0 -9
  848. package/src/_shims/README.md +0 -46
  849. package/src/_shims/auto/runtime-bun.ts +0 -4
  850. package/src/_shims/auto/runtime-node.ts +0 -4
  851. package/src/_shims/auto/runtime.ts +0 -4
  852. package/src/_shims/auto/types-node.ts +0 -4
  853. package/src/_shims/auto/types.d.ts +0 -101
  854. package/src/_shims/auto/types.js +0 -3
  855. package/src/_shims/auto/types.mjs +0 -3
  856. package/src/_shims/bun-runtime.ts +0 -14
  857. package/src/_shims/index.d.ts +0 -83
  858. package/src/_shims/index.js +0 -17
  859. package/src/_shims/index.mjs +0 -11
  860. package/src/_shims/manual-types.d.ts +0 -12
  861. package/src/_shims/manual-types.js +0 -3
  862. package/src/_shims/manual-types.mjs +0 -3
  863. package/src/_shims/node-runtime.ts +0 -81
  864. package/src/_shims/node-types.d.ts +0 -42
  865. package/src/_shims/node-types.js +0 -3
  866. package/src/_shims/node-types.mjs +0 -3
  867. package/src/_shims/registry.ts +0 -67
  868. package/src/_shims/web-runtime.ts +0 -103
  869. package/src/_shims/web-types.d.ts +0 -83
  870. package/src/_shims/web-types.js +0 -3
  871. package/src/_shims/web-types.mjs +0 -3
  872. package/src/core.ts +0 -1236
  873. package/src/pagination.ts +0 -74
  874. package/src/resources/bank-accounts.ts +0 -435
  875. package/src/resources/boxes.ts +0 -1017
  876. package/src/resources/campaigns.ts +0 -853
  877. package/src/resources/cheques/cheques.ts +0 -524
  878. package/src/resources/cheques/index.ts +0 -12
  879. package/src/resources/cheques/url.ts +0 -42
  880. package/src/resources/cheques/with-deposit-ready-pdf.ts +0 -23
  881. package/src/resources/cheques.ts +0 -3
  882. package/src/resources/contacts.ts +0 -415
  883. package/src/resources/letters.ts +0 -902
  884. package/src/resources/mailing-list-imports.ts +0 -1076
  885. package/src/resources/mailing-lists.ts +0 -511
  886. package/src/resources/order-profiles/cheques.ts +0 -888
  887. package/src/resources/order-profiles/index.ts +0 -55
  888. package/src/resources/order-profiles/letters.ts +0 -956
  889. package/src/resources/order-profiles/order-profiles.ts +0 -133
  890. package/src/resources/order-profiles/postcards.ts +0 -694
  891. package/src/resources/order-profiles/self-mailers.ts +0 -707
  892. package/src/resources/postcards.ts +0 -582
  893. package/src/resources/reports/exports.ts +0 -299
  894. package/src/resources/reports/index.ts +0 -25
  895. package/src/resources/reports/reports.ts +0 -494
  896. package/src/resources/self-mailers.ts +0 -1024
  897. package/src/resources/shared.ts +0 -182
  898. package/src/resources/sub-organizations.ts +0 -518
  899. package/src/resources/templates.ts +0 -218
  900. package/src/shims/node.ts +0 -50
  901. package/src/shims/web.ts +0 -50
  902. /package/resources/{order-profiles.d.ts → print-mail/order-profiles.d.ts} +0 -0
  903. /package/resources/{order-profiles.mjs → print-mail/order-profiles.mjs} +0 -0
  904. /package/resources/{reports.d.ts → print-mail/reports.d.ts} +0 -0
  905. /package/resources/{reports.mjs → print-mail/reports.mjs} +0 -0
  906. /package/src/resources/{order-profiles.ts → print-mail/order-profiles.ts} +0 -0
  907. /package/src/resources/{reports.ts → print-mail/reports.ts} +0 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,89 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.3.0 (2025-11-06)
4
+
5
+ Full Changelog: [v0.2.0...v0.3.0](https://github.com/postgrid/postgrid-node/compare/v0.2.0...v0.3.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([abcab58](https://github.com/postgrid/postgrid-node/commit/abcab5822d2a5c0d33df26fe3b900f86f8c796e1))
10
+
11
+ ## 0.2.0 (2025-11-06)
12
+
13
+ Full Changelog: [v0.1.0-alpha.7...v0.2.0](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.7...v0.2.0)
14
+
15
+ ### Chores
16
+
17
+ * update SDK settings ([b77eaca](https://github.com/postgrid/postgrid-node/commit/b77eacae34e549dec20cbaabf417bac4a26d4bfe))
18
+
19
+ ## 0.1.0-alpha.7 (2025-11-05)
20
+
21
+ Full Changelog: [v0.1.0-alpha.6...v0.1.0-alpha.7](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.6...v0.1.0-alpha.7)
22
+
23
+ ### Features
24
+
25
+ * **api:** manual updates ([d5bec88](https://github.com/postgrid/postgrid-node/commit/d5bec887542cd3fc6075f77c110d1a30510d8c8a))
26
+
27
+ ## 0.1.0-alpha.6 (2025-11-04)
28
+
29
+ Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
30
+
31
+ ### Features
32
+
33
+ * **api:** manual updates ([0e2cb4a](https://github.com/postgrid/postgrid-node/commit/0e2cb4a4eba86345e95e9f65b097e580a1f9504d))
34
+ * **api:** manual updates ([f6cda5b](https://github.com/postgrid/postgrid-node/commit/f6cda5b4c5b65b7553a728072da1a75a9297d7e8))
35
+ * **api:** manual updates ([2292eba](https://github.com/postgrid/postgrid-node/commit/2292ebacebbe33cb6506791f298f0a1cadc90bc1))
36
+ * **api:** manual updates ([cb905a8](https://github.com/postgrid/postgrid-node/commit/cb905a8fe663a31c71a9fcecffb8dc191f7b5502))
37
+ * **api:** manual updates ([5e28201](https://github.com/postgrid/postgrid-node/commit/5e2820166ebf3ed1d44c81a747cc6eaee07ba25f))
38
+ * **api:** manual updates ([0d9444a](https://github.com/postgrid/postgrid-node/commit/0d9444af25deee78035a553a7cf0c4e3e0fee2b8))
39
+ * **api:** manual updates ([4ba55b4](https://github.com/postgrid/postgrid-node/commit/4ba55b4f14fcfb7e30989256798af7c17ad12b7d))
40
+ * **api:** manual updates ([5c99f89](https://github.com/postgrid/postgrid-node/commit/5c99f89c149535a95457e1dad589442f6929e057))
41
+ * **api:** manual updates ([8a8263b](https://github.com/postgrid/postgrid-node/commit/8a8263b3486dfaff379eed4c0de05f2edb0c3f46))
42
+ * **api:** manual updates ([6bfa765](https://github.com/postgrid/postgrid-node/commit/6bfa765001e8e1388aaa2cfa89dd586269a72cc3))
43
+ * **api:** manual updates ([6c6f765](https://github.com/postgrid/postgrid-node/commit/6c6f765a5344da461466d54eff27f7be2b3f66cf))
44
+ * **api:** manual updates ([b4e2f75](https://github.com/postgrid/postgrid-node/commit/b4e2f754489d343477e3aacf7f58622b2fb00f40))
45
+ * **api:** manual updates ([0b3222d](https://github.com/postgrid/postgrid-node/commit/0b3222d1182fa3e1a42d81607e0f18bb70369178))
46
+ * **api:** manual updates ([af5db50](https://github.com/postgrid/postgrid-node/commit/af5db50eb9fd8733cbbed0430cdebadd794241a1))
47
+ * **api:** manual updates ([7affe60](https://github.com/postgrid/postgrid-node/commit/7affe6098d10d0fcf531f30de6f511e3759cbacf))
48
+ * **api:** manual updates to merge PM and AV ([9692120](https://github.com/postgrid/postgrid-node/commit/9692120e792062a8a9d05456a19cc6036e707045))
49
+ * **api:** Select API key based on URL ([a4ef8c0](https://github.com/postgrid/postgrid-node/commit/a4ef8c01bf57319a3b44a8dca5620fb65a6e9907))
50
+ * **api:** support both API auth schemes ([8dc1bf5](https://github.com/postgrid/postgrid-node/commit/8dc1bf5d1b5ebfe51a3e525d3787606e49369f54))
51
+ * **api:** Update OpenAPI spec ([5e33ca6](https://github.com/postgrid/postgrid-node/commit/5e33ca64240823dd689ed70bbf413bccf1c78e3b))
52
+
53
+
54
+ ### Bug Fixes
55
+
56
+ * **api:** Examples for AV ([2e0d345](https://github.com/postgrid/postgrid-node/commit/2e0d34544da280ab9dca98c305f12bc1f80e28a7))
57
+ * **api:** header assignment in prepareRequest method ([39ea7ed](https://github.com/postgrid/postgrid-node/commit/39ea7edb8a15adf25bdb0e6df001c713b93a4e94))
58
+ * **api:** restructuring under printMail and addver ([c576dbe](https://github.com/postgrid/postgrid-node/commit/c576dbe5df4d59a84c55f36cc9d33ade25a045dc))
59
+ * coerce nullable values to undefined ([16b5f52](https://github.com/postgrid/postgrid-node/commit/16b5f52b376752133d92213fcdc48001c3d723b5))
60
+
61
+
62
+ ### Performance Improvements
63
+
64
+ * faster formatting ([669e461](https://github.com/postgrid/postgrid-node/commit/669e4618266377faf093b575d65a1e06db6fb957))
65
+
66
+
67
+ ### Chores
68
+
69
+ * **api:** more docs ([9f44e29](https://github.com/postgrid/postgrid-node/commit/9f44e29c300d7df16f65e2dfef7c3ba73afc46d5))
70
+ * **api:** rename API endpoints for AV ([548d9e3](https://github.com/postgrid/postgrid-node/commit/548d9e3085ecb23b038da86ad74284545494f101))
71
+ * **api:** Update OpenAPI schema ([2a29dbc](https://github.com/postgrid/postgrid-node/commit/2a29dbc33aea71d4348e295c203c5c6166b07531))
72
+ * **deps:** update dependency node-fetch to v2.6.13 ([9d18c47](https://github.com/postgrid/postgrid-node/commit/9d18c477e6993a11e5e99a5f1767ccb6f5ca5cd7))
73
+ * do not install brew dependencies in ./scripts/bootstrap by default ([92cd0ec](https://github.com/postgrid/postgrid-node/commit/92cd0ec15019dc755fd2c5d25000dc79a26e9200))
74
+ * **internal:** codegen related update ([b00d3ff](https://github.com/postgrid/postgrid-node/commit/b00d3ffeb99b8a74d7d372bd066e8a8b808cd519))
75
+ * **internal:** codegen related update ([a8ec314](https://github.com/postgrid/postgrid-node/commit/a8ec314e8edbe03fab399e323b9b73912749172b))
76
+ * **internal:** fix incremental formatting in some cases ([2e13552](https://github.com/postgrid/postgrid-node/commit/2e135520c1c15d414dec4ee05377644613a2be20))
77
+ * **internal:** formatting change ([36db802](https://github.com/postgrid/postgrid-node/commit/36db802aa9e9c4eccf281ab0f846fb039ea4152d))
78
+ * **internal:** ignore .eslintcache ([a0a4bd3](https://github.com/postgrid/postgrid-node/commit/a0a4bd3b359f8e1f97b8010ef70aade58c3b701f))
79
+ * **internal:** remove .eslintcache ([c2a1b69](https://github.com/postgrid/postgrid-node/commit/c2a1b697036a5d99876e5c14a748a004f45d581b))
80
+ * **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([867309f](https://github.com/postgrid/postgrid-node/commit/867309fd42d75fdca870c4dbc532769626408428))
81
+ * **internal:** update comment in script ([0f4e66e](https://github.com/postgrid/postgrid-node/commit/0f4e66ee5aaf00c64d332c1924062f024ae1df13))
82
+ * **internal:** use npm pack for build uploads ([db5fba9](https://github.com/postgrid/postgrid-node/commit/db5fba95b07d3e51da3e54005a46d186f2755c40))
83
+ * update @stainless-api/prism-cli to v5.15.0 ([4640767](https://github.com/postgrid/postgrid-node/commit/46407677b2142f0a99834bd5a626a119f36fe463))
84
+ * update CI script ([1adf9d4](https://github.com/postgrid/postgrid-node/commit/1adf9d4dc106b6c31f99e709017b1b85070ac8a5))
85
+ * update SDK settings ([45e20aa](https://github.com/postgrid/postgrid-node/commit/45e20aab8340be7c79151e52ca8fb503a6aa57c7))
86
+
3
87
  ## 0.1.0-alpha.5 (2025-08-07)
4
88
 
5
89
  Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
package/LICENSE CHANGED
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright 2025 PostGrid
189
+ Copyright 2025 Post Grid
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
- # PostGrid Node API Library
1
+ # PostGrid API Library
2
2
 
3
- [![NPM version](https://img.shields.io/npm/v/postgrid-node.svg)](https://npmjs.org/package/postgrid-node) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/postgrid-node)
3
+ [![NPM version](<https://img.shields.io/npm/v/postgrid-node.svg?label=npm%20(stable)>)](https://npmjs.org/package/postgrid-node) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/postgrid-node)
4
4
 
5
- This library provides convenient access to the PostGrid REST API from server-side TypeScript or JavaScript.
5
+ This library provides convenient access to the Post Grid REST API from server-side TypeScript or JavaScript.
6
6
 
7
- The REST API documentation can be found on [docs.postgrid.com](https://docs.postgrid.com). The full API of this library can be found in [api.md](api.md).
7
+ The full API of this library can be found in [api.md](api.md).
8
8
 
9
9
  ## Installation
10
10
 
@@ -21,10 +21,10 @@ The full API of this library can be found in [api.md](api.md).
21
21
  import PostGrid from 'postgrid-node';
22
22
 
23
23
  const client = new PostGrid({
24
- apiKey: 'My API Key',
24
+ printMailAPIKey: process.env['POSTGRID_PRINT_MAIL_API_KEY'], // This is the default and can be omitted
25
25
  });
26
26
 
27
- const contact = await client.contacts.create({
27
+ const contact = await client.printMail.contacts.create({
28
28
  addressLine1: 'addressLine1',
29
29
  countryCode: 'countryCode',
30
30
  firstName: 'firstName',
@@ -42,15 +42,11 @@ This library includes TypeScript definitions for all request params and response
42
42
  import PostGrid from 'postgrid-node';
43
43
 
44
44
  const client = new PostGrid({
45
- apiKey: 'My API Key',
45
+ addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted
46
46
  });
47
47
 
48
- const params: PostGrid.ContactCreateParams = {
49
- addressLine1: 'addressLine1',
50
- countryCode: 'countryCode',
51
- firstName: 'firstName',
52
- };
53
- const contact: PostGrid.Contact = await client.contacts.create(params);
48
+ const params: PostGrid.AddressVerificationVerifyParams = { address: 'address' };
49
+ const response: PostGrid.AddressVerificationVerifyResponse = await client.addressVerification.verify(params);
54
50
  ```
55
51
 
56
52
  Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -63,17 +59,15 @@ a subclass of `APIError` will be thrown:
63
59
 
64
60
  <!-- prettier-ignore -->
65
61
  ```ts
66
- const contact = await client.contacts
67
- .create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
68
- .catch(async (err) => {
69
- if (err instanceof PostGrid.APIError) {
70
- console.log(err.status); // 400
71
- console.log(err.name); // BadRequestError
72
- console.log(err.headers); // {server: 'nginx', ...}
73
- } else {
74
- throw err;
75
- }
76
- });
62
+ const response = await client.addressVerification.verify({ address: 'address' }).catch(async (err) => {
63
+ if (err instanceof PostGrid.APIError) {
64
+ console.log(err.status); // 400
65
+ console.log(err.name); // BadRequestError
66
+ console.log(err.headers); // {server: 'nginx', ...}
67
+ } else {
68
+ throw err;
69
+ }
70
+ });
77
71
  ```
78
72
 
79
73
  Error codes are as follows:
@@ -105,7 +99,7 @@ const client = new PostGrid({
105
99
  });
106
100
 
107
101
  // Or, configure per-request:
108
- await client.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
102
+ await client.addressVerification.verify({ address: 'address' }, {
109
103
  maxRetries: 5,
110
104
  });
111
105
  ```
@@ -122,7 +116,7 @@ const client = new PostGrid({
122
116
  });
123
117
 
124
118
  // Override per-request:
125
- await client.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
119
+ await client.addressVerification.verify({ address: 'address' }, {
126
120
  timeout: 5 * 1000,
127
121
  });
128
122
  ```
@@ -131,60 +125,82 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
131
125
 
132
126
  Note that requests which time out will be [retried twice by default](#retries).
133
127
 
134
- ## Auto-pagination
135
-
136
- List methods in the PostGrid API are paginated.
137
- You can use the `for await … of` syntax to iterate through items across all pages:
138
-
139
- ```ts
140
- async function fetchAllContacts(params) {
141
- const allContacts = [];
142
- // Automatically fetches more pages as needed.
143
- for await (const contact of client.contacts.list()) {
144
- allContacts.push(contact);
145
- }
146
- return allContacts;
147
- }
148
- ```
149
-
150
- Alternatively, you can request a single page at a time:
151
-
152
- ```ts
153
- let page = await client.contacts.list();
154
- for (const contact of page.data) {
155
- console.log(contact);
156
- }
157
-
158
- // Convenience methods are provided for manually paginating:
159
- while (page.hasNextPage()) {
160
- page = await page.getNextPage();
161
- // ...
162
- }
163
- ```
164
-
165
128
  ## Advanced Usage
166
129
 
167
130
  ### Accessing raw Response data (e.g., headers)
168
131
 
169
132
  The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
133
+ This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
170
134
 
171
135
  You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
136
+ Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
172
137
 
173
138
  <!-- prettier-ignore -->
174
139
  ```ts
175
140
  const client = new PostGrid();
176
141
 
177
- const response = await client.contacts
178
- .create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
179
- .asResponse();
142
+ const response = await client.addressVerification.verify({ address: 'address' }).asResponse();
180
143
  console.log(response.headers.get('X-My-Header'));
181
144
  console.log(response.statusText); // access the underlying Response object
182
145
 
183
- const { data: contact, response: raw } = await client.contacts
184
- .create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
146
+ const { data: response, response: raw } = await client.addressVerification
147
+ .verify({ address: 'address' })
185
148
  .withResponse();
186
149
  console.log(raw.headers.get('X-My-Header'));
187
- console.log(contact.id);
150
+ console.log(response.data);
151
+ ```
152
+
153
+ ### Logging
154
+
155
+ > [!IMPORTANT]
156
+ > All log messages are intended for debugging only. The format and content of log messages
157
+ > may change between releases.
158
+
159
+ #### Log levels
160
+
161
+ The log level can be configured in two ways:
162
+
163
+ 1. Via the `POST_GRID_LOG` environment variable
164
+ 2. Using the `logLevel` client option (overrides the environment variable if set)
165
+
166
+ ```ts
167
+ import PostGrid from 'postgrid-node';
168
+
169
+ const client = new PostGrid({
170
+ logLevel: 'debug', // Show all log messages
171
+ });
172
+ ```
173
+
174
+ Available log levels, from most to least verbose:
175
+
176
+ - `'debug'` - Show debug messages, info, warnings, and errors
177
+ - `'info'` - Show info messages, warnings, and errors
178
+ - `'warn'` - Show warnings and errors (default)
179
+ - `'error'` - Show only errors
180
+ - `'off'` - Disable all logging
181
+
182
+ At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
183
+ Some authentication-related headers are redacted, but sensitive data in request and response bodies
184
+ may still be visible.
185
+
186
+ #### Custom logger
187
+
188
+ By default, this library logs to `globalThis.console`. You can also provide a custom logger.
189
+ Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
190
+
191
+ When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
192
+ below the configured level will not be sent to your logger.
193
+
194
+ ```ts
195
+ import PostGrid from 'postgrid-node';
196
+ import pino from 'pino';
197
+
198
+ const logger = pino();
199
+
200
+ const client = new PostGrid({
201
+ logger: logger.child({ name: 'PostGrid' }),
202
+ logLevel: 'debug', // Send all messages to pino, allowing it to filter
203
+ });
188
204
  ```
189
205
 
190
206
  ### Making custom/undocumented requests
@@ -211,9 +227,8 @@ parameter. This library doesn't validate at runtime that the request matches the
211
227
  send will be sent as-is.
212
228
 
213
229
  ```ts
214
- client.foo.create({
215
- foo: 'my_param',
216
- bar: 12,
230
+ client.printMail.contacts.create({
231
+ // ...
217
232
  // @ts-expect-error baz is not yet public
218
233
  baz: 'undocumented option',
219
234
  });
@@ -233,69 +248,85 @@ validate or strip extra properties from the response from the API.
233
248
 
234
249
  ### Customizing the fetch client
235
250
 
236
- By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
251
+ By default, this library expects a global `fetch` function is defined.
237
252
 
238
- If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
239
- (for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
240
- add the following import before your first import `from "PostGrid"`:
253
+ If you want to use a different `fetch` function, you can either polyfill the global:
241
254
 
242
255
  ```ts
243
- // Tell TypeScript and the package to use the global web fetch instead of node-fetch.
244
- // Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
245
- import 'postgrid-node/shims/web';
246
- import PostGrid from 'postgrid-node';
256
+ import fetch from 'my-fetch';
257
+
258
+ globalThis.fetch = fetch;
247
259
  ```
248
260
 
249
- To do the inverse, add `import "postgrid-node/shims/node"` (which does import polyfills).
250
- This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/postgrid/postgrid-node/tree/main/src/_shims#readme)).
261
+ Or pass it to the client:
251
262
 
252
- ### Logging and middleware
263
+ ```ts
264
+ import PostGrid from 'postgrid-node';
265
+ import fetch from 'my-fetch';
253
266
 
254
- You may also provide a custom `fetch` function when instantiating the client,
255
- which can be used to inspect or alter the `Request` or `Response` before/after each request:
267
+ const client = new PostGrid({ fetch });
268
+ ```
269
+
270
+ ### Fetch options
271
+
272
+ If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
256
273
 
257
274
  ```ts
258
- import { fetch } from 'undici'; // as one example
259
275
  import PostGrid from 'postgrid-node';
260
276
 
261
277
  const client = new PostGrid({
262
- fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
263
- console.log('About to make a request', url, init);
264
- const response = await fetch(url, init);
265
- console.log('Got response', response);
266
- return response;
278
+ fetchOptions: {
279
+ // `RequestInit` options
267
280
  },
268
281
  });
269
282
  ```
270
283
 
271
- Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
272
- This is intended for debugging purposes only and may change in the future without notice.
284
+ #### Configuring proxies
285
+
286
+ To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
287
+ options to requests:
288
+
289
+ <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
273
290
 
274
- ### Configuring an HTTP(S) Agent (e.g., for proxies)
291
+ ```ts
292
+ import PostGrid from 'postgrid-node';
293
+ import * as undici from 'undici';
275
294
 
276
- By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
295
+ const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
296
+ const client = new PostGrid({
297
+ fetchOptions: {
298
+ dispatcher: proxyAgent,
299
+ },
300
+ });
301
+ ```
277
302
 
278
- If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
303
+ <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
279
304
 
280
- <!-- prettier-ignore -->
281
305
  ```ts
282
- import http from 'http';
283
- import { HttpsProxyAgent } from 'https-proxy-agent';
306
+ import PostGrid from 'postgrid-node';
284
307
 
285
- // Configure the default for all requests:
286
308
  const client = new PostGrid({
287
- httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
309
+ fetchOptions: {
310
+ proxy: 'http://localhost:8888',
311
+ },
288
312
  });
313
+ ```
289
314
 
290
- // Override per-request:
291
- await client.contacts.create(
292
- { addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' },
293
- {
294
- httpAgent: new http.Agent({ keepAlive: false }),
315
+ <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
316
+
317
+ ```ts
318
+ import PostGrid from 'npm:postgrid-node';
319
+
320
+ const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
321
+ const client = new PostGrid({
322
+ fetchOptions: {
323
+ client: httpClient,
295
324
  },
296
- );
325
+ });
297
326
  ```
298
327
 
328
+ ## Frequently Asked Questions
329
+
299
330
  ## Semantic versioning
300
331
 
301
332
  This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
@@ -310,12 +341,12 @@ We are keen for your feedback; please open an [issue](https://www.github.com/pos
310
341
 
311
342
  ## Requirements
312
343
 
313
- TypeScript >= 4.5 is supported.
344
+ TypeScript >= 4.9 is supported.
314
345
 
315
346
  The following runtimes are supported:
316
347
 
317
348
  - Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
318
- - Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
349
+ - Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
319
350
  - Deno v1.28.0 or higher.
320
351
  - Bun 1.0 or later.
321
352
  - Cloudflare Workers.
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.mjs";
2
+ //# sourceMappingURL=api-promise.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.js";
2
+ //# sourceMappingURL=api-promise.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
package/api-promise.js ADDED
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("./internal/tslib.js");
4
+ /** @deprecated Import from ./core/api-promise instead */
5
+ tslib_1.__exportStar(require("./core/api-promise.js"), exports);
6
+ //# sourceMappingURL=api-promise.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.mjs";
2
+ //# sourceMappingURL=api-promise.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}