postgrid-node 0.4.2 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (422) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/LICENSE +1 -1
  3. package/README.md +15 -12
  4. package/client.d.mts +35 -15
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +35 -15
  7. package/client.d.ts.map +1 -1
  8. package/client.js +61 -15
  9. package/client.js.map +1 -1
  10. package/client.mjs +62 -16
  11. package/client.mjs.map +1 -1
  12. package/internal/parse.d.mts.map +1 -1
  13. package/internal/parse.d.ts.map +1 -1
  14. package/internal/parse.js +5 -0
  15. package/internal/parse.js.map +1 -1
  16. package/internal/parse.mjs +5 -0
  17. package/internal/parse.mjs.map +1 -1
  18. package/internal/types.d.mts +6 -6
  19. package/internal/types.d.mts.map +1 -1
  20. package/internal/types.d.ts +6 -6
  21. package/internal/types.d.ts.map +1 -1
  22. package/internal/utils/env.js +2 -2
  23. package/internal/utils/env.js.map +1 -1
  24. package/internal/utils/env.mjs +2 -2
  25. package/internal/utils/env.mjs.map +1 -1
  26. package/internal/utils/log.d.mts.map +1 -1
  27. package/internal/utils/log.d.ts.map +1 -1
  28. package/internal/utils/log.js +3 -2
  29. package/internal/utils/log.js.map +1 -1
  30. package/internal/utils/log.mjs +3 -2
  31. package/internal/utils/log.mjs.map +1 -1
  32. package/internal/utils/query.d.mts +5 -0
  33. package/internal/utils/query.d.mts.map +1 -0
  34. package/internal/utils/query.d.ts +5 -0
  35. package/internal/utils/query.d.ts.map +1 -0
  36. package/internal/utils/query.js +23 -0
  37. package/internal/utils/query.js.map +1 -0
  38. package/internal/utils/query.mjs +20 -0
  39. package/internal/utils/query.mjs.map +1 -0
  40. package/internal/utils.d.mts +1 -0
  41. package/internal/utils.d.ts +1 -0
  42. package/internal/utils.js +1 -0
  43. package/internal/utils.js.map +1 -1
  44. package/internal/utils.mjs +1 -0
  45. package/package.json +9 -3
  46. package/resources/address-verification.d.mts +1689 -15
  47. package/resources/address-verification.d.mts.map +1 -1
  48. package/resources/address-verification.d.ts +1689 -15
  49. package/resources/address-verification.d.ts.map +1 -1
  50. package/resources/address-verification.js +200 -0
  51. package/resources/address-verification.js.map +1 -1
  52. package/resources/address-verification.mjs +200 -0
  53. package/resources/address-verification.mjs.map +1 -1
  54. package/resources/index.d.mts +3 -3
  55. package/resources/index.d.mts.map +1 -1
  56. package/resources/index.d.ts +3 -3
  57. package/resources/index.d.ts.map +1 -1
  58. package/resources/index.js.map +1 -1
  59. package/resources/index.mjs +1 -1
  60. package/resources/index.mjs.map +1 -1
  61. package/resources/intl-address-verification.d.mts +956 -35
  62. package/resources/intl-address-verification.d.mts.map +1 -1
  63. package/resources/intl-address-verification.d.ts +956 -35
  64. package/resources/intl-address-verification.d.ts.map +1 -1
  65. package/resources/intl-address-verification.js +121 -27
  66. package/resources/intl-address-verification.js.map +1 -1
  67. package/resources/intl-address-verification.mjs +121 -27
  68. package/resources/intl-address-verification.mjs.map +1 -1
  69. package/resources/print-mail/boxes.d.mts +733 -59
  70. package/resources/print-mail/boxes.d.mts.map +1 -1
  71. package/resources/print-mail/boxes.d.ts +733 -59
  72. package/resources/print-mail/boxes.d.ts.map +1 -1
  73. package/resources/print-mail/boxes.js +19 -1
  74. package/resources/print-mail/boxes.js.map +1 -1
  75. package/resources/print-mail/boxes.mjs +19 -1
  76. package/resources/print-mail/boxes.mjs.map +1 -1
  77. package/resources/print-mail/campaigns.d.mts +923 -34
  78. package/resources/print-mail/campaigns.d.mts.map +1 -1
  79. package/resources/print-mail/campaigns.d.ts +923 -34
  80. package/resources/print-mail/campaigns.d.ts.map +1 -1
  81. package/resources/print-mail/campaigns.js +10 -3
  82. package/resources/print-mail/campaigns.js.map +1 -1
  83. package/resources/print-mail/campaigns.mjs +10 -3
  84. package/resources/print-mail/campaigns.mjs.map +1 -1
  85. package/resources/print-mail/cheques.d.mts +60 -11
  86. package/resources/print-mail/cheques.d.mts.map +1 -1
  87. package/resources/print-mail/cheques.d.ts +60 -11
  88. package/resources/print-mail/cheques.d.ts.map +1 -1
  89. package/resources/print-mail/cheques.js +32 -0
  90. package/resources/print-mail/cheques.js.map +1 -1
  91. package/resources/print-mail/cheques.mjs +32 -0
  92. package/resources/print-mail/cheques.mjs.map +1 -1
  93. package/resources/print-mail/contacts.d.mts +138 -3
  94. package/resources/print-mail/contacts.d.mts.map +1 -1
  95. package/resources/print-mail/contacts.d.ts +138 -3
  96. package/resources/print-mail/contacts.d.ts.map +1 -1
  97. package/resources/print-mail/contacts.js.map +1 -1
  98. package/resources/print-mail/contacts.mjs.map +1 -1
  99. package/resources/print-mail/index.d.mts +12 -8
  100. package/resources/print-mail/index.d.mts.map +1 -1
  101. package/resources/print-mail/index.d.ts +12 -8
  102. package/resources/print-mail/index.d.ts.map +1 -1
  103. package/resources/print-mail/index.js +13 -5
  104. package/resources/print-mail/index.js.map +1 -1
  105. package/resources/print-mail/index.mjs +5 -1
  106. package/resources/print-mail/index.mjs.map +1 -1
  107. package/resources/print-mail/letters.d.mts +62 -13
  108. package/resources/print-mail/letters.d.mts.map +1 -1
  109. package/resources/print-mail/letters.d.ts +62 -13
  110. package/resources/print-mail/letters.d.ts.map +1 -1
  111. package/resources/print-mail/letters.js +32 -0
  112. package/resources/print-mail/letters.js.map +1 -1
  113. package/resources/print-mail/letters.mjs +32 -0
  114. package/resources/print-mail/letters.mjs.map +1 -1
  115. package/resources/print-mail/mailing-list-imports.d.mts +5 -1
  116. package/resources/print-mail/mailing-list-imports.d.mts.map +1 -1
  117. package/resources/print-mail/mailing-list-imports.d.ts +5 -1
  118. package/resources/print-mail/mailing-list-imports.d.ts.map +1 -1
  119. package/resources/print-mail/mailing-list-imports.js +4 -0
  120. package/resources/print-mail/mailing-list-imports.js.map +1 -1
  121. package/resources/print-mail/mailing-list-imports.mjs +4 -0
  122. package/resources/print-mail/mailing-list-imports.mjs.map +1 -1
  123. package/resources/print-mail/mailing-lists.d.mts +5 -1
  124. package/resources/print-mail/mailing-lists.d.mts.map +1 -1
  125. package/resources/print-mail/mailing-lists.d.ts +5 -1
  126. package/resources/print-mail/mailing-lists.d.ts.map +1 -1
  127. package/resources/print-mail/mailing-lists.js +4 -0
  128. package/resources/print-mail/mailing-lists.js.map +1 -1
  129. package/resources/print-mail/mailing-lists.mjs +4 -0
  130. package/resources/print-mail/mailing-lists.mjs.map +1 -1
  131. package/resources/print-mail/postcards.d.mts +90 -21
  132. package/resources/print-mail/postcards.d.mts.map +1 -1
  133. package/resources/print-mail/postcards.d.ts +90 -21
  134. package/resources/print-mail/postcards.d.ts.map +1 -1
  135. package/resources/print-mail/postcards.js +33 -0
  136. package/resources/print-mail/postcards.js.map +1 -1
  137. package/resources/print-mail/postcards.mjs +33 -0
  138. package/resources/print-mail/postcards.mjs.map +1 -1
  139. package/resources/print-mail/print-mail.d.mts +41 -162
  140. package/resources/print-mail/print-mail.d.mts.map +1 -1
  141. package/resources/print-mail/print-mail.d.ts +41 -162
  142. package/resources/print-mail/print-mail.d.ts.map +1 -1
  143. package/resources/print-mail/print-mail.js +34 -18
  144. package/resources/print-mail/print-mail.js.map +1 -1
  145. package/resources/print-mail/print-mail.mjs +34 -18
  146. package/resources/print-mail/print-mail.mjs.map +1 -1
  147. package/resources/print-mail/reports/exports.d.mts +7 -0
  148. package/resources/print-mail/reports/exports.d.mts.map +1 -1
  149. package/resources/print-mail/reports/exports.d.ts +7 -0
  150. package/resources/print-mail/reports/exports.d.ts.map +1 -1
  151. package/resources/print-mail/reports/exports.js +7 -0
  152. package/resources/print-mail/reports/exports.js.map +1 -1
  153. package/resources/print-mail/reports/exports.mjs +7 -0
  154. package/resources/print-mail/reports/exports.mjs.map +1 -1
  155. package/resources/print-mail/reports/reports.d.mts +7 -0
  156. package/resources/print-mail/reports/reports.d.mts.map +1 -1
  157. package/resources/print-mail/reports/reports.d.ts +7 -0
  158. package/resources/print-mail/reports/reports.d.ts.map +1 -1
  159. package/resources/print-mail/reports/reports.js +7 -0
  160. package/resources/print-mail/reports/reports.js.map +1 -1
  161. package/resources/print-mail/reports/reports.mjs +7 -0
  162. package/resources/print-mail/reports/reports.mjs.map +1 -1
  163. package/resources/print-mail/reports/samples.d.mts +7 -0
  164. package/resources/print-mail/reports/samples.d.mts.map +1 -1
  165. package/resources/print-mail/reports/samples.d.ts +7 -0
  166. package/resources/print-mail/reports/samples.d.ts.map +1 -1
  167. package/resources/print-mail/reports/samples.js +7 -0
  168. package/resources/print-mail/reports/samples.js.map +1 -1
  169. package/resources/print-mail/reports/samples.mjs +7 -0
  170. package/resources/print-mail/reports/samples.mjs.map +1 -1
  171. package/resources/print-mail/self-mailers.d.mts +52 -20
  172. package/resources/print-mail/self-mailers.d.mts.map +1 -1
  173. package/resources/print-mail/self-mailers.d.ts +52 -20
  174. package/resources/print-mail/self-mailers.d.ts.map +1 -1
  175. package/resources/print-mail/self-mailers.js +17 -0
  176. package/resources/print-mail/self-mailers.js.map +1 -1
  177. package/resources/print-mail/self-mailers.mjs +17 -0
  178. package/resources/print-mail/self-mailers.mjs.map +1 -1
  179. package/resources/print-mail/snap-packs.d.mts +1060 -0
  180. package/resources/print-mail/snap-packs.d.mts.map +1 -0
  181. package/resources/print-mail/snap-packs.d.ts +1060 -0
  182. package/resources/print-mail/snap-packs.d.ts.map +1 -0
  183. package/resources/print-mail/snap-packs.js +117 -0
  184. package/resources/print-mail/snap-packs.js.map +1 -0
  185. package/resources/print-mail/snap-packs.mjs +113 -0
  186. package/resources/print-mail/snap-packs.mjs.map +1 -0
  187. package/resources/print-mail/sub-organizations.d.mts +29 -17
  188. package/resources/print-mail/sub-organizations.d.mts.map +1 -1
  189. package/resources/print-mail/sub-organizations.d.ts +29 -17
  190. package/resources/print-mail/sub-organizations.d.ts.map +1 -1
  191. package/resources/print-mail/sub-organizations.js +26 -14
  192. package/resources/print-mail/sub-organizations.js.map +1 -1
  193. package/resources/print-mail/sub-organizations.mjs +26 -14
  194. package/resources/print-mail/sub-organizations.mjs.map +1 -1
  195. package/resources/print-mail/targeted-list-builds/filters.d.mts +92 -0
  196. package/resources/print-mail/targeted-list-builds/filters.d.mts.map +1 -0
  197. package/resources/print-mail/targeted-list-builds/filters.d.ts +92 -0
  198. package/resources/print-mail/targeted-list-builds/filters.d.ts.map +1 -0
  199. package/resources/print-mail/targeted-list-builds/filters.js +60 -0
  200. package/resources/print-mail/targeted-list-builds/filters.js.map +1 -0
  201. package/resources/print-mail/targeted-list-builds/filters.mjs +56 -0
  202. package/resources/print-mail/targeted-list-builds/filters.mjs.map +1 -0
  203. package/resources/print-mail/targeted-list-builds/index.d.mts +3 -0
  204. package/resources/print-mail/targeted-list-builds/index.d.mts.map +1 -0
  205. package/resources/print-mail/targeted-list-builds/index.d.ts +3 -0
  206. package/resources/print-mail/targeted-list-builds/index.d.ts.map +1 -0
  207. package/resources/print-mail/targeted-list-builds/index.js +9 -0
  208. package/resources/print-mail/targeted-list-builds/index.js.map +1 -0
  209. package/resources/print-mail/targeted-list-builds/index.mjs +4 -0
  210. package/resources/print-mail/targeted-list-builds/index.mjs.map +1 -0
  211. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts +1633 -0
  212. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts.map +1 -0
  213. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts +1633 -0
  214. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts.map +1 -0
  215. package/resources/print-mail/targeted-list-builds/targeted-list-builds.js +154 -0
  216. package/resources/print-mail/targeted-list-builds/targeted-list-builds.js.map +1 -0
  217. package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs +149 -0
  218. package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs.map +1 -0
  219. package/resources/print-mail/targeted-list-builds.d.mts +2 -0
  220. package/resources/print-mail/targeted-list-builds.d.mts.map +1 -0
  221. package/resources/print-mail/targeted-list-builds.d.ts +2 -0
  222. package/resources/print-mail/targeted-list-builds.d.ts.map +1 -0
  223. package/resources/print-mail/targeted-list-builds.js +6 -0
  224. package/resources/print-mail/targeted-list-builds.js.map +1 -0
  225. package/resources/print-mail/targeted-list-builds.mjs +3 -0
  226. package/resources/print-mail/targeted-list-builds.mjs.map +1 -0
  227. package/resources/print-mail/template-editor-sessions.d.mts +355 -0
  228. package/resources/print-mail/template-editor-sessions.d.mts.map +1 -0
  229. package/resources/print-mail/template-editor-sessions.d.ts +355 -0
  230. package/resources/print-mail/template-editor-sessions.d.ts.map +1 -0
  231. package/resources/print-mail/template-editor-sessions.js +78 -0
  232. package/resources/print-mail/template-editor-sessions.js.map +1 -0
  233. package/resources/print-mail/template-editor-sessions.mjs +74 -0
  234. package/resources/print-mail/template-editor-sessions.mjs.map +1 -0
  235. package/resources/print-mail/trackers.d.mts +409 -0
  236. package/resources/print-mail/trackers.d.mts.map +1 -0
  237. package/resources/print-mail/trackers.d.ts +409 -0
  238. package/resources/print-mail/trackers.d.ts.map +1 -0
  239. package/resources/print-mail/trackers.js +116 -0
  240. package/resources/print-mail/trackers.js.map +1 -0
  241. package/resources/print-mail/trackers.mjs +112 -0
  242. package/resources/print-mail/trackers.mjs.map +1 -0
  243. package/resources/print-mail/virtual-mailboxes/index.d.mts +3 -0
  244. package/resources/print-mail/virtual-mailboxes/index.d.mts.map +1 -0
  245. package/resources/print-mail/virtual-mailboxes/index.d.ts +3 -0
  246. package/resources/print-mail/virtual-mailboxes/index.d.ts.map +1 -0
  247. package/resources/print-mail/virtual-mailboxes/index.js +9 -0
  248. package/resources/print-mail/virtual-mailboxes/index.js.map +1 -0
  249. package/resources/print-mail/virtual-mailboxes/index.mjs +4 -0
  250. package/resources/print-mail/virtual-mailboxes/index.mjs.map +1 -0
  251. package/resources/print-mail/virtual-mailboxes/items.d.mts +235 -0
  252. package/resources/print-mail/virtual-mailboxes/items.d.mts.map +1 -0
  253. package/resources/print-mail/virtual-mailboxes/items.d.ts +235 -0
  254. package/resources/print-mail/virtual-mailboxes/items.d.ts.map +1 -0
  255. package/resources/print-mail/virtual-mailboxes/items.js +69 -0
  256. package/resources/print-mail/virtual-mailboxes/items.js.map +1 -0
  257. package/resources/print-mail/virtual-mailboxes/items.mjs +65 -0
  258. package/resources/print-mail/virtual-mailboxes/items.mjs.map +1 -0
  259. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts +334 -0
  260. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts.map +1 -0
  261. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts +334 -0
  262. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts.map +1 -0
  263. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js +92 -0
  264. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js.map +1 -0
  265. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs +87 -0
  266. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs.map +1 -0
  267. package/resources/print-mail/virtual-mailboxes.d.mts +2 -0
  268. package/resources/print-mail/virtual-mailboxes.d.mts.map +1 -0
  269. package/resources/print-mail/virtual-mailboxes.d.ts +2 -0
  270. package/resources/print-mail/virtual-mailboxes.d.ts.map +1 -0
  271. package/resources/print-mail/{order-profiles.js → virtual-mailboxes.js} +2 -2
  272. package/resources/print-mail/virtual-mailboxes.js.map +1 -0
  273. package/resources/print-mail/virtual-mailboxes.mjs +3 -0
  274. package/resources/print-mail/virtual-mailboxes.mjs.map +1 -0
  275. package/src/client.ts +123 -33
  276. package/src/internal/parse.ts +6 -0
  277. package/src/internal/types.ts +6 -8
  278. package/src/internal/utils/env.ts +2 -2
  279. package/src/internal/utils/log.ts +2 -1
  280. package/src/internal/utils/query.ts +23 -0
  281. package/src/internal/utils.ts +1 -0
  282. package/src/resources/address-verification.ts +2190 -24
  283. package/src/resources/index.ts +24 -5
  284. package/src/resources/intl-address-verification.ts +1219 -43
  285. package/src/resources/print-mail/boxes.ts +1011 -99
  286. package/src/resources/print-mail/campaigns.ts +1449 -59
  287. package/src/resources/print-mail/cheques.ts +122 -10
  288. package/src/resources/print-mail/contacts.ts +167 -4
  289. package/src/resources/print-mail/index.ts +74 -11
  290. package/src/resources/print-mail/letters.ts +150 -12
  291. package/src/resources/print-mail/mailing-list-imports.ts +5 -1
  292. package/src/resources/print-mail/mailing-lists.ts +5 -1
  293. package/src/resources/print-mail/postcards.ts +208 -20
  294. package/src/resources/print-mail/print-mail.ts +239 -261
  295. package/src/resources/print-mail/reports/exports.ts +7 -0
  296. package/src/resources/print-mail/reports/reports.ts +7 -0
  297. package/src/resources/print-mail/reports/samples.ts +7 -0
  298. package/src/resources/print-mail/self-mailers.ts +162 -20
  299. package/src/resources/print-mail/snap-packs.ts +1484 -0
  300. package/src/resources/print-mail/sub-organizations.ts +35 -23
  301. package/src/resources/print-mail/targeted-list-builds/filters.ts +113 -0
  302. package/src/resources/print-mail/targeted-list-builds/index.ts +16 -0
  303. package/src/resources/print-mail/targeted-list-builds/targeted-list-builds.ts +2158 -0
  304. package/{resources/print-mail/order-profiles.mjs → src/resources/print-mail/targeted-list-builds.ts} +2 -2
  305. package/src/resources/print-mail/template-editor-sessions.ts +435 -0
  306. package/src/resources/print-mail/trackers.ts +513 -0
  307. package/src/resources/print-mail/virtual-mailboxes/index.ts +22 -0
  308. package/src/resources/print-mail/virtual-mailboxes/items.ts +296 -0
  309. package/src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts +434 -0
  310. package/src/resources/print-mail/{order-profiles.ts → virtual-mailboxes.ts} +1 -1
  311. package/src/version.ts +1 -1
  312. package/version.d.mts +1 -1
  313. package/version.d.ts +1 -1
  314. package/version.js +1 -1
  315. package/version.mjs +1 -1
  316. package/internal/qs/formats.d.mts +0 -7
  317. package/internal/qs/formats.d.mts.map +0 -1
  318. package/internal/qs/formats.d.ts +0 -7
  319. package/internal/qs/formats.d.ts.map +0 -1
  320. package/internal/qs/formats.js +0 -13
  321. package/internal/qs/formats.js.map +0 -1
  322. package/internal/qs/formats.mjs +0 -9
  323. package/internal/qs/formats.mjs.map +0 -1
  324. package/internal/qs/index.d.mts +0 -10
  325. package/internal/qs/index.d.mts.map +0 -1
  326. package/internal/qs/index.d.ts +0 -10
  327. package/internal/qs/index.d.ts.map +0 -1
  328. package/internal/qs/index.js +0 -14
  329. package/internal/qs/index.js.map +0 -1
  330. package/internal/qs/index.mjs +0 -10
  331. package/internal/qs/index.mjs.map +0 -1
  332. package/internal/qs/stringify.d.mts +0 -3
  333. package/internal/qs/stringify.d.mts.map +0 -1
  334. package/internal/qs/stringify.d.ts +0 -3
  335. package/internal/qs/stringify.d.ts.map +0 -1
  336. package/internal/qs/stringify.js +0 -277
  337. package/internal/qs/stringify.js.map +0 -1
  338. package/internal/qs/stringify.mjs +0 -274
  339. package/internal/qs/stringify.mjs.map +0 -1
  340. package/internal/qs/types.d.mts +0 -57
  341. package/internal/qs/types.d.mts.map +0 -1
  342. package/internal/qs/types.d.ts +0 -57
  343. package/internal/qs/types.d.ts.map +0 -1
  344. package/internal/qs/types.js +0 -3
  345. package/internal/qs/types.js.map +0 -1
  346. package/internal/qs/types.mjs +0 -2
  347. package/internal/qs/types.mjs.map +0 -1
  348. package/internal/qs/utils.d.mts +0 -15
  349. package/internal/qs/utils.d.mts.map +0 -1
  350. package/internal/qs/utils.d.ts +0 -15
  351. package/internal/qs/utils.d.ts.map +0 -1
  352. package/internal/qs/utils.js +0 -230
  353. package/internal/qs/utils.js.map +0 -1
  354. package/internal/qs/utils.mjs +0 -217
  355. package/internal/qs/utils.mjs.map +0 -1
  356. package/resources/print-mail/order-profiles/cheques.d.mts +0 -388
  357. package/resources/print-mail/order-profiles/cheques.d.mts.map +0 -1
  358. package/resources/print-mail/order-profiles/cheques.d.ts +0 -388
  359. package/resources/print-mail/order-profiles/cheques.d.ts.map +0 -1
  360. package/resources/print-mail/order-profiles/cheques.js +0 -98
  361. package/resources/print-mail/order-profiles/cheques.js.map +0 -1
  362. package/resources/print-mail/order-profiles/cheques.mjs +0 -94
  363. package/resources/print-mail/order-profiles/cheques.mjs.map +0 -1
  364. package/resources/print-mail/order-profiles/index.d.mts +0 -6
  365. package/resources/print-mail/order-profiles/index.d.mts.map +0 -1
  366. package/resources/print-mail/order-profiles/index.d.ts +0 -6
  367. package/resources/print-mail/order-profiles/index.d.ts.map +0 -1
  368. package/resources/print-mail/order-profiles/index.js +0 -15
  369. package/resources/print-mail/order-profiles/index.js.map +0 -1
  370. package/resources/print-mail/order-profiles/index.mjs +0 -7
  371. package/resources/print-mail/order-profiles/index.mjs.map +0 -1
  372. package/resources/print-mail/order-profiles/letters.d.mts +0 -325
  373. package/resources/print-mail/order-profiles/letters.d.mts.map +0 -1
  374. package/resources/print-mail/order-profiles/letters.d.ts +0 -325
  375. package/resources/print-mail/order-profiles/letters.d.ts.map +0 -1
  376. package/resources/print-mail/order-profiles/letters.js +0 -105
  377. package/resources/print-mail/order-profiles/letters.js.map +0 -1
  378. package/resources/print-mail/order-profiles/letters.mjs +0 -101
  379. package/resources/print-mail/order-profiles/letters.mjs.map +0 -1
  380. package/resources/print-mail/order-profiles/order-profiles.d.mts +0 -22
  381. package/resources/print-mail/order-profiles/order-profiles.d.mts.map +0 -1
  382. package/resources/print-mail/order-profiles/order-profiles.d.ts +0 -22
  383. package/resources/print-mail/order-profiles/order-profiles.d.ts.map +0 -1
  384. package/resources/print-mail/order-profiles/order-profiles.js +0 -29
  385. package/resources/print-mail/order-profiles/order-profiles.js.map +0 -1
  386. package/resources/print-mail/order-profiles/order-profiles.mjs +0 -24
  387. package/resources/print-mail/order-profiles/order-profiles.mjs.map +0 -1
  388. package/resources/print-mail/order-profiles/postcards.d.mts +0 -255
  389. package/resources/print-mail/order-profiles/postcards.d.mts.map +0 -1
  390. package/resources/print-mail/order-profiles/postcards.d.ts +0 -255
  391. package/resources/print-mail/order-profiles/postcards.d.ts.map +0 -1
  392. package/resources/print-mail/order-profiles/postcards.js +0 -97
  393. package/resources/print-mail/order-profiles/postcards.js.map +0 -1
  394. package/resources/print-mail/order-profiles/postcards.mjs +0 -93
  395. package/resources/print-mail/order-profiles/postcards.mjs.map +0 -1
  396. package/resources/print-mail/order-profiles/self-mailers.d.mts +0 -260
  397. package/resources/print-mail/order-profiles/self-mailers.d.mts.map +0 -1
  398. package/resources/print-mail/order-profiles/self-mailers.d.ts +0 -260
  399. package/resources/print-mail/order-profiles/self-mailers.d.ts.map +0 -1
  400. package/resources/print-mail/order-profiles/self-mailers.js +0 -95
  401. package/resources/print-mail/order-profiles/self-mailers.js.map +0 -1
  402. package/resources/print-mail/order-profiles/self-mailers.mjs +0 -91
  403. package/resources/print-mail/order-profiles/self-mailers.mjs.map +0 -1
  404. package/resources/print-mail/order-profiles.d.mts +0 -2
  405. package/resources/print-mail/order-profiles.d.mts.map +0 -1
  406. package/resources/print-mail/order-profiles.d.ts +0 -2
  407. package/resources/print-mail/order-profiles.d.ts.map +0 -1
  408. package/resources/print-mail/order-profiles.js.map +0 -1
  409. package/resources/print-mail/order-profiles.mjs.map +0 -1
  410. package/src/internal/qs/LICENSE.md +0 -13
  411. package/src/internal/qs/README.md +0 -3
  412. package/src/internal/qs/formats.ts +0 -10
  413. package/src/internal/qs/index.ts +0 -13
  414. package/src/internal/qs/stringify.ts +0 -385
  415. package/src/internal/qs/types.ts +0 -71
  416. package/src/internal/qs/utils.ts +0 -265
  417. package/src/resources/print-mail/order-profiles/cheques.ts +0 -486
  418. package/src/resources/print-mail/order-profiles/index.ts +0 -47
  419. package/src/resources/print-mail/order-profiles/letters.ts +0 -412
  420. package/src/resources/print-mail/order-profiles/order-profiles.ts +0 -113
  421. package/src/resources/print-mail/order-profiles/postcards.ts +0 -327
  422. package/src/resources/print-mail/order-profiles/self-mailers.ts +0 -338
