@medusajs/types 1.12.0-snapshot-20240607093839 → 1.12.0-snapshot-20240701122250

Sign up to get free protection for your applications and to get access to all the features.
Files changed (458) hide show
  1. package/dist/api-key/service.d.ts +24 -24
  2. package/dist/api-key/service.d.ts.map +1 -1
  3. package/dist/auth/service.d.ts +18 -18
  4. package/dist/auth/service.d.ts.map +1 -1
  5. package/dist/bundles.d.ts +2 -1
  6. package/dist/bundles.d.ts.map +1 -1
  7. package/dist/bundles.js +3 -2
  8. package/dist/bundles.js.map +1 -1
  9. package/dist/cart/mutations.d.ts +8 -0
  10. package/dist/cart/mutations.d.ts.map +1 -1
  11. package/dist/cart/mutations.js.map +1 -1
  12. package/dist/cart/service.d.ts +30 -52
  13. package/dist/cart/service.d.ts.map +1 -1
  14. package/dist/common/common.d.ts +6 -1
  15. package/dist/common/common.d.ts.map +1 -1
  16. package/dist/currency/service.d.ts +9 -9
  17. package/dist/currency/service.d.ts.map +1 -1
  18. package/dist/customer/mutations.d.ts +27 -26
  19. package/dist/customer/mutations.d.ts.map +1 -1
  20. package/dist/customer/service.d.ts +40 -43
  21. package/dist/customer/service.d.ts.map +1 -1
  22. package/dist/dal/repository-service.d.ts +2 -2
  23. package/dist/dal/repository-service.d.ts.map +1 -1
  24. package/dist/dml/index.d.ts +161 -0
  25. package/dist/dml/index.d.ts.map +1 -0
  26. package/dist/dml/index.js +5 -0
  27. package/dist/dml/index.js.map +1 -0
  28. package/dist/event-bus/common.d.ts +12 -20
  29. package/dist/event-bus/common.d.ts.map +1 -1
  30. package/dist/event-bus/event-bus-module.d.ts +4 -4
  31. package/dist/event-bus/event-bus-module.d.ts.map +1 -1
  32. package/dist/event-bus/event-bus.d.ts +2 -4
  33. package/dist/event-bus/event-bus.d.ts.map +1 -1
  34. package/dist/file/service.d.ts +12 -12
  35. package/dist/file/service.d.ts.map +1 -1
  36. package/dist/fulfillment/mutations/service-zone.d.ts +1 -1
  37. package/dist/fulfillment/mutations/service-zone.d.ts.map +1 -1
  38. package/dist/fulfillment/service.d.ts +27 -27
  39. package/dist/fulfillment/service.d.ts.map +1 -1
  40. package/dist/http/currency/admin/entities.d.ts +14 -0
  41. package/dist/http/currency/admin/entities.d.ts.map +1 -0
  42. package/dist/http/currency/admin/entities.js +3 -0
  43. package/dist/http/currency/admin/entities.js.map +1 -0
  44. package/dist/http/currency/admin/index.d.ts +2 -0
  45. package/dist/http/currency/admin/index.d.ts.map +1 -0
  46. package/dist/{inventory/bundle.js → http/currency/admin/index.js} +2 -3
  47. package/dist/http/currency/admin/index.js.map +1 -0
  48. package/dist/http/currency/index.d.ts +2 -0
  49. package/dist/http/currency/index.d.ts.map +1 -0
  50. package/dist/{region__legacy → http/currency}/index.js +1 -1
  51. package/dist/http/currency/index.js.map +1 -0
  52. package/dist/http/fulfillment-provider/admin/entities.d.ts +1 -5
  53. package/dist/http/fulfillment-provider/admin/entities.d.ts.map +1 -1
  54. package/dist/http/fulfillment-set/admin/entities.d.ts +3 -1
  55. package/dist/http/fulfillment-set/admin/entities.d.ts.map +1 -1
  56. package/dist/http/index.d.ts +5 -0
  57. package/dist/http/index.d.ts.map +1 -1
  58. package/dist/http/index.js +5 -0
  59. package/dist/http/index.js.map +1 -1
  60. package/dist/http/inventory/{inventory.d.ts → admin/entities.d.ts} +2 -10
  61. package/dist/http/inventory/admin/entities.d.ts.map +1 -0
  62. package/dist/http/inventory/admin/entities.js +3 -0
  63. package/dist/http/inventory/admin/entities.js.map +1 -0
  64. package/dist/http/inventory/admin/index.d.ts +5 -0
  65. package/dist/http/inventory/admin/index.d.ts.map +1 -0
  66. package/dist/http/inventory/admin/index.js +21 -0
  67. package/dist/http/inventory/admin/index.js.map +1 -0
  68. package/dist/http/inventory/admin/payloads.d.ts +19 -0
  69. package/dist/http/inventory/admin/payloads.d.ts.map +1 -0
  70. package/dist/http/inventory/admin/payloads.js +3 -0
  71. package/dist/http/inventory/admin/payloads.js.map +1 -0
  72. package/dist/http/inventory/admin/queries.d.ts +18 -0
  73. package/dist/http/inventory/admin/queries.d.ts.map +1 -0
  74. package/dist/http/{product/store.js → inventory/admin/queries.js} +1 -1
  75. package/dist/http/inventory/admin/queries.js.map +1 -0
  76. package/dist/http/inventory/admin/responses.d.ts +10 -0
  77. package/dist/http/inventory/admin/responses.d.ts.map +1 -0
  78. package/dist/http/inventory/admin/responses.js +3 -0
  79. package/dist/http/inventory/admin/responses.js.map +1 -0
  80. package/dist/http/inventory/index.d.ts +1 -2
  81. package/dist/http/inventory/index.d.ts.map +1 -1
  82. package/dist/http/inventory/index.js +1 -2
  83. package/dist/http/inventory/index.js.map +1 -1
  84. package/dist/http/inventory-level/admin/entities.d.ts +11 -0
  85. package/dist/http/inventory-level/admin/entities.d.ts.map +1 -0
  86. package/dist/http/inventory-level/admin/entities.js +3 -0
  87. package/dist/http/inventory-level/admin/entities.js.map +1 -0
  88. package/dist/http/inventory-level/admin/index.d.ts +5 -0
  89. package/dist/http/inventory-level/admin/index.d.ts.map +1 -0
  90. package/dist/http/inventory-level/admin/index.js +21 -0
  91. package/dist/http/inventory-level/admin/index.js.map +1 -0
  92. package/dist/http/inventory-level/admin/payloads.d.ts +15 -0
  93. package/dist/http/inventory-level/admin/payloads.d.ts.map +1 -0
  94. package/dist/http/inventory-level/admin/payloads.js +3 -0
  95. package/dist/http/inventory-level/admin/payloads.js.map +1 -0
  96. package/dist/http/inventory-level/admin/queries.d.ts +5 -0
  97. package/dist/http/inventory-level/admin/queries.d.ts.map +1 -0
  98. package/dist/http/{product/admin.js → inventory-level/admin/queries.js} +1 -1
  99. package/dist/http/inventory-level/admin/queries.js.map +1 -0
  100. package/dist/http/inventory-level/admin/responses.d.ts +9 -0
  101. package/dist/http/inventory-level/admin/responses.d.ts.map +1 -0
  102. package/dist/http/{inventory/inventory.js → inventory-level/admin/responses.js} +1 -1
  103. package/dist/http/inventory-level/admin/responses.js.map +1 -0
  104. package/dist/http/inventory-level/index.d.ts +2 -0
  105. package/dist/http/inventory-level/index.d.ts.map +1 -0
  106. package/dist/http/inventory-level/index.js +18 -0
  107. package/dist/http/inventory-level/index.js.map +1 -0
  108. package/dist/http/order/common.d.ts +2 -0
  109. package/dist/http/order/common.d.ts.map +1 -1
  110. package/dist/http/price-list/admin/entities.d.ts +21 -0
  111. package/dist/http/price-list/admin/entities.d.ts.map +1 -0
  112. package/dist/http/price-list/admin/entities.js +3 -0
  113. package/dist/http/price-list/admin/entities.js.map +1 -0
  114. package/dist/http/price-list/admin/index.d.ts +5 -0
  115. package/dist/http/price-list/admin/index.d.ts.map +1 -0
  116. package/dist/http/price-list/admin/index.js +21 -0
  117. package/dist/http/price-list/admin/index.js.map +1 -0
  118. package/dist/http/price-list/admin/payloads.d.ts +46 -0
  119. package/dist/http/price-list/admin/payloads.d.ts.map +1 -0
  120. package/dist/http/price-list/admin/payloads.js +3 -0
  121. package/dist/http/price-list/admin/payloads.js.map +1 -0
  122. package/dist/http/price-list/admin/queries.d.ts +14 -0
  123. package/dist/http/price-list/admin/queries.d.ts.map +1 -0
  124. package/dist/http/{product-category/store.js → price-list/admin/queries.js} +1 -1
  125. package/dist/http/price-list/admin/queries.js.map +1 -0
  126. package/dist/http/price-list/admin/responses.d.ts +12 -0
  127. package/dist/http/price-list/admin/responses.d.ts.map +1 -0
  128. package/dist/http/price-list/admin/responses.js +3 -0
  129. package/dist/http/price-list/admin/responses.js.map +1 -0
  130. package/dist/http/price-list/index.d.ts +2 -0
  131. package/dist/http/price-list/index.d.ts.map +1 -0
  132. package/dist/http/price-list/index.js +18 -0
  133. package/dist/http/price-list/index.js.map +1 -0
  134. package/dist/http/pricing/admin/{entitites.d.ts → entities.d.ts} +1 -1
  135. package/dist/http/pricing/admin/entities.d.ts.map +1 -0
  136. package/dist/http/pricing/admin/entities.js +3 -0
  137. package/dist/http/pricing/admin/entities.js.map +1 -0
  138. package/dist/http/pricing/admin/index.d.ts +1 -1
  139. package/dist/http/pricing/admin/index.d.ts.map +1 -1
  140. package/dist/http/pricing/admin/index.js +1 -1
  141. package/dist/http/pricing/admin/index.js.map +1 -1
  142. package/dist/http/product/admin/entitites.d.ts +26 -0
  143. package/dist/http/product/admin/entitites.d.ts.map +1 -0
  144. package/dist/http/product/admin/entitites.js.map +1 -0
  145. package/dist/http/product/admin/index.d.ts +5 -0
  146. package/dist/http/product/admin/index.d.ts.map +1 -0
  147. package/dist/http/product/admin/index.js +21 -0
  148. package/dist/http/product/admin/index.js.map +1 -0
  149. package/dist/http/product/admin/payloads.d.ts +152 -0
  150. package/dist/http/product/admin/payloads.d.ts.map +1 -0
  151. package/dist/http/product/admin/payloads.js +3 -0
  152. package/dist/http/product/admin/payloads.js.map +1 -0
  153. package/dist/http/product/admin/queries.d.ts +12 -0
  154. package/dist/http/product/admin/queries.d.ts.map +1 -0
  155. package/dist/http/product/admin/queries.js +3 -0
  156. package/dist/http/product/admin/queries.js.map +1 -0
  157. package/dist/http/product/admin/responses.d.ts +35 -0
  158. package/dist/http/product/admin/responses.d.ts.map +1 -0
  159. package/dist/http/product/admin/responses.js +3 -0
  160. package/dist/http/product/admin/responses.js.map +1 -0
  161. package/dist/http/product/common.d.ts +72 -106
  162. package/dist/http/product/common.d.ts.map +1 -1
  163. package/dist/http/product/store/entitites.d.ts +19 -0
  164. package/dist/http/product/store/entitites.d.ts.map +1 -0
  165. package/dist/http/product/store/entitites.js +3 -0
  166. package/dist/http/product/store/entitites.js.map +1 -0
  167. package/dist/http/product/store/index.d.ts +4 -0
  168. package/dist/http/product/store/index.d.ts.map +1 -0
  169. package/dist/http/product/store/index.js +20 -0
  170. package/dist/http/product/store/index.js.map +1 -0
  171. package/dist/http/product/store/queries.d.ts +13 -0
  172. package/dist/http/product/store/queries.d.ts.map +1 -0
  173. package/dist/http/product/store/queries.js +3 -0
  174. package/dist/http/product/store/queries.js.map +1 -0
  175. package/dist/http/product/store/responses.d.ts +9 -0
  176. package/dist/http/product/store/responses.d.ts.map +1 -0
  177. package/dist/http/product/store/responses.js +3 -0
  178. package/dist/http/product/store/responses.js.map +1 -0
  179. package/dist/http/product-category/admin/entities.d.ts +8 -0
  180. package/dist/http/product-category/admin/entities.d.ts.map +1 -0
  181. package/dist/http/product-category/admin/entities.js +3 -0
  182. package/dist/http/product-category/admin/entities.js.map +1 -0
  183. package/dist/http/product-category/admin/index.d.ts +5 -0
  184. package/dist/http/product-category/admin/index.d.ts.map +1 -0
  185. package/dist/http/product-category/admin/index.js +21 -0
  186. package/dist/http/product-category/admin/index.js.map +1 -0
  187. package/dist/http/product-category/admin/payloads.d.ts +25 -0
  188. package/dist/http/product-category/admin/payloads.d.ts.map +1 -0
  189. package/dist/http/product-category/admin/payloads.js +3 -0
  190. package/dist/http/product-category/admin/payloads.js.map +1 -0
  191. package/dist/http/product-category/admin/queries.d.ts +8 -0
  192. package/dist/http/product-category/admin/queries.d.ts.map +1 -0
  193. package/dist/http/product-category/{admin.js → admin/queries.js} +1 -1
  194. package/dist/http/product-category/admin/queries.js.map +1 -0
  195. package/dist/http/product-category/admin/responses.d.ts +12 -0
  196. package/dist/http/product-category/admin/responses.d.ts.map +1 -0
  197. package/dist/http/product-category/admin/responses.js +3 -0
  198. package/dist/http/product-category/admin/responses.js.map +1 -0
  199. package/dist/http/product-category/common.d.ts +31 -7
  200. package/dist/http/product-category/common.d.ts.map +1 -1
  201. package/dist/http/product-category/store/entities.d.ts +6 -0
  202. package/dist/http/product-category/store/entities.d.ts.map +1 -0
  203. package/dist/http/product-category/store/entities.js +3 -0
  204. package/dist/http/product-category/store/entities.js.map +1 -0
  205. package/dist/http/product-category/store/index.d.ts +4 -0
  206. package/dist/http/product-category/store/index.d.ts.map +1 -0
  207. package/dist/http/product-category/store/index.js +20 -0
  208. package/dist/http/product-category/store/index.js.map +1 -0
  209. package/dist/http/product-category/store/queries.d.ts +6 -0
  210. package/dist/http/product-category/store/queries.d.ts.map +1 -0
  211. package/dist/http/product-category/store/queries.js +3 -0
  212. package/dist/http/product-category/store/queries.js.map +1 -0
  213. package/dist/http/product-category/store/responses.d.ts +10 -0
  214. package/dist/http/product-category/store/responses.d.ts.map +1 -0
  215. package/dist/http/product-category/store/responses.js +3 -0
  216. package/dist/http/product-category/store/responses.js.map +1 -0
  217. package/dist/http/product-type/admin/entities.d.ts +4 -0
  218. package/dist/http/product-type/admin/entities.d.ts.map +1 -0
  219. package/dist/http/product-type/admin/entities.js +3 -0
  220. package/dist/http/product-type/admin/entities.js.map +1 -0
  221. package/dist/http/product-type/admin/index.d.ts +5 -0
  222. package/dist/http/product-type/admin/index.d.ts.map +1 -0
  223. package/dist/http/product-type/admin/index.js +21 -0
  224. package/dist/http/product-type/admin/index.js.map +1 -0
  225. package/dist/http/product-type/admin/payloads.d.ts +9 -0
  226. package/dist/http/product-type/admin/payloads.d.ts.map +1 -0
  227. package/dist/http/product-type/admin/payloads.js +3 -0
  228. package/dist/http/product-type/admin/payloads.js.map +1 -0
  229. package/dist/http/product-type/admin/queries.d.ts +13 -0
  230. package/dist/http/product-type/admin/queries.d.ts.map +1 -0
  231. package/dist/http/product-type/admin/queries.js +3 -0
  232. package/dist/http/product-type/admin/queries.js.map +1 -0
  233. package/dist/http/product-type/admin/responses.d.ts +12 -0
  234. package/dist/http/product-type/admin/responses.d.ts.map +1 -0
  235. package/dist/http/product-type/admin/responses.js +3 -0
  236. package/dist/http/product-type/admin/responses.js.map +1 -0
  237. package/dist/http/product-type/common.d.ts +9 -0
  238. package/dist/http/product-type/common.d.ts.map +1 -0
  239. package/dist/{inventory → http/product-type}/common.js.map +1 -1
  240. package/dist/http/product-type/index.d.ts +3 -0
  241. package/dist/http/product-type/index.d.ts.map +1 -0
  242. package/dist/http/product-type/index.js +19 -0
  243. package/dist/http/product-type/index.js.map +1 -0
  244. package/dist/http/product-type/store/entities.d.ts +4 -0
  245. package/dist/http/product-type/store/entities.d.ts.map +1 -0
  246. package/dist/http/product-type/store/entities.js +3 -0
  247. package/dist/http/product-type/store/entities.js.map +1 -0
  248. package/dist/http/product-type/store/index.d.ts +2 -0
  249. package/dist/http/product-type/store/index.d.ts.map +1 -0
  250. package/dist/http/product-type/store/index.js +18 -0
  251. package/dist/http/product-type/store/index.js.map +1 -0
  252. package/dist/http/promotion/admin/rule-attribute-options.d.ts +5 -0
  253. package/dist/http/promotion/admin/rule-attribute-options.d.ts.map +1 -1
  254. package/dist/http/sales-channel/admin/queries.d.ts +2 -4
  255. package/dist/http/sales-channel/admin/queries.d.ts.map +1 -1
  256. package/dist/http/shipping-option/admin/entities.d.ts +9 -1
  257. package/dist/http/shipping-option/admin/entities.d.ts.map +1 -1
  258. package/dist/http/shipping-option/admin/payloads.d.ts +8 -9
  259. package/dist/http/shipping-option/admin/payloads.d.ts.map +1 -1
  260. package/dist/http/stock-locations/admin/entities.d.ts +2 -1
  261. package/dist/http/stock-locations/admin/entities.d.ts.map +1 -1
  262. package/dist/http/store/admin/entities.d.ts +23 -0
  263. package/dist/http/store/admin/entities.d.ts.map +1 -0
  264. package/dist/http/store/admin/entities.js +3 -0
  265. package/dist/http/store/admin/entities.js.map +1 -0
  266. package/dist/http/store/admin/index.d.ts +5 -0
  267. package/dist/http/store/admin/index.d.ts.map +1 -0
  268. package/dist/http/store/admin/index.js +21 -0
  269. package/dist/http/store/admin/index.js.map +1 -0
  270. package/dist/http/store/admin/payloads.d.ts +14 -0
  271. package/dist/http/store/admin/payloads.d.ts.map +1 -0
  272. package/dist/http/store/admin/payloads.js +3 -0
  273. package/dist/http/store/admin/payloads.js.map +1 -0
  274. package/dist/http/store/admin/queries.d.ts +10 -0
  275. package/dist/http/store/admin/queries.d.ts.map +1 -0
  276. package/dist/http/store/admin/queries.js +3 -0
  277. package/dist/http/store/admin/queries.js.map +1 -0
  278. package/dist/http/store/admin/responses.d.ts +10 -0
  279. package/dist/http/store/admin/responses.d.ts.map +1 -0
  280. package/dist/http/store/admin/responses.js +3 -0
  281. package/dist/http/store/admin/responses.js.map +1 -0
  282. package/dist/http/store/index.d.ts +2 -0
  283. package/dist/http/store/index.d.ts.map +1 -0
  284. package/dist/http/store/index.js +18 -0
  285. package/dist/http/store/index.js.map +1 -0
  286. package/dist/index.d.ts +1 -1
  287. package/dist/index.d.ts.map +1 -1
  288. package/dist/index.js +1 -1
  289. package/dist/index.js.map +1 -1
  290. package/dist/inventory/common/reservation-item.d.ts +1 -1
  291. package/dist/inventory/index.d.ts +1 -2
  292. package/dist/inventory/index.d.ts.map +1 -1
  293. package/dist/inventory/index.js +1 -15
  294. package/dist/inventory/index.js.map +1 -1
  295. package/dist/inventory/mutations/reservation-item.d.ts +7 -7
  296. package/dist/inventory/mutations/reservation-item.d.ts.map +1 -1
  297. package/dist/inventory/service.d.ts +671 -640
  298. package/dist/inventory/service.d.ts.map +1 -1
  299. package/dist/joiner/index.d.ts +5 -2
  300. package/dist/joiner/index.d.ts.map +1 -1
  301. package/dist/modules-sdk/index.d.ts +12 -12
  302. package/dist/modules-sdk/index.d.ts.map +1 -1
  303. package/dist/modules-sdk/index.js +1 -1
  304. package/dist/modules-sdk/index.js.map +1 -1
  305. package/dist/modules-sdk/{internal-module-service.d.ts → medusa-internal-service.d.ts} +19 -18
  306. package/dist/modules-sdk/medusa-internal-service.d.ts.map +1 -0
  307. package/dist/{http/inventory/inventory-level.js → modules-sdk/medusa-internal-service.js} +1 -1
  308. package/dist/modules-sdk/medusa-internal-service.js.map +1 -0
  309. package/dist/notification/service.d.ts +15 -15
  310. package/dist/notification/service.d.ts.map +1 -1
  311. package/dist/order/common.d.ts +50 -1
  312. package/dist/order/common.d.ts.map +1 -1
  313. package/dist/order/mutations.d.ts +68 -17
  314. package/dist/order/mutations.d.ts.map +1 -1
  315. package/dist/order/service.d.ts +41 -30
  316. package/dist/order/service.d.ts.map +1 -1
  317. package/dist/pricing/common/index.d.ts +0 -2
  318. package/dist/pricing/common/index.d.ts.map +1 -1
  319. package/dist/pricing/common/index.js +0 -2
  320. package/dist/pricing/common/index.js.map +1 -1
  321. package/dist/pricing/common/money-amount.d.ts +2 -2
  322. package/dist/pricing/common/money-amount.d.ts.map +1 -1
  323. package/dist/pricing/common/price-list.d.ts +25 -125
  324. package/dist/pricing/common/price-list.d.ts.map +1 -1
  325. package/dist/pricing/common/price-rule.d.ts +8 -16
  326. package/dist/pricing/common/price-rule.d.ts.map +1 -1
  327. package/dist/pricing/common/price-set.d.ts +6 -55
  328. package/dist/pricing/common/price-set.d.ts.map +1 -1
  329. package/dist/pricing/service.d.ts +31 -290
  330. package/dist/pricing/service.d.ts.map +1 -1
  331. package/dist/pricing/workflows.d.ts +5 -5
  332. package/dist/pricing/workflows.d.ts.map +1 -1
  333. package/dist/product/common.d.ts +99 -79
  334. package/dist/product/common.d.ts.map +1 -1
  335. package/dist/product/service.d.ts +322 -203
  336. package/dist/product/service.d.ts.map +1 -1
  337. package/dist/promotion/common/application-method.d.ts +1 -1
  338. package/dist/promotion/common/application-method.d.ts.map +1 -1
  339. package/dist/promotion/mutations.d.ts +6 -6
  340. package/dist/promotion/mutations.d.ts.map +1 -1
  341. package/dist/promotion/service.d.ts +29 -29
  342. package/dist/promotion/service.d.ts.map +1 -1
  343. package/dist/region/common.d.ts.map +1 -1
  344. package/dist/region/mutations.d.ts +4 -3
  345. package/dist/region/mutations.d.ts.map +1 -1
  346. package/dist/region/service.d.ts +31 -31
  347. package/dist/region/service.d.ts.map +1 -1
  348. package/dist/sales-channel/mutations.d.ts +4 -3
  349. package/dist/sales-channel/mutations.d.ts.map +1 -1
  350. package/dist/sales-channel/service.d.ts +28 -28
  351. package/dist/sales-channel/service.d.ts.map +1 -1
  352. package/dist/shared-context.d.ts +2 -3
  353. package/dist/shared-context.d.ts.map +1 -1
  354. package/dist/stock-location/common.d.ts +12 -17
  355. package/dist/stock-location/common.d.ts.map +1 -1
  356. package/dist/stock-location/index.d.ts +0 -1
  357. package/dist/stock-location/index.d.ts.map +1 -1
  358. package/dist/stock-location/index.js +0 -1
  359. package/dist/stock-location/index.js.map +1 -1
  360. package/dist/stock-location/service.d.ts +193 -180
  361. package/dist/stock-location/service.d.ts.map +1 -1
  362. package/dist/store/common/store.d.ts +31 -5
  363. package/dist/store/common/store.d.ts.map +1 -1
  364. package/dist/store/mutations/store.d.ts +14 -40
  365. package/dist/store/mutations/store.d.ts.map +1 -1
  366. package/dist/store/service.d.ts +32 -37
  367. package/dist/store/service.d.ts.map +1 -1
  368. package/dist/tax/mutations.d.ts +7 -6
  369. package/dist/tax/mutations.d.ts.map +1 -1
  370. package/dist/tax/service.d.ts +35 -35
  371. package/dist/tax/service.d.ts.map +1 -1
  372. package/dist/user/service.d.ts +22 -22
  373. package/dist/user/service.d.ts.map +1 -1
  374. package/dist/workflow/fulfillment/service-zones.d.ts +1 -1
  375. package/dist/workflow/fulfillment/service-zones.d.ts.map +1 -1
  376. package/dist/workflow/order/create-fulfillment.d.ts +2 -2
  377. package/dist/workflow/order/create-fulfillment.d.ts.map +1 -1
  378. package/dist/workflow/order/create-return-order.d.ts +8 -7
  379. package/dist/workflow/order/create-return-order.d.ts.map +1 -1
  380. package/dist/workflow/order/create-shipment.d.ts +2 -1
  381. package/dist/workflow/order/create-shipment.d.ts.map +1 -1
  382. package/dist/workflow/order/index.d.ts +1 -0
  383. package/dist/workflow/order/index.d.ts.map +1 -1
  384. package/dist/workflow/order/index.js +1 -0
  385. package/dist/workflow/order/index.js.map +1 -1
  386. package/dist/workflow/order/receive-return.d.ts +17 -0
  387. package/dist/workflow/order/receive-return.d.ts.map +1 -0
  388. package/dist/workflow/order/receive-return.js +3 -0
  389. package/dist/workflow/order/receive-return.js.map +1 -0
  390. package/dist/workflow/price-list/create-price-list.d.ts +1 -2
  391. package/dist/workflow/price-list/create-price-list.d.ts.map +1 -1
  392. package/dist/workflow/product-category/index.d.ts +6 -6
  393. package/dist/workflow/product-category/index.d.ts.map +1 -1
  394. package/dist/workflow/reservation/create-reservations.d.ts +3 -3
  395. package/dist/workflow/reservation/create-reservations.d.ts.map +1 -1
  396. package/dist/workflow/reservation/update-reservations.d.ts +3 -3
  397. package/dist/workflow/reservation/update-reservations.d.ts.map +1 -1
  398. package/dist/workflows/products/mutations.d.ts +2 -2
  399. package/dist/workflows/products/mutations.d.ts.map +1 -1
  400. package/dist/workflows-sdk/service.d.ts +2 -2
  401. package/dist/workflows-sdk/service.d.ts.map +1 -1
  402. package/package.json +1 -2
  403. package/dist/http/inventory/inventory-level.d.ts +0 -20
  404. package/dist/http/inventory/inventory-level.d.ts.map +0 -1
  405. package/dist/http/inventory/inventory-level.js.map +0 -1
  406. package/dist/http/inventory/inventory.d.ts.map +0 -1
  407. package/dist/http/inventory/inventory.js.map +0 -1
  408. package/dist/http/pricing/admin/entitites.d.ts.map +0 -1
  409. package/dist/http/pricing/admin/entitites.js.map +0 -1
  410. package/dist/http/product/admin.d.ts +0 -99
  411. package/dist/http/product/admin.d.ts.map +0 -1
  412. package/dist/http/product/admin.js.map +0 -1
  413. package/dist/http/product/store.d.ts +0 -33
  414. package/dist/http/product/store.d.ts.map +0 -1
  415. package/dist/http/product/store.js.map +0 -1
  416. package/dist/http/product-category/admin.d.ts +0 -9
  417. package/dist/http/product-category/admin.d.ts.map +0 -1
  418. package/dist/http/product-category/admin.js.map +0 -1
  419. package/dist/http/product-category/store.d.ts +0 -9
  420. package/dist/http/product-category/store.d.ts.map +0 -1
  421. package/dist/http/product-category/store.js.map +0 -1
  422. package/dist/inventory/bundle.d.ts +0 -3
  423. package/dist/inventory/bundle.d.ts.map +0 -1
  424. package/dist/inventory/bundle.js.map +0 -1
  425. package/dist/inventory/common.d.ts +0 -495
  426. package/dist/inventory/common.d.ts.map +0 -1
  427. package/dist/inventory/service-next.d.ts +0 -937
  428. package/dist/inventory/service-next.d.ts.map +0 -1
  429. package/dist/inventory/service-next.js +0 -3
  430. package/dist/inventory/service-next.js.map +0 -1
  431. package/dist/modules-sdk/internal-module-service.d.ts.map +0 -1
  432. package/dist/modules-sdk/internal-module-service.js +0 -3
  433. package/dist/modules-sdk/internal-module-service.js.map +0 -1
  434. package/dist/modules-sdk/module-service.d.ts +0 -1
  435. package/dist/modules-sdk/module-service.d.ts.map +0 -1
  436. package/dist/modules-sdk/module-service.js +0 -1
  437. package/dist/modules-sdk/module-service.js.map +0 -1
  438. package/dist/pricing/common/price-set-rule-type.d.ts +0 -24
  439. package/dist/pricing/common/price-set-rule-type.d.ts.map +0 -1
  440. package/dist/pricing/common/price-set-rule-type.js +0 -3
  441. package/dist/pricing/common/price-set-rule-type.js.map +0 -1
  442. package/dist/pricing/common/rule-type.d.ts +0 -102
  443. package/dist/pricing/common/rule-type.d.ts.map +0 -1
  444. package/dist/pricing/common/rule-type.js +0 -3
  445. package/dist/pricing/common/rule-type.js.map +0 -1
  446. package/dist/region__legacy/common.d.ts +0 -44
  447. package/dist/region__legacy/common.d.ts.map +0 -1
  448. package/dist/region__legacy/common.js +0 -3
  449. package/dist/region__legacy/common.js.map +0 -1
  450. package/dist/region__legacy/index.d.ts +0 -2
  451. package/dist/region__legacy/index.d.ts.map +0 -1
  452. package/dist/region__legacy/index.js.map +0 -1
  453. package/dist/stock-location/service-next.d.ts +0 -279
  454. package/dist/stock-location/service-next.d.ts.map +0 -1
  455. package/dist/stock-location/service-next.js +0 -3
  456. package/dist/stock-location/service-next.js.map +0 -1
  457. /package/dist/http/{pricing → product}/admin/entitites.js +0 -0
  458. /package/dist/{inventory → http/product-type}/common.js +0 -0
