@medusajs/types 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144

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 (264) hide show
  1. package/dist/cache/service.d.ts +27 -0
  2. package/dist/cache/service.d.ts.map +1 -1
  3. package/dist/cart/common.d.ts +81 -0
  4. package/dist/cart/common.d.ts.map +1 -1
  5. package/dist/cart/mutations.d.ts +17 -2
  6. package/dist/cart/mutations.d.ts.map +1 -1
  7. package/dist/cart/mutations.js.map +1 -1
  8. package/dist/cart/service.d.ts +114 -1
  9. package/dist/cart/service.d.ts.map +1 -1
  10. package/dist/cart/workflows.d.ts +9 -0
  11. package/dist/cart/workflows.d.ts.map +1 -1
  12. package/dist/common/config-module.d.ts +5 -1
  13. package/dist/common/config-module.d.ts.map +1 -1
  14. package/dist/dal/repository-service.d.ts +2 -2
  15. package/dist/dal/repository-service.d.ts.map +1 -1
  16. package/dist/dml/index.d.ts +8 -0
  17. package/dist/dml/index.d.ts.map +1 -1
  18. package/dist/event-bus/common.d.ts +24 -0
  19. package/dist/event-bus/common.d.ts.map +1 -1
  20. package/dist/event-bus/event-bus-module.d.ts +58 -0
  21. package/dist/event-bus/event-bus-module.d.ts.map +1 -1
  22. package/dist/file/common.d.ts +3 -2
  23. package/dist/file/common.d.ts.map +1 -1
  24. package/dist/file/mutations.d.ts +5 -2
  25. package/dist/file/mutations.d.ts.map +1 -1
  26. package/dist/file/provider.d.ts +9 -3
  27. package/dist/file/provider.d.ts.map +1 -1
  28. package/dist/file/service.d.ts +10 -9
  29. package/dist/file/service.d.ts.map +1 -1
  30. package/dist/fulfillment/common/order.d.ts +2 -72
  31. package/dist/fulfillment/common/order.d.ts.map +1 -1
  32. package/dist/fulfillment/mutations/shipping-option.d.ts +23 -2
  33. package/dist/fulfillment/mutations/shipping-option.d.ts.map +1 -1
  34. package/dist/fulfillment/mutations/shipping-profile.d.ts +1 -1
  35. package/dist/fulfillment/mutations/shipping-profile.d.ts.map +1 -1
  36. package/dist/fulfillment/service.d.ts +3 -0
  37. package/dist/fulfillment/service.d.ts.map +1 -1
  38. package/dist/http/auth/payloads.d.ts +3 -0
  39. package/dist/http/auth/payloads.d.ts.map +1 -1
  40. package/dist/http/common/request.d.ts +2 -2
  41. package/dist/http/common/response.d.ts +21 -0
  42. package/dist/http/common/response.d.ts.map +1 -1
  43. package/dist/http/draft-order/admin/entities.d.ts +6 -0
  44. package/dist/http/draft-order/admin/entities.d.ts.map +1 -0
  45. package/dist/http/draft-order/admin/entities.js +3 -0
  46. package/dist/http/draft-order/admin/entities.js.map +1 -0
  47. package/dist/http/draft-order/admin/index.d.ts +5 -0
  48. package/dist/http/draft-order/admin/index.d.ts.map +1 -0
  49. package/dist/http/draft-order/admin/index.js +21 -0
  50. package/dist/http/draft-order/admin/index.js.map +1 -0
  51. package/dist/http/draft-order/admin/payloads.d.ts +243 -0
  52. package/dist/http/draft-order/admin/payloads.d.ts.map +1 -0
  53. package/dist/http/draft-order/admin/payloads.js +3 -0
  54. package/dist/http/draft-order/admin/payloads.js.map +1 -0
  55. package/dist/http/draft-order/admin/queries.d.ts +35 -0
  56. package/dist/http/draft-order/admin/queries.d.ts.map +1 -0
  57. package/dist/http/draft-order/admin/queries.js +3 -0
  58. package/dist/http/draft-order/admin/queries.js.map +1 -0
  59. package/dist/http/draft-order/admin/responses.d.ts +13 -0
  60. package/dist/http/draft-order/admin/responses.d.ts.map +1 -0
  61. package/dist/http/draft-order/admin/responses.js +3 -0
  62. package/dist/http/draft-order/admin/responses.js.map +1 -0
  63. package/dist/http/draft-order/index.d.ts +2 -0
  64. package/dist/http/draft-order/index.d.ts.map +1 -0
  65. package/dist/http/draft-order/index.js +18 -0
  66. package/dist/http/draft-order/index.js.map +1 -0
  67. package/dist/http/file/admin/responses.d.ts +6 -0
  68. package/dist/http/file/admin/responses.d.ts.map +1 -1
  69. package/dist/http/file/common.d.ts +17 -0
  70. package/dist/http/file/common.d.ts.map +1 -1
  71. package/dist/http/fulfillment/store/index.d.ts +4 -0
  72. package/dist/http/fulfillment/store/index.d.ts.map +1 -1
  73. package/dist/http/fulfillment-provider/admin/responses.d.ts +3 -0
  74. package/dist/http/fulfillment-provider/admin/responses.d.ts.map +1 -1
  75. package/dist/http/index.d.ts +2 -0
  76. package/dist/http/index.d.ts.map +1 -1
  77. package/dist/http/index.js +2 -0
  78. package/dist/http/index.js.map +1 -1
  79. package/dist/http/inventory-level/admin/payloads.d.ts +0 -16
  80. package/dist/http/inventory-level/admin/payloads.d.ts.map +1 -1
  81. package/dist/http/order/admin/entities.d.ts +10 -1
  82. package/dist/http/order/admin/entities.d.ts.map +1 -1
  83. package/dist/http/order/admin/queries.d.ts +0 -9
  84. package/dist/http/order/admin/queries.d.ts.map +1 -1
  85. package/dist/http/order/admin/responses.d.ts +0 -6
  86. package/dist/http/order/admin/responses.d.ts.map +1 -1
  87. package/dist/http/order/common.d.ts +6 -39
  88. package/dist/http/order/common.d.ts.map +1 -1
  89. package/dist/http/payment/admin/queries.d.ts +6 -0
  90. package/dist/http/payment/admin/queries.d.ts.map +1 -1
  91. package/dist/http/payment/admin/responses.d.ts +3 -0
  92. package/dist/http/payment/admin/responses.d.ts.map +1 -1
  93. package/dist/http/plugins/admin/responses.d.ts +10 -0
  94. package/dist/http/plugins/admin/responses.d.ts.map +1 -0
  95. package/dist/http/plugins/admin/responses.js +3 -0
  96. package/dist/http/plugins/admin/responses.js.map +1 -0
  97. package/dist/http/plugins/index.d.ts +2 -0
  98. package/dist/http/plugins/index.d.ts.map +1 -0
  99. package/dist/http/plugins/index.js +18 -0
  100. package/dist/http/plugins/index.js.map +1 -0
  101. package/dist/http/pricing/common.d.ts +8 -0
  102. package/dist/http/pricing/common.d.ts.map +1 -1
  103. package/dist/http/product/admin/payloads.d.ts +2 -2
  104. package/dist/http/product/admin/payloads.d.ts.map +1 -1
  105. package/dist/http/promotion/admin/entities.d.ts +20 -0
  106. package/dist/http/promotion/admin/entities.d.ts.map +1 -1
  107. package/dist/http/promotion/admin/payloads.d.ts +156 -0
  108. package/dist/http/promotion/admin/payloads.d.ts.map +1 -1
  109. package/dist/http/promotion/admin/queries.d.ts +45 -1
  110. package/dist/http/promotion/admin/queries.d.ts.map +1 -1
  111. package/dist/http/promotion/admin/responses.d.ts +17 -2
  112. package/dist/http/promotion/admin/responses.d.ts.map +1 -1
  113. package/dist/http/promotion/common.d.ts +53 -0
  114. package/dist/http/promotion/common.d.ts.map +1 -1
  115. package/dist/http/region/admin/entities.d.ts +3 -0
  116. package/dist/http/region/admin/entities.d.ts.map +1 -1
  117. package/dist/http/region/admin/payloads.d.ts +68 -0
  118. package/dist/http/region/admin/payloads.d.ts.map +1 -1
  119. package/dist/http/region/admin/queries.d.ts +21 -0
  120. package/dist/http/region/admin/queries.d.ts.map +1 -1
  121. package/dist/http/region/admin/responses.d.ts +6 -0
  122. package/dist/http/region/admin/responses.d.ts.map +1 -1
  123. package/dist/http/reservation/admin/entities.d.ts +39 -0
  124. package/dist/http/reservation/admin/entities.d.ts.map +1 -1
  125. package/dist/http/reservation/admin/payloads.d.ts +32 -0
  126. package/dist/http/reservation/admin/payloads.d.ts.map +1 -1
  127. package/dist/http/reservation/admin/queries.d.ts +34 -0
  128. package/dist/http/reservation/admin/queries.d.ts.map +1 -1
  129. package/dist/http/reservation/admin/responses.d.ts +6 -0
  130. package/dist/http/reservation/admin/responses.d.ts.map +1 -1
  131. package/dist/http/return/admin/entities.d.ts +3 -0
  132. package/dist/http/return/admin/entities.d.ts.map +1 -1
  133. package/dist/http/return/admin/payloads.d.ts +154 -0
  134. package/dist/http/return/admin/payloads.d.ts.map +1 -1
  135. package/dist/http/return/admin/queries.d.ts +15 -0
  136. package/dist/http/return/admin/queries.d.ts.map +1 -1
  137. package/dist/http/return/admin/responses.d.ts +6 -0
  138. package/dist/http/return/admin/responses.d.ts.map +1 -1
  139. package/dist/http/return/common.d.ts +73 -0
  140. package/dist/http/return/common.d.ts.map +1 -1
  141. package/dist/http/return-reason/admin/payloads.d.ts +21 -0
  142. package/dist/http/return-reason/admin/payloads.d.ts.map +1 -1
  143. package/dist/http/return-reason/admin/queries.d.ts +3 -0
  144. package/dist/http/return-reason/admin/queries.d.ts.map +1 -1
  145. package/dist/http/return-reason/admin/responses.d.ts +6 -0
  146. package/dist/http/return-reason/admin/responses.d.ts.map +1 -1
  147. package/dist/http/return-reason/common.d.ts +27 -0
  148. package/dist/http/return-reason/common.d.ts.map +1 -1
  149. package/dist/http/sales-channel/admin/entities.d.ts +24 -0
  150. package/dist/http/sales-channel/admin/entities.d.ts.map +1 -1
  151. package/dist/http/sales-channel/admin/payloads.d.ts +32 -0
  152. package/dist/http/sales-channel/admin/payloads.d.ts.map +1 -1
  153. package/dist/http/sales-channel/admin/queries.d.ts +32 -0
  154. package/dist/http/sales-channel/admin/queries.d.ts.map +1 -1
  155. package/dist/http/sales-channel/admin/responses.d.ts +6 -0
  156. package/dist/http/sales-channel/admin/responses.d.ts.map +1 -1
  157. package/dist/http/shipping-option/admin/entities.d.ts +187 -0
  158. package/dist/http/shipping-option/admin/entities.d.ts.map +1 -1
  159. package/dist/http/shipping-option/admin/payloads.d.ts +181 -0
  160. package/dist/http/shipping-option/admin/payloads.d.ts.map +1 -1
  161. package/dist/http/shipping-option/admin/queries.d.ts +36 -0
  162. package/dist/http/shipping-option/admin/queries.d.ts.map +1 -1
  163. package/dist/http/shipping-option/admin/responses.d.ts +6 -0
  164. package/dist/http/shipping-option/admin/responses.d.ts.map +1 -1
  165. package/dist/http/shipping-option/store/payloads.d.ts +12 -0
  166. package/dist/http/shipping-option/store/payloads.d.ts.map +1 -1
  167. package/dist/http/shipping-option/store/responses.d.ts +12 -0
  168. package/dist/http/shipping-option/store/responses.d.ts.map +1 -1
  169. package/dist/http/shipping-profile/admin/entities.d.ts +21 -0
  170. package/dist/http/shipping-profile/admin/entities.d.ts.map +1 -1
  171. package/dist/http/shipping-profile/admin/payloads.d.ts +18 -0
  172. package/dist/http/shipping-profile/admin/payloads.d.ts.map +1 -1
  173. package/dist/http/shipping-profile/admin/queries.d.ts +27 -0
  174. package/dist/http/shipping-profile/admin/queries.d.ts.map +1 -1
  175. package/dist/http/shipping-profile/admin/responses.d.ts +6 -0
  176. package/dist/http/shipping-profile/admin/responses.d.ts.map +1 -1
  177. package/dist/http/stock-locations/admin/entities.d.ts +21 -0
  178. package/dist/http/stock-locations/admin/entities.d.ts.map +1 -1
  179. package/dist/http/stock-locations/admin/payloads.d.ts +69 -0
  180. package/dist/http/stock-locations/admin/payloads.d.ts.map +1 -1
  181. package/dist/http/stock-locations/admin/queries.d.ts +24 -2
  182. package/dist/http/stock-locations/admin/queries.d.ts.map +1 -1
  183. package/dist/http/stock-locations/admin/responses.d.ts +6 -0
  184. package/dist/http/stock-locations/admin/responses.d.ts.map +1 -1
  185. package/dist/http/store/admin/entities.d.ts +54 -0
  186. package/dist/http/store/admin/entities.d.ts.map +1 -1
  187. package/dist/http/store/admin/queries.d.ts +9 -0
  188. package/dist/http/store/admin/queries.d.ts.map +1 -1
  189. package/dist/http/store/admin/responses.d.ts +6 -0
  190. package/dist/http/store/admin/responses.d.ts.map +1 -1
  191. package/dist/http/tax-rate/admin/entities.d.ts +54 -0
  192. package/dist/http/tax-rate/admin/entities.d.ts.map +1 -1
  193. package/dist/http/tax-rate/admin/payloads.d.ts +57 -0
  194. package/dist/http/tax-rate/admin/payloads.d.ts.map +1 -1
  195. package/dist/http/tax-rate/admin/queries.d.ts +30 -0
  196. package/dist/http/tax-rate/admin/queries.d.ts.map +1 -1
  197. package/dist/http/tax-rate/admin/responses.d.ts +6 -0
  198. package/dist/http/tax-rate/admin/responses.d.ts.map +1 -1
  199. package/dist/http/tax-region/admin/entities.d.ts +42 -0
  200. package/dist/http/tax-region/admin/entities.d.ts.map +1 -1
  201. package/dist/http/tax-region/admin/payloads.d.ts +30 -0
  202. package/dist/http/tax-region/admin/payloads.d.ts.map +1 -1
  203. package/dist/http/tax-region/admin/queries.d.ts +28 -0
  204. package/dist/http/tax-region/admin/queries.d.ts.map +1 -1
  205. package/dist/http/tax-region/admin/responses.d.ts +6 -0
  206. package/dist/http/tax-region/admin/responses.d.ts.map +1 -1
  207. package/dist/http/user/admin/entities.d.ts +27 -0
  208. package/dist/http/user/admin/entities.d.ts.map +1 -1
  209. package/dist/http/user/admin/payloads.d.ts +12 -0
  210. package/dist/http/user/admin/payloads.d.ts.map +1 -1
  211. package/dist/http/user/admin/queries.d.ts +24 -0
  212. package/dist/http/user/admin/queries.d.ts.map +1 -1
  213. package/dist/http/user/admin/responses.d.ts +6 -0
  214. package/dist/http/user/admin/responses.d.ts.map +1 -1
  215. package/dist/http/workflow-execution/admin/entities.d.ts +136 -2
  216. package/dist/http/workflow-execution/admin/entities.d.ts.map +1 -1
  217. package/dist/http/workflow-execution/admin/queries.d.ts +6 -0
  218. package/dist/http/workflow-execution/admin/queries.d.ts.map +1 -1
  219. package/dist/http/workflow-execution/admin/responses.d.ts +6 -0
  220. package/dist/http/workflow-execution/admin/responses.d.ts.map +1 -1
  221. package/dist/index-data/query-config/query-input-config.d.ts +1 -1
  222. package/dist/index-data/query-config/query-input-config.d.ts.map +1 -1
  223. package/dist/locking/index.d.ts +466 -0
  224. package/dist/locking/index.d.ts.map +1 -1
  225. package/dist/modules-sdk/index.d.ts +6 -1
  226. package/dist/modules-sdk/index.d.ts.map +1 -1
  227. package/dist/modules-sdk/medusa-internal-service.d.ts +5 -5
  228. package/dist/modules-sdk/medusa-internal-service.d.ts.map +1 -1
  229. package/dist/modules-sdk/remote-query-object-from-string.d.ts +4 -0
  230. package/dist/modules-sdk/remote-query-object-from-string.d.ts.map +1 -1
  231. package/dist/modules-sdk/remote-query.d.ts +16 -0
  232. package/dist/modules-sdk/remote-query.d.ts.map +1 -1
  233. package/dist/notification/mutations.d.ts +5 -4
  234. package/dist/notification/mutations.d.ts.map +1 -1
  235. package/dist/notification/service.d.ts +2 -5
  236. package/dist/notification/service.d.ts.map +1 -1
  237. package/dist/order/common.d.ts +45 -79
  238. package/dist/order/common.d.ts.map +1 -1
  239. package/dist/order/mutations.d.ts +38 -1
  240. package/dist/order/mutations.d.ts.map +1 -1
  241. package/dist/order/service.d.ts +101 -3
  242. package/dist/order/service.d.ts.map +1 -1
  243. package/dist/payment/common.d.ts +9 -1
  244. package/dist/payment/common.d.ts.map +1 -1
  245. package/dist/payment/mutations.d.ts +24 -1
  246. package/dist/payment/mutations.d.ts.map +1 -1
  247. package/dist/payment/provider.d.ts +121 -85
  248. package/dist/payment/provider.d.ts.map +1 -1
  249. package/dist/payment/service.d.ts +89 -10
  250. package/dist/payment/service.d.ts.map +1 -1
  251. package/dist/product/common.d.ts +11 -6
  252. package/dist/product/common.d.ts.map +1 -1
  253. package/dist/tax/provider.d.ts +9 -37
  254. package/dist/tax/provider.d.ts.map +1 -1
  255. package/dist/tsconfig.tsbuildinfo +1 -1
  256. package/dist/workflow/order/items.d.ts +5 -1
  257. package/dist/workflow/order/items.d.ts.map +1 -1
  258. package/dist/workflow/product-category/index.d.ts +5 -4
  259. package/dist/workflow/product-category/index.d.ts.map +1 -1
  260. package/dist/workflows/products/mutations.d.ts +2 -2
  261. package/dist/workflows/products/mutations.d.ts.map +1 -1
  262. package/dist/workflows-sdk/service.d.ts +12 -8
  263. package/dist/workflows-sdk/service.d.ts.map +1 -1
  264. package/package.json +3 -3
