@medusajs/types 2.0.0-rc-20241018141633 → 2.0.0-rc-20241022152047

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. package/dist/api-key/common/api-key.d.ts +8 -0
  2. package/dist/api-key/common/api-key.d.ts.map +1 -1
  3. package/dist/common/common.d.ts +10 -2
  4. package/dist/common/common.d.ts.map +1 -1
  5. package/dist/common/config-module.d.ts +19 -0
  6. package/dist/common/config-module.d.ts.map +1 -1
  7. package/dist/http/api-key/admin/payloads.d.ts +9 -0
  8. package/dist/http/api-key/admin/payloads.d.ts.map +1 -1
  9. package/dist/http/api-key/admin/queries.d.ts +27 -2
  10. package/dist/http/api-key/admin/queries.d.ts.map +1 -1
  11. package/dist/http/api-key/admin/responses.d.ts +45 -0
  12. package/dist/http/api-key/admin/responses.d.ts.map +1 -1
  13. package/dist/http/campaign/admin/payloads.d.ts +74 -0
  14. package/dist/http/campaign/admin/payloads.d.ts.map +1 -1
  15. package/dist/http/campaign/admin/responses.d.ts +54 -0
  16. package/dist/http/campaign/admin/responses.d.ts.map +1 -1
  17. package/dist/http/cart/store/entities.d.ts +39 -0
  18. package/dist/http/cart/store/entities.d.ts.map +1 -1
  19. package/dist/http/cart/store/payloads.d.ts +74 -0
  20. package/dist/http/cart/store/payloads.d.ts.map +1 -1
  21. package/dist/http/cart/store/responses.d.ts +28 -0
  22. package/dist/http/cart/store/responses.d.ts.map +1 -1
  23. package/dist/http/claim/admin/entities.d.ts +9 -0
  24. package/dist/http/claim/admin/entities.d.ts.map +1 -1
  25. package/dist/http/claim/admin/payloads.d.ts +71 -0
  26. package/dist/http/claim/admin/payloads.d.ts.map +1 -1
  27. package/dist/http/claim/admin/queries.d.ts +0 -1
  28. package/dist/http/claim/admin/queries.d.ts.map +1 -1
  29. package/dist/http/claim/admin/responses.d.ts +24 -0
  30. package/dist/http/claim/admin/responses.d.ts.map +1 -1
  31. package/dist/http/claim/common.d.ts +81 -0
  32. package/dist/http/claim/common.d.ts.map +1 -1
  33. package/dist/http/collection/common.d.ts +44 -2
  34. package/dist/http/collection/common.d.ts.map +1 -1
  35. package/dist/http/collection/store/entities.d.ts +3 -0
  36. package/dist/http/collection/store/entities.d.ts.map +1 -1
  37. package/dist/http/collection/store/queries.d.ts +0 -2
  38. package/dist/http/collection/store/queries.d.ts.map +1 -1
  39. package/dist/http/collection/store/responses.d.ts +6 -0
  40. package/dist/http/collection/store/responses.d.ts.map +1 -1
  41. package/dist/http/common/request.d.ts +23 -0
  42. package/dist/http/common/request.d.ts.map +1 -1
  43. package/dist/http/common/response.d.ts +9 -0
  44. package/dist/http/common/response.d.ts.map +1 -1
  45. package/dist/http/currency/admin/queries.d.ts +6 -0
  46. package/dist/http/currency/admin/queries.d.ts.map +1 -1
  47. package/dist/http/currency/admin/responses.d.ts +6 -0
  48. package/dist/http/currency/admin/responses.d.ts.map +1 -1
  49. package/dist/http/currency/common.d.ts +36 -0
  50. package/dist/http/currency/common.d.ts.map +1 -1
  51. package/dist/http/customer/admin/entities.d.ts +9 -0
  52. package/dist/http/customer/admin/entities.d.ts.map +1 -1
  53. package/dist/http/customer/admin/queries.d.ts +6 -0
  54. package/dist/http/customer/admin/queries.d.ts.map +1 -1
  55. package/dist/http/customer/admin/responses.d.ts +6 -0
  56. package/dist/http/customer/admin/responses.d.ts.map +1 -1
  57. package/dist/http/customer/common.d.ts +285 -0
  58. package/dist/http/customer/common.d.ts.map +1 -1
  59. package/dist/http/customer/store/entities.d.ts +3 -0
  60. package/dist/http/customer/store/entities.d.ts.map +1 -1
  61. package/dist/http/customer/store/responses.d.ts +9 -0
  62. package/dist/http/customer/store/responses.d.ts.map +1 -1
  63. package/dist/http/customer-group/admin/entities.d.ts +3 -0
  64. package/dist/http/customer-group/admin/entities.d.ts.map +1 -1
  65. package/dist/http/customer-group/admin/payloads.d.ts +12 -0
  66. package/dist/http/customer-group/admin/payloads.d.ts.map +1 -1
  67. package/dist/http/customer-group/admin/queries.d.ts +59 -4
  68. package/dist/http/customer-group/admin/queries.d.ts.map +1 -1
  69. package/dist/http/customer-group/admin/responses.d.ts +6 -0
  70. package/dist/http/customer-group/admin/responses.d.ts.map +1 -1
  71. package/dist/http/customer-group/common.d.ts +18 -0
  72. package/dist/http/customer-group/common.d.ts.map +1 -1
  73. package/dist/http/exchange/admin/payloads.d.ts +71 -5
  74. package/dist/http/exchange/admin/payloads.d.ts.map +1 -1
  75. package/dist/http/exchange/admin/queries.d.ts +3 -6
  76. package/dist/http/exchange/admin/queries.d.ts.map +1 -1
  77. package/dist/http/exchange/admin/responses.d.ts +21 -0
  78. package/dist/http/exchange/admin/responses.d.ts.map +1 -1
  79. package/dist/http/exchange/common.d.ts +109 -0
  80. package/dist/http/exchange/common.d.ts.map +1 -1
  81. package/dist/http/fulfillment/admin/entitites.d.ts +139 -0
  82. package/dist/http/fulfillment/admin/entitites.d.ts.map +1 -1
  83. package/dist/http/fulfillment/admin/payloads.d.ts +113 -1
  84. package/dist/http/fulfillment/admin/payloads.d.ts.map +1 -1
  85. package/dist/http/fulfillment/admin/responses.d.ts +3 -0
  86. package/dist/http/fulfillment/admin/responses.d.ts.map +1 -1
  87. package/dist/http/fulfillment/store/index.d.ts +54 -1
  88. package/dist/http/fulfillment/store/index.d.ts.map +1 -1
  89. package/dist/http/fulfillment-provider/admin/queries.d.ts +13 -0
  90. package/dist/http/fulfillment-provider/admin/queries.d.ts.map +1 -1
  91. package/dist/http/fulfillment-provider/admin/responses.d.ts +3 -0
  92. package/dist/http/fulfillment-provider/admin/responses.d.ts.map +1 -1
  93. package/dist/http/fulfillment-provider/common.d.ts +6 -0
  94. package/dist/http/fulfillment-provider/common.d.ts.map +1 -1
  95. package/dist/http/fulfillment-set/admin/entities.d.ts +84 -0
  96. package/dist/http/fulfillment-set/admin/entities.d.ts.map +1 -1
  97. package/dist/http/fulfillment-set/admin/payloads.d.ts +66 -0
  98. package/dist/http/fulfillment-set/admin/payloads.d.ts.map +1 -1
  99. package/dist/http/fulfillment-set/admin/responses.d.ts +6 -0
  100. package/dist/http/fulfillment-set/admin/responses.d.ts.map +1 -1
  101. package/dist/http/inventory/admin/entities.d.ts +84 -0
  102. package/dist/http/inventory/admin/entities.d.ts.map +1 -1
  103. package/dist/http/inventory/admin/payloads.d.ts +42 -0
  104. package/dist/http/inventory/admin/payloads.d.ts.map +1 -1
  105. package/dist/http/inventory/admin/queries.d.ts +40 -0
  106. package/dist/http/inventory/admin/queries.d.ts.map +1 -1
  107. package/dist/http/inventory/admin/responses.d.ts +6 -0
  108. package/dist/http/inventory/admin/responses.d.ts.map +1 -1
  109. package/dist/http/inventory-level/admin/entities.d.ts +28 -0
  110. package/dist/http/inventory-level/admin/entities.d.ts.map +1 -1
  111. package/dist/http/inventory-level/admin/payloads.d.ts +30 -0
  112. package/dist/http/inventory-level/admin/payloads.d.ts.map +1 -1
  113. package/dist/http/inventory-level/admin/queries.d.ts +4 -0
  114. package/dist/http/inventory-level/admin/queries.d.ts.map +1 -1
  115. package/dist/http/inventory-level/admin/responses.d.ts +6 -0
  116. package/dist/http/inventory-level/admin/responses.d.ts.map +1 -1
  117. package/dist/http/invite/admin/entities.d.ts +24 -0
  118. package/dist/http/invite/admin/entities.d.ts.map +1 -1
  119. package/dist/http/invite/admin/payloads.d.ts +16 -0
  120. package/dist/http/invite/admin/payloads.d.ts.map +1 -1
  121. package/dist/http/invite/admin/responses.d.ts +12 -0
  122. package/dist/http/invite/admin/responses.d.ts.map +1 -1
  123. package/dist/http/order/admin/entities.d.ts +45 -0
  124. package/dist/http/order/admin/entities.d.ts.map +1 -1
  125. package/dist/http/order/admin/queries.d.ts +6 -0
  126. package/dist/http/order/admin/queries.d.ts.map +1 -1
  127. package/dist/http/order/common.d.ts +630 -0
  128. package/dist/http/order/common.d.ts.map +1 -1
  129. package/dist/http/order/store/entities.d.ts +39 -0
  130. package/dist/http/order/store/entities.d.ts.map +1 -1
  131. package/dist/http/order/store/queries.d.ts +6 -0
  132. package/dist/http/order/store/queries.d.ts.map +1 -1
  133. package/dist/http/order/store/responses.d.ts +6 -0
  134. package/dist/http/order/store/responses.d.ts.map +1 -1
  135. package/dist/http/payment/common.d.ts +3 -0
  136. package/dist/http/payment/common.d.ts.map +1 -1
  137. package/dist/http/payment/store/entities.d.ts +9 -0
  138. package/dist/http/payment/store/entities.d.ts.map +1 -1
  139. package/dist/http/payment/store/payloads.d.ts +18 -0
  140. package/dist/http/payment/store/payloads.d.ts.map +1 -1
  141. package/dist/http/payment/store/queries.d.ts +3 -0
  142. package/dist/http/payment/store/queries.d.ts.map +1 -1
  143. package/dist/http/payment/store/responses.d.ts +6 -0
  144. package/dist/http/payment/store/responses.d.ts.map +1 -1
  145. package/dist/http/product/admin/payloads.d.ts +2 -0
  146. package/dist/http/product/admin/payloads.d.ts.map +1 -1
  147. package/dist/http/product/common.d.ts +268 -0
  148. package/dist/http/product/common.d.ts.map +1 -1
  149. package/dist/http/product/store/entitites.d.ts +36 -0
  150. package/dist/http/product/store/entitites.d.ts.map +1 -1
  151. package/dist/http/product/store/queries.d.ts +19 -1
  152. package/dist/http/product/store/queries.d.ts.map +1 -1
  153. package/dist/http/product/store/responses.d.ts +6 -0
  154. package/dist/http/product/store/responses.d.ts.map +1 -1
  155. package/dist/http/product-category/common.d.ts +94 -0
  156. package/dist/http/product-category/common.d.ts.map +1 -1
  157. package/dist/http/product-category/store/entities.d.ts +9 -0
  158. package/dist/http/product-category/store/entities.d.ts.map +1 -1
  159. package/dist/http/product-category/store/queries.d.ts +1 -1
  160. package/dist/http/product-category/store/queries.d.ts.map +1 -1
  161. package/dist/http/product-category/store/responses.d.ts +6 -0
  162. package/dist/http/product-category/store/responses.d.ts.map +1 -1
  163. package/dist/http/promotion/common.d.ts +3 -0
  164. package/dist/http/promotion/common.d.ts.map +1 -1
  165. package/dist/http/region/common.d.ts +69 -0
  166. package/dist/http/region/common.d.ts.map +1 -1
  167. package/dist/http/region/store/responses.d.ts +6 -0
  168. package/dist/http/region/store/responses.d.ts.map +1 -1
  169. package/dist/http/shipping-option/store/queries.d.ts +8 -0
  170. package/dist/http/shipping-option/store/queries.d.ts.map +1 -1
  171. package/dist/http/shipping-option/store/responses.d.ts +2 -2
  172. package/dist/http/shipping-option/store/responses.d.ts.map +1 -1
  173. package/dist/product/common.d.ts +8 -0
  174. package/dist/product/common.d.ts.map +1 -1
  175. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gBAAgB,CAAC,EAAE,eAAe,CAAA;IAClC,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gBAAgB,CAAC,EAAE,eAAe,GAAG,MAAM,CAAA;IAC3C,eAAe,CAAC,EAAE,eAAe,GAAG,MAAM,CAAA;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,CAAA;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,GAAG,MAAM,CAAA;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,GAAG,MAAM,CAAA;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
