mdd-printful-client 0.2.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 (559) hide show
  1. package/CHANGELOG.md +52 -0
  2. package/LICENSE +201 -0
  3. package/README.md +358 -0
  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 +237 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +237 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +521 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +517 -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 +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  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 +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +78 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +78 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +137 -0
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +2 -0
  234. package/resource.d.ts.map +1 -0
  235. package/resource.js +6 -0
  236. package/resource.js.map +1 -0
  237. package/resource.mjs +2 -0
  238. package/resource.mjs.map +1 -0
  239. package/resources/approval-sheets.d.mts +164 -0
  240. package/resources/approval-sheets.d.mts.map +1 -0
  241. package/resources/approval-sheets.d.ts +164 -0
  242. package/resources/approval-sheets.d.ts.map +1 -0
  243. package/resources/approval-sheets.js +77 -0
  244. package/resources/approval-sheets.js.map +1 -0
  245. package/resources/approval-sheets.mjs +73 -0
  246. package/resources/approval-sheets.mjs.map +1 -0
  247. package/resources/categories.d.mts +88 -0
  248. package/resources/categories.d.mts.map +1 -0
  249. package/resources/categories.d.ts +88 -0
  250. package/resources/categories.d.ts.map +1 -0
  251. package/resources/categories.js +22 -0
  252. package/resources/categories.js.map +1 -0
  253. package/resources/categories.mjs +18 -0
  254. package/resources/categories.mjs.map +1 -0
  255. package/resources/countries.d.mts +46 -0
  256. package/resources/countries.d.mts.map +1 -0
  257. package/resources/countries.d.ts +46 -0
  258. package/resources/countries.d.ts.map +1 -0
  259. package/resources/countries.js +15 -0
  260. package/resources/countries.js.map +1 -0
  261. package/resources/countries.mjs +11 -0
  262. package/resources/countries.mjs.map +1 -0
  263. package/resources/files.d.mts +127 -0
  264. package/resources/files.d.mts.map +1 -0
  265. package/resources/files.d.ts +127 -0
  266. package/resources/files.d.ts.map +1 -0
  267. package/resources/files.js +73 -0
  268. package/resources/files.js.map +1 -0
  269. package/resources/files.mjs +69 -0
  270. package/resources/files.mjs.map +1 -0
  271. package/resources/index.d.mts +18 -0
  272. package/resources/index.d.mts.map +1 -0
  273. package/resources/index.d.ts +18 -0
  274. package/resources/index.d.ts.map +1 -0
  275. package/resources/index.js +39 -0
  276. package/resources/index.js.map +1 -0
  277. package/resources/index.mjs +19 -0
  278. package/resources/index.mjs.map +1 -0
  279. package/resources/mockup-generator.d.mts +651 -0
  280. package/resources/mockup-generator.d.mts.map +1 -0
  281. package/resources/mockup-generator.d.ts +651 -0
  282. package/resources/mockup-generator.d.ts.map +1 -0
  283. package/resources/mockup-generator.js +119 -0
  284. package/resources/mockup-generator.js.map +1 -0
  285. package/resources/mockup-generator.mjs +115 -0
  286. package/resources/mockup-generator.mjs.map +1 -0
  287. package/resources/oauth.d.mts +31 -0
  288. package/resources/oauth.d.mts.map +1 -0
  289. package/resources/oauth.d.ts +31 -0
  290. package/resources/oauth.d.ts.map +1 -0
  291. package/resources/oauth.js +15 -0
  292. package/resources/oauth.js.map +1 -0
  293. package/resources/oauth.mjs +11 -0
  294. package/resources/oauth.mjs.map +1 -0
  295. package/resources/orders.d.mts +923 -0
  296. package/resources/orders.d.mts.map +1 -0
  297. package/resources/orders.d.ts +923 -0
  298. package/resources/orders.d.ts.map +1 -0
  299. package/resources/orders.js +166 -0
  300. package/resources/orders.js.map +1 -0
  301. package/resources/orders.mjs +162 -0
  302. package/resources/orders.mjs.map +1 -0
  303. package/resources/product-templates.d.mts +171 -0
  304. package/resources/product-templates.d.mts.map +1 -0
  305. package/resources/product-templates.d.ts +171 -0
  306. package/resources/product-templates.d.ts.map +1 -0
  307. package/resources/product-templates.js +28 -0
  308. package/resources/product-templates.js.map +1 -0
  309. package/resources/product-templates.mjs +24 -0
  310. package/resources/product-templates.mjs.map +1 -0
  311. package/resources/products.d.mts +511 -0
  312. package/resources/products.d.mts.map +1 -0
  313. package/resources/products.d.ts +511 -0
  314. package/resources/products.d.ts.map +1 -0
  315. package/resources/products.js +35 -0
  316. package/resources/products.js.map +1 -0
  317. package/resources/products.mjs +31 -0
  318. package/resources/products.mjs.map +1 -0
  319. package/resources/reports.d.mts +363 -0
  320. package/resources/reports.d.mts.map +1 -0
  321. package/resources/reports.d.ts +363 -0
  322. package/resources/reports.d.ts.map +1 -0
  323. package/resources/reports.js +56 -0
  324. package/resources/reports.js.map +1 -0
  325. package/resources/reports.mjs +52 -0
  326. package/resources/reports.mjs.map +1 -0
  327. package/resources/shared.d.mts +304 -0
  328. package/resources/shared.d.mts.map +1 -0
  329. package/resources/shared.d.ts +304 -0
  330. package/resources/shared.d.ts.map +1 -0
  331. package/resources/shared.js +4 -0
  332. package/resources/shared.js.map +1 -0
  333. package/resources/shared.mjs +3 -0
  334. package/resources/shared.mjs.map +1 -0
  335. package/resources/shipping.d.mts +215 -0
  336. package/resources/shipping.d.mts.map +1 -0
  337. package/resources/shipping.d.ts +215 -0
  338. package/resources/shipping.d.ts.map +1 -0
  339. package/resources/shipping.js +56 -0
  340. package/resources/shipping.js.map +1 -0
  341. package/resources/shipping.mjs +52 -0
  342. package/resources/shipping.mjs.map +1 -0
  343. package/resources/store/index.d.mts +4 -0
  344. package/resources/store/index.d.mts.map +1 -0
  345. package/resources/store/index.d.ts +4 -0
  346. package/resources/store/index.d.ts.map +1 -0
  347. package/resources/store/index.js +11 -0
  348. package/resources/store/index.js.map +1 -0
  349. package/resources/store/index.mjs +5 -0
  350. package/resources/store/index.mjs.map +1 -0
  351. package/resources/store/products.d.mts +327 -0
  352. package/resources/store/products.d.mts.map +1 -0
  353. package/resources/store/products.d.ts +327 -0
  354. package/resources/store/products.d.ts.map +1 -0
  355. package/resources/store/products.js +164 -0
  356. package/resources/store/products.js.map +1 -0
  357. package/resources/store/products.mjs +160 -0
  358. package/resources/store/products.mjs.map +1 -0
  359. package/resources/store/store.d.mts +148 -0
  360. package/resources/store/store.d.mts.map +1 -0
  361. package/resources/store/store.d.ts +148 -0
  362. package/resources/store/store.d.ts.map +1 -0
  363. package/resources/store/store.js +65 -0
  364. package/resources/store/store.js.map +1 -0
  365. package/resources/store/store.mjs +60 -0
  366. package/resources/store/store.mjs.map +1 -0
  367. package/resources/store/variants.d.mts +151 -0
  368. package/resources/store/variants.d.mts.map +1 -0
  369. package/resources/store/variants.d.ts +151 -0
  370. package/resources/store/variants.d.ts.map +1 -0
  371. package/resources/store/variants.js +74 -0
  372. package/resources/store/variants.js.map +1 -0
  373. package/resources/store/variants.mjs +70 -0
  374. package/resources/store/variants.mjs.map +1 -0
  375. package/resources/store.d.mts +2 -0
  376. package/resources/store.d.mts.map +1 -0
  377. package/resources/store.d.ts +2 -0
  378. package/resources/store.d.ts.map +1 -0
  379. package/resources/store.js +6 -0
  380. package/resources/store.js.map +1 -0
  381. package/resources/store.mjs +3 -0
  382. package/resources/store.mjs.map +1 -0
  383. package/resources/sync/index.d.mts +4 -0
  384. package/resources/sync/index.d.mts.map +1 -0
  385. package/resources/sync/index.d.ts +4 -0
  386. package/resources/sync/index.d.ts.map +1 -0
  387. package/resources/sync/index.js +11 -0
  388. package/resources/sync/index.js.map +1 -0
  389. package/resources/sync/index.mjs +5 -0
  390. package/resources/sync/index.mjs.map +1 -0
  391. package/resources/sync/products.d.mts +138 -0
  392. package/resources/sync/products.d.mts.map +1 -0
  393. package/resources/sync/products.d.ts +138 -0
  394. package/resources/sync/products.d.ts.map +1 -0
  395. package/resources/sync/products.js +69 -0
  396. package/resources/sync/products.js.map +1 -0
  397. package/resources/sync/products.mjs +65 -0
  398. package/resources/sync/products.mjs.map +1 -0
  399. package/resources/sync/sync.d.mts +14 -0
  400. package/resources/sync/sync.d.mts.map +1 -0
  401. package/resources/sync/sync.d.ts +14 -0
  402. package/resources/sync/sync.d.ts.map +1 -0
  403. package/resources/sync/sync.js +21 -0
  404. package/resources/sync/sync.js.map +1 -0
  405. package/resources/sync/sync.mjs +16 -0
  406. package/resources/sync/sync.mjs.map +1 -0
  407. package/resources/sync/variant.d.mts +164 -0
  408. package/resources/sync/variant.d.mts.map +1 -0
  409. package/resources/sync/variant.d.ts +164 -0
  410. package/resources/sync/variant.d.ts.map +1 -0
  411. package/resources/sync/variant.js +78 -0
  412. package/resources/sync/variant.js.map +1 -0
  413. package/resources/sync/variant.mjs +74 -0
  414. package/resources/sync/variant.mjs.map +1 -0
  415. package/resources/sync.d.mts +2 -0
  416. package/resources/sync.d.mts.map +1 -0
  417. package/resources/sync.d.ts +2 -0
  418. package/resources/sync.d.ts.map +1 -0
  419. package/resources/sync.js +6 -0
  420. package/resources/sync.js.map +1 -0
  421. package/resources/sync.mjs +3 -0
  422. package/resources/sync.mjs.map +1 -0
  423. package/resources/tax.d.mts +122 -0
  424. package/resources/tax.d.mts.map +1 -0
  425. package/resources/tax.d.ts +122 -0
  426. package/resources/tax.d.ts.map +1 -0
  427. package/resources/tax.js +31 -0
  428. package/resources/tax.js.map +1 -0
  429. package/resources/tax.mjs +27 -0
  430. package/resources/tax.mjs.map +1 -0
  431. package/resources/warehouse/index.d.mts +3 -0
  432. package/resources/warehouse/index.d.mts.map +1 -0
  433. package/resources/warehouse/index.d.ts +3 -0
  434. package/resources/warehouse/index.d.ts.map +1 -0
  435. package/resources/warehouse/index.js +9 -0
  436. package/resources/warehouse/index.js.map +1 -0
  437. package/resources/warehouse/index.mjs +4 -0
  438. package/resources/warehouse/index.mjs.map +1 -0
  439. package/resources/warehouse/products.d.mts +311 -0
  440. package/resources/warehouse/products.d.mts.map +1 -0
  441. package/resources/warehouse/products.d.ts +311 -0
  442. package/resources/warehouse/products.d.ts.map +1 -0
  443. package/resources/warehouse/products.js +51 -0
  444. package/resources/warehouse/products.js.map +1 -0
  445. package/resources/warehouse/products.mjs +47 -0
  446. package/resources/warehouse/products.mjs.map +1 -0
  447. package/resources/warehouse/warehouse.d.mts +10 -0
  448. package/resources/warehouse/warehouse.d.mts.map +1 -0
  449. package/resources/warehouse/warehouse.d.ts +10 -0
  450. package/resources/warehouse/warehouse.d.ts.map +1 -0
  451. package/resources/warehouse/warehouse.js +17 -0
  452. package/resources/warehouse/warehouse.js.map +1 -0
  453. package/resources/warehouse/warehouse.mjs +12 -0
  454. package/resources/warehouse/warehouse.mjs.map +1 -0
  455. package/resources/warehouse.d.mts +2 -0
  456. package/resources/warehouse.d.mts.map +1 -0
  457. package/resources/warehouse.d.ts +2 -0
  458. package/resources/warehouse.d.ts.map +1 -0
  459. package/resources/warehouse.js +6 -0
  460. package/resources/warehouse.js.map +1 -0
  461. package/resources/warehouse.mjs +3 -0
  462. package/resources/warehouse.mjs.map +1 -0
  463. package/resources/webhooks.d.mts +130 -0
  464. package/resources/webhooks.d.mts.map +1 -0
  465. package/resources/webhooks.d.ts +130 -0
  466. package/resources/webhooks.d.ts.map +1 -0
  467. package/resources/webhooks.js +81 -0
  468. package/resources/webhooks.js.map +1 -0
  469. package/resources/webhooks.mjs +77 -0
  470. package/resources/webhooks.mjs.map +1 -0
  471. package/resources.d.mts +2 -0
  472. package/resources.d.mts.map +1 -0
  473. package/resources.d.ts +2 -0
  474. package/resources.d.ts.map +1 -0
  475. package/resources.js +5 -0
  476. package/resources.js.map +1 -0
  477. package/resources.mjs +2 -0
  478. package/resources.mjs.map +1 -0
  479. package/src/api-promise.ts +2 -0
  480. package/src/client.ts +1030 -0
  481. package/src/core/README.md +3 -0
  482. package/src/core/api-promise.ts +92 -0
  483. package/src/core/error.ts +130 -0
  484. package/src/core/resource.ts +11 -0
  485. package/src/core/uploads.ts +2 -0
  486. package/src/error.ts +2 -0
  487. package/src/index.ts +22 -0
  488. package/src/internal/README.md +3 -0
  489. package/src/internal/builtin-types.ts +93 -0
  490. package/src/internal/detect-platform.ts +196 -0
  491. package/src/internal/errors.ts +33 -0
  492. package/src/internal/headers.ts +97 -0
  493. package/src/internal/parse.ts +56 -0
  494. package/src/internal/request-options.ts +93 -0
  495. package/src/internal/shim-types.ts +26 -0
  496. package/src/internal/shims.ts +107 -0
  497. package/src/internal/to-file.ts +154 -0
  498. package/src/internal/types.ts +95 -0
  499. package/src/internal/uploads.ts +187 -0
  500. package/src/internal/utils/base64.ts +40 -0
  501. package/src/internal/utils/bytes.ts +32 -0
  502. package/src/internal/utils/env.ts +18 -0
  503. package/src/internal/utils/log.ts +126 -0
  504. package/src/internal/utils/path.ts +88 -0
  505. package/src/internal/utils/sleep.ts +3 -0
  506. package/src/internal/utils/uuid.ts +17 -0
  507. package/src/internal/utils/values.ts +105 -0
  508. package/src/internal/utils.ts +8 -0
  509. package/src/lib/.keep +4 -0
  510. package/src/resource.ts +2 -0
  511. package/src/resources/approval-sheets.ts +245 -0
  512. package/src/resources/categories.ts +114 -0
  513. package/src/resources/countries.ts +59 -0
  514. package/src/resources/files.ts +185 -0
  515. package/src/resources/index.ts +115 -0
  516. package/src/resources/mockup-generator.ts +830 -0
  517. package/src/resources/oauth.ts +41 -0
  518. package/src/resources/orders.ts +1212 -0
  519. package/src/resources/product-templates.ts +252 -0
  520. package/src/resources/products.ts +636 -0
  521. package/src/resources/reports.ts +443 -0
  522. package/src/resources/shared.ts +366 -0
  523. package/src/resources/shipping.ts +263 -0
  524. package/src/resources/store/index.ts +33 -0
  525. package/src/resources/store/products.ts +472 -0
  526. package/src/resources/store/store.ts +249 -0
  527. package/src/resources/store/variants.ts +227 -0
  528. package/src/resources/store.ts +3 -0
  529. package/src/resources/sync/index.ts +21 -0
  530. package/src/resources/sync/products.ts +212 -0
  531. package/src/resources/sync/sync.ts +53 -0
  532. package/src/resources/sync/variant.ts +242 -0
  533. package/src/resources/sync.ts +3 -0
  534. package/src/resources/tax.ts +156 -0
  535. package/src/resources/warehouse/index.ts +10 -0
  536. package/src/resources/warehouse/products.ts +412 -0
  537. package/src/resources/warehouse/warehouse.ts +27 -0
  538. package/src/resources/warehouse.ts +3 -0
  539. package/src/resources/webhooks.ts +192 -0
  540. package/src/resources.ts +1 -0
  541. package/src/tsconfig.json +11 -0
  542. package/src/uploads.ts +2 -0
  543. package/src/version.ts +1 -0
  544. package/uploads.d.mts +2 -0
  545. package/uploads.d.mts.map +1 -0
  546. package/uploads.d.ts +2 -0
  547. package/uploads.d.ts.map +1 -0
  548. package/uploads.js +6 -0
  549. package/uploads.js.map +1 -0
  550. package/uploads.mjs +2 -0
  551. package/uploads.mjs.map +1 -0
  552. package/version.d.mts +2 -0
  553. package/version.d.mts.map +1 -0
  554. package/version.d.ts +2 -0
  555. package/version.d.ts.map +1 -0
  556. package/version.js +5 -0
  557. package/version.js.map +1 -0
  558. package/version.mjs +2 -0
  559. package/version.mjs.map +1 -0