@@ -1,17 +1,56 @@
1
1
  import { AdminInventoryItem } from "../../inventory";
2
2
  export interface AdminReservation {
3
+ /**
4
+ * The reservation's ID.
5
+ */
3
6
  id: string;
7
+ /**
8
+ * The ID of the line item that the reservation is for.
9
+ */
4
10
  line_item_id: string | null;
11
+ /**
12
+ * The ID of the location that the quantity is reserved from.
13
+ */
5
14
  location_id: string;
15
+ /**
16
+ * The quantity that is reserved.
17
+ */
6
18
  quantity: number;
19
+ /**
20
+ * The ID of the reservation in an external system.
21
+ */
7
22
  external_id: string | null;
23
+ /**
24
+ * The description of the reservation.
25
+ */
8
26
  description: string | null;
27
+ /**
28
+ * The ID of the inventory item that the reservation is for.
29
+ */
9
30
  inventory_item_id: string;
31
+ /**
32
+ * The inventory item that the reservation is for.
33
+ */
10
34
  inventory_item?: AdminInventoryItem;
35
+ /**
36
+ * Custom key-value pairs that can be added to the reservation.
37
+ */
11
38
  metadata?: Record<string, unknown>;
39
+ /**
40
+ * The ID of the user that created the reservation.
41
+ */
12
42
  created_by?: string | null;
43
+ /**
44
+ * The date that the reservation was deleted.
45
+ */
13
46
  deleted_at?: Date | string | null;
47
+ /**
48
+ * The date that the reservation was created.
49
+ */
14
50
  created_at?: Date | string;
51
+ /**
52
+ * The date that the reservation was updated.
53
+ */
15
54
  updated_at?: Date | string;
16
55
  }
