postgrid-node 0.1.0-alpha.5 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (907) hide show
  1. package/CHANGELOG.md +84 -0
  2. package/LICENSE +1 -1
  3. package/README.md +134 -103
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +191 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +191 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +492 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +488 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +1 -46
  55. package/error.d.ts.map +1 -1
  56. package/error.js +3 -110
  57. package/error.js.map +1 -1
  58. package/error.mjs +1 -96
  59. package/error.mjs.map +1 -1
  60. package/index.d.mts +6 -157
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +5 -156
  63. package/index.d.ts.map +1 -1
  64. package/index.js +12 -166
  65. package/index.js.map +1 -1
  66. package/index.mjs +5 -139
  67. package/index.mjs.map +1 -1
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +1 -0
  111. package/internal/qs/formats.d.ts.map +1 -1
  112. package/internal/qs/formats.js +4 -2
  113. package/internal/qs/formats.js.map +1 -1
  114. package/internal/qs/formats.mjs +2 -1
  115. package/internal/qs/formats.mjs.map +1 -1
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts.map +1 -1
  119. package/internal/qs/stringify.d.mts +3 -0
  120. package/internal/qs/stringify.d.mts.map +1 -0
  121. package/internal/qs/stringify.d.ts.map +1 -1
  122. package/internal/qs/stringify.js +16 -19
  123. package/internal/qs/stringify.js.map +1 -1
  124. package/internal/qs/stringify.mjs +17 -19
  125. package/internal/qs/stringify.mjs.map +1 -1
  126. package/internal/qs/types.d.mts +57 -0
  127. package/internal/qs/types.d.mts.map +1 -0
  128. package/internal/qs/utils.d.mts +15 -0
  129. package/internal/qs/utils.d.mts.map +1 -0
  130. package/internal/qs/utils.d.ts +1 -0
  131. package/internal/qs/utils.d.ts.map +1 -1
  132. package/internal/qs/utils.js +22 -21
  133. package/internal/qs/utils.js.map +1 -1
  134. package/internal/qs/utils.mjs +12 -12
  135. package/internal/qs/utils.mjs.map +1 -1
  136. package/internal/request-options.d.mts +75 -0
  137. package/internal/request-options.d.mts.map +1 -0
  138. package/internal/request-options.d.ts +75 -0
  139. package/internal/request-options.d.ts.map +1 -0
  140. package/internal/request-options.js +14 -0
  141. package/internal/request-options.js.map +1 -0
  142. package/internal/request-options.mjs +10 -0
  143. package/internal/request-options.mjs.map +1 -0
  144. package/internal/shim-types.d.mts +17 -0
  145. package/internal/shim-types.d.mts.map +1 -0
  146. package/internal/shim-types.d.ts +17 -0
  147. package/internal/shim-types.d.ts.map +1 -0
  148. package/internal/shim-types.js +4 -0
  149. package/internal/shim-types.js.map +1 -0
  150. package/internal/shim-types.mjs +3 -0
  151. package/internal/shim-types.mjs.map +1 -0
  152. package/internal/shims.d.mts +20 -0
  153. package/internal/shims.d.mts.map +1 -0
  154. package/internal/shims.d.ts +20 -0
  155. package/internal/shims.d.ts.map +1 -0
  156. package/internal/shims.js +92 -0
  157. package/internal/shims.js.map +1 -0
  158. package/internal/shims.mjs +85 -0
  159. package/internal/shims.mjs.map +1 -0
  160. package/internal/to-file.d.mts +45 -0
  161. package/internal/to-file.d.mts.map +1 -0
  162. package/internal/to-file.d.ts +45 -0
  163. package/internal/to-file.d.ts.map +1 -0
  164. package/internal/to-file.js +91 -0
  165. package/internal/to-file.js.map +1 -0
  166. package/internal/to-file.mjs +88 -0
  167. package/internal/to-file.mjs.map +1 -0
  168. package/internal/tslib.js +81 -0
  169. package/internal/tslib.mjs +17 -0
  170. package/internal/types.d.mts +69 -0
  171. package/internal/types.d.mts.map +1 -0
  172. package/internal/types.d.ts +69 -0
  173. package/internal/types.d.ts.map +1 -0
  174. package/internal/types.js +4 -0
  175. package/internal/types.js.map +1 -0
  176. package/internal/types.mjs +3 -0
  177. package/internal/types.mjs.map +1 -0
  178. package/internal/uploads.d.mts +42 -0
  179. package/internal/uploads.d.mts.map +1 -0
  180. package/internal/uploads.d.ts +42 -0
  181. package/internal/uploads.d.ts.map +1 -0
  182. package/internal/uploads.js +141 -0
  183. package/internal/uploads.js.map +1 -0
  184. package/internal/uploads.mjs +131 -0
  185. package/internal/uploads.mjs.map +1 -0
  186. package/internal/utils/base64.d.mts +3 -0
  187. package/internal/utils/base64.d.mts.map +1 -0
  188. package/internal/utils/base64.d.ts +3 -0
  189. package/internal/utils/base64.d.ts.map +1 -0
  190. package/internal/utils/base64.js +38 -0
  191. package/internal/utils/base64.js.map +1 -0
  192. package/internal/utils/base64.mjs +33 -0
  193. package/internal/utils/base64.mjs.map +1 -0
  194. package/internal/utils/bytes.d.mts +4 -0
  195. package/internal/utils/bytes.d.mts.map +1 -0
  196. package/internal/utils/bytes.d.ts +4 -0
  197. package/internal/utils/bytes.d.ts.map +1 -0
  198. package/internal/utils/bytes.js +31 -0
  199. package/internal/utils/bytes.js.map +1 -0
  200. package/internal/utils/bytes.mjs +26 -0
  201. package/internal/utils/bytes.mjs.map +1 -0
  202. package/internal/utils/env.d.mts +9 -0
  203. package/internal/utils/env.d.mts.map +1 -0
  204. package/internal/utils/env.d.ts +9 -0
  205. package/internal/utils/env.d.ts.map +1 -0
  206. package/internal/utils/env.js +22 -0
  207. package/internal/utils/env.js.map +1 -0
  208. package/internal/utils/env.mjs +18 -0
  209. package/internal/utils/env.mjs.map +1 -0
  210. package/internal/utils/log.d.mts +37 -0
  211. package/internal/utils/log.d.mts.map +1 -0
  212. package/internal/utils/log.d.ts +37 -0
  213. package/internal/utils/log.d.ts.map +1 -0
  214. package/internal/utils/log.js +86 -0
  215. package/internal/utils/log.js.map +1 -0
  216. package/internal/utils/log.mjs +80 -0
  217. package/internal/utils/log.mjs.map +1 -0
  218. package/internal/utils/path.d.mts +15 -0
  219. package/internal/utils/path.d.mts.map +1 -0
  220. package/internal/utils/path.d.ts +15 -0
  221. package/internal/utils/path.d.ts.map +1 -0
  222. package/internal/utils/path.js +79 -0
  223. package/internal/utils/path.js.map +1 -0
  224. package/internal/utils/path.mjs +74 -0
  225. package/internal/utils/path.mjs.map +1 -0
  226. package/internal/utils/sleep.d.mts +2 -0
  227. package/internal/utils/sleep.d.mts.map +1 -0
  228. package/internal/utils/sleep.d.ts +2 -0
  229. package/internal/utils/sleep.d.ts.map +1 -0
  230. package/internal/utils/sleep.js +7 -0
  231. package/internal/utils/sleep.js.map +1 -0
  232. package/internal/utils/sleep.mjs +3 -0
  233. package/internal/utils/sleep.mjs.map +1 -0
  234. package/internal/utils/uuid.d.mts +5 -0
  235. package/internal/utils/uuid.d.mts.map +1 -0
  236. package/internal/utils/uuid.d.ts +5 -0
  237. package/internal/utils/uuid.d.ts.map +1 -0
  238. package/internal/utils/uuid.js +19 -0
  239. package/internal/utils/uuid.js.map +1 -0
  240. package/internal/utils/uuid.mjs +15 -0
  241. package/internal/utils/uuid.mjs.map +1 -0
  242. package/internal/utils/values.d.mts +18 -0
  243. package/internal/utils/values.d.mts.map +1 -0
  244. package/internal/utils/values.d.ts +18 -0
  245. package/internal/utils/values.d.ts.map +1 -0
  246. package/internal/utils/values.js +112 -0
  247. package/internal/utils/values.js.map +1 -0
  248. package/internal/utils/values.mjs +94 -0
  249. package/internal/utils/values.mjs.map +1 -0
  250. package/internal/utils.d.mts +7 -0
  251. package/internal/utils.d.mts.map +1 -0
  252. package/internal/utils.d.ts +7 -0
  253. package/internal/utils.d.ts.map +1 -0
  254. package/internal/utils.js +11 -0
  255. package/internal/utils.js.map +1 -0
  256. package/internal/utils.mjs +8 -0
  257. package/internal/utils.mjs.map +1 -0
  258. package/package.json +110 -75
  259. package/resource.d.mts +2 -0
  260. package/resource.d.mts.map +1 -0
  261. package/resource.d.ts +1 -5
  262. package/resource.d.ts.map +1 -1
  263. package/resource.js +3 -8
  264. package/resource.js.map +1 -1
  265. package/resource.mjs +1 -6
  266. package/resource.mjs.map +1 -1
  267. package/resources/address-verification.d.mts +425 -0
  268. package/resources/address-verification.d.mts.map +1 -0
  269. package/resources/address-verification.d.ts +425 -0
  270. package/resources/address-verification.d.ts.map +1 -0
  271. package/resources/address-verification.js +36 -0
  272. package/resources/address-verification.js.map +1 -0
  273. package/resources/address-verification.mjs +32 -0
  274. package/resources/address-verification.mjs.map +1 -0
  275. package/resources/index.d.mts +4 -0
  276. package/resources/index.d.mts.map +1 -0
  277. package/resources/index.d.ts +3 -15
  278. package/resources/index.d.ts.map +1 -1
  279. package/resources/index.js +7 -57
  280. package/resources/index.js.map +1 -1
  281. package/resources/index.mjs +3 -15
  282. package/resources/index.mjs.map +1 -1
  283. package/resources/intl-address-verification.d.mts +406 -0
  284. package/resources/intl-address-verification.d.mts.map +1 -0
  285. package/resources/intl-address-verification.d.ts +406 -0
  286. package/resources/intl-address-verification.d.ts.map +1 -0
  287. package/resources/intl-address-verification.js +59 -0
  288. package/resources/intl-address-verification.js.map +1 -0
  289. package/resources/intl-address-verification.mjs +55 -0
  290. package/resources/intl-address-verification.mjs.map +1 -0
  291. package/resources/print-mail/bank-accounts.d.mts +345 -0
  292. package/resources/print-mail/bank-accounts.d.mts.map +1 -0
  293. package/resources/print-mail/bank-accounts.d.ts +345 -0
  294. package/resources/print-mail/bank-accounts.d.ts.map +1 -0
  295. package/resources/print-mail/bank-accounts.js +72 -0
  296. package/resources/print-mail/bank-accounts.js.map +1 -0
  297. package/resources/print-mail/bank-accounts.mjs +68 -0
  298. package/resources/print-mail/bank-accounts.mjs.map +1 -0
  299. package/resources/print-mail/boxes.d.mts +873 -0
  300. package/resources/print-mail/boxes.d.mts.map +1 -0
  301. package/resources/print-mail/boxes.d.ts +873 -0
  302. package/resources/print-mail/boxes.d.ts.map +1 -0
  303. package/resources/print-mail/boxes.js +81 -0
  304. package/resources/print-mail/boxes.js.map +1 -0
  305. package/resources/print-mail/boxes.mjs +77 -0
  306. package/resources/print-mail/boxes.mjs.map +1 -0
  307. package/resources/print-mail/campaigns.d.mts +317 -0
  308. package/resources/print-mail/campaigns.d.mts.map +1 -0
  309. package/resources/print-mail/campaigns.d.ts +317 -0
  310. package/resources/print-mail/campaigns.d.ts.map +1 -0
  311. package/resources/print-mail/campaigns.js +114 -0
  312. package/resources/print-mail/campaigns.js.map +1 -0
  313. package/resources/print-mail/campaigns.mjs +110 -0
  314. package/resources/print-mail/campaigns.mjs.map +1 -0
  315. package/resources/print-mail/cheques.d.mts +817 -0
  316. package/resources/print-mail/cheques.d.mts.map +1 -0
  317. package/resources/print-mail/cheques.d.ts +817 -0
  318. package/resources/print-mail/cheques.d.ts.map +1 -0
  319. package/resources/print-mail/cheques.js +121 -0
  320. package/resources/print-mail/cheques.js.map +1 -0
  321. package/resources/print-mail/cheques.mjs +117 -0
  322. package/resources/print-mail/cheques.mjs.map +1 -0
  323. package/resources/print-mail/contacts.d.mts +475 -0
  324. package/resources/print-mail/contacts.d.mts.map +1 -0
  325. package/resources/print-mail/contacts.d.ts +475 -0
  326. package/resources/print-mail/contacts.d.ts.map +1 -0
  327. package/resources/print-mail/contacts.js +76 -0
  328. package/resources/print-mail/contacts.js.map +1 -0
  329. package/resources/print-mail/contacts.mjs +72 -0
  330. package/resources/print-mail/contacts.mjs.map +1 -0
  331. package/resources/print-mail/index.d.mts +16 -0
  332. package/resources/print-mail/index.d.mts.map +1 -0
  333. package/resources/print-mail/index.d.ts +16 -0
  334. package/resources/print-mail/index.d.ts.map +1 -0
  335. package/resources/print-mail/index.js +35 -0
  336. package/resources/print-mail/index.js.map +1 -0
  337. package/resources/print-mail/index.mjs +17 -0
  338. package/resources/print-mail/index.mjs.map +1 -0
  339. package/resources/print-mail/letters.d.mts +1079 -0
  340. package/resources/print-mail/letters.d.mts.map +1 -0
  341. package/resources/print-mail/letters.d.ts +1079 -0
  342. package/resources/print-mail/letters.d.ts.map +1 -0
  343. package/resources/print-mail/letters.js +83 -0
  344. package/resources/print-mail/letters.js.map +1 -0
  345. package/resources/print-mail/letters.mjs +79 -0
  346. package/resources/print-mail/letters.mjs.map +1 -0
  347. package/resources/print-mail/mailing-list-imports.d.mts +354 -0
  348. package/resources/print-mail/mailing-list-imports.d.mts.map +1 -0
  349. package/resources/print-mail/mailing-list-imports.d.ts +354 -0
  350. package/resources/print-mail/mailing-list-imports.d.ts.map +1 -0
  351. package/resources/print-mail/mailing-list-imports.js +105 -0
  352. package/resources/print-mail/mailing-list-imports.js.map +1 -0
  353. package/resources/print-mail/mailing-list-imports.mjs +101 -0
  354. package/resources/print-mail/mailing-list-imports.mjs.map +1 -0
  355. package/resources/print-mail/mailing-lists.d.mts +247 -0
  356. package/resources/print-mail/mailing-lists.d.mts.map +1 -0
  357. package/resources/print-mail/mailing-lists.d.ts +247 -0
  358. package/resources/print-mail/mailing-lists.d.ts.map +1 -0
  359. package/resources/print-mail/mailing-lists.js +117 -0
  360. package/resources/print-mail/mailing-lists.js.map +1 -0
  361. package/resources/print-mail/mailing-lists.mjs +113 -0
  362. package/resources/print-mail/mailing-lists.mjs.map +1 -0
  363. package/resources/print-mail/order-profiles/cheques.d.mts +398 -0
  364. package/resources/print-mail/order-profiles/cheques.d.mts.map +1 -0
  365. package/resources/print-mail/order-profiles/cheques.d.ts +398 -0
  366. package/resources/print-mail/order-profiles/cheques.d.ts.map +1 -0
  367. package/resources/print-mail/order-profiles/cheques.js +92 -0
  368. package/resources/print-mail/order-profiles/cheques.js.map +1 -0
  369. package/resources/print-mail/order-profiles/cheques.mjs +88 -0
  370. package/resources/print-mail/order-profiles/cheques.mjs.map +1 -0
  371. package/resources/print-mail/order-profiles/index.d.mts +6 -0
  372. package/resources/print-mail/order-profiles/index.d.mts.map +1 -0
  373. package/resources/print-mail/order-profiles/index.d.ts +6 -0
  374. package/resources/print-mail/order-profiles/index.d.ts.map +1 -0
  375. package/resources/print-mail/order-profiles/index.js +15 -0
  376. package/resources/print-mail/order-profiles/index.js.map +1 -0
  377. package/resources/print-mail/order-profiles/index.mjs +7 -0
  378. package/resources/print-mail/order-profiles/index.mjs.map +1 -0
  379. package/resources/print-mail/order-profiles/letters.d.mts +333 -0
  380. package/resources/print-mail/order-profiles/letters.d.mts.map +1 -0
  381. package/resources/print-mail/order-profiles/letters.d.ts +333 -0
  382. package/resources/print-mail/order-profiles/letters.d.ts.map +1 -0
  383. package/resources/print-mail/order-profiles/letters.js +99 -0
  384. package/resources/print-mail/order-profiles/letters.js.map +1 -0
  385. package/resources/print-mail/order-profiles/letters.mjs +95 -0
  386. package/resources/print-mail/order-profiles/letters.mjs.map +1 -0
  387. package/resources/print-mail/order-profiles/order-profiles.d.mts +22 -0
  388. package/resources/print-mail/order-profiles/order-profiles.d.mts.map +1 -0
  389. package/resources/print-mail/order-profiles/order-profiles.d.ts +22 -0
  390. package/resources/print-mail/order-profiles/order-profiles.d.ts.map +1 -0
  391. package/resources/print-mail/order-profiles/order-profiles.js +29 -0
  392. package/resources/print-mail/order-profiles/order-profiles.js.map +1 -0
  393. package/resources/print-mail/order-profiles/order-profiles.mjs +24 -0
  394. package/resources/print-mail/order-profiles/order-profiles.mjs.map +1 -0
  395. package/resources/print-mail/order-profiles/postcards.d.mts +263 -0
  396. package/resources/print-mail/order-profiles/postcards.d.mts.map +1 -0
  397. package/resources/print-mail/order-profiles/postcards.d.ts +263 -0
  398. package/resources/print-mail/order-profiles/postcards.d.ts.map +1 -0
  399. package/resources/print-mail/order-profiles/postcards.js +91 -0
  400. package/resources/print-mail/order-profiles/postcards.js.map +1 -0
  401. package/resources/print-mail/order-profiles/postcards.mjs +87 -0
  402. package/resources/print-mail/order-profiles/postcards.mjs.map +1 -0
  403. package/resources/print-mail/order-profiles/self-mailers.d.mts +268 -0
  404. package/resources/print-mail/order-profiles/self-mailers.d.mts.map +1 -0
  405. package/resources/print-mail/order-profiles/self-mailers.d.ts +268 -0
  406. package/resources/print-mail/order-profiles/self-mailers.d.ts.map +1 -0
  407. package/resources/print-mail/order-profiles/self-mailers.js +92 -0
  408. package/resources/print-mail/order-profiles/self-mailers.js.map +1 -0
  409. package/resources/print-mail/order-profiles/self-mailers.mjs +88 -0
  410. package/resources/print-mail/order-profiles/self-mailers.mjs.map +1 -0
  411. package/resources/print-mail/order-profiles.d.mts +2 -0
  412. package/resources/print-mail/order-profiles.d.mts.map +1 -0
  413. package/resources/print-mail/order-profiles.d.ts.map +1 -0
  414. package/resources/print-mail/order-profiles.js +6 -0
  415. package/resources/print-mail/order-profiles.js.map +1 -0
  416. package/resources/print-mail/order-profiles.mjs.map +1 -0
  417. package/resources/print-mail/postcards.d.mts +1220 -0
  418. package/resources/print-mail/postcards.d.mts.map +1 -0
  419. package/resources/print-mail/postcards.d.ts +1220 -0
  420. package/resources/print-mail/postcards.d.ts.map +1 -0
  421. package/resources/print-mail/postcards.js +87 -0
  422. package/resources/print-mail/postcards.js.map +1 -0
  423. package/resources/print-mail/postcards.mjs +83 -0
  424. package/resources/print-mail/postcards.mjs.map +1 -0
  425. package/resources/print-mail/print-mail.d.mts +62 -0
  426. package/resources/print-mail/print-mail.d.mts.map +1 -0
  427. package/resources/print-mail/print-mail.d.ts +62 -0
  428. package/resources/print-mail/print-mail.d.ts.map +1 -0
  429. package/resources/print-mail/print-mail.js +69 -0
  430. package/resources/print-mail/print-mail.js.map +1 -0
  431. package/resources/print-mail/print-mail.mjs +64 -0
  432. package/resources/print-mail/print-mail.mjs.map +1 -0
  433. package/resources/print-mail/reports/exports.d.mts +165 -0
  434. package/resources/print-mail/reports/exports.d.mts.map +1 -0
  435. package/resources/print-mail/reports/exports.d.ts +165 -0
  436. package/resources/print-mail/reports/exports.d.ts.map +1 -0
  437. package/resources/print-mail/reports/exports.js +66 -0
  438. package/resources/print-mail/reports/exports.js.map +1 -0
  439. package/resources/print-mail/reports/exports.mjs +62 -0
  440. package/resources/print-mail/reports/exports.mjs.map +1 -0
  441. package/resources/print-mail/reports/index.d.mts +4 -0
  442. package/resources/print-mail/reports/index.d.mts.map +1 -0
  443. package/resources/print-mail/reports/index.d.ts +4 -0
  444. package/resources/print-mail/reports/index.d.ts.map +1 -0
  445. package/resources/print-mail/reports/index.js +11 -0
  446. package/resources/print-mail/reports/index.js.map +1 -0
  447. package/resources/print-mail/reports/index.mjs +5 -0
  448. package/resources/print-mail/reports/index.mjs.map +1 -0
  449. package/resources/print-mail/reports/reports.d.mts +214 -0
  450. package/resources/print-mail/reports/reports.d.mts.map +1 -0
  451. package/resources/print-mail/reports/reports.d.ts +214 -0
  452. package/resources/print-mail/reports/reports.d.ts.map +1 -0
  453. package/resources/print-mail/reports/reports.js +110 -0
  454. package/resources/print-mail/reports/reports.js.map +1 -0
  455. package/resources/print-mail/reports/reports.mjs +105 -0
  456. package/resources/print-mail/reports/reports.mjs.map +1 -0
  457. package/resources/print-mail/reports/samples.d.mts +69 -0
  458. package/resources/print-mail/reports/samples.d.mts.map +1 -0
  459. package/resources/print-mail/reports/samples.d.ts +69 -0
  460. package/resources/print-mail/reports/samples.d.ts.map +1 -0
  461. package/resources/print-mail/reports/samples.js +28 -0
  462. package/resources/print-mail/reports/samples.js.map +1 -0
  463. package/resources/print-mail/reports/samples.mjs +24 -0
  464. package/resources/print-mail/reports/samples.mjs.map +1 -0
  465. package/resources/print-mail/reports.d.mts +2 -0
  466. package/resources/print-mail/reports.d.mts.map +1 -0
  467. package/resources/print-mail/reports.d.ts.map +1 -0
  468. package/resources/print-mail/reports.js +6 -0
  469. package/resources/print-mail/reports.js.map +1 -0
  470. package/resources/print-mail/reports.mjs.map +1 -0
  471. package/resources/print-mail/self-mailers.d.mts +1218 -0
  472. package/resources/print-mail/self-mailers.d.mts.map +1 -0
  473. package/resources/print-mail/self-mailers.d.ts +1218 -0
  474. package/resources/print-mail/self-mailers.d.ts.map +1 -0
  475. package/resources/print-mail/self-mailers.js +87 -0
  476. package/resources/print-mail/self-mailers.js.map +1 -0
  477. package/resources/print-mail/self-mailers.mjs +83 -0
  478. package/resources/print-mail/self-mailers.mjs.map +1 -0
  479. package/resources/print-mail/sub-organizations.d.mts +304 -0
  480. package/resources/print-mail/sub-organizations.d.mts.map +1 -0
  481. package/resources/print-mail/sub-organizations.d.ts +304 -0
  482. package/resources/print-mail/sub-organizations.d.ts.map +1 -0
  483. package/resources/print-mail/sub-organizations.js +69 -0
  484. package/resources/print-mail/sub-organizations.js.map +1 -0
  485. package/resources/print-mail/sub-organizations.mjs +65 -0
  486. package/resources/print-mail/sub-organizations.mjs.map +1 -0
  487. package/resources/print-mail/templates.d.mts +169 -0
  488. package/resources/print-mail/templates.d.mts.map +1 -0
  489. package/resources/print-mail/templates.d.ts +169 -0
  490. package/resources/print-mail/templates.d.ts.map +1 -0
  491. package/resources/print-mail/templates.js +79 -0
  492. package/resources/print-mail/templates.js.map +1 -0
  493. package/resources/print-mail/templates.mjs +75 -0
  494. package/resources/print-mail/templates.mjs.map +1 -0
  495. package/resources/print-mail.d.mts +2 -0
  496. package/resources/print-mail.d.mts.map +1 -0
  497. package/resources/print-mail.d.ts +2 -0
  498. package/resources/print-mail.d.ts.map +1 -0
  499. package/resources/print-mail.js +6 -0
  500. package/resources/print-mail.js.map +1 -0
  501. package/resources/print-mail.mjs +3 -0
  502. package/resources/print-mail.mjs.map +1 -0
  503. package/resources.d.mts +2 -0
  504. package/resources.d.mts.map +1 -0
  505. package/resources.d.ts.map +1 -1
  506. package/resources.js +2 -15
  507. package/resources.js.map +1 -1
  508. package/src/api-promise.ts +2 -0
  509. package/src/client.ts +793 -0
  510. package/src/core/README.md +3 -0
  511. package/src/core/api-promise.ts +92 -0
  512. package/src/core/error.ts +130 -0
  513. package/src/core/resource.ts +11 -0
  514. package/src/core/uploads.ts +2 -0
  515. package/src/error.ts +2 -130
  516. package/src/index.ts +5 -520
  517. package/src/internal/README.md +3 -0
  518. package/src/internal/builtin-types.ts +93 -0
  519. package/src/internal/detect-platform.ts +196 -0
  520. package/src/internal/errors.ts +33 -0
  521. package/src/internal/headers.ts +97 -0
  522. package/src/internal/parse.ts +50 -0
  523. package/src/internal/qs/formats.ts +2 -1
  524. package/src/internal/qs/stringify.ts +17 -20
  525. package/src/internal/qs/utils.ts +14 -14
  526. package/src/internal/request-options.ts +91 -0
  527. package/src/internal/shim-types.ts +26 -0
  528. package/src/internal/shims.ts +107 -0
  529. package/src/internal/to-file.ts +154 -0
  530. package/src/internal/types.ts +95 -0
  531. package/src/internal/uploads.ts +187 -0
  532. package/src/internal/utils/base64.ts +40 -0
  533. package/src/internal/utils/bytes.ts +32 -0
  534. package/src/internal/utils/env.ts +18 -0
  535. package/src/internal/utils/log.ts +127 -0
  536. package/src/internal/utils/path.ts +88 -0
  537. package/src/internal/utils/sleep.ts +3 -0
  538. package/src/internal/utils/uuid.ts +17 -0
  539. package/src/internal/utils/values.ts +105 -0
  540. package/src/internal/utils.ts +8 -0
  541. package/src/resource.ts +2 -11
  542. package/src/resources/address-verification.ts +542 -0
  543. package/src/resources/index.ts +12 -142
  544. package/src/resources/intl-address-verification.ts +505 -0
  545. package/src/resources/print-mail/bank-accounts.ts +432 -0
  546. package/src/resources/print-mail/boxes.ts +1079 -0
  547. package/src/resources/print-mail/campaigns.ts +408 -0
  548. package/src/resources/print-mail/cheques.ts +995 -0
  549. package/src/resources/print-mail/contacts.ts +594 -0
  550. package/src/resources/print-mail/index.ts +134 -0
  551. package/src/resources/print-mail/letters.ts +1319 -0
  552. package/src/resources/print-mail/mailing-list-imports.ts +433 -0
  553. package/src/resources/print-mail/mailing-lists.ts +316 -0
  554. package/src/resources/print-mail/order-profiles/cheques.ts +498 -0
  555. package/src/resources/print-mail/order-profiles/index.ts +46 -0
  556. package/src/resources/print-mail/order-profiles/letters.ts +423 -0
  557. package/src/resources/print-mail/order-profiles/order-profiles.ts +111 -0
  558. package/src/resources/print-mail/order-profiles/postcards.ts +338 -0
  559. package/src/resources/print-mail/order-profiles/self-mailers.ts +348 -0
  560. package/src/resources/print-mail/postcards.ts +1483 -0
  561. package/src/resources/print-mail/print-mail.ts +331 -0
  562. package/src/resources/print-mail/reports/exports.ts +209 -0
  563. package/src/resources/print-mail/reports/index.ts +20 -0
  564. package/src/resources/print-mail/reports/reports.ts +290 -0
  565. package/src/resources/print-mail/reports/samples.ts +84 -0
  566. package/src/resources/print-mail/self-mailers.ts +1481 -0
  567. package/src/resources/print-mail/sub-organizations.ts +394 -0
  568. package/src/resources/print-mail/templates.ts +216 -0
  569. package/src/resources/print-mail.ts +3 -0
  570. package/src/tsconfig.json +2 -2
  571. package/src/uploads.ts +2 -255
  572. package/src/version.ts +1 -1
  573. package/uploads.d.mts +2 -0
  574. package/uploads.d.mts.map +1 -0
  575. package/uploads.d.ts +1 -74
  576. package/uploads.d.ts.map +1 -1
  577. package/uploads.js +3 -168
  578. package/uploads.js.map +1 -1
  579. package/uploads.mjs +1 -157
  580. package/uploads.mjs.map +1 -1
  581. package/version.d.mts +2 -0
  582. package/version.d.mts.map +1 -0
  583. package/version.d.ts +1 -1
  584. package/version.d.ts.map +1 -1
  585. package/version.js +1 -1
  586. package/version.js.map +1 -1
  587. package/version.mjs +1 -1
  588. package/version.mjs.map +1 -1
  589. package/_shims/MultipartBody.d.ts +0 -9
  590. package/_shims/MultipartBody.d.ts.map +0 -1
  591. package/_shims/MultipartBody.js +0 -16
  592. package/_shims/MultipartBody.js.map +0 -1
  593. package/_shims/MultipartBody.mjs +0 -12
  594. package/_shims/MultipartBody.mjs.map +0 -1
  595. package/_shims/README.md +0 -46
  596. package/_shims/auto/runtime-bun.d.ts +0 -5
  597. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  598. package/_shims/auto/runtime-bun.js +0 -21
  599. package/_shims/auto/runtime-bun.js.map +0 -1
  600. package/_shims/auto/runtime-bun.mjs +0 -2
  601. package/_shims/auto/runtime-bun.mjs.map +0 -1
  602. package/_shims/auto/runtime-node.d.ts +0 -5
  603. package/_shims/auto/runtime-node.d.ts.map +0 -1
  604. package/_shims/auto/runtime-node.js +0 -21
  605. package/_shims/auto/runtime-node.js.map +0 -1
  606. package/_shims/auto/runtime-node.mjs +0 -2
  607. package/_shims/auto/runtime-node.mjs.map +0 -1
  608. package/_shims/auto/runtime.d.ts +0 -5
  609. package/_shims/auto/runtime.d.ts.map +0 -1
  610. package/_shims/auto/runtime.js +0 -21
  611. package/_shims/auto/runtime.js.map +0 -1
  612. package/_shims/auto/runtime.mjs +0 -2
  613. package/_shims/auto/runtime.mjs.map +0 -1
  614. package/_shims/auto/types-node.d.ts +0 -5
  615. package/_shims/auto/types-node.d.ts.map +0 -1
  616. package/_shims/auto/types-node.js +0 -21
  617. package/_shims/auto/types-node.js.map +0 -1
  618. package/_shims/auto/types-node.mjs +0 -2
  619. package/_shims/auto/types-node.mjs.map +0 -1
  620. package/_shims/auto/types.d.ts +0 -101
  621. package/_shims/auto/types.js +0 -3
  622. package/_shims/auto/types.mjs +0 -3
  623. package/_shims/bun-runtime.d.ts +0 -6
  624. package/_shims/bun-runtime.d.ts.map +0 -1
  625. package/_shims/bun-runtime.js +0 -14
  626. package/_shims/bun-runtime.js.map +0 -1
  627. package/_shims/bun-runtime.mjs +0 -10
  628. package/_shims/bun-runtime.mjs.map +0 -1
  629. package/_shims/index.d.ts +0 -83
  630. package/_shims/index.js +0 -17
  631. package/_shims/index.mjs +0 -11
  632. package/_shims/manual-types.d.ts +0 -12
  633. package/_shims/manual-types.js +0 -3
  634. package/_shims/manual-types.mjs +0 -3
  635. package/_shims/node-runtime.d.ts +0 -3
  636. package/_shims/node-runtime.d.ts.map +0 -1
  637. package/_shims/node-runtime.js +0 -89
  638. package/_shims/node-runtime.js.map +0 -1
  639. package/_shims/node-runtime.mjs +0 -56
  640. package/_shims/node-runtime.mjs.map +0 -1
  641. package/_shims/node-types.d.ts +0 -42
  642. package/_shims/node-types.js +0 -3
  643. package/_shims/node-types.mjs +0 -3
  644. package/_shims/registry.d.ts +0 -37
  645. package/_shims/registry.d.ts.map +0 -1
  646. package/_shims/registry.js +0 -41
  647. package/_shims/registry.js.map +0 -1
  648. package/_shims/registry.mjs +0 -37
  649. package/_shims/registry.mjs.map +0 -1
  650. package/_shims/web-runtime.d.ts +0 -5
  651. package/_shims/web-runtime.d.ts.map +0 -1
  652. package/_shims/web-runtime.js +0 -78
  653. package/_shims/web-runtime.js.map +0 -1
  654. package/_shims/web-runtime.mjs +0 -71
  655. package/_shims/web-runtime.mjs.map +0 -1
  656. package/_shims/web-types.d.ts +0 -83
  657. package/_shims/web-types.js +0 -3
  658. package/_shims/web-types.mjs +0 -3
  659. package/core.d.ts +0 -255
  660. package/core.d.ts.map +0 -1
  661. package/core.js +0 -924
  662. package/core.js.map +0 -1
  663. package/core.mjs +0 -892
  664. package/core.mjs.map +0 -1
  665. package/pagination.d.ts +0 -26
  666. package/pagination.d.ts.map +0 -1
  667. package/pagination.js +0 -46
  668. package/pagination.js.map +0 -1
  669. package/pagination.mjs +0 -42
  670. package/pagination.mjs.map +0 -1
  671. package/resources/bank-accounts.d.ts +0 -342
  672. package/resources/bank-accounts.d.ts.map +0 -1
  673. package/resources/bank-accounts.js +0 -70
  674. package/resources/bank-accounts.js.map +0 -1
  675. package/resources/bank-accounts.mjs +0 -65
  676. package/resources/bank-accounts.mjs.map +0 -1
  677. package/resources/boxes.d.ts +0 -748
  678. package/resources/boxes.d.ts.map +0 -1
  679. package/resources/boxes.js +0 -81
  680. package/resources/boxes.js.map +0 -1
  681. package/resources/boxes.mjs +0 -76
  682. package/resources/boxes.mjs.map +0 -1
  683. package/resources/campaigns.d.ts +0 -658
  684. package/resources/campaigns.d.ts.map +0 -1
  685. package/resources/campaigns.js +0 -67
  686. package/resources/campaigns.js.map +0 -1
  687. package/resources/campaigns.mjs +0 -62
  688. package/resources/campaigns.mjs.map +0 -1
  689. package/resources/cheques/cheques.d.ts +0 -388
  690. package/resources/cheques/cheques.d.ts.map +0 -1
  691. package/resources/cheques/cheques.js +0 -118
  692. package/resources/cheques/cheques.js.map +0 -1
  693. package/resources/cheques/cheques.mjs +0 -90
  694. package/resources/cheques/cheques.mjs.map +0 -1
  695. package/resources/cheques/index.d.ts +0 -4
  696. package/resources/cheques/index.d.ts.map +0 -1
  697. package/resources/cheques/index.js +0 -12
  698. package/resources/cheques/index.js.map +0 -1
  699. package/resources/cheques/index.mjs +0 -5
  700. package/resources/cheques/index.mjs.map +0 -1
  701. package/resources/cheques/url.d.ts +0 -34
  702. package/resources/cheques/url.d.ts.map +0 -1
  703. package/resources/cheques/url.js +0 -25
  704. package/resources/cheques/url.js.map +0 -1
  705. package/resources/cheques/url.mjs +0 -21
  706. package/resources/cheques/url.mjs.map +0 -1
  707. package/resources/cheques/with-deposit-ready-pdf.d.ts +0 -19
  708. package/resources/cheques/with-deposit-ready-pdf.d.ts.map +0 -1
  709. package/resources/cheques/with-deposit-ready-pdf.js +0 -24
  710. package/resources/cheques/with-deposit-ready-pdf.js.map +0 -1
  711. package/resources/cheques/with-deposit-ready-pdf.mjs +0 -20
  712. package/resources/cheques/with-deposit-ready-pdf.mjs.map +0 -1
  713. package/resources/cheques.d.ts +0 -2
  714. package/resources/cheques.d.ts.map +0 -1
  715. package/resources/cheques.js +0 -19
  716. package/resources/cheques.js.map +0 -1
  717. package/resources/cheques.mjs +0 -3
  718. package/resources/cheques.mjs.map +0 -1
  719. package/resources/contacts.d.ts +0 -329
  720. package/resources/contacts.d.ts.map +0 -1
  721. package/resources/contacts.js +0 -72
  722. package/resources/contacts.js.map +0 -1
  723. package/resources/contacts.mjs +0 -67
  724. package/resources/contacts.mjs.map +0 -1
  725. package/resources/letters.d.ts +0 -683
  726. package/resources/letters.d.ts.map +0 -1
  727. package/resources/letters.js +0 -79
  728. package/resources/letters.js.map +0 -1
  729. package/resources/letters.mjs +0 -74
  730. package/resources/letters.mjs.map +0 -1
  731. package/resources/mailing-list-imports.d.ts +0 -919
  732. package/resources/mailing-list-imports.d.ts.map +0 -1
  733. package/resources/mailing-list-imports.js +0 -95
  734. package/resources/mailing-list-imports.js.map +0 -1
  735. package/resources/mailing-list-imports.mjs +0 -90
  736. package/resources/mailing-list-imports.mjs.map +0 -1
  737. package/resources/mailing-lists.d.ts +0 -398
  738. package/resources/mailing-lists.d.ts.map +0 -1
  739. package/resources/mailing-lists.js +0 -101
  740. package/resources/mailing-lists.js.map +0 -1
  741. package/resources/mailing-lists.mjs +0 -96
  742. package/resources/mailing-lists.mjs.map +0 -1
  743. package/resources/order-profiles/cheques.d.ts +0 -588
  744. package/resources/order-profiles/cheques.d.ts.map +0 -1
  745. package/resources/order-profiles/cheques.js +0 -74
  746. package/resources/order-profiles/cheques.js.map +0 -1
  747. package/resources/order-profiles/cheques.mjs +0 -69
  748. package/resources/order-profiles/cheques.mjs.map +0 -1
  749. package/resources/order-profiles/index.d.ts +0 -6
  750. package/resources/order-profiles/index.d.ts.map +0 -1
  751. package/resources/order-profiles/index.js +0 -19
  752. package/resources/order-profiles/index.js.map +0 -1
  753. package/resources/order-profiles/index.mjs +0 -7
  754. package/resources/order-profiles/index.mjs.map +0 -1
  755. package/resources/order-profiles/letters.d.ts +0 -647
  756. package/resources/order-profiles/letters.d.ts.map +0 -1
  757. package/resources/order-profiles/letters.js +0 -80
  758. package/resources/order-profiles/letters.js.map +0 -1
  759. package/resources/order-profiles/letters.mjs +0 -75
  760. package/resources/order-profiles/letters.mjs.map +0 -1
  761. package/resources/order-profiles/order-profiles.d.ts +0 -22
  762. package/resources/order-profiles/order-profiles.d.ts.map +0 -1
  763. package/resources/order-profiles/order-profiles.js +0 -55
  764. package/resources/order-profiles/order-profiles.js.map +0 -1
  765. package/resources/order-profiles/order-profiles.mjs +0 -28
  766. package/resources/order-profiles/order-profiles.mjs.map +0 -1
  767. package/resources/order-profiles/postcards.d.ts +0 -423
  768. package/resources/order-profiles/postcards.d.ts.map +0 -1
  769. package/resources/order-profiles/postcards.js +0 -73
  770. package/resources/order-profiles/postcards.js.map +0 -1
  771. package/resources/order-profiles/postcards.mjs +0 -68
  772. package/resources/order-profiles/postcards.mjs.map +0 -1
  773. package/resources/order-profiles/self-mailers.d.ts +0 -435
  774. package/resources/order-profiles/self-mailers.d.ts.map +0 -1
  775. package/resources/order-profiles/self-mailers.js +0 -75
  776. package/resources/order-profiles/self-mailers.js.map +0 -1
  777. package/resources/order-profiles/self-mailers.mjs +0 -70
  778. package/resources/order-profiles/self-mailers.mjs.map +0 -1
  779. package/resources/order-profiles.d.ts.map +0 -1
  780. package/resources/order-profiles.js +0 -19
  781. package/resources/order-profiles.js.map +0 -1
  782. package/resources/order-profiles.mjs.map +0 -1
  783. package/resources/postcards.d.ts +0 -396
  784. package/resources/postcards.d.ts.map +0 -1
  785. package/resources/postcards.js +0 -82
  786. package/resources/postcards.js.map +0 -1
  787. package/resources/postcards.mjs +0 -77
  788. package/resources/postcards.mjs.map +0 -1
  789. package/resources/reports/exports.d.ts +0 -240
  790. package/resources/reports/exports.d.ts.map +0 -1
  791. package/resources/reports/exports.js +0 -60
  792. package/resources/reports/exports.js.map +0 -1
  793. package/resources/reports/exports.mjs +0 -56
  794. package/resources/reports/exports.mjs.map +0 -1
  795. package/resources/reports/index.d.ts +0 -3
  796. package/resources/reports/index.d.ts.map +0 -1
  797. package/resources/reports/index.js +0 -10
  798. package/resources/reports/index.js.map +0 -1
  799. package/resources/reports/index.mjs +0 -4
  800. package/resources/reports/index.mjs.map +0 -1
  801. package/resources/reports/reports.d.ts +0 -382
  802. package/resources/reports/reports.d.ts.map +0 -1
  803. package/resources/reports/reports.js +0 -142
  804. package/resources/reports/reports.js.map +0 -1
  805. package/resources/reports/reports.mjs +0 -114
  806. package/resources/reports/reports.mjs.map +0 -1
  807. package/resources/reports.d.ts.map +0 -1
  808. package/resources/reports.js +0 -19
  809. package/resources/reports.js.map +0 -1
  810. package/resources/reports.mjs.map +0 -1
  811. package/resources/self-mailers.d.ts +0 -706
  812. package/resources/self-mailers.d.ts.map +0 -1
  813. package/resources/self-mailers.js +0 -83
  814. package/resources/self-mailers.js.map +0 -1
  815. package/resources/self-mailers.mjs +0 -78
  816. package/resources/self-mailers.mjs.map +0 -1
  817. package/resources/shared.d.ts +0 -151
  818. package/resources/shared.d.ts.map +0 -1
  819. package/resources/shared.js +0 -4
  820. package/resources/shared.js.map +0 -1
  821. package/resources/shared.mjs +0 -3
  822. package/resources/shared.mjs.map +0 -1
  823. package/resources/sub-organizations.d.ts +0 -394
  824. package/resources/sub-organizations.d.ts.map +0 -1
  825. package/resources/sub-organizations.js +0 -63
  826. package/resources/sub-organizations.js.map +0 -1
  827. package/resources/sub-organizations.mjs +0 -58
  828. package/resources/sub-organizations.mjs.map +0 -1
  829. package/resources/templates.d.ts +0 -166
  830. package/resources/templates.d.ts.map +0 -1
  831. package/resources/templates.js +0 -72
  832. package/resources/templates.js.map +0 -1
  833. package/resources/templates.mjs +0 -67
  834. package/resources/templates.mjs.map +0 -1
  835. package/shims/node.d.ts +0 -30
  836. package/shims/node.d.ts.map +0 -1
  837. package/shims/node.js +0 -31
  838. package/shims/node.js.map +0 -1
  839. package/shims/node.mjs +0 -5
  840. package/shims/node.mjs.map +0 -1
  841. package/shims/web.d.ts +0 -26
  842. package/shims/web.d.ts.map +0 -1
  843. package/shims/web.js +0 -31
  844. package/shims/web.js.map +0 -1
  845. package/shims/web.mjs +0 -5
  846. package/shims/web.mjs.map +0 -1
  847. package/src/_shims/MultipartBody.ts +0 -9
  848. package/src/_shims/README.md +0 -46
  849. package/src/_shims/auto/runtime-bun.ts +0 -4
  850. package/src/_shims/auto/runtime-node.ts +0 -4
  851. package/src/_shims/auto/runtime.ts +0 -4
  852. package/src/_shims/auto/types-node.ts +0 -4
  853. package/src/_shims/auto/types.d.ts +0 -101
  854. package/src/_shims/auto/types.js +0 -3
  855. package/src/_shims/auto/types.mjs +0 -3
  856. package/src/_shims/bun-runtime.ts +0 -14
  857. package/src/_shims/index.d.ts +0 -83
  858. package/src/_shims/index.js +0 -17
  859. package/src/_shims/index.mjs +0 -11
  860. package/src/_shims/manual-types.d.ts +0 -12
  861. package/src/_shims/manual-types.js +0 -3
  862. package/src/_shims/manual-types.mjs +0 -3
  863. package/src/_shims/node-runtime.ts +0 -81
  864. package/src/_shims/node-types.d.ts +0 -42
  865. package/src/_shims/node-types.js +0 -3
  866. package/src/_shims/node-types.mjs +0 -3
  867. package/src/_shims/registry.ts +0 -67
  868. package/src/_shims/web-runtime.ts +0 -103
  869. package/src/_shims/web-types.d.ts +0 -83
  870. package/src/_shims/web-types.js +0 -3
  871. package/src/_shims/web-types.mjs +0 -3
  872. package/src/core.ts +0 -1236
  873. package/src/pagination.ts +0 -74
  874. package/src/resources/bank-accounts.ts +0 -435
  875. package/src/resources/boxes.ts +0 -1017
  876. package/src/resources/campaigns.ts +0 -853
  877. package/src/resources/cheques/cheques.ts +0 -524
  878. package/src/resources/cheques/index.ts +0 -12
  879. package/src/resources/cheques/url.ts +0 -42
  880. package/src/resources/cheques/with-deposit-ready-pdf.ts +0 -23
  881. package/src/resources/cheques.ts +0 -3
  882. package/src/resources/contacts.ts +0 -415
  883. package/src/resources/letters.ts +0 -902
  884. package/src/resources/mailing-list-imports.ts +0 -1076
  885. package/src/resources/mailing-lists.ts +0 -511
  886. package/src/resources/order-profiles/cheques.ts +0 -888
  887. package/src/resources/order-profiles/index.ts +0 -55
  888. package/src/resources/order-profiles/letters.ts +0 -956
  889. package/src/resources/order-profiles/order-profiles.ts +0 -133
  890. package/src/resources/order-profiles/postcards.ts +0 -694
  891. package/src/resources/order-profiles/self-mailers.ts +0 -707
  892. package/src/resources/postcards.ts +0 -582
  893. package/src/resources/reports/exports.ts +0 -299
  894. package/src/resources/reports/index.ts +0 -25
  895. package/src/resources/reports/reports.ts +0 -494
  896. package/src/resources/self-mailers.ts +0 -1024
  897. package/src/resources/shared.ts +0 -182
  898. package/src/resources/sub-organizations.ts +0 -518
  899. package/src/resources/templates.ts +0 -218
  900. package/src/shims/node.ts +0 -50
  901. package/src/shims/web.ts +0 -50
  902. /package/resources/{order-profiles.d.ts → print-mail/order-profiles.d.ts} +0 -0
  903. /package/resources/{order-profiles.mjs → print-mail/order-profiles.mjs} +0 -0
  904. /package/resources/{reports.d.ts → print-mail/reports.d.ts} +0 -0
  905. /package/resources/{reports.mjs → print-mail/reports.mjs} +0 -0
  906. /package/src/resources/{order-profiles.ts → print-mail/order-profiles.ts} +0 -0
  907. /package/src/resources/{reports.ts → print-mail/reports.ts} +0 -0
