postgrid-node 0.5.0 → 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 +84 -0
  2. package/LICENSE +1 -1
  3. package/README.md +13 -10
  4. package/client.d.mts +30 -10
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +30 -10
  7. package/client.d.ts.map +1 -1
  8. package/client.js +56 -10
  9. package/client.js.map +1 -1
  10. package/client.mjs +57 -11
  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 +7 -1
  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 +995 -0
  70. package/resources/print-mail/boxes.d.mts.map +1 -0
  71. package/resources/print-mail/boxes.d.ts +995 -0
  72. package/resources/print-mail/boxes.d.ts.map +1 -0
  73. package/resources/print-mail/boxes.js +103 -0
  74. package/resources/print-mail/boxes.js.map +1 -0
  75. package/resources/print-mail/boxes.mjs +99 -0
  76. package/resources/print-mail/boxes.mjs.map +1 -0
  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 +35 -5
  86. package/resources/print-mail/cheques.d.mts.map +1 -1
  87. package/resources/print-mail/cheques.d.ts +35 -5
  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 -7
  100. package/resources/print-mail/index.d.mts.map +1 -1
  101. package/resources/print-mail/index.d.ts +12 -7
  102. package/resources/print-mail/index.d.ts.map +1 -1
  103. package/resources/print-mail/index.js +15 -5
  104. package/resources/print-mail/index.js.map +1 -1
  105. package/resources/print-mail/index.mjs +6 -1
  106. package/resources/print-mail/index.mjs.map +1 -1
  107. package/resources/print-mail/letters.d.mts +36 -6
  108. package/resources/print-mail/letters.d.mts.map +1 -1
  109. package/resources/print-mail/letters.d.ts +36 -6
  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 +63 -13
  132. package/resources/print-mail/postcards.d.mts.map +1 -1
  133. package/resources/print-mail/postcards.d.ts +63 -13
  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 +42 -159
  140. package/resources/print-mail/print-mail.d.mts.map +1 -1
  141. package/resources/print-mail/print-mail.d.ts +42 -159
  142. package/resources/print-mail/print-mail.d.ts.map +1 -1
  143. package/resources/print-mail/print-mail.js +36 -16
  144. package/resources/print-mail/print-mail.js.map +1 -1
  145. package/resources/print-mail/print-mail.mjs +36 -16
  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 +25 -12
  172. package/resources/print-mail/self-mailers.d.mts.map +1 -1
  173. package/resources/print-mail/self-mailers.d.ts +25 -12
  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 +116 -26
  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 +1324 -0
  286. package/src/resources/print-mail/campaigns.ts +1449 -59
  287. package/src/resources/print-mail/cheques.ts +42 -4
  288. package/src/resources/print-mail/contacts.ts +167 -4
  289. package/src/resources/print-mail/index.ts +79 -4
  290. package/src/resources/print-mail/letters.ts +43 -5
  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 +74 -12
  294. package/src/resources/print-mail/print-mail.ts +245 -239
  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 +28 -12
  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 -387
  357. package/resources/print-mail/order-profiles/cheques.d.mts.map +0 -1
  358. package/resources/print-mail/order-profiles/cheques.d.ts +0 -387
  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 -324
  373. package/resources/print-mail/order-profiles/letters.d.mts.map +0 -1
  374. package/resources/print-mail/order-profiles/letters.d.ts +0 -324
  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 -254
  389. package/resources/print-mail/order-profiles/postcards.d.mts.map +0 -1
  390. package/resources/print-mail/order-profiles/postcards.d.ts +0 -254
  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 -259
  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 -259
  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 -589
  418. package/src/resources/print-mail/order-profiles/index.ts +0 -47
  419. package/src/resources/print-mail/order-profiles/letters.ts +0 -489
  420. package/src/resources/print-mail/order-profiles/order-profiles.ts +0 -113
  421. package/src/resources/print-mail/order-profiles/postcards.ts +0 -404
  422. package/src/resources/print-mail/order-profiles/self-mailers.ts +0 -415