17
56
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEpD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,cAAc,CAAC,EAAE,kBAAkB,CAAA;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAA;IACjC,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC3B"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEpD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC3B"}
@@ -1,15 +1,47 @@
1
1
  export interface AdminCreateReservation {
2
+ /**
3
+ * The ID of the line item to create the reservation for.
4
+ */
2
5
  line_item_id?: string | null;
6
+ /**
7
+ * The ID of the location that the quantity
8
+ * is reserved from.
9
+ */
3
10
  location_id: string;
11
+ /**
12
+ * The ID of the inventory item that the reservation is for.
13
+ */
4
14
  inventory_item_id: string;
15
+ /**
16
+ * The quantity of the inventory item that is reserved.
17
+ */
5
18
  quantity: number;
19
+ /**
20
+ * The description of the reservation.
21
+ */
6
22
  description?: string | null;
23
+ /**
24
+ * Custom key-value pairs that can be added to the reservation.
25
+ */
7
26
  metadata?: Record<string, unknown> | null;
8
27
  }
9
28
  export interface AdminUpdateReservation {
29
+ /**
30
+ * The ID of the location that the quantity
31
+ * is reserved from.
32
+ */
10
33
  location_id?: string;
34
+ /**
35
+ * The quantity of the inventory item that is reserved.
36
+ */
11
37
  quantity?: number;
38
+ /**
39
+ * The description of the reservation.
40
+ */
12
41
  description?: string | null;
42
+ /**
43
+ * Custom key-value pairs that can be added to the reservation.
44
+ */
13
45
  metadata?: Record<string, unknown> | null;
14
46
  }