@@ -2,18 +2,46 @@ import { DeleteResponseWithParent } from "../../common";
2
2
  import { StoreOrder } from "../../order";
3
3
  import { StoreCart } from "./entities";
4
4
  export interface StoreCartResponse {
5
+ /**
6
+ * The cart's details.
7
+ */
5
8
  cart: StoreCart;
6
9
  }
7
10
  export type StoreCompleteCartResponse = {
11
+ /**
12
+ * The response's type. If `cart`, then an error has occurred.
13
+ */
8
14
  type: "cart";
15
+ /**
16
+ * The cart's details.
17
+ */
9
18
  cart: StoreCart;
19
+ /**
20
+ * The error that occurred while completing the cart.
21
+ */
10
22
  error: {
23
+ /**
24
+ * The error message.
25
+ */
11
26
  message: string;
27
+ /**
28
+ * The error name.
29
+ */
12
30
  name: string;
31
+ /**
32
+ * The error type.
33
+ */
13
34
  type: string;
14
35
  };
15
36
  } | {
37
+ /**
38
+ * The response's type. If `order`, then the cart
39
+ * was completed and an order was placed.
40
+ */
16
41
  type: "order";
42
+ /**
43
+ * The order's details.
44
+ */
17
45
  order: StoreOrder;
18
46
  };
