postgrid-node 0.4.2 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (422) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/LICENSE +1 -1
  3. package/README.md +15 -12
  4. package/client.d.mts +35 -15
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +35 -15
  7. package/client.d.ts.map +1 -1
  8. package/client.js +61 -15
  9. package/client.js.map +1 -1
  10. package/client.mjs +62 -16
  11. package/client.mjs.map +1 -1
  12. package/internal/parse.d.mts.map +1 -1
  13. package/internal/parse.d.ts.map +1 -1
  14. package/internal/parse.js +5 -0
  15. package/internal/parse.js.map +1 -1
  16. package/internal/parse.mjs +5 -0
  17. package/internal/parse.mjs.map +1 -1
  18. package/internal/types.d.mts +6 -6
  19. package/internal/types.d.mts.map +1 -1
  20. package/internal/types.d.ts +6 -6
  21. package/internal/types.d.ts.map +1 -1
  22. package/internal/utils/env.js +2 -2
  23. package/internal/utils/env.js.map +1 -1
  24. package/internal/utils/env.mjs +2 -2
  25. package/internal/utils/env.mjs.map +1 -1
  26. package/internal/utils/log.d.mts.map +1 -1
  27. package/internal/utils/log.d.ts.map +1 -1
  28. package/internal/utils/log.js +3 -2
  29. package/internal/utils/log.js.map +1 -1
  30. package/internal/utils/log.mjs +3 -2
  31. package/internal/utils/log.mjs.map +1 -1
  32. package/internal/utils/query.d.mts +5 -0
  33. package/internal/utils/query.d.mts.map +1 -0
  34. package/internal/utils/query.d.ts +5 -0
  35. package/internal/utils/query.d.ts.map +1 -0
  36. package/internal/utils/query.js +23 -0
  37. package/internal/utils/query.js.map +1 -0
  38. package/internal/utils/query.mjs +20 -0
  39. package/internal/utils/query.mjs.map +1 -0
  40. package/internal/utils.d.mts +1 -0
  41. package/internal/utils.d.ts +1 -0
  42. package/internal/utils.js +1 -0
  43. package/internal/utils.js.map +1 -1
  44. package/internal/utils.mjs +1 -0
  45. package/package.json +9 -3
  46. package/resources/address-verification.d.mts +1689 -15
  47. package/resources/address-verification.d.mts.map +1 -1
  48. package/resources/address-verification.d.ts +1689 -15
  49. package/resources/address-verification.d.ts.map +1 -1
  50. package/resources/address-verification.js +200 -0
  51. package/resources/address-verification.js.map +1 -1
  52. package/resources/address-verification.mjs +200 -0
  53. package/resources/address-verification.mjs.map +1 -1
  54. package/resources/index.d.mts +3 -3
  55. package/resources/index.d.mts.map +1 -1
  56. package/resources/index.d.ts +3 -3
  57. package/resources/index.d.ts.map +1 -1
  58. package/resources/index.js.map +1 -1
  59. package/resources/index.mjs +1 -1
  60. package/resources/index.mjs.map +1 -1
  61. package/resources/intl-address-verification.d.mts +956 -35
  62. package/resources/intl-address-verification.d.mts.map +1 -1
  63. package/resources/intl-address-verification.d.ts +956 -35
  64. package/resources/intl-address-verification.d.ts.map +1 -1
  65. package/resources/intl-address-verification.js +121 -27
  66. package/resources/intl-address-verification.js.map +1 -1
  67. package/resources/intl-address-verification.mjs +121 -27
  68. package/resources/intl-address-verification.mjs.map +1 -1
  69. package/resources/print-mail/boxes.d.mts +733 -59
  70. package/resources/print-mail/boxes.d.mts.map +1 -1
  71. package/resources/print-mail/boxes.d.ts +733 -59
  72. package/resources/print-mail/boxes.d.ts.map +1 -1
  73. package/resources/print-mail/boxes.js +19 -1
  74. package/resources/print-mail/boxes.js.map +1 -1
  75. package/resources/print-mail/boxes.mjs +19 -1
  76. package/resources/print-mail/boxes.mjs.map +1 -1
  77. package/resources/print-mail/campaigns.d.mts +923 -34
  78. package/resources/print-mail/campaigns.d.mts.map +1 -1
  79. package/resources/print-mail/campaigns.d.ts +923 -34
  80. package/resources/print-mail/campaigns.d.ts.map +1 -1
  81. package/resources/print-mail/campaigns.js +10 -3
  82. package/resources/print-mail/campaigns.js.map +1 -1
  83. package/resources/print-mail/campaigns.mjs +10 -3
  84. package/resources/print-mail/campaigns.mjs.map +1 -1
  85. package/resources/print-mail/cheques.d.mts +60 -11
  86. package/resources/print-mail/cheques.d.mts.map +1 -1
  87. package/resources/print-mail/cheques.d.ts +60 -11
  88. package/resources/print-mail/cheques.d.ts.map +1 -1
  89. package/resources/print-mail/cheques.js +32 -0
  90. package/resources/print-mail/cheques.js.map +1 -1
  91. package/resources/print-mail/cheques.mjs +32 -0
  92. package/resources/print-mail/cheques.mjs.map +1 -1
  93. package/resources/print-mail/contacts.d.mts +138 -3
  94. package/resources/print-mail/contacts.d.mts.map +1 -1
  95. package/resources/print-mail/contacts.d.ts +138 -3
  96. package/resources/print-mail/contacts.d.ts.map +1 -1
  97. package/resources/print-mail/contacts.js.map +1 -1
  98. package/resources/print-mail/contacts.mjs.map +1 -1
  99. package/resources/print-mail/index.d.mts +12 -8
  100. package/resources/print-mail/index.d.mts.map +1 -1
  101. package/resources/print-mail/index.d.ts +12 -8
  102. package/resources/print-mail/index.d.ts.map +1 -1
  103. package/resources/print-mail/index.js +13 -5
  104. package/resources/print-mail/index.js.map +1 -1
  105. package/resources/print-mail/index.mjs +5 -1
  106. package/resources/print-mail/index.mjs.map +1 -1
  107. package/resources/print-mail/letters.d.mts +62 -13
  108. package/resources/print-mail/letters.d.mts.map +1 -1
  109. package/resources/print-mail/letters.d.ts +62 -13
  110. package/resources/print-mail/letters.d.ts.map +1 -1
  111. package/resources/print-mail/letters.js +32 -0
  112. package/resources/print-mail/letters.js.map +1 -1
  113. package/resources/print-mail/letters.mjs +32 -0
  114. package/resources/print-mail/letters.mjs.map +1 -1
  115. package/resources/print-mail/mailing-list-imports.d.mts +5 -1
  116. package/resources/print-mail/mailing-list-imports.d.mts.map +1 -1
  117. package/resources/print-mail/mailing-list-imports.d.ts +5 -1
  118. package/resources/print-mail/mailing-list-imports.d.ts.map +1 -1
  119. package/resources/print-mail/mailing-list-imports.js +4 -0
  120. package/resources/print-mail/mailing-list-imports.js.map +1 -1
  121. package/resources/print-mail/mailing-list-imports.mjs +4 -0
  122. package/resources/print-mail/mailing-list-imports.mjs.map +1 -1
  123. package/resources/print-mail/mailing-lists.d.mts +5 -1
  124. package/resources/print-mail/mailing-lists.d.mts.map +1 -1
  125. package/resources/print-mail/mailing-lists.d.ts +5 -1
  126. package/resources/print-mail/mailing-lists.d.ts.map +1 -1
  127. package/resources/print-mail/mailing-lists.js +4 -0
  128. package/resources/print-mail/mailing-lists.js.map +1 -1
  129. package/resources/print-mail/mailing-lists.mjs +4 -0
  130. package/resources/print-mail/mailing-lists.mjs.map +1 -1
  131. package/resources/print-mail/postcards.d.mts +90 -21
  132. package/resources/print-mail/postcards.d.mts.map +1 -1
  133. package/resources/print-mail/postcards.d.ts +90 -21
  134. package/resources/print-mail/postcards.d.ts.map +1 -1
  135. package/resources/print-mail/postcards.js +33 -0
  136. package/resources/print-mail/postcards.js.map +1 -1
  137. package/resources/print-mail/postcards.mjs +33 -0
  138. package/resources/print-mail/postcards.mjs.map +1 -1
  139. package/resources/print-mail/print-mail.d.mts +41 -162
  140. package/resources/print-mail/print-mail.d.mts.map +1 -1
  141. package/resources/print-mail/print-mail.d.ts +41 -162
  142. package/resources/print-mail/print-mail.d.ts.map +1 -1
  143. package/resources/print-mail/print-mail.js +34 -18
  144. package/resources/print-mail/print-mail.js.map +1 -1
  145. package/resources/print-mail/print-mail.mjs +34 -18
  146. package/resources/print-mail/print-mail.mjs.map +1 -1
  147. package/resources/print-mail/reports/exports.d.mts +7 -0
  148. package/resources/print-mail/reports/exports.d.mts.map +1 -1
  149. package/resources/print-mail/reports/exports.d.ts +7 -0
  150. package/resources/print-mail/reports/exports.d.ts.map +1 -1
  151. package/resources/print-mail/reports/exports.js +7 -0
  152. package/resources/print-mail/reports/exports.js.map +1 -1
  153. package/resources/print-mail/reports/exports.mjs +7 -0
  154. package/resources/print-mail/reports/exports.mjs.map +1 -1
  155. package/resources/print-mail/reports/reports.d.mts +7 -0
  156. package/resources/print-mail/reports/reports.d.mts.map +1 -1
  157. package/resources/print-mail/reports/reports.d.ts +7 -0
  158. package/resources/print-mail/reports/reports.d.ts.map +1 -1
  159. package/resources/print-mail/reports/reports.js +7 -0
  160. package/resources/print-mail/reports/reports.js.map +1 -1
  161. package/resources/print-mail/reports/reports.mjs +7 -0
  162. package/resources/print-mail/reports/reports.mjs.map +1 -1
  163. package/resources/print-mail/reports/samples.d.mts +7 -0
  164. package/resources/print-mail/reports/samples.d.mts.map +1 -1
  165. package/resources/print-mail/reports/samples.d.ts +7 -0
  166. package/resources/print-mail/reports/samples.d.ts.map +1 -1
  167. package/resources/print-mail/reports/samples.js +7 -0
  168. package/resources/print-mail/reports/samples.js.map +1 -1
  169. package/resources/print-mail/reports/samples.mjs +7 -0
  170. package/resources/print-mail/reports/samples.mjs.map +1 -1
  171. package/resources/print-mail/self-mailers.d.mts +52 -20
  172. package/resources/print-mail/self-mailers.d.mts.map +1 -1
  173. package/resources/print-mail/self-mailers.d.ts +52 -20
  174. package/resources/print-mail/self-mailers.d.ts.map +1 -1
  175. package/resources/print-mail/self-mailers.js +17 -0
  176. package/resources/print-mail/self-mailers.js.map +1 -1
  177. package/resources/print-mail/self-mailers.mjs +17 -0
  178. package/resources/print-mail/self-mailers.mjs.map +1 -1
  179. package/resources/print-mail/snap-packs.d.mts +1060 -0
  180. package/resources/print-mail/snap-packs.d.mts.map +1 -0
  181. package/resources/print-mail/snap-packs.d.ts +1060 -0
  182. package/resources/print-mail/snap-packs.d.ts.map +1 -0
  183. package/resources/print-mail/snap-packs.js +117 -0
  184. package/resources/print-mail/snap-packs.js.map +1 -0
  185. package/resources/print-mail/snap-packs.mjs +113 -0
  186. package/resources/print-mail/snap-packs.mjs.map +1 -0
  187. package/resources/print-mail/sub-organizations.d.mts +29 -17
  188. package/resources/print-mail/sub-organizations.d.mts.map +1 -1
  189. package/resources/print-mail/sub-organizations.d.ts +29 -17
  190. package/resources/print-mail/sub-organizations.d.ts.map +1 -1
  191. package/resources/print-mail/sub-organizations.js +26 -14
  192. package/resources/print-mail/sub-organizations.js.map +1 -1
  193. package/resources/print-mail/sub-organizations.mjs +26 -14
  194. package/resources/print-mail/sub-organizations.mjs.map +1 -1
  195. package/resources/print-mail/targeted-list-builds/filters.d.mts +92 -0
  196. package/resources/print-mail/targeted-list-builds/filters.d.mts.map +1 -0
  197. package/resources/print-mail/targeted-list-builds/filters.d.ts +92 -0
  198. package/resources/print-mail/targeted-list-builds/filters.d.ts.map +1 -0
  199. package/resources/print-mail/targeted-list-builds/filters.js +60 -0
  200. package/resources/print-mail/targeted-list-builds/filters.js.map +1 -0
  201. package/resources/print-mail/targeted-list-builds/filters.mjs +56 -0
  202. package/resources/print-mail/targeted-list-builds/filters.mjs.map +1 -0
  203. package/resources/print-mail/targeted-list-builds/index.d.mts +3 -0
  204. package/resources/print-mail/targeted-list-builds/index.d.mts.map +1 -0
  205. package/resources/print-mail/targeted-list-builds/index.d.ts +3 -0
  206. package/resources/print-mail/targeted-list-builds/index.d.ts.map +1 -0
  207. package/resources/print-mail/targeted-list-builds/index.js +9 -0
  208. package/resources/print-mail/targeted-list-builds/index.js.map +1 -0
  209. package/resources/print-mail/targeted-list-builds/index.mjs +4 -0
  210. package/resources/print-mail/targeted-list-builds/index.mjs.map +1 -0
  211. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts +1633 -0
  212. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts.map +1 -0
  213. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts +1633 -0
  214. package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts.map +1 -0
  215. package/resources/print-mail/targeted-list-builds/targeted-list-builds.js +154 -0
  216. package/resources/print-mail/targeted-list-builds/targeted-list-builds.js.map +1 -0
  217. package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs +149 -0
  218. package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs.map +1 -0
  219. package/resources/print-mail/targeted-list-builds.d.mts +2 -0
  220. package/resources/print-mail/targeted-list-builds.d.mts.map +1 -0
  221. package/resources/print-mail/targeted-list-builds.d.ts +2 -0
  222. package/resources/print-mail/targeted-list-builds.d.ts.map +1 -0
  223. package/resources/print-mail/targeted-list-builds.js +6 -0
  224. package/resources/print-mail/targeted-list-builds.js.map +1 -0
  225. package/resources/print-mail/targeted-list-builds.mjs +3 -0
  226. package/resources/print-mail/targeted-list-builds.mjs.map +1 -0
  227. package/resources/print-mail/template-editor-sessions.d.mts +355 -0
  228. package/resources/print-mail/template-editor-sessions.d.mts.map +1 -0
  229. package/resources/print-mail/template-editor-sessions.d.ts +355 -0
  230. package/resources/print-mail/template-editor-sessions.d.ts.map +1 -0
  231. package/resources/print-mail/template-editor-sessions.js +78 -0
  232. package/resources/print-mail/template-editor-sessions.js.map +1 -0
  233. package/resources/print-mail/template-editor-sessions.mjs +74 -0
  234. package/resources/print-mail/template-editor-sessions.mjs.map +1 -0
  235. package/resources/print-mail/trackers.d.mts +409 -0
  236. package/resources/print-mail/trackers.d.mts.map +1 -0
  237. package/resources/print-mail/trackers.d.ts +409 -0
  238. package/resources/print-mail/trackers.d.ts.map +1 -0
  239. package/resources/print-mail/trackers.js +116 -0
  240. package/resources/print-mail/trackers.js.map +1 -0
  241. package/resources/print-mail/trackers.mjs +112 -0
  242. package/resources/print-mail/trackers.mjs.map +1 -0
  243. package/resources/print-mail/virtual-mailboxes/index.d.mts +3 -0
  244. package/resources/print-mail/virtual-mailboxes/index.d.mts.map +1 -0
  245. package/resources/print-mail/virtual-mailboxes/index.d.ts +3 -0
  246. package/resources/print-mail/virtual-mailboxes/index.d.ts.map +1 -0
  247. package/resources/print-mail/virtual-mailboxes/index.js +9 -0
  248. package/resources/print-mail/virtual-mailboxes/index.js.map +1 -0
  249. package/resources/print-mail/virtual-mailboxes/index.mjs +4 -0
  250. package/resources/print-mail/virtual-mailboxes/index.mjs.map +1 -0
  251. package/resources/print-mail/virtual-mailboxes/items.d.mts +235 -0
  252. package/resources/print-mail/virtual-mailboxes/items.d.mts.map +1 -0
  253. package/resources/print-mail/virtual-mailboxes/items.d.ts +235 -0
  254. package/resources/print-mail/virtual-mailboxes/items.d.ts.map +1 -0
  255. package/resources/print-mail/virtual-mailboxes/items.js +69 -0
  256. package/resources/print-mail/virtual-mailboxes/items.js.map +1 -0
  257. package/resources/print-mail/virtual-mailboxes/items.mjs +65 -0
  258. package/resources/print-mail/virtual-mailboxes/items.mjs.map +1 -0
  259. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts +334 -0
  260. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts.map +1 -0
  261. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts +334 -0
  262. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts.map +1 -0
  263. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js +92 -0
  264. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js.map +1 -0
  265. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs +87 -0
  266. package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs.map +1 -0
  267. package/resources/print-mail/virtual-mailboxes.d.mts +2 -0
  268. package/resources/print-mail/virtual-mailboxes.d.mts.map +1 -0
  269. package/resources/print-mail/virtual-mailboxes.d.ts +2 -0
  270. package/resources/print-mail/virtual-mailboxes.d.ts.map +1 -0
  271. package/resources/print-mail/{order-profiles.js → virtual-mailboxes.js} +2 -2
  272. package/resources/print-mail/virtual-mailboxes.js.map +1 -0
  273. package/resources/print-mail/virtual-mailboxes.mjs +3 -0
  274. package/resources/print-mail/virtual-mailboxes.mjs.map +1 -0
  275. package/src/client.ts +123 -33
  276. package/src/internal/parse.ts +6 -0
  277. package/src/internal/types.ts +6 -8
  278. package/src/internal/utils/env.ts +2 -2
  279. package/src/internal/utils/log.ts +2 -1
  280. package/src/internal/utils/query.ts +23 -0
  281. package/src/internal/utils.ts +1 -0
  282. package/src/resources/address-verification.ts +2190 -24
  283. package/src/resources/index.ts +24 -5
  284. package/src/resources/intl-address-verification.ts +1219 -43
  285. package/src/resources/print-mail/boxes.ts +1011 -99
  286. package/src/resources/print-mail/campaigns.ts +1449 -59
  287. package/src/resources/print-mail/cheques.ts +122 -10
  288. package/src/resources/print-mail/contacts.ts +167 -4
  289. package/src/resources/print-mail/index.ts +74 -11
  290. package/src/resources/print-mail/letters.ts +150 -12
  291. package/src/resources/print-mail/mailing-list-imports.ts +5 -1
  292. package/src/resources/print-mail/mailing-lists.ts +5 -1
  293. package/src/resources/print-mail/postcards.ts +208 -20
  294. package/src/resources/print-mail/print-mail.ts +239 -261
  295. package/src/resources/print-mail/reports/exports.ts +7 -0
  296. package/src/resources/print-mail/reports/reports.ts +7 -0
  297. package/src/resources/print-mail/reports/samples.ts +7 -0
  298. package/src/resources/print-mail/self-mailers.ts +162 -20
  299. package/src/resources/print-mail/snap-packs.ts +1484 -0
  300. package/src/resources/print-mail/sub-organizations.ts +35 -23
  301. package/src/resources/print-mail/targeted-list-builds/filters.ts +113 -0
  302. package/src/resources/print-mail/targeted-list-builds/index.ts +16 -0
  303. package/src/resources/print-mail/targeted-list-builds/targeted-list-builds.ts +2158 -0
  304. package/{resources/print-mail/order-profiles.mjs → src/resources/print-mail/targeted-list-builds.ts} +2 -2
  305. package/src/resources/print-mail/template-editor-sessions.ts +435 -0
  306. package/src/resources/print-mail/trackers.ts +513 -0
  307. package/src/resources/print-mail/virtual-mailboxes/index.ts +22 -0
  308. package/src/resources/print-mail/virtual-mailboxes/items.ts +296 -0
  309. package/src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts +434 -0
  310. package/src/resources/print-mail/{order-profiles.ts → virtual-mailboxes.ts} +1 -1
  311. package/src/version.ts +1 -1
  312. package/version.d.mts +1 -1
  313. package/version.d.ts +1 -1
  314. package/version.js +1 -1
  315. package/version.mjs +1 -1
  316. package/internal/qs/formats.d.mts +0 -7
  317. package/internal/qs/formats.d.mts.map +0 -1
  318. package/internal/qs/formats.d.ts +0 -7
  319. package/internal/qs/formats.d.ts.map +0 -1
  320. package/internal/qs/formats.js +0 -13
  321. package/internal/qs/formats.js.map +0 -1
  322. package/internal/qs/formats.mjs +0 -9
  323. package/internal/qs/formats.mjs.map +0 -1
  324. package/internal/qs/index.d.mts +0 -10
  325. package/internal/qs/index.d.mts.map +0 -1
  326. package/internal/qs/index.d.ts +0 -10
  327. package/internal/qs/index.d.ts.map +0 -1
  328. package/internal/qs/index.js +0 -14
  329. package/internal/qs/index.js.map +0 -1
  330. package/internal/qs/index.mjs +0 -10
  331. package/internal/qs/index.mjs.map +0 -1
  332. package/internal/qs/stringify.d.mts +0 -3
  333. package/internal/qs/stringify.d.mts.map +0 -1
  334. package/internal/qs/stringify.d.ts +0 -3
  335. package/internal/qs/stringify.d.ts.map +0 -1
  336. package/internal/qs/stringify.js +0 -277
  337. package/internal/qs/stringify.js.map +0 -1
  338. package/internal/qs/stringify.mjs +0 -274
  339. package/internal/qs/stringify.mjs.map +0 -1
  340. package/internal/qs/types.d.mts +0 -57
  341. package/internal/qs/types.d.mts.map +0 -1
  342. package/internal/qs/types.d.ts +0 -57
  343. package/internal/qs/types.d.ts.map +0 -1
  344. package/internal/qs/types.js +0 -3
  345. package/internal/qs/types.js.map +0 -1
  346. package/internal/qs/types.mjs +0 -2
  347. package/internal/qs/types.mjs.map +0 -1
  348. package/internal/qs/utils.d.mts +0 -15
  349. package/internal/qs/utils.d.mts.map +0 -1
  350. package/internal/qs/utils.d.ts +0 -15
  351. package/internal/qs/utils.d.ts.map +0 -1
  352. package/internal/qs/utils.js +0 -230
  353. package/internal/qs/utils.js.map +0 -1
  354. package/internal/qs/utils.mjs +0 -217
  355. package/internal/qs/utils.mjs.map +0 -1
  356. package/resources/print-mail/order-profiles/cheques.d.mts +0 -388
  357. package/resources/print-mail/order-profiles/cheques.d.mts.map +0 -1
  358. package/resources/print-mail/order-profiles/cheques.d.ts +0 -388
  359. package/resources/print-mail/order-profiles/cheques.d.ts.map +0 -1
  360. package/resources/print-mail/order-profiles/cheques.js +0 -98
  361. package/resources/print-mail/order-profiles/cheques.js.map +0 -1
  362. package/resources/print-mail/order-profiles/cheques.mjs +0 -94
  363. package/resources/print-mail/order-profiles/cheques.mjs.map +0 -1
  364. package/resources/print-mail/order-profiles/index.d.mts +0 -6
  365. package/resources/print-mail/order-profiles/index.d.mts.map +0 -1
  366. package/resources/print-mail/order-profiles/index.d.ts +0 -6
  367. package/resources/print-mail/order-profiles/index.d.ts.map +0 -1
  368. package/resources/print-mail/order-profiles/index.js +0 -15
  369. package/resources/print-mail/order-profiles/index.js.map +0 -1
  370. package/resources/print-mail/order-profiles/index.mjs +0 -7
  371. package/resources/print-mail/order-profiles/index.mjs.map +0 -1
  372. package/resources/print-mail/order-profiles/letters.d.mts +0 -325
  373. package/resources/print-mail/order-profiles/letters.d.mts.map +0 -1
  374. package/resources/print-mail/order-profiles/letters.d.ts +0 -325
  375. package/resources/print-mail/order-profiles/letters.d.ts.map +0 -1
  376. package/resources/print-mail/order-profiles/letters.js +0 -105
  377. package/resources/print-mail/order-profiles/letters.js.map +0 -1
  378. package/resources/print-mail/order-profiles/letters.mjs +0 -101
  379. package/resources/print-mail/order-profiles/letters.mjs.map +0 -1
  380. package/resources/print-mail/order-profiles/order-profiles.d.mts +0 -22
  381. package/resources/print-mail/order-profiles/order-profiles.d.mts.map +0 -1
  382. package/resources/print-mail/order-profiles/order-profiles.d.ts +0 -22
  383. package/resources/print-mail/order-profiles/order-profiles.d.ts.map +0 -1
  384. package/resources/print-mail/order-profiles/order-profiles.js +0 -29
  385. package/resources/print-mail/order-profiles/order-profiles.js.map +0 -1
  386. package/resources/print-mail/order-profiles/order-profiles.mjs +0 -24
  387. package/resources/print-mail/order-profiles/order-profiles.mjs.map +0 -1
  388. package/resources/print-mail/order-profiles/postcards.d.mts +0 -255
  389. package/resources/print-mail/order-profiles/postcards.d.mts.map +0 -1
  390. package/resources/print-mail/order-profiles/postcards.d.ts +0 -255
  391. package/resources/print-mail/order-profiles/postcards.d.ts.map +0 -1
  392. package/resources/print-mail/order-profiles/postcards.js +0 -97
  393. package/resources/print-mail/order-profiles/postcards.js.map +0 -1
  394. package/resources/print-mail/order-profiles/postcards.mjs +0 -93
  395. package/resources/print-mail/order-profiles/postcards.mjs.map +0 -1
  396. package/resources/print-mail/order-profiles/self-mailers.d.mts +0 -260
  397. package/resources/print-mail/order-profiles/self-mailers.d.mts.map +0 -1
  398. package/resources/print-mail/order-profiles/self-mailers.d.ts +0 -260
  399. package/resources/print-mail/order-profiles/self-mailers.d.ts.map +0 -1
  400. package/resources/print-mail/order-profiles/self-mailers.js +0 -95
  401. package/resources/print-mail/order-profiles/self-mailers.js.map +0 -1
  402. package/resources/print-mail/order-profiles/self-mailers.mjs +0 -91
  403. package/resources/print-mail/order-profiles/self-mailers.mjs.map +0 -1
  404. package/resources/print-mail/order-profiles.d.mts +0 -2
  405. package/resources/print-mail/order-profiles.d.mts.map +0 -1
  406. package/resources/print-mail/order-profiles.d.ts +0 -2
  407. package/resources/print-mail/order-profiles.d.ts.map +0 -1
  408. package/resources/print-mail/order-profiles.js.map +0 -1
  409. package/resources/print-mail/order-profiles.mjs.map +0 -1
  410. package/src/internal/qs/LICENSE.md +0 -13
  411. package/src/internal/qs/README.md +0 -3
  412. package/src/internal/qs/formats.ts +0 -10
  413. package/src/internal/qs/index.ts +0 -13
  414. package/src/internal/qs/stringify.ts +0 -385
  415. package/src/internal/qs/types.ts +0 -71
  416. package/src/internal/qs/utils.ts +0 -265
  417. package/src/resources/print-mail/order-profiles/cheques.ts +0 -486
  418. package/src/resources/print-mail/order-profiles/index.ts +0 -47
  419. package/src/resources/print-mail/order-profiles/letters.ts +0 -412
  420. package/src/resources/print-mail/order-profiles/order-profiles.ts +0 -113
  421. package/src/resources/print-mail/order-profiles/postcards.ts +0 -327
  422. package/src/resources/print-mail/order-profiles/self-mailers.ts +0 -338