15
47
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
@@ -1,15 +1,49 @@
1
1
  import { OperatorMap } from "../../../dal";
2
2
  import { SelectParams } from "../../common";
3
3
  export interface AdminGetReservationsParams {
4
+ /**
5
+ * The maximum number of reservations to retrieve.
6
+ */
4
7
  limit?: number;
8
+ /**
9
+ * The number of reservations to skip.
10
+ */
5
11
  offset?: number;
12
+ /**
13
+ * Filter by the ID(s) of the location(s) to retrieve the
14
+ * reservations for.
15
+ */
6
16
  location_id?: string | string[];
17
+ /**
18
+ * Filter by the ID(s) of the inventory item(s) to retrieve the
19
+ * reservations for.
20
+ */
7
21
  inventory_item_id?: string | string[];
22
+ /**
23
+ * Filter by the ID(s) of the line item(s) to retrieve the
24
+ * reservations for.
25
+ */
8
26
  line_item_id?: string | string[];
27
+ /**
28
+ * Filter by the ID(s) of the user(s) to retrieve the
29
+ * reservations they created.
30
+ */
9
31
  created_by?: string | string[];
32
+ /**
33
+ * Filter by reservation description(s).
34
+ */
10
35
  description?: string | OperatorMap<string>;
36
+ /**
37
+ * Apply filters on the reservation's creation date.
38
+ */
11
39
  created_at?: OperatorMap<string>;
40
+ /**
41
+ * Apply filters on the reservation's update date.
42
+ */
12
43
  updated_at?: OperatorMap<string>;
44
+ /**
45
+ * Apply filters on the reservation's deletion date.
46
+ */
13
47
  deleted_at?: OperatorMap<string>;
14
48
  }