@@ -0,0 +1,1212 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import * as Shared from './shared';
5
+ import { APIPromise } from '../core/api-promise';
6
+ import { buildHeaders } from '../internal/headers';
7
+ import { RequestOptions } from '../internal/request-options';
8
+ import { path } from '../internal/utils/path';
9
+
10
+ export class Orders extends APIResource {
11
+ /**
12
+ * Creates a new order and optionally submits it for fulfillment
13
+ * ([See examples](#tag/Examples/Orders-API-examples))
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const order = await client.orders.create({
18
+ * items: [{}],
19
+ * recipient: {},
20
+ * });
21
+ * ```
22
+ */
23
+ create(params: OrderCreateParams, options?: RequestOptions): APIPromise<OrderCreateResponse> {
24
+ const { confirm, update_existing, 'X-PF-Store-Id': xPfStoreID, ...body } = params;
25
+ return this._client.post('/orders', {
26
+ query: { confirm, update_existing },
27
+ body,
28
+ ...options,
29
+ headers: buildHeaders([
30
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
31
+ options?.headers,
32
+ ]),
33
+ __security: {},
34
+ });
35
+ }
36
+
37
+ /**
38
+ * Returns order data by ID or External ID.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const order = await client.orders.retrieve('string');
43
+ * ```
44
+ */
45
+ retrieve(
46
+ id: string | number,
47
+ params: OrderRetrieveParams | null | undefined = {},
48
+ options?: RequestOptions,
49
+ ): APIPromise<OrderRetrieveResponse> {
50
+ const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
51
+ return this._client.get(path`/orders/${id}`, {
52
+ ...options,
53
+ headers: buildHeaders([
54
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
55
+ options?.headers,
56
+ ]),
57
+ __security: {},
58
+ });
59
+ }
60
+
61
+ /**
62
+ * Updates unsubmitted order and optionally submits it for the fulfillment.
63
+ *
64
+ * Note that you need to post only the fields that need to be changed, not all
65
+ * required fields.
66
+ *
67
+ * If items array is given in the update data, the items will be:
68
+ *
69
+ * a) updated, if the update data contains the item id or external_id parameter
70
+ * that alreay exists
71
+ *
72
+ * b) deleted, if the request doesn't contain the item with previously existing id
73
+ *
74
+ * c) created as new if the id is not given or does not already exist
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const order = await client.orders.update('string', {
79
+ * items: [{}],
80
+ * recipient: {},
81
+ * });
82
+ * ```
83
+ */
84
+ update(
85
+ id: string | number,
86
+ params: OrderUpdateParams,
87
+ options?: RequestOptions,
88
+ ): APIPromise<OrderUpdateResponse> {
89
+ const { confirm, 'X-PF-Store-Id': xPfStoreID, ...body } = params;
90
+ return this._client.put(path`/orders/${id}`, {
91
+ query: { confirm },
92
+ body,
93
+ ...options,
94
+ headers: buildHeaders([
95
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
96
+ options?.headers,
97
+ ]),
98
+ __security: {},
99
+ });
100
+ }
101
+
102
+ /**
103
+ * Returns list of order objects from your store
104
+ *
105
+ * @example
106
+ * ```ts
107
+ * const orders = await client.orders.list();
108
+ * ```
109
+ */
110
+ list(
111
+ query: OrderListParams | null | undefined = {},
112
+ options?: RequestOptions,
113
+ ): APIPromise<OrderListResponse> {
114
+ return this._client.get('/orders', { query, ...options, __security: {} });
115
+ }
116
+
117
+ /**
118
+ * Cancels pending order or draft. Charged amount is returned to the store owner's
119
+ * credit card.
120
+ *
121
+ * @example
122
+ * ```ts
123
+ * const response = await client.orders.cancel('string');
124
+ * ```
125
+ */
126
+ cancel(
127
+ id: string | number,
128
+ params: OrderCancelParams | null | undefined = {},
129
+ options?: RequestOptions,
130
+ ): APIPromise<OrderCancelResponse> {
131
+ const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
132
+ return this._client.delete(path`/orders/${id}`, {
133
+ ...options,
134
+ headers: buildHeaders([
135
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
136
+ options?.headers,
137
+ ]),
138
+ __security: {},
139
+ });
140
+ }
141
+
142
+ /**
143
+ * Approves for fulfillment an order that was saved as a draft. Store owner's
144
+ * credit card is charged when the order is submitted for fulfillment.
145
+ *
146
+ * @example
147
+ * ```ts
148
+ * const response = await client.orders.confirm('string');
149
+ * ```
150
+ */
151
+ confirm(
152
+ id: string | number,
153
+ params: OrderConfirmParams | null | undefined = {},
154
+ options?: RequestOptions,
155
+ ): APIPromise<OrderConfirmResponse> {
156
+ const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
157
+ return this._client.post(path`/orders/${id}/confirm`, {
158
+ ...options,
159
+ headers: buildHeaders([
160
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
161
+ options?.headers,
162
+ ]),
163
+ __security: {},
164
+ });
165
+ }
166
+
167
+ /**
168
+ * Calculates the estimated order costs including item costs, print costs (back
169
+ * prints, inside labels etc.), shipping and taxes
170
+ *
171
+ * @example
172
+ * ```ts
173
+ * const response = await client.orders.estimateCosts({
174
+ * items: [{}],
175
+ * recipient: {},
176
+ * });
177
+ * ```
178
+ */
179
+ estimateCosts(
180
+ params: OrderEstimateCostsParams,
181
+ options?: RequestOptions,
182
+ ): APIPromise<OrderEstimateCostsResponse> {
183
+ const { 'X-PF-Store-Id': xPfStoreID, ...body } = params;
184
+ return this._client.post('/orders/estimate-costs', {
185
+ body,
186
+ ...options,
187
+ headers: buildHeaders([
188
+ { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
189
+ options?.headers,
190
+ ]),
191
+ __security: {},
192
+ });
193
+ }
194
+ }
195
+
196
+ /**
197
+ * Information about the address
198
+ */
199
+ export interface Address {
200
+ /**
201
+ * Address line 1
202
+ */
203
+ address1?: string;
204
+
205
+ /**
206
+ * Address line 2
207
+ */
208
+ address2?: string;
209
+
210
+ /**
211
+ * City
212
+ */
213
+ city?: string;
214
+
215
+ /**
216
+ * Company name
217
+ */
218
+ company?: string;
219
+
220
+ /**
221
+ * Country code
222
+ */
223
+ country_code?: string;
224
+
225
+ /**
226
+ * Country name
227
+ */
228
+ country_name?: string;
229
+
230
+ /**
231
+ * Email address
232
+ */
233
+ email?: string;
234
+
235
+ /**
236
+ * Full name
237
+ */
238
+ name?: string;
239
+
240
+ /**
241
+ * Phone number
242
+ */
243
+ phone?: string;
244
+
245
+ /**
246
+ * State code
247
+ */
248
+ state_code?: string;
249
+
250
+ /**
251
+ * State name
252
+ */
253
+ state_name?: string;
254
+
255
+ /**
256
+ * TAX number (`optional`, but in case of Brazil country this field becomes
257
+ * `required` and will be used as CPF/CNPJ number) CPF format is 000.000.000-00 (14
258
+ * characters); CNPJ format is 00.000.000/0000-00 (18 characters).
259
+ */
260
+ tax_number?: string;
261
+
262
+ /**
263
+ * ZIP/Postal code
264
+ */
265
+ zip?: string;
266
+ }
267
+
268
+ /**
269
+ * Order costs (Printful prices)
270
+ */
271
+ export interface Costs {
272
+ /**
273
+ * Additional fee for custom product
274
+ */
275
+ additional_fee?: string;
276
+
277
+ /**
278
+ * 3 letter currency code
279
+ */
280
+ currency?: string;
281
+
282
+ /**
283
+ * Digitization costs
284
+ */
285
+ digitization?: string;
286
+
287
+ /**
288
+ * Discount sum
289
+ */
290
+ discount?: string;
291
+
292
+ /**
293
+ * Custom product fulfillment fee
294
+ */
295
+ fulfillment_fee?: string;
296
+
297
+ /**
298
+ * Retail delivery fee
299
+ */
300
+ retail_delivery_fee?: string;
301
+
302
+ /**
303
+ * Shipping costs
304
+ */
305
+ shipping?: string;
306
+
307
+ /**
308
+ * Total cost of all items
309
+ */
310
+ subtotal?: string;
311
+
312
+ /**
313
+ * Sum of taxes (not included in the item price)
314
+ */
315
+ tax?: string;
316
+
317
+ /**
318
+ * Grand Total (subtotal-discount+tax+vat+shipping)
319
+ */
320
+ total?: string;
321
+
322
+ /**
323
+ * Sum of vat (not included in the item price)
324
+ */
325
+ vat?: string;
326
+ }
327
+
328
+ /**
329
+ * Optional gift message for the packing slip
330
+ */
331
+ export interface Gift {
332
+ /**
333
+ * Gift message text
334
+ */
335
+ message?: string;
336
+
337
+ /**
338
+ * Gift message title
339
+ */
340
+ subject?: string;
341
+ }
342
+
343
+ /**
344
+ * Information about an incomplete item in the order
345
+ */
346
+ export interface IncompleteItem {
347
+ /**
348
+ * External order line item id.
349
+ */
350
+ external_line_item_id?: string;
351
+
352
+ /**
353
+ * External variant ID of the incompleted item.
354
+ */
355
+ external_variant_id?: string;
356
+
357
+ /**
358
+ * Incomplete item name
359
+ */
360
+ name?: string;
361
+
362
+ /**
363
+ * Incompleted item quantity
364
+ */
365
+ quantity?: number;
366
+
367
+ /**
368
+ * Sync variant ID of the incompleted item.
369
+ */
370
+ sync_variant_id?: number;
371
+ }
372
+
373
+ /**
374
+ * Information about an item in the order
375
+ */
376
+ export interface Item {
377
+ /**
378
+ * Line item ID
379
+ */
380
+ id?: number;
381
+
382
+ /**
383
+ * Whether the item belongs to discontinued product i.e. it's permanently
384
+ * unavailable
385
+ */
386
+ discontinued?: boolean;
387
+
388
+ /**
389
+ * Line item ID from the external system
390
+ */
391
+ external_id?: string;
392
+
393
+ /**
394
+ * External variant ID of the item ordered.
395
+ * [Example](#tag/Examples/Orders-API-examples/Using-sync-variant-with-external-ID).
396
+ */
397
+ external_variant_id?: string;
398
+
399
+ /**
400
+ * Array of attached printfiles / preview images
401
+ */
402
+ files?: Array<Item.File>;
403
+
404
+ /**
405
+ * Display name of the item. If not given, a name from the Printful system will be
406
+ * displayed on the packing slip
407
+ */
408
+ name?: string;
409
+
410
+ /**
411
+ * Array of additional options for this product [See examples](#tag/Common/Options)
412
+ */
413
+ options?: Array<Option>;
414
+
415
+ /**
416
+ * Whether the item is out of stock i.e. temporarily unavailable
417
+ */
418
+ out_of_stock?: boolean;
419
+
420
+ /**
421
+ * Printful price of the item
422
+ */
423
+ price?: string;
424
+
425
+ /**
426
+ * Short information about the Printful Product and Variant
427
+ */
428
+ product?: Shared.ProductVariant;
429
+
430
+ /**
431
+ * The ID of a Product Template to generate the printfiles from. The `variant_id`
432
+ * field must be passed as well. Can't be combined with following fields:
433
+ * `sync_variant_id`, `external_variant_id`, `warehouse_product_variant_id`,
434
+ * `files`, `options`, `external_product_id`.
435
+ * [Examples](#tag/Examples/Orders-API-examples/Using-a-product-template).
436
+ */
437
+ product_template_id?: number;
438
+
439
+ /**
440
+ * Number of items ordered (Limited to 1000 for one item)
441
+ */
442
+ quantity?: number;
443
+
444
+ /**
445
+ * Original retail price of the item to be displayed on the packing slip
446
+ */
447
+ retail_price?: string;
448
+
449
+ /**
450
+ * Product identifier (SKU) from the external system
451
+ */
452
+ sku?: string;
453
+
454
+ /**
455
+ * Sync variant ID of the item ordered.
456
+ * [Example](#tag/Examples/Orders-API-examples/Using-a-sync-variant).
457
+ */
458
+ sync_variant_id?: number;
459
+
460
+ /**
461
+ * Variant ID of the item ordered. See [Catalog API](#tag/Catalog-API)
462
+ */
463
+ variant_id?: number;
464
+
465
+ /**
466
+ * Warehousing product variant ID of the item ordered. See Warehouse Products API
467
+ */
468
+ warehouse_product_variant_id?: number;
469
+ }
470
+
471
+ export namespace Item {
472
+ /**
473
+ * Information about the File
474
+ */
475
+ export interface File extends Shared.File {}
476
+ }
477
+
478
+ /**
479
+ * Additional option for order item
480
+ */
481
+ export interface Option {
482
+ /**
483
+ * Option ID
484
+ */
485
+ id?: string;
486
+
487
+ /**
488
+ * Option value
489
+ */
490
+ value?: string;
491
+ }
492
+
493
+ /**
494
+ * Information about the Order
495
+ */
496
+ export interface Order {
497
+ /**
498
+ * Array of items in the order
499
+ */
500
+ items: Array<Item>;
501
+
502
+ /**
503
+ * Information about the address
504
+ */
505
+ recipient: Address;
506
+
507
+ /**
508
+ * Order ID
509
+ */
510
+ id?: number;
511
+
512
+ /**
513
+ * Array of branding items in the order
514
+ */
515
+ branding_items?: Array<Item>;
516
+
517
+ /**
518
+ * Order costs (Printful prices)
519
+ */
520
+ costs?: Costs;
521
+
522
+ /**
523
+ * Time when the order was created
524
+ */
525
+ created?: number;
526
+
527
+ /**
528
+ * Order ID from the external system
529
+ */
530
+ external_id?: string | null;
531
+
532
+ /**
533
+ * Optional gift message for the packing slip
534
+ */
535
+ gift?: Gift;
536
+
537
+ /**
538
+ * Array of incomplete items in the order
539
+ */
540
+ incomplete_items?: Array<IncompleteItem>;
541
+
542
+ /**
543
+ * Custom packing slip for this order. Example of a packing slip with explained
544
+ * fields can be found [here](#packing-slip).
545
+ */
546
+ packing_slip?: Shared.PackingSlip;
547
+
548
+ /**
549
+ * Difference between order price and retail costs. Will be shown only if order is
550
+ * completed.
551
+ */
552
+ pricing_breakdown?: Array<PricingBreakdown>;
553
+
554
+ /**
555
+ * Retail costs that are to be displayed on the packing slip for international
556
+ * shipments. Retail costs are used only if every item in order contains the
557
+ * `retail_price` attribute.
558
+ */
559
+ retail_costs?: RetailCosts;
560
+
561
+ /**
562
+ * Array of shipments already shipped for this order
563
+ */
564
+ shipments?: Array<Shipment>;
565
+
566
+ /**
567
+ * Shipping method. Defaults to 'STANDARD'
568
+ */
569
+ shipping?: string;
570
+
571
+ /**
572
+ * Human readable shipping method name.
573
+ */
574
+ shipping_service_name?: string;
575
+
576
+ /**
577
+ * Order status:<br /> **draft** - order is not submitted for fulfillment<br />
578
+ * **failed** - order was submitted for fulfillment but was not accepted because of
579
+ * an error (problem with address, printfiles, charging, etc.)<br /> **inreview** -
580
+ * order is being reviewed<br /> **pending** - order has been submitted for
581
+ * fulfillment<br /> **canceled** - order is canceled<br /> **onhold** - order has
582
+ * encountered a problem during the fulfillment that needs to be resolved together
583
+ * with the Printful customer service **inprocess** - order is being fulfilled and
584
+ * is no longer cancellable<br /> **partial** - order is partially fulfilled (some
585
+ * items are shipped already, the rest will follow)<br /> **fulfilled** - all items
586
+ * are shipped<br />
587
+ */
588
+ status?: string;
589
+
590
+ /**
591
+ * Store ID
592
+ */
593
+ store?: number;
594
+
595
+ /**
596
+ * Time when the order was updated
597
+ */
598
+ updated?: number;
599
+ }
600
+
601
+ /**
602
+ * Information about item in an order shipment
603
+ */
604
+ export interface OrderShipmentItem {
605
+ /**
606
+ * Line item ID
607
+ */
608
+ item_id?: number;
609
+
610
+ /**
611
+ * A boolean indicating that the pickup stage of this item's fulfillment has been
612
+ * completed
613
+ */
614
+ picked?: 0 | 1;
615
+
616
+ /**
617
+ * A boolean indicting that the item has been printed, sublimated or sewed.
618
+ */
619
+ printed?: 0 | 1;
620
+
621
+ /**
622
+ * Quantity of items in this shipment
623
+ */
624
+ quantity?: number;
625
+ }
626
+
627
+ /**
628
+ * Difference between order price and retail costs. Will be shown only if order is
629
+ * completed.
630
+ */
631
+ export interface PricingBreakdown {
632
+ /**
633
+ * Shipment tracking number
634
+ */
635
+ currency_symbol?: string;
636
+
637
+ /**
638
+ * Amount customer paid
639
+ */
640
+ customer_pays?: string;
641
+
642
+ /**
643
+ * Printful price
644
+ */
645
+ printful_price?: string;
646
+
647
+ /**
648
+ * Profit
649
+ */
650
+ profit?: string;
651
+ }
652
+
653
+ /**
654
+ * Retail costs that are to be displayed on the packing slip for international
655
+ * shipments. Retail costs are used only if every item in order contains the
656
+ * `retail_price` attribute.
657
+ */
658
+ export interface RetailCosts {
659
+ /**
660
+ * 3 letter currency code
661
+ */
662
+ currency?: string;
663
+
664
+ /**
665
+ * Discount sum
666
+ */
667
+ discount?: string | null;
668
+
669
+ /**
670
+ * Shipping costs
671
+ */
672
+ shipping?: string | null;
673
+
674
+ /**
675
+ * Total cost of all items
676
+ */
677
+ subtotal?: string | null;
678
+
679
+ /**
680
+ * Sum of taxes (not included in the item price)
681
+ */
682
+ tax?: string | null;
683
+
684
+ /**
685
+ * Grand Total (subtotal-discount+tax+vat+shipping)
686
+ */
687
+ total?: string | null;
688
+
689
+ /**
690
+ * Sum of VAT (not included in the item price)
691
+ */
692
+ vat?: string | null;
693
+ }
694
+
695
+ /**
696
+ * Information about order shipment
697
+ */
698
+ export interface Shipment {
699
+ /**
700
+ * Shipment ID
701
+ */
702
+ id?: number;
703
+
704
+ /**
705
+ * Carrier name
706
+ */
707
+ carrier?: string;
708
+
709
+ /**
710
+ * Shipping time
711
+ */
712
+ created?: number;
713
+
714
+ /**
715
+ * Array of items in this shipment
716
+ */
717
+ items?: Array<OrderShipmentItem>;
718
+
719
+ /**
720
+ * Whether this is a reshipment
721
+ */
722
+ reshipment?: boolean;
723
+
724
+ /**
725
+ * Delivery service name
726
+ */
727
+ service?: string;
728
+
729
+ /**
730
+ * Ship date
731
+ */
732
+ ship_date?: string;
733
+
734
+ /**
735
+ * Ship time in unix timestamp
736
+ */
737
+ shipped_at?: string;
738
+
739
+ /**
740
+ * Shipment tracking number
741
+ */
742
+ tracking_number?: string;
743
+
744
+ /**
745
+ * Shipment tracking URL
746
+ */
747
+ tracking_url?: string;
748
+ }
749
+
750
+ export interface OrderCreateResponse {
751
+ /**
752
+ * Response status code `200`
753
+ */
754
+ code?: number;
755
+
756
+ /**
757
+ * Information about the Order
758
+ */
759
+ result?: Order;
760
+ }
761
+
762
+ export interface OrderRetrieveResponse {
763
+ /**
764
+ * Response status code `200`
765
+ */
766
+ code?: number;
767
+
768
+ /**
769
+ * Information about the Order
770
+ */
771
+ result?: Order;
772
+ }
773
+
774
+ export interface OrderUpdateResponse {
775
+ /**
776
+ * Response status code `200`
777
+ */
778
+ code?: number;
779
+
780
+ /**
781
+ * Information about the Order
782
+ */
783
+ result?: Order;
784
+ }
785
+
786
+ export interface OrderListResponse {
787
+ /**
788
+ * Response status code `200`
789
+ */
790
+ code?: number;
791
+
792
+ /**
793
+ * Paging information
794
+ */
795
+ paging?: Shared.Paging;
796
+
797
+ result?: Array<Order>;
798
+ }
799
+
800
+ export interface OrderCancelResponse {
801
+ /**
802
+ * Response status code `200`
803
+ */
804
+ code?: number;
805
+
806
+ /**
807
+ * Information about the Order
808
+ */
809
+ result?: Order;
810
+ }
811
+
812
+ export interface OrderConfirmResponse {
813
+ /**
814
+ * Response status code `200`
815
+ */
816
+ code?: number;
817
+
818
+ /**
819
+ * Information about the Order
820
+ */
821
+ result?: Order;
822
+ }
823
+
824
+ export interface OrderEstimateCostsResponse {
825
+ /**
826
+ * Response status code `200`
827
+ */
828
+ code?: number;
829
+
830
+ result?: OrderEstimateCostsResponse.Result;
831
+ }
832
+
833
+ export namespace OrderEstimateCostsResponse {
834
+ export interface Result {
835
+ /**
836
+ * Order costs (Printful prices)
837
+ */
838
+ costs?: Result.Costs;
839
+
840
+ /**
841
+ * Retail costs that are to be displayed on the packing slip for international
842
+ * shipments. Retail costs are used only if every item in order contains the
843
+ * `retail_price` attribute.
844
+ */
845
+ retail_costs?: Result.RetailCosts;
846
+ }
847
+
848
+ export namespace Result {
849
+ /**
850
+ * Order costs (Printful prices)
851
+ */
852
+ export interface Costs {
853
+ /**
854
+ * Additional fee for custom product
855
+ */
856
+ additional_fee?: number;
857
+
858
+ /**
859
+ * 3 letter currency code
860
+ */
861
+ currency?: string;
862
+
863
+ /**
864
+ * Digitization costs
865
+ */
866
+ digitization?: string;
867
+
868
+ /**
869
+ * Discount sum
870
+ */
871
+ discount?: number;
872
+
873
+ /**
874
+ * Custom product fulfillment fee
875
+ */
876
+ fulfillment_fee?: number;
877
+
878
+ /**
879
+ * Shipping costs
880
+ */
881
+ shipping?: number;
882
+
883
+ /**
884
+ * Total cost of all items
885
+ */
886
+ subtotal?: number;
887
+
888
+ /**
889
+ * Sum of taxes (not included in the item price)
890
+ */
891
+ tax?: number;
892
+
893
+ /**
894
+ * Grand Total (subtotal-discount+tax+vat+shipping)
895
+ */
896
+ total?: number;
897
+
898
+ /**
899
+ * Sum of vat (not included in the item price)
900
+ */
901
+ vat?: number;
902
+ }
903
+
904
+ /**
905
+ * Retail costs that are to be displayed on the packing slip for international
906
+ * shipments. Retail costs are used only if every item in order contains the
907
+ * `retail_price` attribute.
908
+ */
909
+ export interface RetailCosts {
910
+ /**
911
+ * 3 letter currency code
912
+ */
913
+ currency?: string;
914
+
915
+ /**
916
+ * Discount sum
917
+ */
918
+ discount?: number | null;
919
+
920
+ /**
921
+ * Shipping costs
922
+ */
923
+ shipping?: number | null;
924
+
925
+ /**
926
+ * Total cost of all items
927
+ */
928
+ subtotal?: number | null;
929
+
930
+ /**
931
+ * Sum of taxes (not included in the item price)
932
+ */
933
+ tax?: number | null;
934
+
935
+ /**
936
+ * Grand Total (subtotal-discount+tax+vat+shipping)
937
+ */
938
+ total?: number | null;
939
+
940
+ /**
941
+ * Sum of VAT (not included in the item price)
942
+ */
943
+ vat?: number | null;
944
+ }
945
+ }
946
+ }
947
+
948
+ export interface OrderCreateParams {
949
+ /**
950
+ * Body param: Array of items in the order
951
+ */
952
+ items: Array<Item>;
953
+
954
+ /**
955
+ * Body param: Information about the address
956
+ */
957
+ recipient: Address;
958
+
959
+ /**
960
+ * Query param: Automatically submit the newly created order for fulfillment (skip
961
+ * the Draft phase)
962
+ */
963
+ confirm?: boolean;
964
+
965
+ /**
966
+ * Query param: Try to update existing order if an order with the specified
967
+ * external_id already exists
968
+ */
969
+ update_existing?: boolean;
970
+
971
+ /**
972
+ * Body param: Order costs (Printful prices)
973
+ */
974
+ costs?: Costs;
975
+
976
+ /**
977
+ * Body param: Order ID from the external system
978
+ */
979
+ external_id?: string | null;
980
+
981
+ /**
982
+ * Body param: Optional gift message for the packing slip
983
+ */
984
+ gift?: Gift;
985
+
986
+ /**
987
+ * Body param: Custom packing slip for this order. Example of a packing slip with
988
+ * explained fields can be found [here](#packing-slip).
989
+ */
990
+ packing_slip?: Shared.PackingSlip;
991
+
992
+ /**
993
+ * Body param: Retail costs that are to be displayed on the packing slip for
994
+ * international shipments. Retail costs are used only if every item in order
995
+ * contains the `retail_price` attribute.
996
+ */
997
+ retail_costs?: RetailCosts;
998
+
999
+ /**
1000
+ * Body param: Shipping method. Defaults to 'STANDARD'
1001
+ */
1002
+ shipping?: string;
1003
+
1004
+ /**
1005
+ * Header param: Use this to specify which store you want to use (required only for
1006
+ * account level token).
1007
+ *
1008
+ * The store IDs can be retrieved with the
1009
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1010
+ * endpoint.
1011
+ */
1012
+ 'X-PF-Store-Id'?: string;
1013
+ }
1014
+
1015
+ export interface OrderRetrieveParams {
1016
+ /**
1017
+ * Use this to specify which store you want to use (required only for account level
1018
+ * token).
1019
+ *
1020
+ * The store IDs can be retrieved with the
1021
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1022
+ * endpoint.
1023
+ */
1024
+ 'X-PF-Store-Id'?: string;
1025
+ }
1026
+
1027
+ export interface OrderUpdateParams {
1028
+ /**
1029
+ * Body param: Array of items in the order
1030
+ */
1031
+ items: Array<Item>;
1032
+
1033
+ /**
1034
+ * Body param: Information about the address
1035
+ */
1036
+ recipient: Address;
1037
+
1038
+ /**
1039
+ * Query param: Automatically submit the newly created order for fulfillment (skip
1040
+ * the Draft phase)
1041
+ */
1042
+ confirm?: boolean;
1043
+
1044
+ /**
1045
+ * Body param: Order costs (Printful prices)
1046
+ */
1047
+ costs?: Costs;
1048
+
1049
+ /**
1050
+ * Body param: Order ID from the external system
1051
+ */
1052
+ external_id?: string | null;
1053
+
1054
+ /**
1055
+ * Body param: Optional gift message for the packing slip
1056
+ */
1057
+ gift?: Gift;
1058
+
1059
+ /**
1060
+ * Body param: Custom packing slip for this order. Example of a packing slip with
1061
+ * explained fields can be found [here](#packing-slip).
1062
+ */
1063
+ packing_slip?: Shared.PackingSlip;
1064
+
1065
+ /**
1066
+ * Body param: Retail costs that are to be displayed on the packing slip for
1067
+ * international shipments. Retail costs are used only if every item in order
1068
+ * contains the `retail_price` attribute.
1069
+ */
1070
+ retail_costs?: RetailCosts;
1071
+
1072
+ /**
1073
+ * Body param: Shipping method. Defaults to 'STANDARD'
1074
+ */
1075
+ shipping?: string;
1076
+
1077
+ /**
1078
+ * Header param: Use this to specify which store you want to use (required only for
1079
+ * account level token).
1080
+ *
1081
+ * The store IDs can be retrieved with the
1082
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1083
+ * endpoint.
1084
+ */
1085
+ 'X-PF-Store-Id'?: string;
1086
+ }
1087
+
1088
+ export interface OrderListParams {
1089
+ /**
1090
+ * Number of items per page (max 100)
1091
+ */
1092
+ limit?: number;
1093
+
1094
+ /**
1095
+ * Result set offset
1096
+ */
1097
+ offset?: number;
1098
+
1099
+ /**
1100
+ * Filter by order status
1101
+ */
1102
+ status?: string;
1103
+ }
1104
+
1105
+ export interface OrderCancelParams {
1106
+ /**
1107
+ * Use this to specify which store you want to use (required only for account level
1108
+ * token).
1109
+ *
1110
+ * The store IDs can be retrieved with the
1111
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1112
+ * endpoint.
1113
+ */
1114
+ 'X-PF-Store-Id'?: string;
1115
+ }
1116
+
1117
+ export interface OrderConfirmParams {
1118
+ /**
1119
+ * Use this to specify which store you want to use (required only for account level
1120
+ * token).
1121
+ *
1122
+ * The store IDs can be retrieved with the
1123
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1124
+ * endpoint.
1125
+ */
1126
+ 'X-PF-Store-Id'?: string;
1127
+ }
1128
+
1129
+ export interface OrderEstimateCostsParams {
1130
+ /**
1131
+ * Body param: Array of items in the order
1132
+ */
1133
+ items: Array<Item>;
1134
+
1135
+ /**
1136
+ * Body param: Information about the address
1137
+ */
1138
+ recipient: Address;
1139
+
1140
+ /**
1141
+ * Body param: Order costs (Printful prices)
1142
+ */
1143
+ costs?: Costs;
1144
+
1145
+ /**
1146
+ * Body param: Order ID from the external system
1147
+ */
1148
+ external_id?: string | null;
1149
+
1150
+ /**
1151
+ * Body param: Optional gift message for the packing slip
1152
+ */
1153
+ gift?: Gift;
1154
+
1155
+ /**
1156
+ * Body param: Custom packing slip for this order. Example of a packing slip with
1157
+ * explained fields can be found [here](#packing-slip).
1158
+ */
1159
+ packing_slip?: Shared.PackingSlip;
1160
+
1161
+ /**
1162
+ * Body param: Retail costs that are to be displayed on the packing slip for
1163
+ * international shipments. Retail costs are used only if every item in order
1164
+ * contains the `retail_price` attribute.
1165
+ */
1166
+ retail_costs?: RetailCosts;
1167
+
1168
+ /**
1169
+ * Body param: Shipping method. Defaults to 'STANDARD'
1170
+ */
1171
+ shipping?: string;
1172
+
1173
+ /**
1174
+ * Header param: Use this to specify which store you want to use (required only for
1175
+ * account level token).
1176
+ *
1177
+ * The store IDs can be retrieved with the
1178
+ * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
1179
+ * endpoint.
1180
+ */
1181
+ 'X-PF-Store-Id'?: string;
1182
+ }
1183
+
1184
+ export declare namespace Orders {
1185
+ export {
1186
+ type Address as Address,
1187
+ type Costs as Costs,
1188
+ type Gift as Gift,
1189
+ type IncompleteItem as IncompleteItem,
1190
+ type Item as Item,
1191
+ type Option as Option,
1192
+ type Order as Order,
1193
+ type OrderShipmentItem as OrderShipmentItem,
1194
+ type PricingBreakdown as PricingBreakdown,
1195
+ type RetailCosts as RetailCosts,
1196
+ type Shipment as Shipment,
1197
+ type OrderCreateResponse as OrderCreateResponse,
1198
+ type OrderRetrieveResponse as OrderRetrieveResponse,
1199
+ type OrderUpdateResponse as OrderUpdateResponse,
1200
+ type OrderListResponse as OrderListResponse,
1201
+ type OrderCancelResponse as OrderCancelResponse,
1202
+ type OrderConfirmResponse as OrderConfirmResponse,
1203
+ type OrderEstimateCostsResponse as OrderEstimateCostsResponse,
1204
+ type OrderCreateParams as OrderCreateParams,
1205
+ type OrderRetrieveParams as OrderRetrieveParams,
1206
+ type OrderUpdateParams as OrderUpdateParams,
1207
+ type OrderListParams as OrderListParams,
1208
+ type OrderCancelParams as OrderCancelParams,
1209
+ type OrderConfirmParams as OrderConfirmParams,
1210
+ type OrderEstimateCostsParams as OrderEstimateCostsParams,
1211
+ };
1212
+ }