@@ -1,937 +0,0 @@
1
- import { RestoreReturn, SoftDeleteReturn } from "../dal";
2
- import { InventoryNext } from ".";
3
- import { FindConfig } from "../common";
4
- import { IModuleService } from "../modules-sdk";
5
- import { Context } from "../shared-context";
6
- /**
7
- * The main service interface for the Inventory Module.
8
- */
9
- export interface IInventoryServiceNext extends IModuleService {
10
- /**
11
- * This method retrieves a paginated list of inventory items based on optional filters and configuration.
12
- *
13
- * @param {FilterableInventoryItemProps} selector - The filters to apply on the retrieved inventory items.
14
- * @param {FindConfig<InventoryItemDTO>} config - The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the
15
- * attributes or relations associated with a inventory item.
16
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
17
- * @returns {Promise<InventoryItemDTO[]>} The list of inventory items.
18
- *
19
- * @example
20
- * To retrieve a list of inventory items using their IDs:
21
- *
22
- * ```ts
23
- * const inventoryItems = await inventoryModuleService.list({
24
- * id: ["iitem_123", "iitem_321"],
25
- * })
26
- * ```
27
- *
28
- * To specify relations that should be retrieved within the inventory items:
29
- *
30
- * ```ts
31
- * const inventoryItems = await inventoryModuleService.list(
32
- * {
33
- * id: ["iitem_123", "iitem_321"],
34
- * },
35
- * {
36
- * relations: ["location_levels"],
37
- * }
38
- * )
39
- * ```
40
- *
41
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
42
- *
43
- * ```ts
44
- * const inventoryItems = await inventoryModuleService.list(
45
- * {
46
- * id: ["iitem_123", "iitem_321"],
47
- * },
48
- * {
49
- * relations: ["location_levels"],
50
- * take: 20,
51
- * skip: 2,
52
- * }
53
- * )
54
- * ```
55
- */
56
- list(selector: InventoryNext.FilterableInventoryItemProps, config?: FindConfig<InventoryNext.InventoryItemDTO>, context?: Context): Promise<InventoryNext.InventoryItemDTO[]>;
57
- /**
58
- * This method retrieves a paginated list of inventory items along with the total count of available inventory items satisfying the provided filters.
59
- *
60
- * @param {FilterableInventoryItemProps} selector - The filters to apply on the retrieved inventory items.
61
- * @param {FindConfig<InventoryItemDTO>} config - The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the
62
- * attributes or relations associated with a inventory item.
63
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
64
- * @returns {Promise<[InventoryItemDTO[], number]>} The list of inventory items along with their total count.
65
- *
66
- * @example
67
- * To retrieve a list of inventory items using their IDs:
68
- *
69
- * ```ts
70
- * const [inventoryItems, count] =
71
- * await inventoryModuleService.listAndCount({
72
- * id: ["iitem_123", "iitem_321"],
73
- * })
74
- * ```
75
- *
76
- * To specify relations that should be retrieved within the inventory items:
77
- *
78
- * ```ts
79
- * const [inventoryItems, count] =
80
- * await inventoryModuleService.listAndCount(
81
- * {
82
- * id: ["iitem_123", "iitem_321"],
83
- * },
84
- * {
85
- * relations: ["location_levels"],
86
- * }
87
- * )
88
- * ```
89
- *
90
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
91
- *
92
- * ```ts
93
- * const [inventoryItems, count] =
94
- * await inventoryModuleService.listAndCount(
95
- * {
96
- * id: ["iitem_123", "iitem_321"],
97
- * },
98
- * {
99
- * relations: ["location_levels"],
100
- * take: 20,
101
- * skip: 2,
102
- * }
103
- * )
104
- * ```
105
- */
106
- listAndCount(selector: InventoryNext.FilterableInventoryItemProps, config?: FindConfig<InventoryNext.InventoryItemDTO>, context?: Context): Promise<[InventoryNext.InventoryItemDTO[], number]>;
107
- /**
108
- * This method retrieves a paginated list of reservation items based on optional filters and configuration.
109
- *
110
- * @param {FilterableReservationItemProps} selector - The filters to apply on the retrieved reservation items.
111
- * @param {FindConfig<ReservationItemDTO>} config - The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the
112
- * attributes or relations associated with a reservation item.
113
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
114
- * @returns {Promise<ReservationItemDTO[]>} The list of reservation items.
115
- *
116
- * @example
117
- * To retrieve a list of reservation items using their IDs:
118
- *
119
- * ```ts
120
- * const reservationItems =
121
- * await inventoryModuleService.listReservationItems({
122
- * id: ["resitem_123", "resitem_321"],
123
- * })
124
- * ```
125
- *
126
- * To specify relations that should be retrieved within the reservation items:
127
- *
128
- * ```ts
129
- * const reservationItems =
130
- * await inventoryModuleService.listReservationItems(
131
- * {
132
- * id: ["resitem_123", "resitem_321"],
133
- * },
134
- * {
135
- * relations: ["inventory_item"],
136
- * }
137
- * )
138
- * ```
139
- *
140
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
141
- *
142
- * ```ts
143
- * const reservationItems =
144
- * await inventoryModuleService.listReservationItems(
145
- * {
146
- * id: ["resitem_123", "resitem_321"],
147
- * },
148
- * {
149
- * relations: ["inventory_item"],
150
- * take: 20,
151
- * skip: 2,
152
- * }
153
- * )
154
- * ```
155
- */
156
- listReservationItems(selector: InventoryNext.FilterableReservationItemProps, config?: FindConfig<InventoryNext.ReservationItemDTO>, context?: Context): Promise<InventoryNext.ReservationItemDTO[]>;
157
- /**
158
- * This method retrieves a paginated list of reservation items along with the total count of available reservation items satisfying the provided filters.
159
- *
160
- * @param {FilterableReservationItemProps} selector - The filters to apply on the retrieved reservation items.
161
- * @param {FindConfig<ReservationItemDTO>} config - The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the
162
- * attributes or relations associated with a reservation item.
163
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
164
- * @returns {Promise<[ReservationItemDTO[], number]>} The list of reservation items along with their total count.
165
- *
166
- * @example
167
- * To retrieve a list of reservation items using their IDs:
168
- *
169
- * ```ts
170
- * const [reservationItems, count] =
171
- * await inventoryModuleService.listAndCountReservationItems({
172
- * id: ["resitem_123", "resitem_321"],
173
- * })
174
- * ```
175
- *
176
- * To specify relations that should be retrieved within the reservation items:
177
- *
178
- * ```ts
179
- * const [reservationItems, count] =
180
- * await inventoryModuleService.listAndCountReservationItems(
181
- * {
182
- * id: ["resitem_123", "resitem_321"],
183
- * },
184
- * {
185
- * relations: ["inventory_item"],
186
- * }
187
- * )
188
- * ```
189
- *
190
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
191
- *
192
- * ```ts
193
- * const [reservationItems, count] =
194
- * await inventoryModuleService.listAndCountReservationItems(
195
- * {
196
- * id: ["resitem_123", "resitem_321"],
197
- * },
198
- * {
199
- * relations: ["inventory_item"],
200
- * take: 20,
201
- * skip: 2,
202
- * }
203
- * )
204
- * ```
205
- */
206
- listAndCountReservationItems(selector: InventoryNext.FilterableReservationItemProps, config?: FindConfig<InventoryNext.ReservationItemDTO>, context?: Context): Promise<[InventoryNext.ReservationItemDTO[], number]>;
207
- /**
208
- * This method retrieves a paginated list of inventory levels based on optional filters and configuration.
209
- *
210
- * @param {FilterableInventoryLevelProps} selector - The filters to apply on the retrieved inventory levels.
211
- * @param {FindConfig<InventoryLevelDTO>} config - The configurations determining how the inventory level is retrieved. Its properties, such as `select` or `relations`, accept the
212
- * attributes or relations associated with a inventory level.
213
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
214
- * @returns {Promise<InventoryLevelDTO[]>} The list of inventory levels.
215
- *
216
- * @example
217
- * To retrieve a list of inventory levels using the IDs of their associated inventory items:
218
- *
219
- * ```ts
220
- * const inventoryLevels =
221
- * await inventoryModuleService.listInventoryLevels({
222
- * inventory_item_id: ["iitem_123", "iitem_321"],
223
- * })
224
- * ```
225
- *
226
- * To specify relations that should be retrieved within the inventory levels:
227
- *
228
- * ```ts
229
- * const inventoryLevels =
230
- * await inventoryModuleService.listInventoryLevels(
231
- * {
232
- * inventory_item_id: ["iitem_123", "iitem_321"],
233
- * },
234
- * {
235
- * relations: ["inventory_item"],
236
- * }
237
- * )
238
- * ```
239
- *
240
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
241
- *
242
- * ```ts
243
- * const inventoryLevels =
244
- * await inventoryModuleService.listInventoryLevels(
245
- * {
246
- * inventory_item_id: ["iitem_123", "iitem_321"],
247
- * },
248
- * {
249
- * relations: ["inventory_item"],
250
- * take: 20,
251
- * skip: 2,
252
- * }
253
- * )
254
- * ```
255
- */
256
- listInventoryLevels(selector: InventoryNext.FilterableInventoryLevelProps, config?: FindConfig<InventoryNext.InventoryLevelDTO>, context?: Context): Promise<InventoryNext.InventoryLevelDTO[]>;
257
- /**
258
- * This method retrieves a paginated list of inventory levels along with the total count of available inventory levels satisfying the provided filters.
259
- *
260
- * @param {FilterableInventoryLevelProps} selector - The filters to apply on the retrieved inventory levels.
261
- * @param {FindConfig<InventoryLevelDTO>} config - The configurations determining how the inventory level is retrieved. Its properties, such as `select` or `relations`, accept the
262
- * attributes or relations associated with a inventory level.
263
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
264
- * @returns {Promise<[InventoryLevelDTO[], number]>} The list of inventory levels along with their total count.
265
- *
266
- * @example
267
- * To retrieve a list of inventory levels using the IDs of their associated inventory items:
268
- *
269
- * ```ts
270
- * const [inventoryLevels, count] =
271
- * await inventoryModuleService.listAndCountInventoryLevels(
272
- * {
273
- * inventory_item_id: ["iitem_123", "iitem_321"],
274
- * },
275
- * {
276
- * relations: ["inventory_item"],
277
- * take: 20,
278
- * skip: 2,
279
- * }
280
- * )
281
- * ```
282
- *
283
- * To specify relations that should be retrieved within the inventory levels:
284
- *
285
- * ```ts
286
- * const [inventoryLevels, count] =
287
- * await inventoryModuleService.listAndCountInventoryLevels(
288
- * {
289
- * inventory_item_id: ["iitem_123", "iitem_321"],
290
- * },
291
- * {
292
- * relations: ["inventory_item"],
293
- * }
294
- * )
295
- * ```
296
- *
297
- * By default, only the first `10` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
298
- *
299
- * ```ts
300
- * const [inventoryLevels, count] =
301
- * await inventoryModuleService.listAndCountInventoryLevels({
302
- * inventory_item_id: ["iitem_123", "iitem_321"],
303
- * })
304
- * ```
305
- */
306
- listAndCountInventoryLevels(selector: InventoryNext.FilterableInventoryLevelProps, config?: FindConfig<InventoryNext.InventoryLevelDTO>, context?: Context): Promise<[InventoryNext.InventoryLevelDTO[], number]>;
307
- /**
308
- * This method retrieves an inventory item by its ID.
309
- *
310
- * @param {string} inventoryItemId - The inventory item's ID.
311
- * @param {FindConfig<InventoryItemDTO>} config - The configurations determining how the inventory item is retrieved. Its properties, such as `select` or `relations`, accept the
312
- * attributes or relations associated with a inventory item.
313
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
314
- * @returns {Promise<InventoryItemDTO>} The retrieved inventory item.
315
- *
316
- * @example
317
- * A simple example that retrieves a inventory item by its ID:
318
- *
319
- * ```ts
320
- * const inventoryItem =
321
- * await inventoryModuleService.retrieve("iitem_123")
322
- * ```
323
- *
324
- * To specify relations that should be retrieved:
325
- *
326
- * ```ts
327
- * const inventoryItem = await inventoryModuleService.retrieve(
328
- * "iitem_123",
329
- * {
330
- * relations: ["location_levels"],
331
- * }
332
- * )
333
- * ```
334
- */
335
- retrieve(inventoryItemId: string, config?: FindConfig<InventoryNext.InventoryItemDTO>, context?: Context): Promise<InventoryNext.InventoryItemDTO>;
336
- /**
337
- * This method retrieves an inventory level based on its associated inventory item and location.
338
- *
339
- * @param {string} inventoryItemId - The inventory item's ID.
340
- * @param {string} locationId - The location's ID.
341
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
342
- * @returns {Promise<InventoryLevelDTO>} The retrieved inventory level.
343
- *
344
- * @example
345
- * const inventoryLevel =
346
- * await inventoryModuleService.retrieveInventoryLevelByItemAndLocation(
347
- * "iitem_123",
348
- * "loc_123"
349
- * )
350
- */
351
- retrieveInventoryLevelByItemAndLocation(inventoryItemId: string, locationId: string, context?: Context): Promise<InventoryNext.InventoryLevelDTO>;
352
- /**
353
- * This method retrieves an inventory level by its ID.
354
- *
355
- * @param {string} inventoryLevelId - The inventory level's ID.
356
- * @param {FindConfig<InventoryLevelDTO>} config - The configurations determining how the inventory level is retrieved. Its properties, such as `select` or `relations`, accept the
357
- * attributes or relations associated with a inventory level.
358
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
359
- * @returns {Promise<InventoryLevelDTO>} The retrieved inventory level.
360
- *
361
- * @example
362
- * A simple example that retrieves a inventory level by its ID:
363
- *
364
- * ```ts
365
- * const inventoryLevel =
366
- * await inventoryModuleService.retrieveInventoryLevel(
367
- * "iitem_123"
368
- * )
369
- * ```
370
- *
371
- * To specify relations that should be retrieved:
372
- *
373
- * ```ts
374
- * const inventoryLevel =
375
- * await inventoryModuleService.retrieveInventoryLevel(
376
- * "iitem_123",
377
- * {
378
- * relations: ["inventory_item"],
379
- * }
380
- * )
381
- * ```
382
- */
383
- retrieveInventoryLevel(inventoryLevelId: string, config?: FindConfig<InventoryNext.InventoryLevelDTO>, context?: Context): Promise<InventoryNext.InventoryLevelDTO>;
384
- /**
385
- * This method retrieves a reservation item by its ID.
386
- *
387
- * @param {string} reservationId - The reservation's ID.
388
- * @param {FindConfig<ReservationItemDTO>} config - The configurations determining how the reservation item is retrieved. Its properties, such as `select` or `relations`, accept the
389
- * attributes or relations associated with a reservation item.
390
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
391
- * @returns {Promise<ReservationItemDTO>} The retrieved reservation item.
392
- *
393
- * @example
394
- * A simple example that retrieves a reservation item by its ID:
395
- *
396
- * ```ts
397
- * const reservationItem =
398
- * await inventoryModuleService.retrieveReservationItem(
399
- * "resitem"
400
- * )
401
- * ```
402
- *
403
- * To specify relations that should be retrieved:
404
- *
405
- * ```ts
406
- * const reservationItem =
407
- * await inventoryModuleService.retrieveReservationItem(
408
- * "resitem",
409
- * {
410
- * relations: ["inventory_item"],
411
- * }
412
- * )
413
- * ```
414
- */
415
- retrieveReservationItem(reservationId: string, config?: FindConfig<InventoryNext.ReservationItemDTO>, context?: Context): Promise<InventoryNext.ReservationItemDTO>;
416
- /**
417
- * This method creates reservation items.
418
- *
419
- * @param {CreateReservationItemInput[]} input - The details of the reservation items to be created.
420
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
421
- * @returns {Promise<ReservationItemDTO[]>} The created reservation items.
422
- *
423
- * @example
424
- * const reservationItems =
425
- * await inventoryModuleService.createReservationItems([
426
- * {
427
- * inventory_item_id: "iitem_123",
428
- * location_id: "loc_123",
429
- * quantity: 10,
430
- * },
431
- * ])
432
- */
433
- createReservationItems(input: InventoryNext.CreateReservationItemInput[], context?: Context): Promise<InventoryNext.ReservationItemDTO[]>;
434
- /**
435
- * This method creates a reservation item.
436
- *
437
- * @param {CreateReservationItemInput} input - The details of the reservation item to be created.
438
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
439
- * @returns {Promise<ReservationItemDTO>} The created reservation item.
440
- *
441
- * @example
442
- * const reservationItem =
443
- * await inventoryModuleService.createReservationItems({
444
- * inventory_item_id: "iitem_123",
445
- * location_id: "loc_123",
446
- * quantity: 10,
447
- * })
448
- */
449
- createReservationItems(input: InventoryNext.CreateReservationItemInput, context?: Context): Promise<InventoryNext.ReservationItemDTO>;
450
- /**
451
- * This method creates inventory items.
452
- *
453
- * @param {CreateInventoryItemInput[]} input - The details of the inventory items to be created.
454
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
455
- * @returns {Promise<InventoryItemDTO[]>} The created inventory items.
456
- *
457
- * @example
458
- * const inventoryItems = await inventoryModuleService.create([
459
- * {
460
- * sku: "SHIRT",
461
- * },
462
- * ])
463
- */
464
- create(input: InventoryNext.CreateInventoryItemInput[], context?: Context): Promise<InventoryNext.InventoryItemDTO[]>;
465
- /**
466
- * This method creates an inventory item.
467
- *
468
- * @param {CreateInventoryItemInput} input - The details of the inventory item to be created.
469
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
470
- * @returns {Promise<InventoryItemDTO>} The created inventory item.
471
- *
472
- * @example
473
- * const inventoryItem = await inventoryModuleService.create({
474
- * sku: "SHIRT",
475
- * })
476
- */
477
- create(input: InventoryNext.CreateInventoryItemInput, context?: Context): Promise<InventoryNext.InventoryItemDTO>;
478
- /**
479
- * This method creates inventory levels.
480
- *
481
- * @param {CreateInventoryLevelInput[]} data - The details of the inventory levels to be created.
482
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
483
- * @returns {Promise<InventoryLevelDTO[]>} The created inventory levels.
484
- *
485
- * @example
486
- * const inventoryLevels =
487
- * await inventoryModuleService.createInventoryLevels([
488
- * {
489
- * inventory_item_id: "iitem_123",
490
- * location_id: "loc_123",
491
- * stocked_quantity: 10,
492
- * },
493
- * {
494
- * inventory_item_id: "iitem_321",
495
- * location_id: "loc_321",
496
- * stocked_quantity: 20,
497
- * reserved_quantity: 10,
498
- * },
499
- * ])
500
- */
501
- createInventoryLevels(data: InventoryNext.CreateInventoryLevelInput[], context?: Context): Promise<InventoryNext.InventoryLevelDTO[]>;
502
- /**
503
- * This method creates an inventory level.
504
- *
505
- * @param {CreateInventoryLevelInput} data - The details of the inventory level to be created.
506
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
507
- * @returns {Promise<InventoryLevelDTO>} The created inventory level.
508
- *
509
- * @example
510
- * const inventoryLevels =
511
- * await inventoryModuleService.createInventoryLevels({
512
- * inventory_item_id: "iitem_123",
513
- * location_id: "loc_123",
514
- * stocked_quantity: 10,
515
- * })
516
- */
517
- createInventoryLevels(data: InventoryNext.CreateInventoryLevelInput, context?: Context): Promise<InventoryNext.InventoryLevelDTO>;
518
- /**
519
- * This method updates existing inventory levels.
520
- *
521
- * @param {BulkUpdateInventoryLevelInput[]} updates - The list of The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
522
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
523
- * @returns {Promise<InventoryLevelDTO[]>} The updated inventory levels.
524
- *
525
- * @example
526
- * const inventoryLevels =
527
- * await inventoryModuleService.updateInventoryLevels([
528
- * {
529
- * inventory_item_id: "iitem_123",
530
- * location_id: "loc_123",
531
- * id: "ilev_123",
532
- * stocked_quantity: 20,
533
- * },
534
- * ])
535
- */
536
- updateInventoryLevels(updates: InventoryNext.BulkUpdateInventoryLevelInput[], context?: Context): Promise<InventoryNext.InventoryLevelDTO[]>;
537
- /**
538
- * This method updates an existing inventory level.
539
- *
540
- * @param {BulkUpdateInventoryLevelInput} updates - The attributes to update in an inventory level. The inventory level is identified by the IDs of its associated inventory item and location.
541
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
542
- * @returns {Promise<InventoryLevelDTO>} The updated inventory level.
543
- *
544
- * @example
545
- * const inventoryLevel =
546
- * await inventoryModuleService.updateInventoryLevels({
547
- * inventory_item_id: "iitem_123",
548
- * location_id: "loc_123",
549
- * stocked_quantity: 20,
550
- * })
551
- */
552
- updateInventoryLevels(updates: InventoryNext.BulkUpdateInventoryLevelInput, context?: Context): Promise<InventoryNext.InventoryLevelDTO>;
553
- /**
554
- * This method updates an existing inventory item.
555
- *
556
- * @param {UpdateInventoryItemInput} input - The attributes to update in the inventory item.
557
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
558
- * @returns {Promise<InventoryItemDTO>} The updated inventory item.
559
- *
560
- * @example
561
- * const inventoryItem = await inventoryModuleService.update({
562
- * id: "iitem_123",
563
- * title: "Medusa Shirt Inventory",
564
- * })
565
- */
566
- update(input: InventoryNext.UpdateInventoryItemInput, context?: Context): Promise<InventoryNext.InventoryItemDTO>;
567
- /**
568
- * This method updates existing inventory items.
569
- *
570
- * @param {UpdateInventoryItemInput[]} input - The attributes to update in the inventory items.
571
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
572
- * @returns {Promise<InventoryItemDTO[]>} The updated inventory items.
573
- *
574
- * @example
575
- * const inventoryItems = await inventoryModuleService.update([
576
- * {
577
- * id: "iitem_123",
578
- * title: "Medusa Shirt Inventory",
579
- * },
580
- * {
581
- * id: "iitem_321",
582
- * description: "The inventory of Medusa pants",
583
- * },
584
- * ])
585
- */
586
- update(input: InventoryNext.UpdateInventoryItemInput[], context?: Context): Promise<InventoryNext.InventoryItemDTO[]>;
587
- /**
588
- * This method updates an existing reservation item.
589
- *
590
- * @param {UpdateReservationItemInput} input - The attributes to update in a reservation item.
591
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
592
- * @returns {Promise<ReservationItemDTO>} The updated reservation item.
593
- *
594
- * @example
595
- * const reservationItem =
596
- * await inventoryModuleService.updateReservationItems({
597
- * id: "resitem_123",
598
- * quantity: 10,
599
- * })
600
- */
601
- updateReservationItems(input: InventoryNext.UpdateReservationItemInput, context?: Context): Promise<InventoryNext.ReservationItemDTO>;
602
- /**
603
- * This method updates existing reservation items.
604
- *
605
- * @param {UpdateReservationItemInput[]} input - The attributes to update in the reservation items.
606
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
607
- * @returns {Promise<ReservationItemDTO[]>} The updated reservation items.
608
- *
609
- * @example
610
- * const reservationItems =
611
- * await inventoryModuleService.updateReservationItems([
612
- * {
613
- * id: "resitem_123",
614
- * quantity: 10,
615
- * },
616
- * ])
617
- */
618
- updateReservationItems(input: InventoryNext.UpdateReservationItemInput[], context?: Context): Promise<InventoryNext.ReservationItemDTO[]>;
619
- /**
620
- * This method deletes a reservation item by its associated line item.
621
- *
622
- * @param {string | string[]} lineItemId - The line item's ID.
623
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
624
- * @returns {Promise<void>} Resolves when the reservation item is deleted.
625
- *
626
- * @example
627
- * await inventoryModuleService.deleteReservationItemByLocationId(
628
- * "cali_123"
629
- * )
630
- */
631
- deleteReservationItemsByLineItem(lineItemId: string | string[], context?: Context): Promise<void>;
632
- /**
633
- * This method is used to restore the reservation items associated with a line item or multiple line items that were deleted.
634
- *
635
- * @param {string | string[]} lineItemId - The ID(s) of the line item(s).
636
- * @param {SharedContext} context - A context used to share re9sources, such as transaction manager, between the application and the module.
637
- * @returns {Promise<void>} Resolves when the reservation items are successfully deleted.
638
- *
639
- * @example
640
- * import {
641
- * initialize as initializeInventoryModule,
642
- * } from "@medusajs/inventory"
643
- *
644
- * async function restoreReservationItemsByLineItem (
645
- * lineItemIds: string[]
646
- * ) {
647
- * const inventoryModule = await initializeInventoryModule({})
648
- *
649
- * await inventoryModule.restoreReservationItemsByLineItem(
650
- * lineItemIds
651
- * )
652
- * }
653
- */
654
- restoreReservationItemsByLineItem(lineItemId: string | string[], context?: Context): Promise<void>;
655
- /**
656
- * This method deletes reservation items by their IDs.
657
- *
658
- * @param {string | string[]} reservationItemId - The reservation items' IDs.
659
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
660
- * @returns {Promise<void>} Resolves when the reservation item is deleted.
661
- *
662
- * @example
663
- * await inventoryModuleService.deleteReservationItems(
664
- * "resitem_123"
665
- * )
666
- */
667
- deleteReservationItems(reservationItemId: string | string[], context?: Context): Promise<void>;
668
- /**
669
- * This method soft deletes reservations by their IDs.
670
- *
671
- * @param {string[]} inventoryLevelIds - The reservations' IDs.
672
- * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
673
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
674
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
675
- * If there are no related records, the promise resolves to `void`.
676
- *
677
- * @example
678
- * await inventoryModuleService.softDeleteReservationItems([
679
- * "ilev_123",
680
- * ])
681
- */
682
- softDeleteReservationItems<TReturnableLinkableKeys extends string = string>(ReservationItemIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
683
- /**
684
- * This method restores soft deleted reservations by their IDs.
685
- *
686
- * @param {string[]} ReservationItemIds - The reservations' IDs.
687
- * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the reservation. You can pass to its `returnLinkableKeys`
688
- * property any of the reservation's relation attribute names, such as `{type relation name}`.
689
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
690
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
691
- * If there are no related records restored, the promise resolves to `void`.
692
- *
693
- * @example
694
- * await inventoryModuleService.restoreReservationItems([
695
- * "ilev_123",
696
- * ])
697
- */
698
- restoreReservationItems<TReturnableLinkableKeys extends string = string>(ReservationItemIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
699
- /**
700
- * This method deletes inventory items by their IDs.
701
- *
702
- * @param {string | string[]} inventoryItemId - The inventory item's ID.
703
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
704
- * @returns {Promise<void>} Resolves when the inventory items are deleted.
705
- *
706
- * @example
707
- * await inventoryModuleService.delete("iitem_123")
708
- */
709
- delete(inventoryItemId: string | string[], context?: Context): Promise<void>;
710
- /**
711
- * This method soft deletes inventory items by their IDs.
712
- *
713
- * @param {string[]} inventoryItemIds - The inventory items' IDs.
714
- * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
715
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
716
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated location levels.
717
- * The object's keys are the ID attribute names of the inventory service next entity's relations, such as `location_level_id`, and its value is an array of strings, each being the ID of a record associated
718
- * with the inventory item through this relation, such as the IDs of associated location levels.
719
- *
720
- * If there are no related records, the promise resolves to `void`.
721
- *
722
- * @example
723
- * await inventoryModuleService.softDelete(
724
- * ["iitem_123", "iitem_321"],
725
- * {
726
- * returnLinkableKeys: ["location_level"],
727
- * }
728
- * )
729
- */
730
- softDelete<TReturnableLinkableKeys extends string = string>(inventoryItemIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
731
- /**
732
- * This method restores soft deleted inventory items by their IDs.
733
- *
734
- * @param {string[]} inventoryItemIds - The inventory items' IDs.
735
- * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the inventory items. You can pass to its `returnLinkableKeys`
736
- * property any of the inventory item's relation attribute names, such as `location_levels`.
737
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
738
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated location levels.
739
- * The object's keys are the ID attribute names of the inventory item entity's relations, such as `location_level_id`,
740
- * and its value is an array of strings, each being the ID of the record associated with the inventory item through this relation,
741
- * such as the IDs of associated location levels.
742
- *
743
- * If there are no related records restored, the promise resolves to `void`.
744
- *
745
- * @example
746
- * await inventoryModuleService.restore(
747
- * ["iitem_123", "iitem_321"],
748
- * {
749
- * returnLinkableKeys: ["location_level"],
750
- * }
751
- * )
752
- */
753
- restore<TReturnableLinkableKeys extends string = string>(inventoryItemIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
754
- /**
755
- * This method soft deletes inventory item's level by the associated location.
756
- *
757
- * @param {string | string[]} locationId - The locations' IDs.
758
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
759
- * @returns {Promise<[object[], Record<string, unknown[]>]>} An array, where the first item is an array includes the soft-deleted inventory levels,
760
- * and the second is an object that includes the IDs of related records that were soft-deleted.
761
- *
762
- * @example
763
- * await inventoryModuleService.deleteInventoryItemLevelByLocationId(
764
- * "loc_123"
765
- * )
766
- */
767
- deleteInventoryItemLevelByLocationId(locationId: string | string[], context?: Context): Promise<[object[], Record<string, unknown[]>]>;
768
- /**
769
- * This method deletes reservation items by their associated location.
770
- *
771
- * @param {string | string[]} locationId - The location's ID.
772
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
773
- * @returns {Promise<void>} Resolves when then reservation items are deleted successfully.
774
- *
775
- * @example
776
- * await inventoryModuleService.deleteReservationItemByLocationId(
777
- * "loc_123"
778
- * )
779
- */
780
- deleteReservationItemByLocationId(locationId: string | string[], context?: Context): Promise<void>;
781
- /**
782
- * This method deletes an inventory level by its associated inventory item and location.
783
- *
784
- * @param {string} inventoryItemId - The inventory item's ID.
785
- * @param {string} locationId - The location's ID.
786
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
787
- * @returns {Promise<void>} Resolves when the inventory level is deleted successfully.
788
- *
789
- * @example
790
- * await inventoryModuleService.deleteInventoryLevel(
791
- * "iitem_123",
792
- * "loc_123"
793
- * )
794
- */
795
- deleteInventoryLevel(inventoryItemId: string, locationId: string, context?: Context): Promise<void>;
796
- /**
797
- * This method deletes inventory levels by their IDs.
798
- *
799
- * @param {string | string[]} inventoryLevelIds - The inventory levels' IDs.
800
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
801
- * @returns {Promise<void>} Resolves when the inventory levels are deleted.
802
- *
803
- * @example
804
- * await inventoryModuleService.deleteInventoryLevels("ilev_123")
805
- */
806
- deleteInventoryLevels(inventoryLevelIds: string | string[], context?: Context): Promise<void>;
807
- /**
808
- * This method soft deletes inventory levels by their IDs.
809
- *
810
- * @param {string[]} inventoryLevelIds - The inventory levels' IDs.
811
- * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
812
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
813
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
814
- * If there are no related records, the promise resolves to `void`.
815
- *
816
- * @example
817
- * await inventoryModuleService.softDeleteInventoryLevels([
818
- * "ilev_123",
819
- * ])
820
- */
821
- softDeleteInventoryLevels<TReturnableLinkableKeys extends string = string>(inventoryLevelIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
822
- /**
823
- * This method restores soft deleted inventory levels by their IDs.
824
- *
825
- * @param {string[]} inventoryLevelIds - The inventory levels' IDs.
826
- * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the inventory level. You can pass to its `returnLinkableKeys`
827
- * property any of the inventory level's relation attribute names, such as `{type relation name}`.
828
- * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
829
- * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
830
- * If there are no related records restored, the promise resolves to `void`.
831
- *
832
- * @example
833
- * await inventoryModuleService.restoreInventoryLevels([
834
- * "ilev_123",
835
- * ])
836
- */
837
- restoreInventoryLevels<TReturnableLinkableKeys extends string = string>(inventoryLevelIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
838
- /**
839
- * This method adjusts the inventory quantity of an item in a location.
840
- *
841
- * @param {string} inventoryItemId - The inventory item's ID.
842
- * @param {string} locationId - The location's ID.
843
- * @param {number} adjustment - the adjustment to make to the quantity.
844
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
845
- * @returns {Promise<InventoryLevelDTO>} The updated inventory level.
846
- *
847
- * @example
848
- * // add to the inventory quantity
849
- * const inventoryLevel1 =
850
- * await inventoryModuleService.adjustInventory(
851
- * "iitem_123",
852
- * "loc_123",
853
- * 5
854
- * )
855
- *
856
- * // subtract from the inventory quantity
857
- * const inventoryLevel2 =
858
- * await inventoryModuleService.adjustInventory(
859
- * "iitem_123",
860
- * "loc_123",
861
- * -5
862
- * )
863
- */
864
- adjustInventory(data: {
865
- inventoryItemId: string;
866
- locationId: string;
867
- adjustment: number;
868
- }[], context?: Context): Promise<InventoryNext.InventoryLevelDTO[]>;
869
- adjustInventory(inventoryItemId: string, locationId: string, adjustment: number, context?: Context): Promise<InventoryNext.InventoryLevelDTO>;
870
- /**
871
- * This method confirms that a quantity is available of an inventory item in the specified locations.
872
- *
873
- * @param {string} inventoryItemId - The inventory item's ID.
874
- * @param {string[]} locationIds - The locations' IDs.
875
- * @param {number} quantity - The quantity to confirm its availability.
876
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
877
- * @returns {Promise<boolean>} Whether the quantity is available.
878
- *
879
- * @example
880
- * const isAvailable =
881
- * await inventoryModuleService.confirmInventory(
882
- * "iitem_123",
883
- * ["loc_123", "loc_321"],
884
- * 10
885
- * )
886
- */
887
- confirmInventory(inventoryItemId: string, locationIds: string[], quantity: number, context?: Context): Promise<boolean>;
888
- /**
889
- * This method retrieves the available quantity of an inventory item in the specified locations.
890
- *
891
- * @param {string} inventoryItemId - The inventory item's ID.
892
- * @param {string[]} locationIds - The locations' IDs.
893
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
894
- * @returns {Promise<number>} The available quantity of the item.
895
- *
896
- * @example
897
- * const availableQuantity =
898
- * await inventoryModuleService.retrieveAvailableQuantity(
899
- * "iitem_123",
900
- * ["loc_123", "loc_321"]
901
- * )
902
- */
903
- retrieveAvailableQuantity(inventoryItemId: string, locationIds: string[], context?: Context): Promise<number>;
904
- /**
905
- * This method retrieves the stocked quantity of an inventory item in the specified location.
906
- *
907
- * @param {string} inventoryItemId - The inventory item's ID.
908
- * @param {string[]} locationIds - The locations' IDs.
909
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
910
- * @returns {Promise<number>} The stocked quantity of the item.
911
- *
912
- * @example
913
- * const stockedQuantity =
914
- * await inventoryModuleService.retrieveStockedQuantity(
915
- * "iitem_123",
916
- * ["loc_123", "loc_321"]
917
- * )
918
- */
919
- retrieveStockedQuantity(inventoryItemId: string, locationIds: string[], context?: Context): Promise<number>;
920
- /**
921
- * This method retrieves the reserved quantity of an inventory item in the specified location.
922
- *
923
- * @param {string} inventoryItemId - The inventory item's ID.
924
- * @param {string[]} locationIds - The locations' IDs.
925
- * @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
926
- * @returns {Promise<number>} The reserved quantity of the item.
927
- *
928
- * @example
929
- * const reservedQuantity =
930
- * await inventoryModuleService.retrieveReservedQuantity(
931
- * "iitem_123",
932
- * ["loc_123", "loc_321"]
933
- * )
934
- */
935
- retrieveReservedQuantity(inventoryItemId: string, locationIds: string[], context?: Context): Promise<number>;
936
- }
937
- //# sourceMappingURL=service-next.d.ts.map