15
49
  export interface AdminReservationParams extends SelectParams {
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,0BAA0B;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;CAAG"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;CAAG"}
@@ -1,9 +1,15 @@
1
1
  import { DeleteResponse, PaginatedResponse } from "../../common";
2
2
  import { AdminReservation } from "./entities";
3
3
  export interface AdminReservationResponse {
4
+ /**
5
+ * The reservation's details.
6
+ */
4
7
  reservation: AdminReservation;
5
8
  }
6
9
  export type AdminReservationListResponse = PaginatedResponse<{
10
+ /**
11
+ * The list of reservations.
12
+ */
7
13
  reservations: AdminReservation[];
8
14
  }>;
9
15
  export type AdminReservationDeleteResponse = DeleteResponse<"reservation">;
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE7C,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,gBAAgB,CAAA;CAC9B;AAED,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC3D,YAAY,EAAE,gBAAgB,EAAE,CAAA;CACjC,CAAC,CAAA;AAEF,MAAM,MAAM,8BAA8B,GAAG,cAAc,CAAC,aAAa,CAAC,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/reservation/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE7C,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,gBAAgB,CAAA;CAC9B;AAED,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC3D;;OAEG;IACH,YAAY,EAAE,gBAAgB,EAAE,CAAA;CACjC,CAAC,CAAA;AAEF,MAAM,MAAM,8BAA8B,GAAG,cAAc,CAAC,aAAa,CAAC,CAAA"}
@@ -2,6 +2,9 @@ import { BaseReturn, BaseReturnItem } from "../common";
2
2
  export interface AdminReturnItem extends BaseReturnItem {
3
3
  }