@@ -0,0 +1,4 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export { Items, } from "./items.mjs";
3
+ export { VirtualMailboxes, } from "./virtual-mailboxes.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,KAAK,GAQN;OACM,EACL,gBAAgB,GAQjB"}
@@ -0,0 +1,235 @@
1
+ import { APIResource } from "../../../core/resource.mjs";
2
+ import { APIPromise } from "../../../core/api-promise.mjs";
3
+ import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.mjs";
4
+ import { RequestOptions } from "../../../internal/request-options.mjs";
5
+ /**
6
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
7
+ * without needing a traditional physical mailbox. Each mailbox is fully
8
+ * digital, giving you a unique ID, status, and a set of capabilities such as
9
+ * forwarding mail to another address or viewing envelope scans. This allows you
10
+ * to manage physical correspondence entirely online.
11
+ *
12
+ * You can request access to this feature by reaching out to
13
+ * support@postgrid.com
14
+ */
15
+ export declare class Items extends APIResource {
16
+ /**
17
+ * Create a test item for a virtual mailbox. This is only available in test mode,
18
+ * an error will be returned if you attempt this call in live mode.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const item =
23
+ * await client.printMail.virtualMailboxes.items.create(
24
+ * 'id',
25
+ * { matchedLetter: 'letter_abcdef1234567890' },
26
+ * );
27
+ * ```
28
+ */
29
+ create(id: string, body: ItemCreateParams, options?: RequestOptions): APIPromise<ItemCreateResponse>;
30
+ /**
31
+ * Retrieves a single item for a virtual mailbox.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const item =
36
+ * await client.printMail.virtualMailboxes.items.retrieve(
37
+ * 'itemID',
38
+ * { id: 'id' },
39
+ * );
40
+ * ```
41
+ */
42
+ retrieve(itemID: string, params: ItemRetrieveParams, options?: RequestOptions): APIPromise<ItemRetrieveResponse>;
43
+ /**
44
+ * Lists items for a virtual mailbox.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * // Automatically fetches more pages as needed.
49
+ * for await (const itemListResponse of client.printMail.virtualMailboxes.items.list(
50
+ * 'id',
51
+ * )) {
52
+ * // ...
53
+ * }
54
+ * ```
55
+ */
56
+ list(id: string, query?: ItemListParams | null | undefined, options?: RequestOptions): PagePromise<ItemListResponsesSkipLimit, ItemListResponse>;
57
+ }
58
+ export type ItemListResponsesSkipLimit = SkipLimit<ItemListResponse>;
59
+ /**
60
+ * The virtual mailbox item object.
61
+ */
62
+ export interface ItemCreateResponse {
63
+ /**
64
+ * A unique ID prefixed with virtual*mailbox_item*
65
+ */
66
+ id: string;
67
+ /**
68
+ * The UTC time at which this resource was created.
69
+ */
70
+ createdAt: string;
71
+ /**
72
+ * `true` if this is a live mode resource else `false`.
73
+ */
74
+ live: boolean;
75
+ /**
76
+ * Always "virtual_mailbox_item".
77
+ */
78
+ object: 'virtual_mailbox_item';
79
+ /**
80
+ * The UTC time at which this resource was last updated.
81
+ */
82
+ updatedAt: string;
83
+ /**
84
+ * The ID of the virtual mailbox associated with this item.
85
+ */
86
+ virtualMailbox: string;
87
+ /**
88
+ * An optional string describing this resource. Will be visible in the API and the
89
+ * dashboard.
90
+ */
91
+ description?: string;
92
+ /**
93
+ * A URL of the envelope scan PDF.
94
+ */
95
+ fileURL?: string;
96
+ /**
97
+ * The ID of the letter this item was matched to.
98
+ */
99
+ matchedLetter?: string;
100
+ /**
101
+ * See the section on Metadata.
102
+ */
103
+ metadata?: {
104
+ [key: string]: unknown;
105
+ };
106
+ }
107
+ /**
108
+ * The virtual mailbox item object.
109
+ */
110
+ export interface ItemRetrieveResponse {
111
+ /**
112
+ * A unique ID prefixed with virtual*mailbox_item*
113
+ */
114
+ id: string;
115
+ /**
116
+ * The UTC time at which this resource was created.
117
+ */
118
+ createdAt: string;
119
+ /**
120
+ * `true` if this is a live mode resource else `false`.
121
+ */
122
+ live: boolean;
123
+ /**
124
+ * Always "virtual_mailbox_item".
125
+ */
126
+ object: 'virtual_mailbox_item';
127
+ /**
128
+ * The UTC time at which this resource was last updated.
129
+ */
130
+ updatedAt: string;
131
+ /**
132
+ * The ID of the virtual mailbox associated with this item.
133
+ */
134
+ virtualMailbox: string;
135
+ /**
136
+ * An optional string describing this resource. Will be visible in the API and the
137
+ * dashboard.
138
+ */
139
+ description?: string;
140
+ /**
141
+ * A URL of the envelope scan PDF.
142
+ */
143
+ fileURL?: string;
144
+ /**
145
+ * The ID of the letter this item was matched to.
146
+ */
147
+ matchedLetter?: string;
148
+ /**
149
+ * See the section on Metadata.
150
+ */
151
+ metadata?: {
152
+ [key: string]: unknown;
153
+ };
154
+ }
155
+ /**
156
+ * The virtual mailbox item object.
157
+ */
158
+ export interface ItemListResponse {
159
+ /**
160
+ * A unique ID prefixed with virtual*mailbox_item*
161
+ */
162
+ id: string;
163
+ /**
164
+ * The UTC time at which this resource was created.
165
+ */
166
+ createdAt: string;
167
+ /**
168
+ * `true` if this is a live mode resource else `false`.
169
+ */
170
+ live: boolean;
171
+ /**
172
+ * Always "virtual_mailbox_item".
173
+ */
174
+ object: 'virtual_mailbox_item';
175
+ /**
176
+ * The UTC time at which this resource was last updated.
177
+ */
178
+ updatedAt: string;
179
+ /**
180
+ * The ID of the virtual mailbox associated with this item.
181
+ */
182
+ virtualMailbox: string;
183
+ /**
184
+ * An optional string describing this resource. Will be visible in the API and the
185
+ * dashboard.
186
+ */
187
+ description?: string;
188
+ /**
189
+ * A URL of the envelope scan PDF.
190
+ */
191
+ fileURL?: string;
192
+ /**
193
+ * The ID of the letter this item was matched to.
194
+ */
195
+ matchedLetter?: string;
196
+ /**
197
+ * See the section on Metadata.
198
+ */
199
+ metadata?: {
200
+ [key: string]: unknown;
201
+ };
202
+ }
203
+ export interface ItemCreateParams {
204
+ /**
205
+ * The description of the item.
206
+ */
207
+ description?: string;
208
+ /**
209
+ * The ID of a letter to match this test item to.
210
+ */
211
+ matchedLetter?: string;
212
+ /**
213
+ * The metadata of the item.
214
+ */
215
+ metadata?: {
216
+ [key: string]: unknown;
217
+ };
218
+ }
219
+ export interface ItemRetrieveParams {
220
+ id: string;
221
+ }
222
+ export interface ItemListParams extends SkipLimitParams {
223
+ /**
224
+ * You can supply any string to help narrow down the list of resources. For
225
+ * example, if you pass `"New York"` (quoted), it will return resources that have
226
+ * that string present somewhere in their response. Alternatively, you can supply a
227
+ * structured search query. See the documentation on `StructuredSearchQuery` for
228
+ * more details.
229
+ */
230
+ search?: string;
231
+ }
232
+ export declare namespace Items {
233
+ export { type ItemCreateResponse as ItemCreateResponse, type ItemRetrieveResponse as ItemRetrieveResponse, type ItemListResponse as ItemListResponse, type ItemListResponsesSkipLimit as ItemListResponsesSkipLimit, type ItemCreateParams as ItemCreateParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemListParams as ItemListParams, };
234
+ }
235
+ //# sourceMappingURL=items.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"items.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;GASG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIpG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC;CAO7D;AAED,MAAM,MAAM,0BAA0B,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
@@ -0,0 +1,235 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import { APIPromise } from "../../../core/api-promise.js";
3
+ import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.js";
4
+ import { RequestOptions } from "../../../internal/request-options.js";
5
+ /**
6
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
7
+ * without needing a traditional physical mailbox. Each mailbox is fully
8
+ * digital, giving you a unique ID, status, and a set of capabilities such as
9
+ * forwarding mail to another address or viewing envelope scans. This allows you
10
+ * to manage physical correspondence entirely online.
11
+ *
12
+ * You can request access to this feature by reaching out to
13
+ * support@postgrid.com
14
+ */
15
+ export declare class Items extends APIResource {
16
+ /**
17
+ * Create a test item for a virtual mailbox. This is only available in test mode,
18
+ * an error will be returned if you attempt this call in live mode.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const item =
23
+ * await client.printMail.virtualMailboxes.items.create(
24
+ * 'id',
25
+ * { matchedLetter: 'letter_abcdef1234567890' },
26
+ * );
27
+ * ```
28
+ */
29
+ create(id: string, body: ItemCreateParams, options?: RequestOptions): APIPromise<ItemCreateResponse>;
30
+ /**
31
+ * Retrieves a single item for a virtual mailbox.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const item =
36
+ * await client.printMail.virtualMailboxes.items.retrieve(
37
+ * 'itemID',
38
+ * { id: 'id' },
39
+ * );
40
+ * ```
41
+ */
42
+ retrieve(itemID: string, params: ItemRetrieveParams, options?: RequestOptions): APIPromise<ItemRetrieveResponse>;
43
+ /**
44
+ * Lists items for a virtual mailbox.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * // Automatically fetches more pages as needed.
49
+ * for await (const itemListResponse of client.printMail.virtualMailboxes.items.list(
50
+ * 'id',
51
+ * )) {
52
+ * // ...
53
+ * }
54
+ * ```
55
+ */
56
+ list(id: string, query?: ItemListParams | null | undefined, options?: RequestOptions): PagePromise<ItemListResponsesSkipLimit, ItemListResponse>;
57
+ }
58
+ export type ItemListResponsesSkipLimit = SkipLimit<ItemListResponse>;
59
+ /**
60
+ * The virtual mailbox item object.
61
+ */
62
+ export interface ItemCreateResponse {
63
+ /**
64
+ * A unique ID prefixed with virtual*mailbox_item*
65
+ */
66
+ id: string;
67
+ /**
68
+ * The UTC time at which this resource was created.
69
+ */
70
+ createdAt: string;
71
+ /**
72
+ * `true` if this is a live mode resource else `false`.
73
+ */
74
+ live: boolean;
75
+ /**
76
+ * Always "virtual_mailbox_item".
77
+ */
78
+ object: 'virtual_mailbox_item';
79
+ /**
80
+ * The UTC time at which this resource was last updated.
81
+ */
82
+ updatedAt: string;
83
+ /**
84
+ * The ID of the virtual mailbox associated with this item.
85
+ */
86
+ virtualMailbox: string;
87
+ /**
88
+ * An optional string describing this resource. Will be visible in the API and the
89
+ * dashboard.
90
+ */
91
+ description?: string;
92
+ /**
93
+ * A URL of the envelope scan PDF.
94
+ */
95
+ fileURL?: string;
96
+ /**
97
+ * The ID of the letter this item was matched to.
98
+ */
99
+ matchedLetter?: string;
100
+ /**
101
+ * See the section on Metadata.
102
+ */
103
+ metadata?: {
104
+ [key: string]: unknown;
105
+ };
106
+ }
107
+ /**
108
+ * The virtual mailbox item object.
109
+ */
110
+ export interface ItemRetrieveResponse {
111
+ /**
112
+ * A unique ID prefixed with virtual*mailbox_item*
113
+ */
114
+ id: string;
115
+ /**
116
+ * The UTC time at which this resource was created.
117
+ */
118
+ createdAt: string;
119
+ /**
120
+ * `true` if this is a live mode resource else `false`.
121
+ */
122
+ live: boolean;
123
+ /**
124
+ * Always "virtual_mailbox_item".
125
+ */
126
+ object: 'virtual_mailbox_item';
127
+ /**
128
+ * The UTC time at which this resource was last updated.
129
+ */
130
+ updatedAt: string;
131
+ /**
132
+ * The ID of the virtual mailbox associated with this item.
133
+ */
134
+ virtualMailbox: string;
135
+ /**
136
+ * An optional string describing this resource. Will be visible in the API and the
137
+ * dashboard.
138
+ */
139
+ description?: string;
140
+ /**
141
+ * A URL of the envelope scan PDF.
142
+ */
143
+ fileURL?: string;
144
+ /**
145
+ * The ID of the letter this item was matched to.
146
+ */
147
+ matchedLetter?: string;
148
+ /**
149
+ * See the section on Metadata.
150
+ */
151
+ metadata?: {
152
+ [key: string]: unknown;
153
+ };
154
+ }
155
+ /**
156
+ * The virtual mailbox item object.
157
+ */
158
+ export interface ItemListResponse {
159
+ /**
160
+ * A unique ID prefixed with virtual*mailbox_item*
161
+ */
162
+ id: string;
163
+ /**
164
+ * The UTC time at which this resource was created.
165
+ */
166
+ createdAt: string;
167
+ /**
168
+ * `true` if this is a live mode resource else `false`.
169
+ */
170
+ live: boolean;
171
+ /**
172
+ * Always "virtual_mailbox_item".
173
+ */
174
+ object: 'virtual_mailbox_item';
175
+ /**
176
+ * The UTC time at which this resource was last updated.
177
+ */
178
+ updatedAt: string;
179
+ /**
180
+ * The ID of the virtual mailbox associated with this item.
181
+ */
182
+ virtualMailbox: string;
183
+ /**
184
+ * An optional string describing this resource. Will be visible in the API and the
185
+ * dashboard.
186
+ */
187
+ description?: string;
188
+ /**
189
+ * A URL of the envelope scan PDF.
190
+ */
191
+ fileURL?: string;
192
+ /**
193
+ * The ID of the letter this item was matched to.
194
+ */
195
+ matchedLetter?: string;
196
+ /**
197
+ * See the section on Metadata.
198
+ */
199
+ metadata?: {
200
+ [key: string]: unknown;
201
+ };
202
+ }
203
+ export interface ItemCreateParams {
204
+ /**
205
+ * The description of the item.
206
+ */
207
+ description?: string;
208
+ /**
209
+ * The ID of a letter to match this test item to.
210
+ */
211
+ matchedLetter?: string;
212
+ /**
213
+ * The metadata of the item.
214
+ */
215
+ metadata?: {
216
+ [key: string]: unknown;
217
+ };
218
+ }
219
+ export interface ItemRetrieveParams {
220
+ id: string;
221
+ }
222
+ export interface ItemListParams extends SkipLimitParams {
223
+ /**
224
+ * You can supply any string to help narrow down the list of resources. For
225
+ * example, if you pass `"New York"` (quoted), it will return resources that have
226
+ * that string present somewhere in their response. Alternatively, you can supply a
227
+ * structured search query. See the documentation on `StructuredSearchQuery` for
228
+ * more details.
229
+ */
230
+ search?: string;
231
+ }
232
+ export declare namespace Items {
233
+ export { type ItemCreateResponse as ItemCreateResponse, type ItemRetrieveResponse as ItemRetrieveResponse, type ItemListResponse as ItemListResponse, type ItemListResponsesSkipLimit as ItemListResponsesSkipLimit, type ItemCreateParams as ItemCreateParams, type ItemRetrieveParams as ItemRetrieveParams, type ItemListParams as ItemListParams, };
234
+ }
235
+ //# sourceMappingURL=items.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/items.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;GASG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIpG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,gBAAgB,CAAC;CAO7D;AAED,MAAM,MAAM,0BAA0B,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
@@ -0,0 +1,69 @@
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.Items = void 0;
5
+ const resource_1 = require("../../../core/resource.js");
6
+ const pagination_1 = require("../../../core/pagination.js");
7
+ const path_1 = require("../../../internal/utils/path.js");
8
+ /**
9
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
10
+ * without needing a traditional physical mailbox. Each mailbox is fully
11
+ * digital, giving you a unique ID, status, and a set of capabilities such as
12
+ * forwarding mail to another address or viewing envelope scans. This allows you
13
+ * to manage physical correspondence entirely online.
14
+ *
15
+ * You can request access to this feature by reaching out to
16
+ * support@postgrid.com
17
+ */
18
+ class Items extends resource_1.APIResource {
19
+ /**
20
+ * Create a test item for a virtual mailbox. This is only available in test mode,
21
+ * an error will be returned if you attempt this call in live mode.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const item =
26
+ * await client.printMail.virtualMailboxes.items.create(
27
+ * 'id',
28
+ * { matchedLetter: 'letter_abcdef1234567890' },
29
+ * );
30
+ * ```
31
+ */
32
+ create(id, body, options) {
33
+ return this._client.post((0, path_1.path) `/print-mail/v1/virtual_mailboxes/${id}/items`, { body, ...options });
34
+ }
35
+ /**
36
+ * Retrieves a single item for a virtual mailbox.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const item =
41
+ * await client.printMail.virtualMailboxes.items.retrieve(
42
+ * 'itemID',
43
+ * { id: 'id' },
44
+ * );
45
+ * ```
46
+ */
47
+ retrieve(itemID, params, options) {
48
+ const { id } = params;
49
+ return this._client.get((0, path_1.path) `/print-mail/v1/virtual_mailboxes/${id}/items/${itemID}`, options);
50
+ }
51
+ /**
52
+ * Lists items for a virtual mailbox.
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * // Automatically fetches more pages as needed.
57
+ * for await (const itemListResponse of client.printMail.virtualMailboxes.items.list(
58
+ * 'id',
59
+ * )) {
60
+ * // ...
61
+ * }
62
+ * ```
63
+ */
64
+ list(id, query = {}, options) {
65
+ return this._client.getAPIList((0, path_1.path) `/print-mail/v1/virtual_mailboxes/${id}/items`, (pagination_1.SkipLimit), { query, ...options });
66
+ }
67
+ }
68
+ exports.Items = Items;
69
+ //# sourceMappingURL=items.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"items.js","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAwF;AAExF,0DAAoD;AAEpD;;;;;;;;;GASG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAc,EACd,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oCAAoC,EAAE,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,oCAAoC,EAAE,QAAQ,EAClD,CAAA,sBAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA/DD,sBA+DC"}
@@ -0,0 +1,65 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import { SkipLimit } from "../../../core/pagination.mjs";
4
+ import { path } from "../../../internal/utils/path.mjs";
5
+ /**
6
+ * Virtual mailboxes let you receive, scan, and forward your physical mail
7
+ * without needing a traditional physical mailbox. Each mailbox is fully
8
+ * digital, giving you a unique ID, status, and a set of capabilities such as
9
+ * forwarding mail to another address or viewing envelope scans. This allows you
10
+ * to manage physical correspondence entirely online.
11
+ *
12
+ * You can request access to this feature by reaching out to
13
+ * support@postgrid.com
14
+ */
15
+ export class Items extends APIResource {
16
+ /**
17
+ * Create a test item for a virtual mailbox. This is only available in test mode,
18
+ * an error will be returned if you attempt this call in live mode.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const item =
23
+ * await client.printMail.virtualMailboxes.items.create(
24
+ * 'id',
25
+ * { matchedLetter: 'letter_abcdef1234567890' },
26
+ * );
27
+ * ```
28
+ */
29
+ create(id, body, options) {
30
+ return this._client.post(path `/print-mail/v1/virtual_mailboxes/${id}/items`, { body, ...options });
31
+ }
32
+ /**
33
+ * Retrieves a single item for a virtual mailbox.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const item =
38
+ * await client.printMail.virtualMailboxes.items.retrieve(
39
+ * 'itemID',
40
+ * { id: 'id' },
41
+ * );
42
+ * ```
43
+ */
44
+ retrieve(itemID, params, options) {
45
+ const { id } = params;
46
+ return this._client.get(path `/print-mail/v1/virtual_mailboxes/${id}/items/${itemID}`, options);
47
+ }
48
+ /**
49
+ * Lists items for a virtual mailbox.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * // Automatically fetches more pages as needed.
54
+ * for await (const itemListResponse of client.printMail.virtualMailboxes.items.list(
55
+ * 'id',
56
+ * )) {
57
+ * // ...
58
+ * }
59
+ * ```
60
+ */
61
+ list(id, query = {}, options) {
62
+ return this._client.getAPIList(path `/print-mail/v1/virtual_mailboxes/${id}/items`, (SkipLimit), { query, ...options });
63
+ }
64
+ }
65
+ //# sourceMappingURL=items.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"items.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/virtual-mailboxes/items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,SAAS,EAAwB;OAEhD,EAAE,IAAI,EAAE;AAEf;;;;;;;;;GASG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oCAAoC,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAc,EACd,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oCAAoC,EAAE,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,oCAAoC,EAAE,QAAQ,EAClD,CAAA,SAA2B,CAAA,EAC3B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}