@@ -0,0 +1,92 @@
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.VirtualMailboxes = void 0;
5
+ const tslib_1 = require("../../../internal/tslib.js");
6
+ const resource_1 = require("../../../core/resource.js");
7
+ const ItemsAPI = tslib_1.__importStar(require("./items.js"));
8
+ const items_1 = require("./items.js");
9
+ const pagination_1 = require("../../../core/pagination.js");
10
+ const path_1 = require("../../../internal/utils/path.js");
11
+ /**
12
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
13
+ * without needing a traditional physical mailbox. Each mailbox is fully
14
+ * digital, giving you a unique ID, status, and a set of capabilities such as
15
+ * forwarding mail to another address or viewing envelope scans. This allows you
16
+ * to manage physical correspondence entirely online.
17
+ *
18
+ * You can request access to this feature by reaching out to
19
+ * support@postgrid.com
20
+ */
21
+ class VirtualMailboxes extends resource_1.APIResource {
22
+ constructor() {
23
+ super(...arguments);
24
+ this.items = new ItemsAPI.Items(this._client);
25
+ }
26
+ /**
27
+ * Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending
28
+ * assignment and cannot be used until it has been assigned and activated by our
29
+ * team. You will be notified via email once the virtual mailbox has been
30
+ * activated. In test mode, the virtual mailbox will be activated immediately upon
31
+ * creation.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const virtualMailbox =
36
+ * await client.printMail.virtualMailboxes.create({
37
+ * countryCode: 'US',
38
+ * capabilities: {
39
+ * envelopeScans: true,
40
+ * forwardMailTo: 'contact_pxd7wnnD1xY6H6etKNvjb4',
41
+ * },
42
+ * });
43
+ * ```
44
+ */
45
+ create(body, options) {
46
+ return this._client.post('/print-mail/v1/virtual_mailboxes', { body, ...options });
47
+ }
48
+ /**
49
+ * Retrieve Virtual Mailbox
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * const virtualMailbox =
54
+ * await client.printMail.virtualMailboxes.retrieve('id');
55
+ * ```
56
+ */
57
+ retrieve(id, options) {
58
+ return this._client.get((0, path_1.path) `/print-mail/v1/virtual_mailboxes/${id}`, options);
59
+ }
60
+ /**
61
+ * Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query
62
+ * parameters to refine the list.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * // Automatically fetches more pages as needed.
67
+ * for await (const virtualMailboxListResponse of client.printMail.virtualMailboxes.list()) {
68
+ * // ...
69
+ * }
70
+ * ```
71
+ */
72
+ list(query = {}, options) {
73
+ return this._client.getAPIList('/print-mail/v1/virtual_mailboxes', (pagination_1.SkipLimit), { query, ...options });
74
+ }
75
+ /**
76
+ * Retrieves the physical address of the virtual mailbox.
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * const response =
81
+ * await client.printMail.virtualMailboxes.retrieveAddress(
82
+ * 'id',
83
+ * );
84
+ * ```
85
+ */
86
+ retrieveAddress(id, options) {
87
+ return this._client.get((0, path_1.path) `/print-mail/v1/virtual_mailboxes/${id}/address`, options);
88
+ }
89
+ }
90
+ exports.VirtualMailboxes = VirtualMailboxes;
91
+ VirtualMailboxes.Items = items_1.Items;
92
+ //# sourceMappingURL=virtual-mailboxes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.js","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,6DAAoC;AACpC,sCASiB;AAEjB,4DAAwF;AAExF,0DAAoD;AAEpD;;;;;;;;;GASG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8E3D,CAAC;IA5EC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kCAAkC,EAClC,CAAA,sBAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAU,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AA/ED,4CA+EC;AA6SD,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC"}
@@ -0,0 +1,87 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import * as ItemsAPI from "./items.mjs";
4
+ import { Items, } from "./items.mjs";
5
+ import { SkipLimit } from "../../../core/pagination.mjs";
6
+ import { path } from "../../../internal/utils/path.mjs";
7
+ /**
8
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
9
+ * without needing a traditional physical mailbox. Each mailbox is fully
10
+ * digital, giving you a unique ID, status, and a set of capabilities such as
11
+ * forwarding mail to another address or viewing envelope scans. This allows you
12
+ * to manage physical correspondence entirely online.
13
+ *
14
+ * You can request access to this feature by reaching out to
15
+ * support@postgrid.com
16
+ */
17
+ export class VirtualMailboxes extends APIResource {
18
+ constructor() {
19
+ super(...arguments);
20
+ this.items = new ItemsAPI.Items(this._client);
21
+ }
22
+ /**
23
+ * Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending
24
+ * assignment and cannot be used until it has been assigned and activated by our
25
+ * team. You will be notified via email once the virtual mailbox has been
26
+ * activated. In test mode, the virtual mailbox will be activated immediately upon
27
+ * creation.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const virtualMailbox =
32
+ * await client.printMail.virtualMailboxes.create({
33
+ * countryCode: 'US',
34
+ * capabilities: {
35
+ * envelopeScans: true,
36
+ * forwardMailTo: 'contact_pxd7wnnD1xY6H6etKNvjb4',
37
+ * },
38
+ * });
39
+ * ```
40
+ */
41
+ create(body, options) {
42
+ return this._client.post('/print-mail/v1/virtual_mailboxes', { body, ...options });
43
+ }
44
+ /**
45
+ * Retrieve Virtual Mailbox
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const virtualMailbox =
50
+ * await client.printMail.virtualMailboxes.retrieve('id');
51
+ * ```
52
+ */
53
+ retrieve(id, options) {
54
+ return this._client.get(path `/print-mail/v1/virtual_mailboxes/${id}`, options);
55
+ }
56
+ /**
57
+ * Lists virtual mailboxes. You can use the `skip`, `limit`, and `search` query
58
+ * parameters to refine the list.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * // Automatically fetches more pages as needed.
63
+ * for await (const virtualMailboxListResponse of client.printMail.virtualMailboxes.list()) {
64
+ * // ...
65
+ * }
66
+ * ```
67
+ */
68
+ list(query = {}, options) {
69
+ return this._client.getAPIList('/print-mail/v1/virtual_mailboxes', (SkipLimit), { query, ...options });
70
+ }
71
+ /**
72
+ * Retrieves the physical address of the virtual mailbox.
73
+ *
74
+ * @example
75
+ * ```ts
76
+ * const response =
77
+ * await client.printMail.virtualMailboxes.retrieveAddress(
78
+ * 'id',
79
+ * );
80
+ * ```
81
+ */
82
+ retrieveAddress(id, options) {
83
+ return this._client.get(path `/print-mail/v1/virtual_mailboxes/${id}/address`, options);
84
+ }
85
+ }
86
+ VirtualMailboxes.Items = Items;
87
+ //# sourceMappingURL=virtual-mailboxes.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,QAAQ;OACb,EAQL,KAAK,GACN;OAEM,EAAe,SAAS,EAAwB;OAEhD,EAAE,IAAI,EAAE;AAEf;;;;;;;;;GASG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8E3D,CAAC;IA5EC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oCAAoC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kCAAkC,EAClC,CAAA,SAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAU,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oCAAoC,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AA6SD,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC"}
@@ -0,0 +1,2 @@
1
+ export * from "./virtual-mailboxes/index.mjs";
2
+ //# sourceMappingURL=virtual-mailboxes.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/virtual-mailboxes.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./virtual-mailboxes/index.js";
2
+ //# sourceMappingURL=virtual-mailboxes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/virtual-mailboxes.ts"],"names":[],"mappings":""}
@@ -2,5 +2,5 @@
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  const tslib_1 = require("../../internal/tslib.js");
5
- tslib_1.__exportStar(require("./order-profiles/index.js"), exports);
6
- //# sourceMappingURL=order-profiles.js.map
5
+ tslib_1.__exportStar(require("./virtual-mailboxes/index.js"), exports);
6
+ //# sourceMappingURL=virtual-mailboxes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.js","sourceRoot":"","sources":["../../src/resources/print-mail/virtual-mailboxes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uEAA0C"}
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export * from "./virtual-mailboxes/index.mjs";
3
+ //# sourceMappingURL=virtual-mailboxes.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"virtual-mailboxes.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/virtual-mailboxes.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
package/src/client.ts CHANGED
@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
11
11
  import { getPlatformHeaders } from './internal/detect-platform';