4
4
  export interface AdminReturn extends BaseReturn {
5
+ /**
6
+ * The return's items.
7
+ */
5
8
  items: AdminReturnItem[];
6
9
  }
7
10
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,WAAW,eAAgB,SAAQ,cAAc;CAAG;AAC1D,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,KAAK,EAAE,eAAe,EAAE,CAAA;CACzB"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,WAAW,eAAgB,SAAQ,cAAc;CAAG;AAC1D,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C;;OAEG;IACH,KAAK,EAAE,eAAe,EAAE,CAAA;CACzB"}
@@ -1,78 +1,232 @@
1
1
  export interface AdminInitiateReturnRequest {
2
+ /**
3
+ * The ID of the order that the return belongs to.
4
+ */
2
5
  order_id: string;
6
+ /**
7
+ * The ID of the stock location to return the items to.
8
+ */
3
9
  location_id?: string;
10
+ /**
11
+ * The return's description.
12
+ */
4
13
  description?: string;
14
+ /**
15
+ * A note that is viewed by admins only to
16
+ * describe the return.
17
+ */
5
18
  internal_note?: string;
19
+ /**
20
+ * Whether to send a notification to the customer
21
+ * for return updates.
22
+ */
6
23
  no_notification?: boolean;
24
+ /**
25
+ * Custom key-value pairs that can be added to the return.
26
+ */
7
27
  metadata?: Record<string, unknown>;
8
28
  }
9
29
  export interface AdminAddReturnItem {
30
+ /**
31
+ * The ID of the order item to add to the return.
32
+ */
10
33
  id: string;
34
+ /**
35
+ * The quantity of the item to return.
36
+ */
11
37
  quantity: number;
38
+ /**
39
+ * A note to describe why the item is being returned.
40
+ */
12
41
  description?: string;
42
+ /**
43
+ * A note that is viewed by admins only to
44
+ * describe why the item is being returned.
45
+ */
13
46
  internal_note?: string;
47
+ /**
48
+ * Custom key-value pairs that can be added to the return item.
49
+ */
14
50
  metadata?: Record<string, unknown>;
15
51
  }
16
52
  export interface AdminAddReturnItems {
17
53
  items: AdminAddReturnItem[];
18
54
  }
19
55
  export interface AdminUpdateReturnItems {
56
+ /**
57
+ * The quantity of the item to return.
58
+ */
20
59
  quantity?: number;
60
+ /**
61
+ * A note that is viewed by admins only to
62
+ * describe why the item is being returned.
63
+ */
21
64
  internal_note?: string | null;
65
+ /**
66
+ * The ID of the return reason to associate with the item.
67
+ */
22
68
  reason_id?: string | null;
23
69
  }
24
70
  export interface AdminAddReturnShipping {
71
+ /**
72
+ * The ID of the shipping option that the shipping method
73
+ * is created from.
74
+ */
25
75
  shipping_option_id: string;
76
+ /**
77
+ * A custom amount to set for the shipping method.
78
+ * If not provided, the shipping option's fixed or calculated amount will be used.
79
+ */
26
80
  custom_amount?: number;
81
+ /**
82
+ * A note to describe the shipping method.
83
+ */
27
84
  description?: string;
85
+ /**
86
+ * A note that is viewed by admins only to
87
+ * describe the shipping method.
88
+ */
28
89
  internal_note?: string;
90
+ /**
91
+ * Custom key-value pairs that can be added to the shipping method.
92
+ */
29
93
  metadata?: Record<string, unknown>;
30
94
  }
31
95
  export interface AdminUpdateReturnShipping {
96
+ /**
97
+ * A custom amount to set for the shipping method.
98
+ * If not provided, the shipping option's fixed or calculated amount will be used.
99
+ */
32
100
  custom_amount?: number;
101
+ /**
102
+ * A note that is viewed by admins only to
103
+ * describe the shipping method.
104
+ */
33
105
  internal_note?: string;
106
+ /**
107
+ * Custom key-value pairs that can be added to the shipping method.
108
+ */
34
109
  metadata?: Record<string, unknown>;
35
110
  }
36
111
  export interface AdminConfirmReturnRequest {
112
+ /**
113
+ * Whether to send a notification to the customer
114
+ * for return updates.
115
+ */
37
116
  no_notification?: boolean;
38
117
  }