@@ -1,706 +0,0 @@
1
- import { APIResource } from "../resource.js";
2
- import * as Core from "../core.js";
3
- import * as ContactsAPI from "./contacts.js";
4
- import * as Shared from "./shared.js";
5
- import { List, type ListParams } from "../pagination.js";
6
- export declare class SelfMailers extends APIResource {
7
- /**
8
- * Create a self-mailer. Note that you can supply one of the following:
9
- *
10
- * - HTML content for the inside and outside of the self-mailer
11
- * - A template ID for the inside and outside of the self-mailer
12
- * - A URL or file for a 2 page PDF where the first page is the outside of the
13
- * self-mailer and the second page is the inside
14
- * - Upload the aforementioned PDF file via a multipart form upload request
15
- *
16
- * @example
17
- * ```ts
18
- * const selfMailer = await client.selfMailers.create({
19
- * from: 'contact_123',
20
- * insideHTML: '<html>Inside</html>',
21
- * outsideHTML: '<html>Outside</html>',
22
- * size: '8.5x11_bifold',
23
- * to: 'contact_456',
24
- * });
25
- * ```
26
- */
27
- create(body: SelfMailerCreateParams, options?: Core.RequestOptions): Core.APIPromise<SelfMailerCreateResponse>;
28
- /**
29
- * Retrieve a self-mailer by ID.
30
- *
31
- * @example
32
- * ```ts
33
- * const selfMailer = await client.selfMailers.retrieve('id');
34
- * ```
35
- */
36
- retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerRetrieveResponse>;
37
- /**
38
- * Get a list of self-mailers.
39
- *
40
- * @example
41
- * ```ts
42
- * // Automatically fetches more pages as needed.
43
- * for await (const selfMailerListResponse of client.selfMailers.list()) {
44
- * // ...
45
- * }
46
- * ```
47
- */
48
- list(query?: SelfMailerListParams, options?: Core.RequestOptions): Core.PagePromise<SelfMailerListResponsesList, SelfMailerListResponse>;
49
- list(options?: Core.RequestOptions): Core.PagePromise<SelfMailerListResponsesList, SelfMailerListResponse>;
50
- /**
51
- * Cancel a self-mailer by ID. Note that this operation cannot be undone.
52
- *
53
- * @example
54
- * ```ts
55
- * const response = await client.selfMailers.cancel('id');
56
- * ```
57
- */
58
- cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerCancelResponse>;
59
- /**
60
- * Retrieve a self-mailer preview URL.
61
- *
62
- * This is only available for customers with our document management addon, which
63
- * offers document generation and hosting capabilities. This endpoint has a much
64
- * higher rate limit than the regular order retrieval endpoint, so it is suitable
65
- * for customer-facing use-cases.
66
- *
67
- * @example
68
- * ```ts
69
- * const response =
70
- * await client.selfMailers.retrievePreviewURL('id');
71
- * ```
72
- */
73
- retrievePreviewURL(id: string, options?: Core.RequestOptions): Core.APIPromise<SelfMailerRetrievePreviewURLResponse>;
74
- }
75
- export declare class SelfMailerListResponsesList extends List<SelfMailerListResponse> {
76
- }
77
- export interface SelfMailerCreateResponse {
78
- /**
79
- * A unique ID prefixed with self*mailer*
80
- */
81
- id: string;
82
- /**
83
- * The UTC time at which this resource was created.
84
- */
85
- createdAt: string;
86
- /**
87
- * The contact information of the sender.
88
- */
89
- from: ContactsAPI.Contact;
90
- /**
91
- * `true` if this is a live mode resource else `false`.
92
- */
93
- live: boolean;
94
- /**
95
- * The mailing class of this order. This determines the speed and cost of delivery.
96
- * See `OrderMailingClass` for more details.
97
- */
98
- 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';
99
- /**
100
- * Always `self_mailer`.
101
- */
102
- object: 'self_mailer';
103
- /**
104
- * This order will transition from `ready` to `printing` on the day after this
105
- * date. For example, if this is a date on Tuesday, the order will transition to
106
- * `printing` on Wednesday at midnight eastern time.
107
- */
108
- sendDate: string;
109
- /**
110
- * Enum representing the supported self-mailer sizes.
111
- */
112
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
113
- /**
114
- * See `OrderStatus` for more details on the status of this order.
115
- */
116
- status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
117
- /**
118
- * The recipient of this order. This will be provided even if you delete the
119
- * underlying contact.
120
- */
121
- to: ContactsAPI.Contact;
122
- /**
123
- * The UTC time at which this resource was last updated.
124
- */
125
- updatedAt: string;
126
- /**
127
- * The cancellation details of this order. Populated if the order has been
128
- * cancelled.
129
- */
130
- cancellation?: Shared.Cancellation;
131
- /**
132
- * An optional string describing this resource. Will be visible in the API and the
133
- * dashboard.
134
- */
135
- description?: string;
136
- /**
137
- * The last date that the IMB status was updated. See `imbStatus` for more details.
138
- */
139
- imbDate?: string;
140
- /**
141
- * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
142
- * US-printed and US-destined orders. This is the most detailed way to track
143
- * non-express/certified orders.
144
- */
145
- imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
146
- /**
147
- * The most recent ZIP code of the USPS facility that the order has been processed
148
- * through. Only populated when an `imbStatus` is present.
149
- */
150
- imbZIPCode?: string;
151
- /**
152
- * These will be merged with the variables in the template or HTML you create this
153
- * order with. The keys in this object should match the variable names in the
154
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
155
- * PDFs uploaded with the order.
156
- */
157
- mergeVariables?: {
158
- [key: string]: unknown;
159
- };
160
- /**
161
- * See the section on Metadata.
162
- */
163
- metadata?: {
164
- [key: string]: unknown;
165
- };
166
- /**
167
- * The tracking number of this order. Populated after an express/certified order
168
- * has been processed for delivery.
169
- */
170
- trackingNumber?: string;
171
- /**
172
- * PostGrid renders a PDF preview for all orders. This should be inspected to
173
- * ensure that the order is correct before it is sent out because it shows what
174
- * will be printed and mailed to the recipient. Once the PDF preview is generated,
175
- * this field will be returned by all `GET` endpoints which produce this order.
176
- *
177
- * This URL is a signed link to the PDF preview. It will expire after a short
178
- * period of time. If you need to access this URL after it has expired, you can
179
- * regenerate it by calling the `GET` endpoint again.
180
- */
181
- url?: string;
182
- }
183
- export interface SelfMailerRetrieveResponse {
184
- /**
185
- * A unique ID prefixed with self*mailer*
186
- */
187
- id: string;
188
- /**
189
- * The UTC time at which this resource was created.
190
- */
191
- createdAt: string;
192
- /**
193
- * The contact information of the sender.
194
- */
195
- from: ContactsAPI.Contact;
196
- /**
197
- * `true` if this is a live mode resource else `false`.
198
- */
199
- live: boolean;
200
- /**
201
- * The mailing class of this order. This determines the speed and cost of delivery.
202
- * See `OrderMailingClass` for more details.
203
- */
204
- 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';
205
- /**
206
- * Always `self_mailer`.
207
- */
208
- object: 'self_mailer';
209
- /**
210
- * This order will transition from `ready` to `printing` on the day after this
211
- * date. For example, if this is a date on Tuesday, the order will transition to
212
- * `printing` on Wednesday at midnight eastern time.
213
- */
214
- sendDate: string;
215
- /**
216
- * Enum representing the supported self-mailer sizes.
217
- */
218
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
219
- /**
220
- * See `OrderStatus` for more details on the status of this order.
221
- */
222
- status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
223
- /**
224
- * The recipient of this order. This will be provided even if you delete the
225
- * underlying contact.
226
- */
227
- to: ContactsAPI.Contact;
228
- /**
229
- * The UTC time at which this resource was last updated.
230
- */
231
- updatedAt: string;
232
- /**
233
- * The cancellation details of this order. Populated if the order has been
234
- * cancelled.
235
- */
236
- cancellation?: Shared.Cancellation;
237
- /**
238
- * An optional string describing this resource. Will be visible in the API and the
239
- * dashboard.
240
- */
241
- description?: string;
242
- /**
243
- * The last date that the IMB status was updated. See `imbStatus` for more details.
244
- */
245
- imbDate?: string;
246
- /**
247
- * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
248
- * US-printed and US-destined orders. This is the most detailed way to track
249
- * non-express/certified orders.
250
- */
251
- imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
252
- /**
253
- * The most recent ZIP code of the USPS facility that the order has been processed
254
- * through. Only populated when an `imbStatus` is present.
255
- */
256
- imbZIPCode?: string;
257
- /**
258
- * These will be merged with the variables in the template or HTML you create this
259
- * order with. The keys in this object should match the variable names in the
260
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
261
- * PDFs uploaded with the order.
262
- */
263
- mergeVariables?: {
264
- [key: string]: unknown;
265
- };
266
- /**
267
- * See the section on Metadata.
268
- */
269
- metadata?: {
270
- [key: string]: unknown;
271
- };
272
- /**
273
- * The tracking number of this order. Populated after an express/certified order
274
- * has been processed for delivery.
275
- */
276
- trackingNumber?: string;
277
- /**
278
- * PostGrid renders a PDF preview for all orders. This should be inspected to
279
- * ensure that the order is correct before it is sent out because it shows what
280
- * will be printed and mailed to the recipient. Once the PDF preview is generated,
281
- * this field will be returned by all `GET` endpoints which produce this order.
282
- *
283
- * This URL is a signed link to the PDF preview. It will expire after a short
284
- * period of time. If you need to access this URL after it has expired, you can
285
- * regenerate it by calling the `GET` endpoint again.
286
- */
287
- url?: string;
288
- }
289
- export interface SelfMailerListResponse {
290
- /**
291
- * A unique ID prefixed with self*mailer*
292
- */
293
- id: string;
294
- /**
295
- * The UTC time at which this resource was created.
296
- */
297
- createdAt: string;
298
- /**
299
- * The contact information of the sender.
300
- */
301
- from: ContactsAPI.Contact;
302
- /**
303
- * `true` if this is a live mode resource else `false`.
304
- */
305
- live: boolean;
306
- /**
307
- * The mailing class of this order. This determines the speed and cost of delivery.
308
- * See `OrderMailingClass` for more details.
309
- */
310
- 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';
311
- /**
312
- * Always `self_mailer`.
313
- */
314
- object: 'self_mailer';
315
- /**
316
- * This order will transition from `ready` to `printing` on the day after this
317
- * date. For example, if this is a date on Tuesday, the order will transition to
318
- * `printing` on Wednesday at midnight eastern time.
319
- */
320
- sendDate: string;
321
- /**
322
- * Enum representing the supported self-mailer sizes.
323
- */
324
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
325
- /**
326
- * See `OrderStatus` for more details on the status of this order.
327
- */
328
- status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
329
- /**
330
- * The recipient of this order. This will be provided even if you delete the
331
- * underlying contact.
332
- */
333
- to: ContactsAPI.Contact;
334
- /**
335
- * The UTC time at which this resource was last updated.
336
- */
337
- updatedAt: string;
338
- /**
339
- * The cancellation details of this order. Populated if the order has been
340
- * cancelled.
341
- */
342
- cancellation?: Shared.Cancellation;
343
- /**
344
- * An optional string describing this resource. Will be visible in the API and the
345
- * dashboard.
346
- */
347
- description?: string;
348
- /**
349
- * The last date that the IMB status was updated. See `imbStatus` for more details.
350
- */
351
- imbDate?: string;
352
- /**
353
- * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
354
- * US-printed and US-destined orders. This is the most detailed way to track
355
- * non-express/certified orders.
356
- */
357
- imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
358
- /**
359
- * The most recent ZIP code of the USPS facility that the order has been processed
360
- * through. Only populated when an `imbStatus` is present.
361
- */
362
- imbZIPCode?: string;
363
- /**
364
- * These will be merged with the variables in the template or HTML you create this
365
- * order with. The keys in this object should match the variable names in the
366
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
367
- * PDFs uploaded with the order.
368
- */
369
- mergeVariables?: {
370
- [key: string]: unknown;
371
- };
372
- /**
373
- * See the section on Metadata.
374
- */
375
- metadata?: {
376
- [key: string]: unknown;
377
- };
378
- /**
379
- * The tracking number of this order. Populated after an express/certified order
380
- * has been processed for delivery.
381
- */
382
- trackingNumber?: string;
383
- /**
384
- * PostGrid renders a PDF preview for all orders. This should be inspected to
385
- * ensure that the order is correct before it is sent out because it shows what
386
- * will be printed and mailed to the recipient. Once the PDF preview is generated,
387
- * this field will be returned by all `GET` endpoints which produce this order.
388
- *
389
- * This URL is a signed link to the PDF preview. It will expire after a short
390
- * period of time. If you need to access this URL after it has expired, you can
391
- * regenerate it by calling the `GET` endpoint again.
392
- */
393
- url?: string;
394
- }
395
- export interface SelfMailerCancelResponse {
396
- /**
397
- * A unique ID prefixed with self*mailer*
398
- */
399
- id: string;
400
- /**
401
- * The UTC time at which this resource was created.
402
- */
403
- createdAt: string;
404
- /**
405
- * The contact information of the sender.
406
- */
407
- from: ContactsAPI.Contact;
408
- /**
409
- * `true` if this is a live mode resource else `false`.
410
- */
411
- live: boolean;
412
- /**
413
- * The mailing class of this order. This determines the speed and cost of delivery.
414
- * See `OrderMailingClass` for more details.
415
- */
416
- 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';
417
- /**
418
- * Always `self_mailer`.
419
- */
420
- object: 'self_mailer';
421
- /**
422
- * This order will transition from `ready` to `printing` on the day after this
423
- * date. For example, if this is a date on Tuesday, the order will transition to
424
- * `printing` on Wednesday at midnight eastern time.
425
- */
426
- sendDate: string;
427
- /**
428
- * Enum representing the supported self-mailer sizes.
429
- */
430
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
431
- /**
432
- * See `OrderStatus` for more details on the status of this order.
433
- */
434
- status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
435
- /**
436
- * The recipient of this order. This will be provided even if you delete the
437
- * underlying contact.
438
- */
439
- to: ContactsAPI.Contact;
440
- /**
441
- * The UTC time at which this resource was last updated.
442
- */
443
- updatedAt: string;
444
- /**
445
- * The cancellation details of this order. Populated if the order has been
446
- * cancelled.
447
- */
448
- cancellation?: Shared.Cancellation;
449
- /**
450
- * An optional string describing this resource. Will be visible in the API and the
451
- * dashboard.
452
- */
453
- description?: string;
454
- /**
455
- * The last date that the IMB status was updated. See `imbStatus` for more details.
456
- */
457
- imbDate?: string;
458
- /**
459
- * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
460
- * US-printed and US-destined orders. This is the most detailed way to track
461
- * non-express/certified orders.
462
- */
463
- imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
464
- /**
465
- * The most recent ZIP code of the USPS facility that the order has been processed
466
- * through. Only populated when an `imbStatus` is present.
467
- */
468
- imbZIPCode?: string;
469
- /**
470
- * These will be merged with the variables in the template or HTML you create this
471
- * order with. The keys in this object should match the variable names in the
472
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
473
- * PDFs uploaded with the order.
474
- */
475
- mergeVariables?: {
476
- [key: string]: unknown;
477
- };
478
- /**
479
- * See the section on Metadata.
480
- */
481
- metadata?: {
482
- [key: string]: unknown;
483
- };
484
- /**
485
- * The tracking number of this order. Populated after an express/certified order
486
- * has been processed for delivery.
487
- */
488
- trackingNumber?: string;
489
- /**
490
- * PostGrid renders a PDF preview for all orders. This should be inspected to
491
- * ensure that the order is correct before it is sent out because it shows what
492
- * will be printed and mailed to the recipient. Once the PDF preview is generated,
493
- * this field will be returned by all `GET` endpoints which produce this order.
494
- *
495
- * This URL is a signed link to the PDF preview. It will expire after a short
496
- * period of time. If you need to access this URL after it has expired, you can
497
- * regenerate it by calling the `GET` endpoint again.
498
- */
499
- url?: string;
500
- }
501
- export interface SelfMailerRetrievePreviewURLResponse {
502
- /**
503
- * A unique ID prefixed with self*mailer*
504
- */
505
- id: string;
506
- object: string;
507
- /**
508
- * A signed URL linking to the order preview PDF. The link remains valid for 15
509
- * minutes from the time of the API call.
510
- */
511
- url: string;
512
- }
513
- export type SelfMailerCreateParams = SelfMailerCreateParams.SelfMailerCreateWithHTML | SelfMailerCreateParams.SelfMailerCreateWithTemplate | SelfMailerCreateParams.SelfMailerCreateWithPdfurl | SelfMailerCreateParams.SelfMailerCreateWithPdfFile;
514
- export declare namespace SelfMailerCreateParams {
515
- interface SelfMailerCreateWithHTML {
516
- /**
517
- * The contact information of the sender. You can pass contact information inline
518
- * here just like you can for the `to`.
519
- */
520
- from: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
521
- /**
522
- * The HTML content for the inside of the self-mailer. You can supply _either_ this
523
- * or `insideTemplate` but not both.
524
- */
525
- insideHTML: string;
526
- /**
527
- * The HTML content for the outside of the self-mailer. You can supply _either_
528
- * this or `outsideTemplate` but not both.
529
- */
530
- outsideHTML: string;
531
- /**
532
- * Enum representing the supported self-mailer sizes.
533
- */
534
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
535
- /**
536
- * The recipient of this order. You can either supply the contact information
537
- * inline here or provide a contact ID. PostGrid will automatically deduplicate
538
- * contacts regardless of whether you provide the information inline here or call
539
- * the contact creation endpoint.
540
- */
541
- to: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
542
- /**
543
- * An optional string describing this resource. Will be visible in the API and the
544
- * dashboard.
545
- */
546
- description?: string;
547
- /**
548
- * The mailing class of this order. If not provided, automatically set to
549
- * `first_class`.
550
- */
551
- 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';
552
- /**
553
- * These will be merged with the variables in the template or HTML you create this
554
- * order with. The keys in this object should match the variable names in the
555
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
556
- * PDFs uploaded with the order.
557
- */
558
- mergeVariables?: {
559
- [key: string]: unknown;
560
- };
561
- /**
562
- * See the section on Metadata.
563
- */
564
- metadata?: {
565
- [key: string]: unknown;
566
- };
567
- /**
568
- * This order will transition from `ready` to `printing` on the day after this
569
- * date. You can use this parameter to schedule orders for a future date.
570
- */
571
- sendDate?: string;
572
- }
573
- interface SelfMailerCreateWithTemplate {
574
- /**
575
- * The template ID for the inside of the self-mailer. You can supply _either_ this
576
- * or `insideHTML` but not both.
577
- */
578
- insideTemplate: string;
579
- /**
580
- * The template ID for the outside of the self-mailer. You can supply _either_ this
581
- * or `outsideHTML` but not both.
582
- */
583
- outsideTemplate: string;
584
- }
585
- interface SelfMailerCreateWithPdfurl {
586
- /**
587
- * The contact information of the sender. You can pass contact information inline
588
- * here just like you can for the `to`.
589
- */
590
- from: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
591
- /**
592
- * A URL pointing to a 2 page PDF file. The first page is the inside of the
593
- * self-mailer and the second page is the outside (where the address will be
594
- * stamped on).
595
- */
596
- pdf: string;
597
- /**
598
- * Enum representing the supported self-mailer sizes.
599
- */
600
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
601
- /**
602
- * The recipient of this order. You can either supply the contact information
603
- * inline here or provide a contact ID. PostGrid will automatically deduplicate
604
- * contacts regardless of whether you provide the information inline here or call
605
- * the contact creation endpoint.
606
- */
607
- to: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
608
- /**
609
- * An optional string describing this resource. Will be visible in the API and the
610
- * dashboard.
611
- */
612
- description?: string;
613
- /**
614
- * The mailing class of this order. If not provided, automatically set to
615
- * `first_class`.
616
- */
617
- 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';
618
- /**
619
- * These will be merged with the variables in the template or HTML you create this
620
- * order with. The keys in this object should match the variable names in the
621
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
622
- * PDFs uploaded with the order.
623
- */
624
- mergeVariables?: {
625
- [key: string]: unknown;
626
- };
627
- /**
628
- * See the section on Metadata.
629
- */
630
- metadata?: {
631
- [key: string]: unknown;
632
- };
633
- /**
634
- * This order will transition from `ready` to `printing` on the day after this
635
- * date. You can use this parameter to schedule orders for a future date.
636
- */
637
- sendDate?: string;
638
- }
639
- interface SelfMailerCreateWithPdfFile {
640
- /**
641
- * The contact information of the sender. You can pass contact information inline
642
- * here just like you can for the `to`.
643
- */
644
- from: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
645
- /**
646
- * A 2 page PDF file. The first page is the inside of the self-mailer and the
647
- * second page is the outside (where the address will be stamped on).
648
- */
649
- pdf: string;
650
- /**
651
- * Enum representing the supported self-mailer sizes.
652
- */
653
- size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
654
- /**
655
- * The recipient of this order. You can either supply the contact information
656
- * inline here or provide a contact ID. PostGrid will automatically deduplicate
657
- * contacts regardless of whether you provide the information inline here or call
658
- * the contact creation endpoint.
659
- */
660
- to: Shared.ContactCreateWithFirstName | Shared.ContactCreateWithCompanyName | string;
661
- /**
662
- * An optional string describing this resource. Will be visible in the API and the
663
- * dashboard.
664
- */
665
- description?: string;
666
- /**
667
- * The mailing class of this order. If not provided, automatically set to
668
- * `first_class`.
669
- */
670
- 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';
671
- /**
672
- * These will be merged with the variables in the template or HTML you create this
673
- * order with. The keys in this object should match the variable names in the
674
- * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
675
- * PDFs uploaded with the order.
676
- */
677
- mergeVariables?: {
678
- [key: string]: unknown;
679
- };
680
- /**
681
- * See the section on Metadata.
682
- */
683
- metadata?: {
684
- [key: string]: unknown;
685
- };
686
- /**
687
- * This order will transition from `ready` to `printing` on the day after this
688
- * date. You can use this parameter to schedule orders for a future date.
689
- */
690
- sendDate?: string;
691
- }
692
- }
693
- export interface SelfMailerListParams extends ListParams {
694
- /**
695
- * You can supply any string to help narrow down the list of resources. For
696
- * example, if you pass `"New York"` (quoted), it will return resources that have
697
- * that string present somewhere in their response. Alternatively, you can supply a
698
- * structured search query. See the documentation on `StructuredSearchQuery` for
699
- * more details.
700
- */
701
- search?: string;
702
- }
703
- export declare namespace SelfMailers {
704
- export { type SelfMailerCreateResponse as SelfMailerCreateResponse, type SelfMailerRetrieveResponse as SelfMailerRetrieveResponse, type SelfMailerListResponse as SelfMailerListResponse, type SelfMailerCancelResponse as SelfMailerCancelResponse, type SelfMailerRetrievePreviewURLResponse as SelfMailerRetrievePreviewURLResponse, SelfMailerListResponsesList as SelfMailerListResponsesList, type SelfMailerCreateParams as SelfMailerCreateParams, type SelfMailerListParams as SelfMailerListParams, };
705
- }
706
- //# sourceMappingURL=self-mailers.d.ts.map