19
47
  export type StoreLineItemDeleteResponse = DeleteResponseWithParent<"line-item", StoreCart>;
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,MAAM,yBAAyB,GACjC;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,EAAE;QACL,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,GACD;IACE,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,UAAU,CAAA;CAClB,CAAA;AAEL,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,CAChE,WAAW,EACX,SAAS,CACV,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,MAAM,yBAAyB,GACjC;IACA;;OAEG;IACD,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;IACf;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,GACD;IACA;;;OAGG;IACD,IAAI,EAAE,OAAO,CAAA;IACb;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB,CAAA;AAEL,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,CAChE,WAAW,EACX,SAAS,CACV,CAAA"}
@@ -2,8 +2,17 @@ import { AdminOrder, AdminOrderShippingMethod } from "../../order";
2
2
  import { AdminReturn } from "../../return";
3
3
  import { BaseClaim } from "../common";
4
4
  export interface AdminClaim extends BaseClaim {
5
+ /**
6
+ * The order this claim is created for.
7
+ */
5
8
  order: AdminOrder;
9
+ /**
10
+ * The associated return.
11
+ */
6
12
  return: AdminReturn;
13
+ /**
14
+ * The shipping methods of the claim's additional items.
15
+ */
7
16
  shipping_methods?: AdminOrderShippingMethod[];
8
17
  }