39
118
  export interface AdminUpdateReturnRequest {
119
+ /**
120
+ * The ID of the stock location to return the items to.
121
+ */
40
122
  location_id?: string | null;
123
+ /**
124
+ * Whether to send a notification to the customer
125
+ * for return updates.
126
+ */
41
127
  no_notification?: boolean;
128
+ /**
129
+ * Custom key-value pairs that can be added to the return.
130
+ */
42
131
  metadata?: Record<string, unknown> | null;
43
132
  }
44
133
  export interface AdminConfirmReceiveReturn {
134
+ /**
135
+ * Whether to send a notification to the customer
136
+ * for return updates.
137
+ */
45
138
  no_notification?: boolean;
46
139
  }
47
140
  export interface AdminInitiateReceiveReturn {
141
+ /**
142
+ * A note that is viewed by admins only to
143
+ * describe the return.
144
+ */
48
145
  internal_note?: string;
146
+ /**
147
+ * A note to describe the return.
148
+ */
49
149
  description?: string;
150
+ /**
151
+ * Custom key-value pairs that can be added to the return.
152
+ */
50
153
  metadata?: Record<string, unknown>;
51
154
  }
52
155
  export interface AdminReceiveItems {
156
+ /**
157
+ * The received items in the return.
158
+ */
53
159
  items: {
160
+ /**
161
+ * The ID of the received item.
162
+ */
54
163
  id: string;
164
+ /**
165
+ * The received quantity of the item.
166
+ */
55
167
  quantity: number;
168
+ /**
169
+ * A note that is viewed by admins only to
170
+ * describe the received item.
171
+ */
56
172
  internal_note?: string;
57
173
  }[];
58
174
  }
59
175
  export interface AdminDismissItems {
176
+ /**
177
+ * The damaged items to add to the return.
178
+ */
60
179
  items: {
180
+ /**
181
+ * The ID of the item to add to the return.
182
+ */
61
183
  id: string;
184
+ /**
185
+ * The quantity of the item that is damaged.
186
+ */
62
187
  quantity: number;
188
+ /**
189
+ * A note that is viewed by admins only to
190
+ * describe the damaged item.
191
+ */
63
192
  internal_note?: string;
64
193
  }[];
65
194
  }
66
195
  export interface AdminUpdateReceiveItems {
196
+ /**
197
+ * The received quantity of the item.
198
+ */
67
199
  quantity?: number;
200
+ /**
201
+ * A note that is viewed by admins only to
202
+ * describe the received item.
203
+ */
68
204
  internal_note?: string;
205
+ /**
206
+ * The ID of the return reason to associate with the item.
207
+ */
69
208
  reason_id?: string;
209
+ /**
210
+ * Custom key-value pairs that can be added to the received item.
211
+ */
70
212
  metadata?: Record<string, unknown>;
71
213
  }
72
214
  export interface AdminUpdateDismissItems {
215
+ /**
216
+ * The quantity of the item that is damaged.
217
+ */
73
218
  quantity?: number;
219
+ /**
220
+ * A note that is viewed by admins only to
221
+ */
74
222
  internal_note?: string;
223
+ /**
224
+ * The ID of the return reason to associate with the item.
225
+ */
75
226
  reason_id?: string;
227
+ /**
228
+ * Custom key-value pairs that can be added to the received item.
229
+ */
76
230
  metadata?: Record<string, unknown>;
77
231
  }
78
232
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAClE;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAClE;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}
@@ -1,10 +1,25 @@
1
1
  import { OperatorMap } from "../../../dal";
2
2
  import { FindParams } from "../../common";
3
3
  export interface AdminReturnFilters extends FindParams {
4
+ /**
5
+ * Filter by return ID(s).
6
+ */
4
7
  id?: string[] | string | OperatorMap<string | string[]>;
8
+ /**
9
+ * Filter by order ID(s) to retrieve their returns.
10
+ */
5
11
  order_id?: string[] | string | OperatorMap<string | string[]>;
12
+ /**
13
+ * Filter by status.
14
+ */
6
15
  status?: string[] | string | Record<string, unknown> | OperatorMap<Record<string, unknown>>;
16
+ /**
17
+ * Filter by the date when the return was created.
18
+ */
7
19
  created_at?: OperatorMap<string>;
20
+ /**
21
+ * Filter by the date when the return was updated.
22
+ */
8
23
  updated_at?: OperatorMap<string>;
9
24
  }
10
25
  //# sourceMappingURL=queries.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC7D,MAAM,CAAC,EACH,MAAM,EAAE,GACR,MAAM,GACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC7D;;OAEG;IACH,MAAM,CAAC,EACH,MAAM,EAAE,GACR,MAAM,GACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
@@ -3,9 +3,15 @@ import { DeleteResponse, PaginatedResponse } from "../../common";
3
3
  import { AdminOrderPreview } from "../../order";
4
4
  import { AdminReturn } from "./entities";
5
5
  export interface AdminReturnResponse {
6
+ /**
7
+ * The return's details.
8
+ */
6
9
  return: AdminReturn;
7
10
  }