12
12
  import * as Shims from './internal/shims';
13
13
  import * as Opts from './internal/request-options';
14
- import * as qs from './internal/qs';
14
+ import { stringifyQuery } from './internal/utils/query';
15
15
  import { VERSION } from './version';
16
16
  import * as Errors from './core/error';
17
17
  import * as Pagination from './core/pagination';
@@ -21,6 +21,21 @@ import * as API from './resources/index';
21
21
  import { APIPromise } from './core/api-promise';
22
22
  import {
23
23
  AddressVerification,
24
+ AddressVerificationAutocompleteParams,
25
+ AddressVerificationAutocompleteResponse,
26
+ AddressVerificationBatchVerificationParams,
27
+ AddressVerificationBatchVerificationResponse,
28
+ AddressVerificationGetAutocompletePreviewsParams,
29
+ AddressVerificationGetAutocompletePreviewsResponse,
30
+ AddressVerificationGetLookupInfoResponse,
31
+ AddressVerificationLookupCityOrStateFromPostalOrZipCodeParams,
32
+ AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse,
33
+ AddressVerificationLookupZipCodeFromCityOrStateParams,
34
+ AddressVerificationLookupZipCodeFromCityOrStateResponse,
35
+ AddressVerificationParseAnAddressParams,
36
+ AddressVerificationParseAnAddressResponse,
37
+ AddressVerificationSuggestAddressesParams,
38
+ AddressVerificationSuggestAddressesResponse,
24
39
  AddressVerificationVerifyParams,
25
40
  AddressVerificationVerifyResponse,
26
41
  Errors as AddressVerificationAPIErrors,
@@ -28,14 +43,18 @@ import {
28
43
  } from './resources/address-verification';
29
44
  import {
30
45
  IntlAddressVerification,
46
+ IntlAddressVerificationAutocompleteParams,
47
+ IntlAddressVerificationAutocompleteResponse,
48
+ IntlAddressVerificationBatchVerificationParams,
49
+ IntlAddressVerificationBatchVerificationResponse,
50
+ IntlAddressVerificationGetAutocompleteAdvancedPreviewsParams,
51
+ IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse,
52
+ IntlAddressVerificationGetAutocompletePreviewsParams,
53
+ IntlAddressVerificationGetAutocompletePreviewsResponse,
31
54
  IntlAddressVerificationVerifyParams,
32
55
  IntlAddressVerificationVerifyResponse,
33
56
  } from './resources/intl-address-verification';
34
- import {
35
- ContactCreateWithCompanyName,
36
- ContactCreateWithFirstName,
37
- PrintMail,
38
- } from './resources/print-mail/print-mail';
57
+ import { PrintMail } from './resources/print-mail/print-mail';
39
58
  import { type Fetch } from './internal/builtin-types';
40
59
  import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
41
60
  import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -63,7 +82,7 @@ export interface ClientOptions {
63
82
  /**
64
83
  * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
65
84
  *
66
- * Defaults to process.env['POST_GRID_BASE_URL'].
85
+ * Defaults to process.env['POSTGRID_BASE_URL'].
67
86
  */
68
87
  baseURL?: string | null | undefined;
69
88
 
@@ -117,7 +136,7 @@ export interface ClientOptions {
117
136
  /**
118
137
  * Set the log level.
119
138
  *
120
- * Defaults to process.env['POST_GRID_LOG'] or 'warn' if it isn't set.
139
+ * Defaults to process.env['POSTGRID_LOG'] or 'warn' if it isn't set.
121
140
  */
122
141
  logLevel?: LogLevel | undefined;
123
142
 
@@ -130,7 +149,7 @@ export interface ClientOptions {
130
149
  }
131
150
 
132
151
  /**
133
- * API Client for interfacing with the Post Grid API.
152
+ * API Client for interfacing with the PostGrid API.
134
153
  */
135
154
  export class PostGrid {
136
155
  addressVerificationAPIKey: string | null;
@@ -139,7 +158,7 @@ export class PostGrid {
139
158
  baseURL: string;
140
159
  maxRetries: number;
141
160
  timeout: number;
142
- logger: Logger | undefined;
161
+ logger: Logger;
143
162
  logLevel: LogLevel | undefined;
144
163
  fetchOptions: MergedRequestInit | undefined;
145
164
 
@@ -149,11 +168,11 @@ export class PostGrid {
149
168
  private _options: ClientOptions;
150
169
 
151
170
  /**
152
- * API Client for interfacing with the Post Grid API.
171
+ * API Client for interfacing with the PostGrid API.
153
172
  *
154
173
  * @param {string | null | undefined} [opts.addressVerificationAPIKey=process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'] ?? null]
155
174
  * @param {string | null | undefined} [opts.printMailAPIKey=process.env['POSTGRID_PRINT_MAIL_API_KEY'] ?? null]
156
- * @param {string} [opts.baseURL=process.env['POST_GRID_BASE_URL'] ?? https://api.postgrid.com] - Override the default base URL for the API.
175
+ * @param {string} [opts.baseURL=process.env['POSTGRID_BASE_URL'] ?? https://api.postgrid.com] - Override the default base URL for the API.
157
176
  * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
158
177
  * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
159
178
  * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -162,7 +181,7 @@ export class PostGrid {
162
181
  * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
163
182
  */
164
183
  constructor({
165
- baseURL = readEnv('POST_GRID_BASE_URL'),
184
+ baseURL = readEnv('POSTGRID_BASE_URL'),
166
185
  addressVerificationAPIKey = readEnv('POSTGRID_ADDRESS_VERIFICATION_API_KEY') ?? null,
167
186
  printMailAPIKey = readEnv('POSTGRID_PRINT_MAIL_API_KEY') ?? null,
168
187
  ...opts
@@ -182,13 +201,25 @@ export class PostGrid {
182
201
  this.logLevel = defaultLogLevel;
183
202
  this.logLevel =
184
203
  parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
185
- parseLogLevel(readEnv('POST_GRID_LOG'), "process.env['POST_GRID_LOG']", this) ??
204
+ parseLogLevel(readEnv('POSTGRID_LOG'), "process.env['POSTGRID_LOG']", this) ??
186
205
  defaultLogLevel;
187
206
  this.fetchOptions = options.fetchOptions;
188
207
  this.maxRetries = options.maxRetries ?? 2;
189
208
  this.fetch = options.fetch ?? Shims.getDefaultFetch();
190
209
  this.#encoder = Opts.FallbackEncoder;
191
210
 
211
+ const customHeadersEnv = readEnv('POSTGRID_CUSTOM_HEADERS');
212
+ if (customHeadersEnv) {
213
+ const parsed: Record<string, string> = {};
214
+ for (const line of customHeadersEnv.split('\n')) {
215
+ const colon = line.indexOf(':');
216
+ if (colon >= 0) {
217
+ parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
218
+ }
219
+ }
220
+ options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
221
+ }
222
+
192
223
  this._options = options;
193
224
 
194
225
  this.addressVerificationAPIKey = addressVerificationAPIKey;
@@ -269,8 +300,11 @@ export class PostGrid {
269
300
  return buildHeaders([{ 'X-API-Key': this.printMailAPIKey }]);
270
301
  }
271
302
 
272
- protected stringifyQuery(query: Record<string, unknown>): string {
273
- return qs.stringify(query, { arrayFormat: 'comma' });
303
+ /**
304
+ * Basic re-implementation of `qs.stringify` for primitive types.
305
+ */
306
+ protected stringifyQuery(query: object | Record<string, unknown>): string {
307
+ return stringifyQuery(query);
274
308
  }
275
309
 
276
310
  private getUserAgent(): string {
@@ -302,12 +336,13 @@ export class PostGrid {
302
336
  : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
303
337
 
304
338
  const defaultQuery = this.defaultQuery();
305
- if (!isEmptyObj(defaultQuery)) {
306
- query = { ...defaultQuery, ...query };
339
+ const pathQuery = Object.fromEntries(url.searchParams);
340
+ if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
341
+ query = { ...pathQuery, ...defaultQuery, ...query };
307
342
  }
308
343
 
309
344
  if (typeof query === 'object' && query && !Array.isArray(query)) {
310
- url.search = this.stringifyQuery(query as Record<string, unknown>);
345
+ url.search = this.stringifyQuery(query);
311
346
  }
312
347
 
313
348
  return url.toString();
@@ -503,7 +538,7 @@ export class PostGrid {
503
538
  loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
504
539
 
505
540
  const errText = await response.text().catch((err: any) => castToError(err).message);
506
- const errJSON = safeJSON(errText);
541
+ const errJSON = safeJSON(errText) as any;
507
542
  const errMessage = errJSON ? undefined : errText;
508
543
 
509
544
  loggerFor(this).debug(
@@ -540,9 +575,14 @@ export class PostGrid {
540
575
  getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
541
576
  path: string,
542
577
  Page: new (...args: any[]) => PageClass,
543
- opts?: RequestOptions,
578
+ opts?: PromiseOrValue<RequestOptions>,
544
579
  ): Pagination.PagePromise<PageClass, Item> {
545
- return this.requestAPIList(Page, { method: 'get', path, ...opts });
580
+ return this.requestAPIList(
581
+ Page,
582
+ opts && 'then' in opts ?
583
+ opts.then((opts) => ({ method: 'get', path, ...opts }))
584
+ : { method: 'get', path, ...opts },
585
+ );
546
586
  }
547
587
 
548
588
  requestAPIList<
@@ -550,7 +590,7 @@ export class PostGrid {
550
590
  PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
551
591
  >(
552
592
  Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
553
- options: FinalRequestOptions,
593
+ options: PromiseOrValue<FinalRequestOptions>,
554
594
  ): Pagination.PagePromise<PageClass, Item> {
555
595
  const request = this.makeRequest(options, null, undefined);
556
596
  return new Pagination.PagePromise<PageClass, Item>(this as any as PostGrid, request, Page);
@@ -563,9 +603,10 @@ export class PostGrid {
563
603
  controller: AbortController,
564
604
  ): Promise<Response> {
565
605
  const { signal, method, ...options } = init || {};
566
- if (signal) signal.addEventListener('abort', () => controller.abort());
606
+ const abort = this._makeAbort(controller);
607
+ if (signal) signal.addEventListener('abort', abort, { once: true });
567
608
 
568
- const timeout = setTimeout(() => controller.abort(), ms);
609
+ const timeout = setTimeout(abort, ms);
569
610
 
570
611
  const isReadableBody =
571
612
  ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -642,9 +683,9 @@ export class PostGrid {
642
683
  }
643
684
  }
644
685
 
645
- // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
646
- // just do what it says, but otherwise calculate a default
647
- if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
686
+ // If the API asks us to wait a certain amount of time, just do what it
687
+ // says, but otherwise calculate a default
688
+ if (timeoutMillis === undefined) {
648
689
  const maxRetries = options.maxRetries ?? this.maxRetries;
649
690
  timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
650
691
  }
@@ -732,6 +773,12 @@ export class PostGrid {
732
773
  return headers.values;
733
774
  }
734
775
 
776
+ private _makeAbort(controller: AbortController) {
777
+ // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
778
+ // would capture all request options, and cause a memory leak.
779
+ return () => controller.abort();
780
+ }
781
+
735
782
  private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
736
783
  bodyHeaders: HeadersLike;
737
784
  body: BodyInit | undefined;
@@ -764,6 +811,14 @@ export class PostGrid {
764
811
  (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
765
812
  ) {
766
813
  return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
814
+ } else if (
815
+ typeof body === 'object' &&
816
+ headers.values.get('content-type') === 'application/x-www-form-urlencoded'
817
+ ) {
818
+ return {
819
+ bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
820
+ body: this.stringifyQuery(body),
821
+ };
767
822
  } else {
768
823
  return this.#encoder({ body, headers });
769
824
  }
@@ -788,7 +843,23 @@ export class PostGrid {
788
843
 
789
844
  static toFile = Uploads.toFile;
790
845
 
846
+ /**
847
+ * Standard Address Verification API.
848
+ *
849
+ * Provides endpoints to verify and standardize addresses across US and Canada,
850
+ * supporting both structured and freeform inputs.
851
+ *
852
+ * Note that this uses a different set of lookups than our international API.
853
+ *
854
+ */
791
855
  addressVerification: API.AddressVerification = new API.AddressVerification(this);
856
+ /**
857
+ * International Address Verification API.
858
+ *
859
+ * Provides endpoints to verify and standardize international addresses,
860
+ * supporting both structured and freeform inputs.
861
+ *
862
+ */
792
863
  intlAddressVerification: API.IntlAddressVerification = new API.IntlAddressVerification(this);
793
864
  printMail: API.PrintMail = new API.PrintMail(this);
794
865
  }
@@ -807,19 +878,38 @@ export declare namespace PostGrid {
807
878
  AddressVerification as AddressVerification,
808
879
  type AddressVerificationAPIErrors as Errors,
809
880
  type Status as Status,
881
+ type AddressVerificationAutocompleteResponse as AddressVerificationAutocompleteResponse,
882
+ type AddressVerificationBatchVerificationResponse as AddressVerificationBatchVerificationResponse,
883
+ type AddressVerificationGetAutocompletePreviewsResponse as AddressVerificationGetAutocompletePreviewsResponse,
884
+ type AddressVerificationGetLookupInfoResponse as AddressVerificationGetLookupInfoResponse,
885
+ type AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse as AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse,
886
+ type AddressVerificationLookupZipCodeFromCityOrStateResponse as AddressVerificationLookupZipCodeFromCityOrStateResponse,
887
+ type AddressVerificationParseAnAddressResponse as AddressVerificationParseAnAddressResponse,
888
+ type AddressVerificationSuggestAddressesResponse as AddressVerificationSuggestAddressesResponse,
810
889
  type AddressVerificationVerifyResponse as AddressVerificationVerifyResponse,
890
+ type AddressVerificationAutocompleteParams as AddressVerificationAutocompleteParams,
891
+ type AddressVerificationBatchVerificationParams as AddressVerificationBatchVerificationParams,
892
+ type AddressVerificationGetAutocompletePreviewsParams as AddressVerificationGetAutocompletePreviewsParams,
893
+ type AddressVerificationLookupCityOrStateFromPostalOrZipCodeParams as AddressVerificationLookupCityOrStateFromPostalOrZipCodeParams,
894
+ type AddressVerificationLookupZipCodeFromCityOrStateParams as AddressVerificationLookupZipCodeFromCityOrStateParams,
895
+ type AddressVerificationParseAnAddressParams as AddressVerificationParseAnAddressParams,
896
+ type AddressVerificationSuggestAddressesParams as AddressVerificationSuggestAddressesParams,
811
897
  type AddressVerificationVerifyParams as AddressVerificationVerifyParams,
812
898
  };
813
899
 
814
900
  export {
815
901
  IntlAddressVerification as IntlAddressVerification,
902
+ type IntlAddressVerificationAutocompleteResponse as IntlAddressVerificationAutocompleteResponse,
903
+ type IntlAddressVerificationBatchVerificationResponse as IntlAddressVerificationBatchVerificationResponse,
904
+ type IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse as IntlAddressVerificationGetAutocompleteAdvancedPreviewsResponse,
905
+ type IntlAddressVerificationGetAutocompletePreviewsResponse as IntlAddressVerificationGetAutocompletePreviewsResponse,
816
906
  type IntlAddressVerificationVerifyResponse as IntlAddressVerificationVerifyResponse,
907
+ type IntlAddressVerificationAutocompleteParams as IntlAddressVerificationAutocompleteParams,
908
+ type IntlAddressVerificationBatchVerificationParams as IntlAddressVerificationBatchVerificationParams,
909
+ type IntlAddressVerificationGetAutocompleteAdvancedPreviewsParams as IntlAddressVerificationGetAutocompleteAdvancedPreviewsParams,
910
+ type IntlAddressVerificationGetAutocompletePreviewsParams as IntlAddressVerificationGetAutocompletePreviewsParams,
817
911
  type IntlAddressVerificationVerifyParams as IntlAddressVerificationVerifyParams,
818
912
  };
819
913
 
820
- export {
821
- PrintMail as PrintMail,
822
- type ContactCreateWithCompanyName as ContactCreateWithCompanyName,
823
- type ContactCreateWithFirstName as ContactCreateWithFirstName,
824
- };
914
+ export { PrintMail as PrintMail };
825
915
  }
@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: PostGrid, props: APIRespon
29
29
  const mediaType = contentType?.split(';')[0]?.trim();
30
30
  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
31
31
  if (isJSON) {
32
+ const contentLength = response.headers.get('content-length');
33
+ if (contentLength === '0') {
34
+ // if there is no content we can't do anything
35
+ return undefined as T;
36
+ }
37
+
32
38
  const json = await response.json();
33
39
  return json as T;
34
40
  }
@@ -40,7 +40,6 @@ type OverloadedParameters<T> =
40
40
  : T extends (...args: infer A) => unknown ? A
41
41
  : never;
42
42
 
43
- /* eslint-disable */
44
43
  /**
45
44
  * These imports attempt to get types from a parent package's dependencies.
46
45
  * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
@@ -63,19 +62,18 @@ type OverloadedParameters<T> =
63
62
  *
64
63
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
65
64
  */
66
- /** @ts-ignore For users with \@types/node */
65
+ /** @ts-ignore For users with \@types/node */ /* prettier-ignore */
67
66
  type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
68
- /** @ts-ignore For users with undici */
67
+ /** @ts-ignore For users with undici */ /* prettier-ignore */
69
68
  type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
70
- /** @ts-ignore For users with \@types/bun */
69
+ /** @ts-ignore For users with \@types/bun */ /* prettier-ignore */
71
70
  type BunRequestInit = globalThis.FetchRequestInit;
72
- /** @ts-ignore For users with node-fetch@2 */
71
+ /** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */
73
72
  type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
74
- /** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
73
+ /** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */
75
74
  type NodeFetch3RequestInit = NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
76
- /** @ts-ignore For users who use Deno */
75
+ /** @ts-ignore For users who use Deno */ /* prettier-ignore */
77
76
  type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
78
- /* eslint-enable */
79
77
 
80
78
  type RequestInits =
81
79
  | NotAny<UndiciTypesRequestInit>
@@ -9,10 +9,10 @@
9
9
  */
10
10
  export const readEnv = (env: string): string | undefined => {
11
11
  if (typeof (globalThis as any).process !== 'undefined') {
12
- return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
12
+ return (globalThis as any).process.env?.[env]?.trim() || undefined;
13
13
  }
14
14
  if (typeof (globalThis as any).Deno !== 'undefined') {
15
- return (globalThis as any).Deno.env?.get?.(env)?.trim();
15
+ return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
16
16
  }
17
17
  return undefined;
18
18
  };
@@ -106,8 +106,9 @@ export const formatRequestDetails = (details: {
106
106
  ([name, value]) => [
107
107
  name,
108
108
  (
109
- name.toLowerCase() === 'x-api-key' ||
110
109
  name.toLowerCase() === 'authorization' ||
110
+ name.toLowerCase() === 'api-key' ||
111
+ name.toLowerCase() === 'x-api-key' ||
111
112
  name.toLowerCase() === 'cookie' ||
112
113
  name.toLowerCase() === 'set-cookie'
113
114
  ) ?
@@ -0,0 +1,23 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { PostGridError } from '../../core/error';
4
+
5
+ /**
6
+ * Basic re-implementation of `qs.stringify` for primitive types.
7
+ */
8
+ export function stringifyQuery(query: object | Record<string, unknown>) {
9
+ return Object.entries(query)
10
+ .filter(([_, value]) => typeof value !== 'undefined')
11
+ .map(([key, value]) => {
12
+ if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
13
+ return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
14
+ }
15
+ if (value === null) {
16
+ return `${encodeURIComponent(key)}=`;
17
+ }
18
+ throw new PostGridError(
19
+ `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
20
+ );
21
+ })
22
+ .join('&');
23
+ }