@@ -1,260 +0,0 @@
1
- import { APIResource } from "../../../core/resource.mjs";
2
- import * as BoxesAPI from "../boxes.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
- export declare class SelfMailers extends APIResource {
7
- /**
8
- * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
9
- * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
10
- * request `Content-Type` must be `multipart/form-data`.
11
- *
12
- * @example
13
- * ```ts
14
- * const selfMailerProfile =
15
- * await client.printMail.orderProfiles.selfMailers.create({
16
- * size: '8.5x11_bifold',
17
- * });
18
- * ```
19
- */
20
- create(params: SelfMailerCreateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
21
- /**
22
- * Retrieves the details of a specific Self-Mailer Profile.
23
- *
24
- * @example
25
- * ```ts
26
- * const selfMailerProfile =
27
- * await client.printMail.orderProfiles.selfMailers.retrieve(
28
- * 'id',
29
- * );
30
- * ```
31
- */
32
- retrieve(id: string, query?: SelfMailerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerProfile>;
33
- /**
34
- * Updates specific fields of an existing Self-Mailer Profile. If providing a
35
- * `pdf`, the request `Content-Type` must be `multipart/form-data`.
36
- *
37
- * @example
38
- * ```ts
39
- * const selfMailerProfile =
40
- * await client.printMail.orderProfiles.selfMailers.update(
41
- * 'id',
42
- * { size: '8.5x11_bifold' },
43
- * );
44
- * ```
45
- */
46
- update(id: string, params: SelfMailerUpdateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
47
- /**
48
- * Retrieves a list of Self-Mailer Profiles.
49
- *
50
- * @example
51
- * ```ts
52
- * // Automatically fetches more pages as needed.
53
- * for await (const selfMailerProfile of client.printMail.orderProfiles.selfMailers.list()) {
54
- * // ...
55
- * }
56
- * ```
57
- */
58
- list(query?: SelfMailerListParams | null | undefined, options?: RequestOptions): PagePromise<SelfMailerProfilesSkipLimit, SelfMailerProfile>;
59
- /**
60
- * Deletes a Self-Mailer Profile.
61
- *
62
- * @example
63
- * ```ts
64
- * const selfMailer =
65
- * await client.printMail.orderProfiles.selfMailers.delete(
66
- * 'id',
67
- * );
68
- * ```
69
- */
70
- delete(id: string, options?: RequestOptions): APIPromise<SelfMailerDeleteResponse>;
71
- }
72
- export type SelfMailerProfilesSkipLimit = SkipLimit<SelfMailerProfile>;
73
- /**
74
- * Represents a Self-Mailer Profile resource.
75
- */
76
- export interface SelfMailerProfile {
77
- /**
78
- * Unique identifier for the order profile.
79
- */
80
- id: string;
81
- /**
82
- * Timestamp when the profile was created.
83
- */
84
- createdAt: string;
85
- /**
86
- * Indicates if the profile is associated with the live or test environment.
87
- */
88
- live: boolean;
89
- /**
90
- * Always `self_mailer_profile`.
91
- */
92
- object: 'self_mailer_profile';
93
- /**
94
- * Enum representing the supported self-mailer sizes.
95
- */
96
- size: SelfMailerSize;
97
- /**
98
- * Timestamp when the profile was last updated.
99
- */
100
- updatedAt: string;
101
- /**
102
- * An optional description for the profile. Set to `null` to remove during update.
103
- */
104
- description?: string | null;
105
- /**
106
- * ID of the template for the inside. Required unless `pdf` is provided.
107
- */
108
- insideTemplate?: string;
109
- /**
110
- * Mailing class (cannot include extra services for self-mailers).
111
- */
112
- mailingClass?: BoxesAPI.OrderMailingClass;
113
- /**
114
- * Default merge variables for orders created using this profile.
115
- */
116
- mergeVariables?: {
117
- [key: string]: unknown;
118
- } | null;
119
- /**
120
- * Optional key-value metadata.
121
- */
122
- metadata?: {
123
- [key: string]: string;
124
- } | null;
125
- /**
126
- * ID of the template for the outside. Required unless `pdf` is provided.
127
- */
128
- outsideTemplate?: string;
129
- /**
130
- * A temporary, signed URL to view the uploaded PDF, if any.
131
- */
132
- uploadedPDF?: string;
133
- }
134
- /**
135
- * Enum representing the supported self-mailer sizes.
136
- */
137
- export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
138
- export interface SelfMailerDeleteResponse {
139
- /**
140
- * Unique identifier for the order profile.
141
- */
142
- id: string;
143
- deleted: true;
144
- /**
145
- * Always `self_mailer_profile`.
146
- */
147
- object: 'self_mailer_profile';
148
- }
149
- export interface SelfMailerCreateParams {
150
- /**
151
- * Body param: Enum representing the supported self-mailer sizes.
152
- */
153
- size: SelfMailerSize;
154
- /**
155
- * Query param: Optional list of related resources to expand in the response.
156
- */
157
- expand?: Array<string>;
158
- /**
159
- * Body param: An optional description for the profile. Set to `null` to remove
160
- * during update.
161
- */
162
- description?: string | null;
163
- /**
164
- * Body param: ID of the template for the inside. Required unless `pdf` is
165
- * provided.
166
- */
167
- insideTemplate?: string;
168
- /**
169
- * Body param: Mailing class (cannot include extra services for self-mailers).
170
- */
171
- mailingClass?: BoxesAPI.OrderMailingClass;
172
- /**
173
- * Body param: Default merge variables for orders created using this profile.
174
- */
175
- mergeVariables?: {
176
- [key: string]: unknown;
177
- } | null;
178
- /**
179
- * Body param: Optional key-value metadata.
180
- */
181
- metadata?: {
182
- [key: string]: string;
183
- } | null;
184
- /**
185
- * Body param: ID of the template for the outside. Required unless `pdf` is
186
- * provided.
187
- */
188
- outsideTemplate?: string;
189
- /**
190
- * Body param: A 2-page PDF file containing the self-mailer content (inside and
191
- * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
192
- */
193
- pdf?: string;
194
- }
195
- export interface SelfMailerRetrieveParams {
196
- /**
197
- * Optional list of related resources to expand in the response.
198
- */
199
- expand?: Array<string>;
200
- }
201
- export interface SelfMailerUpdateParams {
202
- /**
203
- * Body param: Enum representing the supported self-mailer sizes.
204
- */
205
- size: SelfMailerSize;
206
- /**
207
- * Query param: Optional list of related resources to expand in the response.
208
- */
209
- expand?: Array<string>;
210
- /**
211
- * Body param: An optional description for the profile. Set to `null` to remove
212
- * during update.
213
- */
214
- description?: string | null;
215
- /**
216
- * Body param: ID of the template for the inside. Required unless `pdf` is
217
- * provided.
218
- */
219
- insideTemplate?: string;
220
- /**
221
- * Body param: Mailing class (cannot include extra services for self-mailers).
222
- */
223
- mailingClass?: BoxesAPI.OrderMailingClass;
224
- /**
225
- * Body param: Default merge variables for orders created using this profile.
226
- */
227
- mergeVariables?: {
228
- [key: string]: unknown;
229
- } | null;
230
- /**
231
- * Body param: Optional key-value metadata.
232
- */
233
- metadata?: {
234
- [key: string]: string;
235
- } | null;
236
- /**
237
- * Body param: ID of the template for the outside. Required unless `pdf` is
238
- * provided.
239
- */
240
- outsideTemplate?: string;
241
- /**
242
- * Body param: A 2-page PDF file containing the self-mailer content (inside and
243
- * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
244
- */
245
- pdf?: string;
246
- }
247
- export interface SelfMailerListParams extends SkipLimitParams {
248
- /**
249
- * You can supply any string to help narrow down the list of resources. For
250
- * example, if you pass `"New York"` (quoted), it will return resources that have
251
- * that string present somewhere in their response. Alternatively, you can supply a
252
- * structured search query. See the documentation on `StructuredSearchQuery` for
253
- * more details.
254
- */
255
- search?: string;
256
- }
257
- export declare namespace SelfMailers {
258
- export { type SelfMailerProfile as SelfMailerProfile, type SelfMailerSize as SelfMailerSize, type SelfMailerDeleteResponse as SelfMailerDeleteResponse, type SelfMailerProfilesSkipLimit as SelfMailerProfilesSkipLimit, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerRetrieveParams as SelfMailerRetrieveParams, type SelfMailerUpdateParams as SelfMailerUpdateParams, type SelfMailerListParams as SelfMailerListParams, };
259
- }
260
- //# sourceMappingURL=self-mailers.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"self-mailers.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAS/F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAShC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,iBAAiB,CAAC;IAQ9D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED,MAAM,MAAM,2BAA2B,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;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,qBAAqB,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEnF,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -1,260 +0,0 @@
1
- import { APIResource } from "../../../core/resource.js";
2
- import * as BoxesAPI from "../boxes.js";
3
- import { APIPromise } from "../../../core/api-promise.js";
4
- import { PagePromise, SkipLimit, type SkipLimitParams } from "../../../core/pagination.js";
5
- import { RequestOptions } from "../../../internal/request-options.js";
6
- export declare class SelfMailers extends APIResource {
7
- /**
8
- * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
9
- * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
10
- * request `Content-Type` must be `multipart/form-data`.
11
- *
12
- * @example
13
- * ```ts
14
- * const selfMailerProfile =
15
- * await client.printMail.orderProfiles.selfMailers.create({
16
- * size: '8.5x11_bifold',
17
- * });
18
- * ```
19
- */
20
- create(params: SelfMailerCreateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
21
- /**
22
- * Retrieves the details of a specific Self-Mailer Profile.
23
- *
24
- * @example
25
- * ```ts
26
- * const selfMailerProfile =
27
- * await client.printMail.orderProfiles.selfMailers.retrieve(
28
- * 'id',
29
- * );
30
- * ```
31
- */
32
- retrieve(id: string, query?: SelfMailerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SelfMailerProfile>;
33
- /**
34
- * Updates specific fields of an existing Self-Mailer Profile. If providing a
35
- * `pdf`, the request `Content-Type` must be `multipart/form-data`.
36
- *
37
- * @example
38
- * ```ts
39
- * const selfMailerProfile =
40
- * await client.printMail.orderProfiles.selfMailers.update(
41
- * 'id',
42
- * { size: '8.5x11_bifold' },
43
- * );
44
- * ```
45
- */
46
- update(id: string, params: SelfMailerUpdateParams, options?: RequestOptions): APIPromise<SelfMailerProfile>;
47
- /**
48
- * Retrieves a list of Self-Mailer Profiles.
49
- *
50
- * @example
51
- * ```ts
52
- * // Automatically fetches more pages as needed.
53
- * for await (const selfMailerProfile of client.printMail.orderProfiles.selfMailers.list()) {
54
- * // ...
55
- * }
56
- * ```
57
- */
58
- list(query?: SelfMailerListParams | null | undefined, options?: RequestOptions): PagePromise<SelfMailerProfilesSkipLimit, SelfMailerProfile>;
59
- /**
60
- * Deletes a Self-Mailer Profile.
61
- *
62
- * @example
63
- * ```ts
64
- * const selfMailer =
65
- * await client.printMail.orderProfiles.selfMailers.delete(
66
- * 'id',
67
- * );
68
- * ```
69
- */
70
- delete(id: string, options?: RequestOptions): APIPromise<SelfMailerDeleteResponse>;
71
- }
72
- export type SelfMailerProfilesSkipLimit = SkipLimit<SelfMailerProfile>;
73
- /**
74
- * Represents a Self-Mailer Profile resource.
75
- */
76
- export interface SelfMailerProfile {
77
- /**
78
- * Unique identifier for the order profile.
79
- */
80
- id: string;
81
- /**
82
- * Timestamp when the profile was created.
83
- */
84
- createdAt: string;
85
- /**
86
- * Indicates if the profile is associated with the live or test environment.
87
- */
88
- live: boolean;
89
- /**
90
- * Always `self_mailer_profile`.
91
- */
92
- object: 'self_mailer_profile';
93
- /**
94
- * Enum representing the supported self-mailer sizes.
95
- */
96
- size: SelfMailerSize;
97
- /**
98
- * Timestamp when the profile was last updated.
99
- */
100
- updatedAt: string;
101
- /**
102
- * An optional description for the profile. Set to `null` to remove during update.
103
- */
104
- description?: string | null;
105
- /**
106
- * ID of the template for the inside. Required unless `pdf` is provided.
107
- */
108
- insideTemplate?: string;
109
- /**
110
- * Mailing class (cannot include extra services for self-mailers).
111
- */
112
- mailingClass?: BoxesAPI.OrderMailingClass;
113
- /**
114
- * Default merge variables for orders created using this profile.
115
- */
116
- mergeVariables?: {
117
- [key: string]: unknown;
118
- } | null;
119
- /**
120
- * Optional key-value metadata.
121
- */
122
- metadata?: {
123
- [key: string]: string;
124
- } | null;
125
- /**
126
- * ID of the template for the outside. Required unless `pdf` is provided.
127
- */
128
- outsideTemplate?: string;
129
- /**
130
- * A temporary, signed URL to view the uploaded PDF, if any.
131
- */
132
- uploadedPDF?: string;
133
- }
134
- /**
135
- * Enum representing the supported self-mailer sizes.
136
- */
137
- export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
138
- export interface SelfMailerDeleteResponse {
139
- /**
140
- * Unique identifier for the order profile.
141
- */
142
- id: string;
143
- deleted: true;
144
- /**
145
- * Always `self_mailer_profile`.
146
- */
147
- object: 'self_mailer_profile';
148
- }
149
- export interface SelfMailerCreateParams {
150
- /**
151
- * Body param: Enum representing the supported self-mailer sizes.
152
- */
153
- size: SelfMailerSize;
154
- /**
155
- * Query param: Optional list of related resources to expand in the response.
156
- */
157
- expand?: Array<string>;
158
- /**
159
- * Body param: An optional description for the profile. Set to `null` to remove
160
- * during update.
161
- */
162
- description?: string | null;
163
- /**
164
- * Body param: ID of the template for the inside. Required unless `pdf` is
165
- * provided.
166
- */
167
- insideTemplate?: string;
168
- /**
169
- * Body param: Mailing class (cannot include extra services for self-mailers).
170
- */
171
- mailingClass?: BoxesAPI.OrderMailingClass;
172
- /**
173
- * Body param: Default merge variables for orders created using this profile.
174
- */
175
- mergeVariables?: {
176
- [key: string]: unknown;
177
- } | null;
178
- /**
179
- * Body param: Optional key-value metadata.
180
- */
181
- metadata?: {
182
- [key: string]: string;
183
- } | null;
184
- /**
185
- * Body param: ID of the template for the outside. Required unless `pdf` is
186
- * provided.
187
- */
188
- outsideTemplate?: string;
189
- /**
190
- * Body param: A 2-page PDF file containing the self-mailer content (inside and
191
- * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
192
- */
193
- pdf?: string;
194
- }
195
- export interface SelfMailerRetrieveParams {
196
- /**
197
- * Optional list of related resources to expand in the response.
198
- */
199
- expand?: Array<string>;
200
- }
201
- export interface SelfMailerUpdateParams {
202
- /**
203
- * Body param: Enum representing the supported self-mailer sizes.
204
- */
205
- size: SelfMailerSize;
206
- /**
207
- * Query param: Optional list of related resources to expand in the response.
208
- */
209
- expand?: Array<string>;
210
- /**
211
- * Body param: An optional description for the profile. Set to `null` to remove
212
- * during update.
213
- */
214
- description?: string | null;
215
- /**
216
- * Body param: ID of the template for the inside. Required unless `pdf` is
217
- * provided.
218
- */
219
- insideTemplate?: string;
220
- /**
221
- * Body param: Mailing class (cannot include extra services for self-mailers).
222
- */
223
- mailingClass?: BoxesAPI.OrderMailingClass;
224
- /**
225
- * Body param: Default merge variables for orders created using this profile.
226
- */
227
- mergeVariables?: {
228
- [key: string]: unknown;
229
- } | null;
230
- /**
231
- * Body param: Optional key-value metadata.
232
- */
233
- metadata?: {
234
- [key: string]: string;
235
- } | null;
236
- /**
237
- * Body param: ID of the template for the outside. Required unless `pdf` is
238
- * provided.
239
- */
240
- outsideTemplate?: string;
241
- /**
242
- * Body param: A 2-page PDF file containing the self-mailer content (inside and
243
- * outside). Cannot be used with `insideTemplate`/`outsideTemplate`.
244
- */
245
- pdf?: string;
246
- }
247
- export interface SelfMailerListParams extends SkipLimitParams {
248
- /**
249
- * You can supply any string to help narrow down the list of resources. For
250
- * example, if you pass `"New York"` (quoted), it will return resources that have
251
- * that string present somewhere in their response. Alternatively, you can supply a
252
- * structured search query. See the documentation on `StructuredSearchQuery` for
253
- * more details.
254
- */
255
- search?: string;
256
- }
257
- export declare namespace SelfMailers {
258
- export { type SelfMailerProfile as SelfMailerProfile, type SelfMailerSize as SelfMailerSize, type SelfMailerDeleteResponse as SelfMailerDeleteResponse, type SelfMailerProfilesSkipLimit as SelfMailerProfilesSkipLimit, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerRetrieveParams as SelfMailerRetrieveParams, type SelfMailerUpdateParams as SelfMailerUpdateParams, type SelfMailerListParams as SelfMailerListParams, };
259
- }
260
- //# sourceMappingURL=self-mailers.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAS/F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAShC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,iBAAiB,CAAC;IAQ9D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGnF;AAED,MAAM,MAAM,2BAA2B,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;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,qBAAqB,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEnF,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -1,95 +0,0 @@
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.SelfMailers = 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
- class SelfMailers extends resource_1.APIResource {
9
- /**
10
- * Creates a new Self-Mailer Profile. Provide either `insideTemplate` and
11
- * `outsideTemplate` IDs, or upload a 2-page `pdf`. If providing a `pdf`, the
12
- * request `Content-Type` must be `multipart/form-data`.
13
- *
14
- * @example
15
- * ```ts
16
- * const selfMailerProfile =
17
- * await client.printMail.orderProfiles.selfMailers.create({
18
- * size: '8.5x11_bifold',
19
- * });
20
- * ```
21
- */
22
- create(params, options) {
23
- const { expand, ...body } = params;
24
- return this._client.post('/print-mail/v1/order_profiles/self_mailers', {
25
- query: { expand },
26
- body,
27
- ...options,
28
- });
29
- }
30
- /**
31
- * Retrieves the details of a specific Self-Mailer Profile.
32
- *
33
- * @example
34
- * ```ts
35
- * const selfMailerProfile =
36
- * await client.printMail.orderProfiles.selfMailers.retrieve(
37
- * 'id',
38
- * );
39
- * ```
40
- */
41
- retrieve(id, query = {}, options) {
42
- return this._client.get((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, { query, ...options });
43
- }
44
- /**
45
- * Updates specific fields of an existing Self-Mailer Profile. If providing a
46
- * `pdf`, the request `Content-Type` must be `multipart/form-data`.
47
- *
48
- * @example
49
- * ```ts
50
- * const selfMailerProfile =
51
- * await client.printMail.orderProfiles.selfMailers.update(
52
- * 'id',
53
- * { size: '8.5x11_bifold' },
54
- * );
55
- * ```
56
- */
57
- update(id, params, options) {
58
- const { expand, ...body } = params;
59
- return this._client.post((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, {
60
- query: { expand },
61
- body,
62
- ...options,
63
- });
64
- }
65
- /**
66
- * Retrieves a list of Self-Mailer Profiles.
67
- *
68
- * @example
69
- * ```ts
70
- * // Automatically fetches more pages as needed.
71
- * for await (const selfMailerProfile of client.printMail.orderProfiles.selfMailers.list()) {
72
- * // ...
73
- * }
74
- * ```
75
- */
76
- list(query = {}, options) {
77
- return this._client.getAPIList('/print-mail/v1/order_profiles/self_mailers', (pagination_1.SkipLimit), { query, ...options });
78
- }
79
- /**
80
- * Deletes a Self-Mailer Profile.
81
- *
82
- * @example
83
- * ```ts
84
- * const selfMailer =
85
- * await client.printMail.orderProfiles.selfMailers.delete(
86
- * 'id',
87
- * );
88
- * ```
89
- */
90
- delete(id, options) {
91
- return this._client.delete((0, path_1.path) `/print-mail/v1/order_profiles/self_mailers/${id}`, options);
92
- }
93
- }
94
- exports.SelfMailers = SelfMailers;
95
- //# sourceMappingURL=self-mailers.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../../../src/resources/print-mail/order-profiles/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAAwF;AAExF,0DAAoD;AAEpD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE;YACrE,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE;YAC/E,KAAK,EAAE,EAAE,MAAM,EAAE;YACjB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4CAA4C,EAC5C,CAAA,sBAA4B,CAAA,EAC5B,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8CAA8C,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;CACF;AAxGD,kCAwGC"}