9
18
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,UAAU,CAAA;IACjB,MAAM,EAAE,WAAW,CAAA;IACnB,gBAAgB,CAAC,EAAE,wBAAwB,EAAE,CAAA;CAC9C"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;IACjB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,EAAE,CAAA;CAC9C"}
@@ -5,37 +5,108 @@ declare enum ClaimReason {
5
5
  OTHER = "other"
6
6
  }
7
7
  interface AdminClaimAddItems {
8
+ /**
9
+ * The items to add to the claim.
10
+ */
8
11
  items: {
12
+ /**
13
+ * The ID of the item in the order.
14
+ */
9
15
  id: string;
16
+ /**
17
+ * The quantity to claim.
18
+ */
10
19
  quantity: number;
20
+ /**
21
+ * The reason for adding this item to the claim.
22
+ */
11
23
  reason?: ClaimReason;
24
+ /**
25
+ * The claim item's description.
26
+ */
12
27
  description?: string;
28
+ /**
29
+ * An internal note viewed by admin users only.
30
+ */
13
31
  internal_note?: string;
14
32
  }[];
15
33
  }
16
34
  interface AdminClaimUpdateItem {
35
+ /**
36
+ * The item's claimed quantity.
37
+ */
17
38
  quantity?: number;
39
+ /**
40
+ * The ID of the associated claim reason.
41
+ */
18
42
  reason_id?: string | null;
43
+ /**
44
+ * The claim item's description.
45
+ */
19
46
  description?: string;
47
+ /**
48
+ * An internal note viewed by admin users only.
49
+ */
20
50
  internal_note?: string | null;
21
51
  }
22
52
  interface AdminClaimAddShippingMethod {
53
+ /**
54
+ * The ID of the shipping option to create the method from.
55
+ */
23
56
  shipping_option_id: string;
57
+ /**
58
+ * A custom amount to use instead of the shipping option's amount.
59
+ */
24
60
  custom_amount?: number;
61
+ /**
62
+ * The method's description.
63
+ */
25
64
  description?: string;
65
+ /**
66
+ * An internal note viewed by admin users only.
67
+ */
26
68
  internal_note?: string;
69
+ /**
70
+ * Key-value pairs of custom data.
71
+ */
27
72
  metadata?: Record<string, unknown> | null;
28
73
  }
