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
package/resources/print-mail/snap-packs.d.mts ADDED
@@ -0,0 +1,1060 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as ContactsAPI from "./contacts.mjs";
3
+ import { APIPromise } from "../../core/api-promise.mjs";
4
+ import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
5
+ import { RequestOptions } from "../../internal/request-options.mjs";
6
+ /**
7
+ * Snap packs are pressure-sealed mailers that resemble official documents
8
+ * and encourage higher open rates. They do not require envelopes and are
9
+ * opened by tearing along perforated edges. The sealed design keeps contents
10
+ * hidden until opened, making snap packs ideal for sensitive or important
11
+ * documents such as contracts, forms, or notices.
12
+ *
13
+ * You can request access to this feature by reaching out to
14
+ * support@postgrid.com
15
+ */
16
+ export declare class SnapPacks extends APIResource {
17
+ /**
18
+ * Create a snap pack. You can supply one of the following:
19
+ *
20
+ * - HTML content for the inside and outside of the snap pack
21
+ * - Template IDs for the inside and outside of the snap pack
22
+ * - A URL or file upload for a two-page PDF that matches the snap pack layout
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const snapPack = await client.printMail.snapPacks.create({
27
+ * from: 'contact_123',
28
+ * insideHTML: '<html>Inside</html>',
29
+ * outsideHTML: '<html>Outside</html>',
30
+ * size: '8.5x11_bifold_v',
31
+ * to: 'contact_456',
32
+ * });
33
+ * ```
34
+ */
35
+ create(body: SnapPackCreateParams, options?: RequestOptions): APIPromise<SnapPackCreateResponse>;
36
+ /**
37
+ * Retrieve a snap pack by ID.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const snapPack = await client.printMail.snapPacks.retrieve(
42
+ * 'id',
43
+ * );
44
+ * ```
45
+ */
46
+ retrieve(id: string, options?: RequestOptions): APIPromise<SnapPackRetrieveResponse>;
47
+ /**
48
+ * Get a list of snap packs.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * // Automatically fetches more pages as needed.
53
+ * for await (const snapPackListResponse of client.printMail.snapPacks.list()) {
54
+ * // ...
55
+ * }
56
+ * ```
57
+ */
58
+ list(query?: SnapPackListParams | null | undefined, options?: RequestOptions): PagePromise<SnapPackListResponsesSkipLimit, SnapPackListResponse>;
59
+ /**
60
+ * Cancel a snap pack by ID. Note that this operation cannot be undone and that
61
+ * only snap packs with a status of `ready` can be cancelled.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const snapPack = await client.printMail.snapPacks.delete(
66
+ * 'id',
67
+ * );
68
+ * ```
69
+ */
70
+ delete(id: string, options?: RequestOptions): APIPromise<SnapPackDeleteResponse>;
71
+ /**
72
+ * Progresses a snap pack's `status` to the next stage. This is only available in
73
+ * test mode and can be used to simulate how a live order would progress through
74
+ * the different statuses.
75
+ *
76
+ * Note: this will fail with an `invalid_progression_error` if the status is one of
77
+ * `completed` or `cancelled`.
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const response =
82
+ * await client.printMail.snapPacks.progressions('id');
83
+ * ```
84
+ */
85
+ progressions(id: string, options?: RequestOptions): APIPromise<SnapPackProgressionsResponse>;
86
+ /**
87
+ * Provides sizes and mailing classes available for the destination.
88
+ *
89
+ * @example
90
+ * ```ts
91
+ * const response =
92
+ * await client.printMail.snapPacks.retrieveCapabilities({
93
+ * returnCountryCode: 'returnCountryCode',
94
+ * });
95
+ * ```
96
+ */
97
+ retrieveCapabilities(query: SnapPackRetrieveCapabilitiesParams, options?: RequestOptions): APIPromise<SnapPackRetrieveCapabilitiesResponse>;
98
+ }
99
+ export type SnapPackListResponsesSkipLimit = SkipLimit<SnapPackListResponse>;
100
+ export interface SnapPackCreateResponse {
101
+ /**
102
+ * A unique ID prefixed with snap*pack*
103
+ */
104
+ id: string;
105
+ /**
106
+ * The UTC time at which this resource was created.
107
+ */
108
+ createdAt: string;
109
+ /**
110
+ * The contact information of the sender.
111
+ */
112
+ from: ContactsAPI.Contact;
113
+ /**
114
+ * `true` if this is a live mode resource else `false`.
115
+ */
116
+ live: boolean;
117
+ /**
118
+ * The mailing class of this order. This determines the speed and cost of delivery.
119
+ * See `OrderMailingClass` for more details.
120
+ */
121
+ mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
122
+ /**
123
+ * Always `snap_pack`.
124
+ */
125
+ object: 'snap_pack';
126
+ /**
127
+ * This order will transition from `ready` to `printing` on the day after this
128
+ * date. For example, if this is a date on Tuesday, the order will transition to
129
+ * `printing` on Wednesday at midnight eastern time.
130
+ */
131
+ sendDate: string;
132
+ /**
133
+ * Enum representing the supported snap pack sizes.
134
+ */
135
+ size: '8.5x11_bifold_v';
136
+ /**
137
+ * See `OrderStatus` for more details on the status of this order.
138
+ */
139
+ status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
140
+ /**
141
+ * The recipient of this order. This will be provided even if you delete the
142
+ * underlying contact.
143
+ */
144
+ to: ContactsAPI.Contact;
145
+ /**
146
+ * The UTC time at which this resource was last updated.
147
+ */
148
+ updatedAt: string;
149
+ /**
150
+ * The cancellation details of this order. Populated if the order has been
151
+ * cancelled.
152
+ */
153
+ cancellation?: SnapPackCreateResponse.Cancellation;
154
+ /**
155
+ * An optional string describing this resource. Will be visible in the API and the
156
+ * dashboard.
157
+ */
158
+ description?: string;
159
+ /**
160
+ * The last date that the IMB status was updated. See `imbStatus` for more details.
161
+ */
162
+ imbDate?: string;
163
+ /**
164
+ * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
165
+ * US-printed and US-destined orders. This is the most detailed way to track
166
+ * non-express/certified orders.
167
+ */
168
+ imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
169
+ /**
170
+ * The most recent ZIP code of the USPS facility that the order has been processed
171
+ * through. Only populated when an `imbStatus` is present.
172
+ */
173
+ imbZIPCode?: string;
174
+ /**
175
+ * The HTML content for the inside of the snap pack, when provided instead of a
176
+ * template or PDF.
177
+ */
178
+ insideHTML?: string;
179
+ /**
180
+ * The template ID for the inside of the snap pack, when provided instead of HTML
181
+ * or PDF.
182
+ */
183
+ insideTemplate?: string;
184
+ /**
185
+ * These will be merged with the variables in the template or HTML you create this
186
+ * order with. The keys in this object should match the variable names in the
187
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
188
+ * PDFs uploaded with the order.
189
+ */
190
+ mergeVariables?: {
191
+ [key: string]: unknown;
192
+ };
193
+ /**
194
+ * See the section on Metadata.
195
+ */
196
+ metadata?: {
197
+ [key: string]: unknown;
198
+ };
199
+ /**
200
+ * The HTML content for the outside of the snap pack, when provided instead of a
201
+ * template or PDF.
202
+ */
203
+ outsideHTML?: string;
204
+ /**
205
+ * The template ID for the outside of the snap pack, when provided instead of HTML
206
+ * or PDF.
207
+ */
208
+ outsideTemplate?: string;
209
+ /**
210
+ * The tracking number of this order. Populated after an express/certified order
211
+ * has been processed for delivery.
212
+ */
213
+ trackingNumber?: string;
214
+ /**
215
+ * A signed URL to the uploaded PDF provided at creation time, if a PDF was
216
+ * supplied.
217
+ */
218
+ uploadedPDF?: string;
219
+ /**
220
+ * PostGrid renders a PDF preview for all orders. This should be inspected to
221
+ * ensure that the order is correct before it is sent out because it shows what
222
+ * will be printed and mailed to the recipient. Once the PDF preview is generated,
223
+ * this field will be returned by all `GET` endpoints which produce this order.
224
+ *
225
+ * This URL is a signed link to the PDF preview. It will expire after a short
226
+ * period of time. If you need to access this URL after it has expired, you can
227
+ * regenerate it by calling the `GET` endpoint again.
228
+ */
229
+ url?: string;
230
+ }
231
+ export declare namespace SnapPackCreateResponse {
232
+ /**
233
+ * The cancellation details of this order. Populated if the order has been
234
+ * cancelled.
235
+ */
236
+ interface Cancellation {
237
+ /**
238
+ * The reason for the cancellation.
239
+ */
240
+ reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
241
+ /**
242
+ * The user ID who cancelled the order.
243
+ */
244
+ cancelledByUser?: string;
245
+ /**
246
+ * An optional note provided by the user who cancelled the order.
247
+ */
248
+ note?: string;
249
+ }
250
+ }
251
+ export interface SnapPackRetrieveResponse {
252
+ /**
253
+ * A unique ID prefixed with snap*pack*
254
+ */
255
+ id: string;
256
+ /**
257
+ * The UTC time at which this resource was created.
258
+ */
259
+ createdAt: string;
260
+ /**
261
+ * The contact information of the sender.
262
+ */
263
+ from: ContactsAPI.Contact;
264
+ /**
265
+ * `true` if this is a live mode resource else `false`.
266
+ */
267
+ live: boolean;
268
+ /**
269
+ * The mailing class of this order. This determines the speed and cost of delivery.
270
+ * See `OrderMailingClass` for more details.
271
+ */
272
+ mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
273
+ /**
274
+ * Always `snap_pack`.
275
+ */
276
+ object: 'snap_pack';
277
+ /**
278
+ * This order will transition from `ready` to `printing` on the day after this
279
+ * date. For example, if this is a date on Tuesday, the order will transition to
280
+ * `printing` on Wednesday at midnight eastern time.
281
+ */
282
+ sendDate: string;
283
+ /**
284
+ * Enum representing the supported snap pack sizes.
285
+ */
286
+ size: '8.5x11_bifold_v';
287
+ /**
288
+ * See `OrderStatus` for more details on the status of this order.
289
+ */
290
+ status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
291
+ /**
292
+ * The recipient of this order. This will be provided even if you delete the
293
+ * underlying contact.
294
+ */
295
+ to: ContactsAPI.Contact;
296
+ /**
297
+ * The UTC time at which this resource was last updated.
298
+ */
299
+ updatedAt: string;
300
+ /**
301
+ * The cancellation details of this order. Populated if the order has been
302
+ * cancelled.
303
+ */
304
+ cancellation?: SnapPackRetrieveResponse.Cancellation;
305
+ /**
306
+ * An optional string describing this resource. Will be visible in the API and the
307
+ * dashboard.
308
+ */
309
+ description?: string;
310
+ /**
311
+ * The last date that the IMB status was updated. See `imbStatus` for more details.
312
+ */
313
+ imbDate?: string;
314
+ /**
315
+ * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
316
+ * US-printed and US-destined orders. This is the most detailed way to track
317
+ * non-express/certified orders.
318
+ */
319
+ imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
320
+ /**
321
+ * The most recent ZIP code of the USPS facility that the order has been processed
322
+ * through. Only populated when an `imbStatus` is present.
323
+ */
324
+ imbZIPCode?: string;
325
+ /**
326
+ * The HTML content for the inside of the snap pack, when provided instead of a
327
+ * template or PDF.
328
+ */
329
+ insideHTML?: string;
330
+ /**
331
+ * The template ID for the inside of the snap pack, when provided instead of HTML
332
+ * or PDF.
333
+ */
334
+ insideTemplate?: string;
335
+ /**
336
+ * These will be merged with the variables in the template or HTML you create this
337
+ * order with. The keys in this object should match the variable names in the
338
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
339
+ * PDFs uploaded with the order.
340
+ */
341
+ mergeVariables?: {
342
+ [key: string]: unknown;
343
+ };
344
+ /**
345
+ * See the section on Metadata.
346
+ */
347
+ metadata?: {
348
+ [key: string]: unknown;
349
+ };
350
+ /**
351
+ * The HTML content for the outside of the snap pack, when provided instead of a
352
+ * template or PDF.
353
+ */
354
+ outsideHTML?: string;
355
+ /**
356
+ * The template ID for the outside of the snap pack, when provided instead of HTML
357
+ * or PDF.
358
+ */
359
+ outsideTemplate?: string;
360
+ /**
361
+ * The tracking number of this order. Populated after an express/certified order
362
+ * has been processed for delivery.
363
+ */
364
+ trackingNumber?: string;
365
+ /**
366
+ * A signed URL to the uploaded PDF provided at creation time, if a PDF was
367
+ * supplied.
368
+ */
369
+ uploadedPDF?: string;
370
+ /**
371
+ * PostGrid renders a PDF preview for all orders. This should be inspected to
372
+ * ensure that the order is correct before it is sent out because it shows what
373
+ * will be printed and mailed to the recipient. Once the PDF preview is generated,
374
+ * this field will be returned by all `GET` endpoints which produce this order.
375
+ *
376
+ * This URL is a signed link to the PDF preview. It will expire after a short
377
+ * period of time. If you need to access this URL after it has expired, you can
378
+ * regenerate it by calling the `GET` endpoint again.
379
+ */
380
+ url?: string;
381
+ }
382
+ export declare namespace SnapPackRetrieveResponse {
383
+ /**
384
+ * The cancellation details of this order. Populated if the order has been
385
+ * cancelled.
386
+ */
387
+ interface Cancellation {
388
+ /**
389
+ * The reason for the cancellation.
390
+ */
391
+ reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
392
+ /**
393
+ * The user ID who cancelled the order.
394
+ */
395
+ cancelledByUser?: string;
396
+ /**
397
+ * An optional note provided by the user who cancelled the order.
398
+ */
399
+ note?: string;
400
+ }
401
+ }
402
+ export interface SnapPackListResponse {
403
+ /**
404
+ * A unique ID prefixed with snap*pack*
405
+ */
406
+ id: string;
407
+ /**
408
+ * The UTC time at which this resource was created.
409
+ */
410
+ createdAt: string;
411
+ /**
412
+ * The contact information of the sender.
413
+ */
414
+ from: ContactsAPI.Contact;
415
+ /**
416
+ * `true` if this is a live mode resource else `false`.
417
+ */
418
+ live: boolean;
419
+ /**
420
+ * The mailing class of this order. This determines the speed and cost of delivery.
421
+ * See `OrderMailingClass` for more details.
422
+ */
423
+ mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
424
+ /**
425
+ * Always `snap_pack`.
426
+ */
427
+ object: 'snap_pack';
428
+ /**
429
+ * This order will transition from `ready` to `printing` on the day after this
430
+ * date. For example, if this is a date on Tuesday, the order will transition to
431
+ * `printing` on Wednesday at midnight eastern time.
432
+ */
433
+ sendDate: string;
434
+ /**
435
+ * Enum representing the supported snap pack sizes.
436
+ */
437
+ size: '8.5x11_bifold_v';
438
+ /**
439
+ * See `OrderStatus` for more details on the status of this order.
440
+ */
441
+ status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
442
+ /**
443
+ * The recipient of this order. This will be provided even if you delete the
444
+ * underlying contact.
445
+ */
446
+ to: ContactsAPI.Contact;
447
+ /**
448
+ * The UTC time at which this resource was last updated.
449
+ */
450
+ updatedAt: string;
451
+ /**
452
+ * The cancellation details of this order. Populated if the order has been
453
+ * cancelled.
454
+ */
455
+ cancellation?: SnapPackListResponse.Cancellation;
456
+ /**
457
+ * An optional string describing this resource. Will be visible in the API and the
458
+ * dashboard.
459
+ */
460
+ description?: string;
461
+ /**
462
+ * The last date that the IMB status was updated. See `imbStatus` for more details.
463
+ */
464
+ imbDate?: string;
465
+ /**
466
+ * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
467
+ * US-printed and US-destined orders. This is the most detailed way to track
468
+ * non-express/certified orders.
469
+ */
470
+ imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
471
+ /**
472
+ * The most recent ZIP code of the USPS facility that the order has been processed
473
+ * through. Only populated when an `imbStatus` is present.
474
+ */
475
+ imbZIPCode?: string;
476
+ /**
477
+ * The HTML content for the inside of the snap pack, when provided instead of a
478
+ * template or PDF.
479
+ */
480
+ insideHTML?: string;
481
+ /**
482
+ * The template ID for the inside of the snap pack, when provided instead of HTML
483
+ * or PDF.
484
+ */
485
+ insideTemplate?: string;
486
+ /**
487
+ * These will be merged with the variables in the template or HTML you create this
488
+ * order with. The keys in this object should match the variable names in the
489
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
490
+ * PDFs uploaded with the order.
491
+ */
492
+ mergeVariables?: {
493
+ [key: string]: unknown;
494
+ };
495
+ /**
496
+ * See the section on Metadata.
497
+ */
498
+ metadata?: {
499
+ [key: string]: unknown;
500
+ };
501
+ /**
502
+ * The HTML content for the outside of the snap pack, when provided instead of a
503
+ * template or PDF.
504
+ */
505
+ outsideHTML?: string;
506
+ /**
507
+ * The template ID for the outside of the snap pack, when provided instead of HTML
508
+ * or PDF.
509
+ */
510
+ outsideTemplate?: string;
511
+ /**
512
+ * The tracking number of this order. Populated after an express/certified order
513
+ * has been processed for delivery.
514
+ */
515
+ trackingNumber?: string;
516
+ /**
517
+ * A signed URL to the uploaded PDF provided at creation time, if a PDF was
518
+ * supplied.
519
+ */
520
+ uploadedPDF?: string;
521
+ /**
522
+ * PostGrid renders a PDF preview for all orders. This should be inspected to
523
+ * ensure that the order is correct before it is sent out because it shows what
524
+ * will be printed and mailed to the recipient. Once the PDF preview is generated,
525
+ * this field will be returned by all `GET` endpoints which produce this order.
526
+ *
527
+ * This URL is a signed link to the PDF preview. It will expire after a short
528
+ * period of time. If you need to access this URL after it has expired, you can
529
+ * regenerate it by calling the `GET` endpoint again.
530
+ */
531
+ url?: string;
532
+ }
533
+ export declare namespace SnapPackListResponse {
534
+ /**
535
+ * The cancellation details of this order. Populated if the order has been
536
+ * cancelled.
537
+ */
538
+ interface Cancellation {
539
+ /**
540
+ * The reason for the cancellation.
541
+ */
542
+ reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
543
+ /**
544
+ * The user ID who cancelled the order.
545
+ */
546
+ cancelledByUser?: string;
547
+ /**
548
+ * An optional note provided by the user who cancelled the order.
549
+ */
550
+ note?: string;
551
+ }
552
+ }
553
+ export interface SnapPackDeleteResponse {
554
+ /**
555
+ * A unique ID prefixed with snap*pack*
556
+ */
557
+ id: string;
558
+ /**
559
+ * The UTC time at which this resource was created.
560
+ */
561
+ createdAt: string;
562
+ /**
563
+ * The contact information of the sender.
564
+ */
565
+ from: ContactsAPI.Contact;
566
+ /**
567
+ * `true` if this is a live mode resource else `false`.
568
+ */
569
+ live: boolean;
570
+ /**
571
+ * The mailing class of this order. This determines the speed and cost of delivery.
572
+ * See `OrderMailingClass` for more details.
573
+ */
574
+ mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
575
+ /**
576
+ * Always `snap_pack`.
577
+ */
578
+ object: 'snap_pack';
579
+ /**
580
+ * This order will transition from `ready` to `printing` on the day after this
581
+ * date. For example, if this is a date on Tuesday, the order will transition to
582
+ * `printing` on Wednesday at midnight eastern time.
583
+ */
584
+ sendDate: string;
585
+ /**
586
+ * Enum representing the supported snap pack sizes.
587
+ */
588
+ size: '8.5x11_bifold_v';
589
+ /**
590
+ * See `OrderStatus` for more details on the status of this order.
591
+ */
592
+ status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
593
+ /**
594
+ * The recipient of this order. This will be provided even if you delete the
595
+ * underlying contact.
596
+ */
597
+ to: ContactsAPI.Contact;
598
+ /**
599
+ * The UTC time at which this resource was last updated.
600
+ */
601
+ updatedAt: string;
602
+ /**
603
+ * The cancellation details of this order. Populated if the order has been
604
+ * cancelled.
605
+ */
606
+ cancellation?: SnapPackDeleteResponse.Cancellation;
607
+ /**
608
+ * An optional string describing this resource. Will be visible in the API and the
609
+ * dashboard.
610
+ */
611
+ description?: string;
612
+ /**
613
+ * The last date that the IMB status was updated. See `imbStatus` for more details.
614
+ */
615
+ imbDate?: string;
616
+ /**
617
+ * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
618
+ * US-printed and US-destined orders. This is the most detailed way to track
619
+ * non-express/certified orders.
620
+ */
621
+ imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
622
+ /**
623
+ * The most recent ZIP code of the USPS facility that the order has been processed
624
+ * through. Only populated when an `imbStatus` is present.
625
+ */
626
+ imbZIPCode?: string;
627
+ /**
628
+ * The HTML content for the inside of the snap pack, when provided instead of a
629
+ * template or PDF.
630
+ */
631
+ insideHTML?: string;
632
+ /**
633
+ * The template ID for the inside of the snap pack, when provided instead of HTML
634
+ * or PDF.
635
+ */
636
+ insideTemplate?: string;
637
+ /**
638
+ * These will be merged with the variables in the template or HTML you create this
639
+ * order with. The keys in this object should match the variable names in the
640
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
641
+ * PDFs uploaded with the order.
642
+ */
643
+ mergeVariables?: {
644
+ [key: string]: unknown;
645
+ };
646
+ /**
647
+ * See the section on Metadata.
648
+ */
649
+ metadata?: {
650
+ [key: string]: unknown;
651
+ };
652
+ /**
653
+ * The HTML content for the outside of the snap pack, when provided instead of a
654
+ * template or PDF.
655
+ */
656
+ outsideHTML?: string;
657
+ /**
658
+ * The template ID for the outside of the snap pack, when provided instead of HTML
659
+ * or PDF.
660
+ */
661
+ outsideTemplate?: string;
662
+ /**
663
+ * The tracking number of this order. Populated after an express/certified order
664
+ * has been processed for delivery.
665
+ */
666
+ trackingNumber?: string;
667
+ /**
668
+ * A signed URL to the uploaded PDF provided at creation time, if a PDF was
669
+ * supplied.
670
+ */
671
+ uploadedPDF?: string;
672
+ /**
673
+ * PostGrid renders a PDF preview for all orders. This should be inspected to
674
+ * ensure that the order is correct before it is sent out because it shows what
675
+ * will be printed and mailed to the recipient. Once the PDF preview is generated,
676
+ * this field will be returned by all `GET` endpoints which produce this order.
677
+ *
678
+ * This URL is a signed link to the PDF preview. It will expire after a short
679
+ * period of time. If you need to access this URL after it has expired, you can
680
+ * regenerate it by calling the `GET` endpoint again.
681
+ */
682
+ url?: string;
683
+ }
684
+ export declare namespace SnapPackDeleteResponse {
685
+ /**
686
+ * The cancellation details of this order. Populated if the order has been
687
+ * cancelled.
688
+ */
689
+ interface Cancellation {
690
+ /**
691
+ * The reason for the cancellation.
692
+ */
693
+ reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
694
+ /**
695
+ * The user ID who cancelled the order.
696
+ */
697
+ cancelledByUser?: string;
698
+ /**
699
+ * An optional note provided by the user who cancelled the order.
700
+ */
701
+ note?: string;
702
+ }
703
+ }
704
+ export interface SnapPackProgressionsResponse {
705
+ /**
706
+ * A unique ID prefixed with snap*pack*
707
+ */
708
+ id: string;
709
+ /**
710
+ * The UTC time at which this resource was created.
711
+ */
712
+ createdAt: string;
713
+ /**
714
+ * The contact information of the sender.
715
+ */
716
+ from: ContactsAPI.Contact;
717
+ /**
718
+ * `true` if this is a live mode resource else `false`.
719
+ */
720
+ live: boolean;
721
+ /**
722
+ * The mailing class of this order. This determines the speed and cost of delivery.
723
+ * See `OrderMailingClass` for more details.
724
+ */
725
+ mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
726
+ /**
727
+ * Always `snap_pack`.
728
+ */
729
+ object: 'snap_pack';
730
+ /**
731
+ * This order will transition from `ready` to `printing` on the day after this
732
+ * date. For example, if this is a date on Tuesday, the order will transition to
733
+ * `printing` on Wednesday at midnight eastern time.
734
+ */
735
+ sendDate: string;
736
+ /**
737
+ * Enum representing the supported snap pack sizes.
738
+ */
739
+ size: '8.5x11_bifold_v';
740
+ /**
741
+ * See `OrderStatus` for more details on the status of this order.
742
+ */
743
+ status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
744
+ /**
745
+ * The recipient of this order. This will be provided even if you delete the
746
+ * underlying contact.
747
+ */
748
+ to: ContactsAPI.Contact;
749
+ /**
750
+ * The UTC time at which this resource was last updated.
751
+ */
752
+ updatedAt: string;
753
+ /**
754
+ * The cancellation details of this order. Populated if the order has been
755
+ * cancelled.
756
+ */
757
+ cancellation?: SnapPackProgressionsResponse.Cancellation;
758
+ /**
759
+ * An optional string describing this resource. Will be visible in the API and the
760
+ * dashboard.
761
+ */
762
+ description?: string;
763
+ /**
764
+ * The last date that the IMB status was updated. See `imbStatus` for more details.
765
+ */
766
+ imbDate?: string;
767
+ /**
768
+ * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
769
+ * US-printed and US-destined orders. This is the most detailed way to track
770
+ * non-express/certified orders.
771
+ */
772
+ imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
773
+ /**
774
+ * The most recent ZIP code of the USPS facility that the order has been processed
775
+ * through. Only populated when an `imbStatus` is present.
776
+ */
777
+ imbZIPCode?: string;
778
+ /**
779
+ * The HTML content for the inside of the snap pack, when provided instead of a
780
+ * template or PDF.
781
+ */
782
+ insideHTML?: string;
783
+ /**
784
+ * The template ID for the inside of the snap pack, when provided instead of HTML
785
+ * or PDF.
786
+ */
787
+ insideTemplate?: string;
788
+ /**
789
+ * These will be merged with the variables in the template or HTML you create this
790
+ * order with. The keys in this object should match the variable names in the
791
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
792
+ * PDFs uploaded with the order.
793
+ */
794
+ mergeVariables?: {
795
+ [key: string]: unknown;
796
+ };
797
+ /**
798
+ * See the section on Metadata.
799
+ */
800
+ metadata?: {
801
+ [key: string]: unknown;
802
+ };
803
+ /**
804
+ * The HTML content for the outside of the snap pack, when provided instead of a
805
+ * template or PDF.
806
+ */
807
+ outsideHTML?: string;
808
+ /**
809
+ * The template ID for the outside of the snap pack, when provided instead of HTML
810
+ * or PDF.
811
+ */
812
+ outsideTemplate?: string;
813
+ /**
814
+ * The tracking number of this order. Populated after an express/certified order
815
+ * has been processed for delivery.
816
+ */
817
+ trackingNumber?: string;
818
+ /**
819
+ * A signed URL to the uploaded PDF provided at creation time, if a PDF was
820
+ * supplied.
821
+ */
822
+ uploadedPDF?: string;
823
+ /**
824
+ * PostGrid renders a PDF preview for all orders. This should be inspected to
825
+ * ensure that the order is correct before it is sent out because it shows what
826
+ * will be printed and mailed to the recipient. Once the PDF preview is generated,
827
+ * this field will be returned by all `GET` endpoints which produce this order.
828
+ *
829
+ * This URL is a signed link to the PDF preview. It will expire after a short
830
+ * period of time. If you need to access this URL after it has expired, you can
831
+ * regenerate it by calling the `GET` endpoint again.
832
+ */
833
+ url?: string;
834
+ }
835
+ export declare namespace SnapPackProgressionsResponse {
836
+ /**
837
+ * The cancellation details of this order. Populated if the order has been
838
+ * cancelled.
839
+ */
840
+ interface Cancellation {
841
+ /**
842
+ * The reason for the cancellation.
843
+ */
844
+ reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
845
+ /**
846
+ * The user ID who cancelled the order.
847
+ */
848
+ cancelledByUser?: string;
849
+ /**
850
+ * An optional note provided by the user who cancelled the order.
851
+ */
852
+ note?: string;
853
+ }
854
+ }
855
+ export interface SnapPackRetrieveCapabilitiesResponse {
856
+ mailingClasses: Array<'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class'>;
857
+ sizes: Array<'8.5x11_bifold_v'>;
858
+ }
859
+ export type SnapPackCreateParams = SnapPackCreateParams.SnapPackCreateWithHTML | SnapPackCreateParams.SnapPackCreateWithTemplate | SnapPackCreateParams.SnapPackCreateWithPdf;
860
+ export declare namespace SnapPackCreateParams {
861
+ interface SnapPackCreateWithHTML {
862
+ /**
863
+ * The contact information of the sender. You can pass contact information inline
864
+ * here just like you can for the `to` contact.
865
+ */
866
+ from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
867
+ /**
868
+ * The HTML content for the inside of the snap pack. You can supply _either_ this
869
+ * or `insideTemplate` but not both.
870
+ */
871
+ insideHTML: string;
872
+ /**
873
+ * The HTML content for the outside of the snap pack. You can supply _either_ this
874
+ * or `outsideTemplate` but not both.
875
+ */
876
+ outsideHTML: string;
877
+ /**
878
+ * Enum representing the supported snap pack sizes.
879
+ */
880
+ size: '8.5x11_bifold_v';
881
+ /**
882
+ * The recipient of this order. You can either supply the contact information
883
+ * inline here or provide a contact ID. PostGrid will automatically deduplicate
884
+ * contacts regardless of whether you provide the information inline here or call
885
+ * the contact creation endpoint.
886
+ */
887
+ to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
888
+ /**
889
+ * An optional string describing this resource. Will be visible in the API and the
890
+ * dashboard.
891
+ */
892
+ description?: string;
893
+ /**
894
+ * The mailing class of this order. If not provided, automatically set to
895
+ * `first_class`.
896
+ */
897
+ mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
898
+ /**
899
+ * These will be merged with the variables in the template or HTML you create this
900
+ * order with. The keys in this object should match the variable names in the
901
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
902
+ * PDFs uploaded with the order.
903
+ */
904
+ mergeVariables?: {
905
+ [key: string]: unknown;
906
+ };
907
+ /**
908
+ * See the section on Metadata.
909
+ */
910
+ metadata?: {
911
+ [key: string]: unknown;
912
+ };
913
+ /**
914
+ * This order will transition from `ready` to `printing` on the day after this
915
+ * date. You can use this parameter to schedule orders for a future date.
916
+ */
917
+ sendDate?: string;
918
+ }
919
+ interface SnapPackCreateWithTemplate {
920
+ /**
921
+ * The contact information of the sender. You can pass contact information inline
922
+ * here just like you can for the `to` contact.
923
+ */
924
+ from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
925
+ /**
926
+ * The template ID for the inside of the snap pack. You can supply _either_ this or
927
+ * `insideHTML` but not both.
928
+ */
929
+ insideTemplate: string;
930
+ /**
931
+ * The template ID for the outside of the snap pack. You can supply _either_ this
932
+ * or `outsideHTML` but not both.
933
+ */
934
+ outsideTemplate: string;
935
+ /**
936
+ * Enum representing the supported snap pack sizes.
937
+ */
938
+ size: '8.5x11_bifold_v';
939
+ /**
940
+ * The recipient of this order. You can either supply the contact information
941
+ * inline here or provide a contact ID. PostGrid will automatically deduplicate
942
+ * contacts regardless of whether you provide the information inline here or call
943
+ * the contact creation endpoint.
944
+ */
945
+ to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
946
+ /**
947
+ * An optional string describing this resource. Will be visible in the API and the
948
+ * dashboard.
949
+ */
950
+ description?: string;
951
+ /**
952
+ * The mailing class of this order. If not provided, automatically set to
953
+ * `first_class`.
954
+ */
955
+ mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
956
+ /**
957
+ * These will be merged with the variables in the template or HTML you create this
958
+ * order with. The keys in this object should match the variable names in the
959
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
960
+ * PDFs uploaded with the order.
961
+ */
962
+ mergeVariables?: {
963
+ [key: string]: unknown;
964
+ };
965
+ /**
966
+ * See the section on Metadata.
967
+ */
968
+ metadata?: {
969
+ [key: string]: unknown;
970
+ };
971
+ /**
972
+ * This order will transition from `ready` to `printing` on the day after this
973
+ * date. You can use this parameter to schedule orders for a future date.
974
+ */
975
+ sendDate?: string;
976
+ }
977
+ interface SnapPackCreateWithPdf {
978
+ /**
979
+ * The contact information of the sender. You can pass contact information inline
980
+ * here just like you can for the `to` contact.
981
+ */
982
+ from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
983
+ /**
984
+ * A URL or a multipart-uploaded two-page PDF (first page is the outside, second
985
+ * page is the inside) that matches the selected snap pack size.
986
+ */
987
+ pdf: string;
988
+ /**
989
+ * Enum representing the supported snap pack sizes.
990
+ */
991
+ size: '8.5x11_bifold_v';
992
+ /**
993
+ * The recipient of this order. You can either supply the contact information
994
+ * inline here or provide a contact ID. PostGrid will automatically deduplicate
995
+ * contacts regardless of whether you provide the information inline here or call
996
+ * the contact creation endpoint.
997
+ */
998
+ to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
999
+ /**
1000
+ * An optional string describing this resource. Will be visible in the API and the
1001
+ * dashboard.
1002
+ */
1003
+ description?: string;
1004
+ /**
1005
+ * The mailing class of this order. If not provided, automatically set to
1006
+ * `first_class`.
1007
+ */
1008
+ mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
1009
+ /**
1010
+ * These will be merged with the variables in the template or HTML you create this
1011
+ * order with. The keys in this object should match the variable names in the
1012
+ * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
1013
+ * PDFs uploaded with the order.
1014
+ */
1015
+ mergeVariables?: {
1016
+ [key: string]: unknown;
1017
+ };
1018
+ /**
1019
+ * See the section on Metadata.
1020
+ */
1021
+ metadata?: {
1022
+ [key: string]: unknown;
1023
+ };
1024
+ /**
1025
+ * This order will transition from `ready` to `printing` on the day after this
1026
+ * date. You can use this parameter to schedule orders for a future date.
1027
+ */
1028
+ sendDate?: string;
1029
+ }
1030
+ }
1031
+ export interface SnapPackListParams extends SkipLimitParams {
1032
+ /**
1033
+ * You can supply any string to help narrow down the list of resources. For
1034
+ * example, if you pass `"New York"` (quoted), it will return resources that have
1035
+ * that string present somewhere in their response. Alternatively, you can supply a
1036
+ * structured search query. See the documentation on `StructuredSearchQuery` for
1037
+ * more details.
1038
+ */
1039
+ search?: string;
1040
+ }
1041
+ export interface SnapPackRetrieveCapabilitiesParams {
1042
+ /**
1043
+ * The country code where mail may be returned to.
1044
+ */
1045
+ returnCountryCode: string;
1046
+ /**
1047
+ * The country code of where the snap pack will be sent to. One of `mailingList` or
1048
+ * `destinationCountryCode` must be supplied but not both.
1049
+ */
1050
+ destinationCountryCode?: string;
1051
+ /**
1052
+ * Sources destination countries from the provided mailing list. One of
1053
+ * `mailingList` or `destinationCountryCode` must be supplied but not both.
1054
+ */
1055
+ mailingList?: string;
1056
+ }
1057
+ export declare namespace SnapPacks {
1058
+ export { type SnapPackCreateResponse as SnapPackCreateResponse, type SnapPackRetrieveResponse as SnapPackRetrieveResponse, type SnapPackListResponse as SnapPackListResponse, type SnapPackDeleteResponse as SnapPackDeleteResponse, type SnapPackProgressionsResponse as SnapPackProgressionsResponse, type SnapPackRetrieveCapabilitiesResponse as SnapPackRetrieveCapabilitiesResponse, type SnapPackListResponsesSkipLimit as SnapPackListResponsesSkipLimit, type SnapPackCreateParams as SnapPackCreateParams, type SnapPackListParams as SnapPackListParams, type SnapPackRetrieveCapabilitiesParams as SnapPackRetrieveCapabilitiesParams, };
1059
+ }
1060
+ //# sourceMappingURL=snap-packs.d.mts.map