8
11
  export type AdminReturnsResponse = PaginatedResponse<{
12
+ /**
13
+ * The list of returns.
14
+ */
9
15
  returns: AdminReturn[];
10
16
  }>;
11
17
  export interface AdminOrderReturnResponse {
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACnD,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB,CAAC,CAAA;AAEF,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,QAAQ,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,EAAE,iBAAiB,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/return/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACnD;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB,CAAC,CAAA;AAEF,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,QAAQ,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,EAAE,iBAAiB,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA"}
@@ -1,29 +1,102 @@
1
1
  import { ReturnStatus } from "../../order";
2
2
  export interface BaseReturnItem {
3
+ /**
4
+ * The return item's ID.
5
+ */
3
6
  id: string;
7
+ /**
8
+ * The quantity of the item that is to be returned.
9
+ */
4
10
  quantity: number;
11
+ /**
12
+ * The quantity of the item that has been received.
13
+ */
5
14
  received_quantity: number;
15
+ /**
16
+ * The quantity of the item that has been received and is damaged.
17
+ * This quantity is not added back to the quantity in the stock location.
18
+ */
6
19
  damaged_quantity: number;
20
+ /**
21
+ * The ID of the associated return reason.
22
+ */
7
23
  reason_id?: string;
24
+ /**
25
+ * A note to describe why the item is being returned.
26
+ */
8
27
  note?: string;
28
+ /**
29
+ * The ID of the order item that is being returned.
30
+ */
9
31
  item_id: string;
32
+ /**
33
+ * The ID of the return that the item belongs to.
34
+ */
10
35
  return_id: string;
36
+ /**
37
+ * Custom key-value pairs that can be added to the return item.
38
+ */
11
39
  metadata?: Record<string, unknown>;
12
40
  }
13
41
  export interface BaseReturn {
42
+ /**
43
+ * The return's ID.
44
+ */
14
45
  id: string;
46
+ /**
47
+ * The ID of the order that the return belongs to.
48
+ */
15
49
  order_id: string;
50
+ /**
51
+ * The return's status.
52
+ */
16
53
  status?: ReturnStatus;
54
+ /**
55
+ * The ID of the exchange that the return belongs to,
56
+ * if available.
57
+ */
17
58
  exchange_id?: string;
59
+ /**
60
+ * The ID of the stock location that the items are returned to.
61
+ */
18
62
  location_id?: string;
63
+ /**
64
+ * The ID of the claim that the return belongs to,
65
+ * if available.
66
+ */
19
67
  claim_id?: string;
68
+ /**
69
+ * The order's version once the return is applied.
70
+ */
20
71
  order_version: number;
72
+ /**
73
+ * The display ID of the return.
74
+ */
21
75
  display_id: number;
76
+ /**
77
+ * Whether to send the customers notifications about
78
+ * return updates.
79
+ */
22
80
  no_notification?: boolean;
81
+ /**
82
+ * The amount that is to be refunded to the customer.
83
+ */
23
84
  refund_amount?: number;
85
+ /**
86
+ * The return's items.
87
+ */
24
88
  items: BaseReturnItem[];
89
+ /**
90
+ * The date when the return was received.
91
+ */
25
92
  received_at: string;
93
+ /**
94
+ * The date when the return was created.
95
+ */
26
96
  created_at: string;
97
+ /**
98
+ * The date when the return was canceled.
99
+ */
27
100
  canceled_at: string;
28
101
  }
29
102
  //# sourceMappingURL=common.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/return/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;CACpB"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/return/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB"}
@@ -1,10 +1,31 @@
1
1
  type AdminBaseReturnReasonPayload = {
2
+ /**
3
+ * The return reason's value.
4
+ *
5
+ * @example
6
+ * "refund"
7
+ */
2
8
  value: string;
9
+ /**
10
+ * The return reason's label.
11
+ *
12
+ * @example
13
+ * "Refund"
14
+ */
3
15
  label: string;
16
+ /**
17
+ * The return reason's description.
18
+ */
4
19
  description?: string;
20
+ /**
21
+ * Custom key-value pairs that can be added to the return reason.
22
+ */
5
23
  metadata?: Record<string, unknown> | null;
6
24
  };
7
25
  export interface AdminCreateReturnReason extends AdminBaseReturnReasonPayload {
26
+ /**
27
+ * The ID of the return reason's parent.
28
+ */
8
29
  parent_return_reason_id?: string;
9
30
  }
10
31
  export interface AdminUpdateReturnReason extends AdminBaseReturnReasonPayload {
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/payloads.ts"],"names":[],"mappings":"AAAA,KAAK,4BAA4B,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C,CAAA;AAED,MAAM,WAAW,uBAAwB,SAAQ,4BAA4B;IAC3E,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,uBAAwB,SAAQ,4BAA4B;CAAG"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/payloads.ts"],"names":[],"mappings":"AAAA,KAAK,4BAA4B,GAAG;IAClC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C,CAAA;AAED,MAAM,WAAW,uBAAwB,SAAQ,4BAA4B;IAC3E;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,uBAAwB,SAAQ,4BAA4B;CAAG"}