29
74
  interface AdminClaimUpdateShippingMethod {
75
+ /**
76
+ * A custom amount to use instead of the shipping option's amount.
77
+ */
30
78
  custom_amount?: number | null;
79
+ /**
80
+ * An internal note viewed by admin users only.
81
+ */
31
82
  internal_note?: string;
83
+ /**
84
+ * Key-value pairs of custom data.
85
+ */
32
86
  metadata?: Record<string, unknown> | null;
33
87
  }
34
88
  export interface AdminCreateClaim {
89
+ /**
90
+ * The claim's type. If `refund`, it means the claim's items
91
+ * are returned and the customer is refunded. If `replace`, it
92
+ * means the merchant will send new items in place of the returned items.
93
+ */
35
94
  type: "refund" | "replace";
95
+ /**
96
+ * The ID of the order this claim is created for.
97
+ */
36
98
  order_id: string;
99
+ /**
100
+ * The claim's description.
101
+ */
37
102
  description?: string;
103
+ /**
104
+ * An internal note viewed by admin users only.
105
+ */
38
106
  internal_note?: string;
107
+ /**
108
+ * Key-value pairs of custom data.
109
+ */
39
110
  metadata?: Record<string, unknown> | null;
40
111
  }
41
112
  export interface AdminAddClaimItems extends AdminClaimAddItems {
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/payloads.ts"],"names":[],"mappings":"AAAA,aAAK,WAAW;IACd,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,KAAK,UAAU;CAChB;AAED,UAAU,kBAAkB;IAC1B,KAAK,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,UAAU,oBAAoB;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,UAAU,2BAA2B;IACnC,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,GAAG,IAAI,CAAA;CAC1C;AAED,UAAU,8BAA8B;IACtC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B,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,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;CAAG;AACjE,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;CAAG;AAErE,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AACxE,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;CAAG;AAE5E,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;CAAG;AACzE,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;CAAG;AAE7E,MAAM,WAAW,4BACf,SAAQ,2BAA2B;CAAG;AACxC,MAAM,WAAW,+BACf,SAAQ,8BAA8B;CAAG;AAE3C,MAAM,WAAW,6BACf,SAAQ,2BAA2B;CAAG;AACxC,MAAM,WAAW,gCACf,SAAQ,8BAA8B;CAAG;AAE3C,MAAM,WAAW,iBAAiB;CAEjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/payloads.ts"],"names":[],"mappings":"AAAA,aAAK,WAAW;IACd,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,KAAK,UAAU;CAChB;AAED,UAAU,kBAAkB;IAC1B;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;WAEG;QACH,MAAM,CAAC,EAAE,WAAW,CAAA;QACpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,UAAU,oBAAoB;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,UAAU,2BAA2B;IACnC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,UAAU,8BAA8B;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;CAAG;AACjE,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;CAAG;AAErE,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;CAAG;AACxE,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;CAAG;AAE5E,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;CAAG;AACzE,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;CAAG;AAE7E,MAAM,WAAW,4BACf,SAAQ,2BAA2B;CAAG;AACxC,MAAM,WAAW,+BACf,SAAQ,8BAA8B;CAAG;AAE3C,MAAM,WAAW,6BACf,SAAQ,2BAA2B;CAAG;AACxC,MAAM,WAAW,gCACf,SAAQ,8BAA8B;CAAG;AAE3C,MAAM,WAAW,iBAAiB;CAEjC;AAED,MAAM,WAAW,gBAAgB;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B"}
@@ -2,7 +2,6 @@ import { BaseFilterable, OperatorMap } from "../../../dal";
2
2
  import { SelectParams } from "../../common";
3
3
  import { BaseClaimListParams } from "../common";
4
4
  export interface AdminClaimListParams extends BaseClaimListParams, BaseFilterable<AdminClaimListParams> {
5
- deleted_at?: OperatorMap<string>;
6
5
  }
7
6
  export interface AdminClaimParams extends SelectParams {
8
7
  id?: string | string[];
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE/C,MAAM,WAAW,oBACf,SAAQ,mBAAmB,EACzB,cAAc,CAAC,oBAAoB,CAAC;IACtC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE/C,MAAM,WAAW,oBACf,SAAQ,mBAAmB,EACzB,cAAc,CAAC,oBAAoB,CAAC;CAAI;AAE5C,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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"}
@@ -4,22 +4,46 @@ import { AdminOrderPreview } from "../../order";
4
4
  import { AdminReturn } from "../../return";
5
5
  import { AdminClaim } from "./entities";
6
6
  export interface AdminClaimResponse {
7
+ /**
8
+ * The claim's details.
9
+ */
7
10
  claim: AdminClaim;
8
11
  }
9
12
  export interface AdminClaimListResponse extends PaginatedResponse<{
13
+ /**
14
+ * The list of claims.
15
+ */
10
16
  claims: AdminClaim[];
11
17
  }> {
12
18
  }
13
19
  export interface AdminClaimOrderResponse {
20
+ /**
21
+ * The order's details.
22
+ */
14
23
  order: OrderDTO;
24
+ /**
25
+ * The claim's details.
26
+ */
15
27
  claim: AdminClaim;
16
28
  }
17
29
  export interface AdminClaimPreviewResponse {
30
+ /**
31
+ * Preview of the order when the claim is applied.
32
+ */
18
33
  order_preview: AdminOrderPreview;
34
+ /**
35
+ * The claim's details.
36
+ */
19
37
  claim: AdminClaim;
20
38
  }
21
39
  export interface AdminClaimReturnPreviewResponse {
40
+ /**
41
+ * Preview of the order when the claim is applied.
42
+ */
22
43
  order_preview: AdminOrderPreview;
44
+ /**
45
+ * The return's details.
46
+ */
23
47
  return: AdminReturn;
24
48
  }
25
49
  export interface AdminClaimRequestResponse extends AdminClaimPreviewResponse {
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/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,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,sBACf,SAAQ,iBAAiB,CAAC;IACxB,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAC;CAAG;AAEP,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,QAAQ,CAAA;IACf,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,iBAAiB,CAAA;IAChC,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,iBAAiB,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,wBAAyB,SAAQ,cAAc,CAAC,OAAO,CAAC;CAAG"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/claim/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,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,sBACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAC;CAAG;AAEP,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;IAChC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;IAChC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,wBAAyB,SAAQ,cAAc,CAAC,OAAO,CAAC;CAAG"}
@@ -17,34 +17,115 @@ export interface BaseClaimItem {
17
17
  updated_at?: Date | string;
18
18
  }
19
19
  export interface BaseClaim {
20
+ /**
21
+ * The claim's ID.
22
+ */
20
23
  id: string;
24
+ /**
25
+ * The claim's type.
26
+ */
21
27
  type: OrderClaimType;
28
+ /**
29
+ * The ID of the order this claim was created for.
30
+ */
22
31
  order_id: string;
32
+ /**
33
+ * The ID of the associated return.
34
+ */
23
35
  return_id?: string;
36
+ /**
37
+ * The claim's display ID.
38
+ */
24
39
  display_id: number;
40
+ /**
41
+ * The version of the order when the claim is applied.
42
+ */
25
43
  order_version: string;
44
+ /**
45
+ * The amount to be refunded due to this claim.
46
+ */
26
47
  refund_amount?: number;
48
+ /**
49
+ * The ID of the user that created this claim.
50
+ */
27
51
  created_by?: string;
52
+ /**
53
+ * The date the claim was created.
54
+ */
28
55
  created_at: Date | string;
56
+ /**
57
+ * The date the claim was updated.
58
+ */
29
59
  updated_at: Date | string;
60
+ /**
61
+ * The date the claim was canceled.
62
+ */
30
63
  canceled_at: Date | string;
64
+ /**
65
+ * The date the claim was deleted.
66
+ */
31
67
  deleted_at?: Date | string;
68
+ /**
69
+ * The claim's additional items if its `type` is `replace`.
70
+ */
32
71
  additional_items: BaseClaimItem[];
72
+ /**
73
+ * The claim's items.
74
+ */
33
75
  claim_items: BaseClaimItem[];
76
+ /**
77
+ * Whether to notify the customer about changes in the claim.
78
+ */
34
79
  no_notification?: boolean;
80
+ /**
81
+ * The order this claim was created for.
82
+ */
35
83
  order?: BaseOrder;
84
+ /**
85
+ * The associated return.
86
+ */
36
87
  return?: BaseReturn;
88
+ /**
89
+ * The shipping methods of the claim's additional items.
90
+ */
37
91
  shipping_methods?: BaseOrderShippingMethod[];
92
+ /**
93
+ * The claim's transactions.
94
+ */
38
95
  transactions?: BaseOrderTransaction[];
96
+ /**
97
+ * Key-value pairs of custom data.
98
+ */
39
99
  metadata?: Record<string, unknown> | null;
40
100
  }
41
101
  export interface BaseClaimListParams extends FindParams {
102
+ /**
103
+ * Query or keywords to search the claim's searchable fields.
104
+ */
42
105
  q?: string;
106
+ /**
107
+ * Filter by ID(s).
108
+ */
43
109
  id?: string | string[];
110
+ /**
111
+ * Retrieve the claims of the specified order ID(s).
112
+ */
44
113
  order_id?: string | string[];
114
+ /**
115
+ * Filter by status(es).
116
+ */
45
117
  status?: string | string[];
118
+ /**
119
+ * Filter by the claim's creation date.
120
+ */
46
121
  created_at?: OperatorMap<string>;
122
+ /**
123
+ * Filter by the claim's update date.
124
+ */
47
125
  updated_at?: OperatorMap<string>;
126
+ /**
127
+ * Filter by the claim's deletion date.
128
+ */
48
129
  deleted_at?: OperatorMap<string>;
49
130
  }
50
131
  //# sourceMappingURL=common.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/claim/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,WAAW,CAAA;IACnB,YAAY,EAAE,iBAAiB,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,WAAW,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,gBAAgB,EAAE,aAAa,EAAE,CAAA;IACjC,WAAW,EAAE,aAAa,EAAE,CAAA;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/claim/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,WAAW,CAAA;IACnB,YAAY,EAAE,iBAAiB,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,cAAc,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,gBAAgB,EAAE,aAAa,EAAE,CAAA;IACjC;;OAEG;IACH,WAAW,EAAE,aAAa,EAAE,CAAA;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;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"}
@@ -1,24 +1,66 @@
1
1
  import { BaseFilterable, OperatorMap } from "../../dal";
2
2
  import { FindParams, SelectParams } from "../common";
3
- import { AdminProduct } from "../product";
3
+ import { BaseProduct } from "../product/common";
4
4
  export interface BaseCollection {
5
+ /**
6
+ * The collection's ID.
7
+ */
5
8
  id: string;
9
+ /**
10
+ * The collection's title.
11
+ */
6
12
  title: string;
13
+ /**
14
+ * The collection's handle.
15
+ */
7
16
  handle: string;
17
+ /**
18
+ * The date the collection was created.
19
+ */
8
20
  created_at: string;
21
+ /**
22
+ * The date the collection was updated.
23
+ */
9
24
  updated_at: string;
25
+ /**
26
+ * The date the collection was deleted.
27
+ */
10
28
  deleted_at: string | null;
11
- products?: AdminProduct[];
29
+ /**
30
+ * The collection's products.
31
+ */
32
+ products?: BaseProduct[];
33
+ /**
34
+ * Key-value pairs of custom data.
35
+ */
12
36
  metadata: Record<string, unknown> | null;
13
37
  }
14
38
  export interface BaseCollectionParams extends SelectParams {
15
39
  }
16
40
  export interface BaseCollectionListParams extends FindParams, BaseFilterable<BaseCollectionListParams> {
41
+ /**
42
+ * A query or keywords to search the collection's searchable fields by.
43
+ */
17
44
  q?: string;
45
+ /**
46
+ * Filter by collection ID(s).
47
+ */
18
48
  id?: string | string[];
49
+ /**
50
+ * Filter by collection handle(s).
51
+ */
19
52
  handle?: string | string[];
53
+ /**
54
+ * Filter by collection title(s).
55
+ */
20
56
  title?: string | string[];
57
+ /**
58
+ * Apply filters on collection creation dates.
59
+ */
21
60
  created_at?: OperatorMap<string>;
61
+ /**
62
+ * Apply filters on collection update dates.
63
+ */
22
64
  updated_at?: OperatorMap<string>;
23
65
  }
24
66
  //# sourceMappingURL=common.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/collection/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAEzC,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG;AAE7D,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/collection/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG;AAE7D,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
@@ -1,6 +1,9 @@
1
1
  import { StoreProduct } from "../../product";
2
2
  import { BaseCollection } from "../common";
3
3
  export interface StoreCollection extends Omit<BaseCollection, "products"> {
4
+ /**
5
+ * The collection's products.
6
+ */
4
7
  products?: StoreProduct[];
5
8
  }
6
9
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC;IACvE,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC;IACvE;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B"}
@@ -1,6 +1,4 @@
1
- import { OperatorMap } from "../../../dal";
2
1
  import { BaseCollectionListParams } from "../common";
3
2
  export interface StoreCollectionFilters extends Omit<BaseCollectionListParams, "id"> {
4
- deleted_at?: OperatorMap<string>;
5
3
  }
6
4
  //# sourceMappingURL=queries.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAEpD,MAAM,WAAW,sBACf,SAAQ,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC;IAC5C,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAEpD,MAAM,WAAW,sBACf,SAAQ,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC;CAC7C"}
@@ -1,9 +1,15 @@
1
1
  import { StoreCollection } from ".";
2
2
  import { PaginatedResponse } from "../../common";
3
3
  export interface StoreCollectionResponse {
4
+ /**
5
+ * The collection's details.
6
+ */
4
7
  collection: StoreCollection;
5
8
  }
6
9
  export type StoreCollectionListResponse = PaginatedResponse<{
10
+ /**
11
+ * The paginated list of collections.
12
+ */
7
13
  collections: StoreCollection[];
8
14
  }>;
9
15
  //# sourceMappingURL=responses.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;IAC1D,WAAW,EAAE,eAAe,EAAE,CAAA;CAC/B,CAAC,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;IAC1D;;OAEG;IACH,WAAW,EAAE,eAAe,EAAE,CAAA;CAC/B,CAAC,CAAA"}
@@ -1,13 +1,36 @@
1
1
  export interface SelectParams {
2
+ /**
3
+ * The fields and relations to retrieve.
4
+ *
5
+ * Learn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
6
+ */
2
7
  fields?: string;
3
8
  }
4
9
  export interface FindParams extends SelectParams {
10
+ /**
11
+ * The maximum number of items to retrieve.
12
+ */
5
13
  limit?: number;
14
+ /**
15
+ * The number of items to skip before retrieving the returned items.
16
+ */
6
17
  offset?: number;
18
+ /**
19
+ * The field to sort by and in which order.
20
+ *
21
+ * @example
22
+ * -created_at
23
+ */
7
24
  order?: string;
8
25
  }
9
26
  export interface AdminBatchLink {
27
+ /**
28
+ * The items to create an association to.
29
+ */
10
30
  add?: string[];
31
+ /**
32
+ * The items to remove association from.
33
+ */
11
34
  remove?: string[];
12
35
  }
13
36
  //# sourceMappingURL=request.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
1
+ {"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
@@ -19,8 +19,17 @@ export type DeleteResponseWithParent<TObject extends string, TParent = {}> = Del
19
19
  parent?: TParent;
20
20
  };
21
21
  export type PaginatedResponse<T> = {
22
+ /**
23
+ * The maximum number of items retrieved.
24
+ */
22
25
  limit: number;
26
+ /**
27
+ * The number of items to skip before retrieving the returned items.
28
+ */
23
29
  offset: number;
30
+ /**
31
+ * The total number of items.
32
+ */
24
33
  count: number;
25
34
  } & T;
26
35
  export type BatchResponse<T> = {
@@ -1 +1 @@
1
- {"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../src/http/common/response.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,MAAM,IAAI;IACnD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,CAClC,OAAO,SAAS,MAAM,EACtB,OAAO,GAAG,EAAE,IACV,cAAc,CAAC,OAAO,CAAC,GAAG;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,GAAG,CAAC,CAAA;AAEL,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,EAAE,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,CAAA;KACjB,CAAA;CACF,CAAA"}
1
+ {"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../src/http/common/response.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,MAAM,IAAI;IACnD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,wBAAwB,CAClC,OAAO,SAAS,MAAM,EACtB,OAAO,GAAG,EAAE,IACV,cAAc,CAAC,OAAO,CAAC,GAAG;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GAAG,CAAC,CAAA;AAEL,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,EAAE,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,CAAA;KACjB,CAAA;CACF,CAAA"}
@@ -3,7 +3,13 @@ import { FindParams, SelectParams } from "../../common";
3
3
  export interface AdminCurrencyParams extends SelectParams {
4
4
  }
5
5
  export interface AdminCurrencyListParams extends FindParams, BaseFilterable<AdminCurrencyListParams> {
6
+ /**
7
+ * Query or keyword to search the currency's searchable fields.
8
+ */
6
9
  q?: string;
10
+ /**
11
+ * Filter by currency code(s).
12
+ */
7
13
  code?: string | string[];
8
14
  }
9
15
  //# sourceMappingURL=queries.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/currency/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;CAAG;AAE5D,MAAM,WAAW,uBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,uBAAuB,CAAC;IACzC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/currency/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;CAAG;AAE5D,MAAM,WAAW,uBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,uBAAuB,CAAC;IACzC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB"}
@@ -1,9 +1,15 @@
1
1
  import { PaginatedResponse } from "../../common";
2
2
  import { AdminCurrency } from "./entities";
3
3
  export interface AdminCurrencyResponse {
4
+ /**
5
+ * The currency's details.
6
+ */
4
7
  currency: AdminCurrency;
5
8
  }
6
9
  export interface AdminCurrencyListResponse extends PaginatedResponse<{
10
+ /**
11
+ * The list of currencies
12
+ */
7
13
  currencies: AdminCurrency[];
8
14
  }> {
9
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/currency/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,yBACf,SAAQ,iBAAiB,CAAC;IAAE,UAAU,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC;CAAG"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/currency/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,yBACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,aAAa,EAAE,CAAA;CAC5B,CAAC;CAAG"}