@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
@@ -40,6 +40,14 @@ export interface ApiKeyDTO {
40
40
  * The date the API key was created.
41
41
  */
42
42
  created_at: Date;
43
+ /**
44
+ * The date the API key was updated.
45
+ */
46
+ updated_at: Date;
47
+ /**
48
+ * The date the API key was deleted.
49
+ */
50
+ deleted_at: Date | null;
43
51
  /**
44
52
  * Who revoked the API key. For example,
45
53
  * the ID of the user that revoked it.
@@ -1 +1 @@
1
- {"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/common/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB,UAAU,CAAC,EAAE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;CACtC"}
1
+ {"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/common/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB,UAAU,CAAC,EAAE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;CACtC"}
@@ -211,14 +211,22 @@ export type RawRounding = {
211
211
  */
212
212
  export type QueryConfig<TEntity> = {
213
213
  /**
214
- * Default fields and relations to return
214
+ * Default fields and relations to return.
215
+ * use `*` or `.*` to select all fields from a relations (e.g '*products' or 'products.*' will select all products properties)
215
216
  */
216
217
  defaults?: (keyof TEntity | string)[];
217
218
  /**
218
- * Fields and relations that are allowed to be requested
219
+ * Fields and relations that are allowed to be requested.
220
+ * Symbol such as `*`, `+` and `-` should be removed as they dont make sense for
221
+ * the authorization search.
219
222
  */
220
223
  allowed?: string[];
221
224
  defaultLimit?: number;
225
+ /**
226
+ * If the route that will use that configuration is supposed to return a list of entities. This
227
+ * will change the configuration that will be created on req.listConfig and req.remoteQueryConfig (among
228
+ * other things it will include pagination and sorting)
229
+ */
222
230
  isList?: boolean;
223
231
  };
224
232
  export type TransformObjectMethodToAsync<T extends object> = {
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAA;AAEN;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAC1D,QAAQ,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;CAC/B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC7C,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU,CAAC,MAAM;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAA;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,CAAA;AAEzB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;CAAG;AAGpC,MAAM,WAAW,0BAA0B;CAAG;AAE9C;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,CAAA;IAET;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,CAAA;IAET;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,QAAQ,SAAS,MAAM,IAAI,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC5E,GAAG,QAAQ,IAAI,GACf,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,GAAG,GAC9B,GAAG,QAAQ,EAAE,GACb,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,GAAG,GAC9B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,QAAQ,EAAE,GACb,QAAQ,SACJ,GAAG,MAAM,CAAC,IAAI,GACd,GAAG,MAAM,CAAC,IAAI,GACd,GAAG,MAAM,CAAC,GAAG,GACb,GAAG,MAAM,CAAC,GAAG,GACb,GAAG,MAAM,CAAC,GAAG,GACjB,GAAG,QAAQ,IAAI,GACf,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,GAChD,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,MAAM,GACV,GAAG,QAAQ,GAAG,CAAA;AAElB,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IACpC,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GACtC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,GACpB,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GACrD,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAChC,CAAC,CAAA;AAEP,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IACpC,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GACtC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,GACpB,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GACrD,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAChC,CAAC,CAAA;AAEP,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,OAAO,IAAI;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAA;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,MAAM,IAAI;KAC1D,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACtD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACnC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClC,CAAC,CAAC,CAAC,CAAC;CACT,CAAA"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAA;AAEN;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAC1D,QAAQ,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;CAC/B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC7C,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU,CAAC,MAAM;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAA;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,gBAAgB,GAChB,WAAW,GACX,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,CAAA;AAEzB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;CAAG;AAGpC,MAAM,WAAW,0BAA0B;CAAG;AAE9C;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,CAAA;IAET;;OAEG;IACH,EAAE,CAAC,EAAE,IAAI,CAAA;IAET;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,QAAQ,SAAS,MAAM,IAAI,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC5E,GAAG,QAAQ,IAAI,GACf,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,GAAG,GAC9B,GAAG,QAAQ,EAAE,GACb,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,GAAG,GAC9B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,QAAQ,EAAE,GACb,QAAQ,SACJ,GAAG,MAAM,CAAC,IAAI,GACd,GAAG,MAAM,CAAC,IAAI,GACd,GAAG,MAAM,CAAC,GAAG,GACb,GAAG,MAAM,CAAC,GAAG,GACb,GAAG,MAAM,CAAC,GAAG,GACjB,GAAG,QAAQ,IAAI,GACf,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAC/B,GAAG,CAAC,KAAK,GACT,QAAQ,SAAS,GAAG,MAAM,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,IAAI,GAChD,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,MAAM,GACV,QAAQ,SAAS,GAAG,MAAM,CAAC,KAAK,GAChC,GAAG,CAAC,MAAM,GACV,GAAG,QAAQ,GAAG,CAAA;AAElB,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IACpC,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GACtC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,GACpB,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GACrD,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAChC,CAAC,CAAA;AAEP,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IACpC,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GACtC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,GACpB,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GACrD,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAChC,CAAC,CAAA;AAEP,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,OAAO,IAAI;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAA;IACrC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,MAAM,IAAI;KAC1D,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACtD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACnC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,4BAA4B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClC,CAAC,CAAC,CAAC,CAAC;CACT,CAAA"}
@@ -702,6 +702,25 @@ export type ProjectConfigOptions = {
702
702
  * ```
703
703
  */
704
704
  authMethodsPerActor?: Record<string, string[]>;
705
+ /**
706
+ * Specifies the fields that can't be selected in the response unless specified in the allowed query config.
707
+ * This is useful to restrict sensitive fields from being exposed in the API.
708
+ *
709
+ * @example
710
+ *
711
+ * ```js title="medusa-config.js"
712
+ * module.exports = defineConfig({
713
+ * projectConfig: {
714
+ * http: {
715
+ * restrictedFields: {
716
+ * store: ["order", "orders"],
717
+ * }
718
+ * }
719
+ * ```
720
+ */
721
+ restrictedFields?: {
722
+ store?: string[];
723
+ };
705
724
  };
706
725
  };
707
726
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAClB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE;gBACJ;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAA;aAC3B,CAAA;SACF,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,WAAW,CAAC,EAAE,sBAAsB,CAAA;QACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAC/C,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,EAAE,CACL;QACE,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,MAAM,CACd,MAAM,EACN,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA"}
1
+ {"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAE3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAClB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE;gBACJ;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAA;aAC3B,CAAA;SACF,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,WAAW,CAAC,EAAE,sBAAsB,CAAA;QACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE9C;;;;;;;;;;;;;;;WAeG;QACH,gBAAgB,CAAC,EAAE;YACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;SAEjB,CAAA;KACF,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,EAAE,CACL;QACE,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,MAAM,CACd,MAAM,EACN,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA"}
@@ -1,9 +1,18 @@
1
1
  import { ApiKeyType } from "../../../api-key";
2
2
  export interface AdminCreateApiKey {
3
+ /**
4
+ * The API key's title.
5
+ */
3
6
  title: string;
7
+ /**
8
+ * The API key's type.
9
+ */
4
10
  type: ApiKeyType;
5
11
  }
6
12
  export interface AdminUpdateApiKey {
13
+ /**
14
+ * The API key's title.
15
+ */
7
16
  title: string;
8
17
  }
9
18
  export interface AdminRevokeApiKey {
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
@@ -2,16 +2,41 @@ import { ApiKeyType } from "../../../api-key";
2
2
  import { BaseFilterable, OperatorMap } from "../../../dal";
3
3
  import { FindParams } from "../../common";
4
4
  export interface AdminGetApiKeysParams extends FindParams, BaseFilterable<AdminGetApiKeysParams> {
5
+ /**
6
+ * Query or keywords to search the API key's searchable fields.
7
+ */
5
8
  q?: string;
9
+ /**
10
+ * Filter by API key ID(s).
11
+ */
6
12
  id?: string | string[];
13
+ /**
14
+ * Filter by title(s).
15
+ */
7
16
  title?: string | string[];
17
+ /**
18
+ * Filter by token(s).
19
+ */
8
20
  token?: string | string[];
21
+ /**
22
+ * Filter by type.
23
+ */
9
24
  type?: ApiKeyType;
25
+ /**
26
+ * Apply filters on the API key's creation date.
27
+ */
10
28
  created_at?: OperatorMap<string>;
29
+ /**
30
+ * Apply filters on the API key's update date.
31
+ */
11
32
  updated_at?: OperatorMap<string>;
33
+ /**
34
+ * Apply filters on the API key's deletion date.
35
+ */
12
36
  deleted_at?: OperatorMap<string>;
37
+ /**
38
+ * Apply filters on the API key's revocation date.
39
+ */
13
40
  revoked_at?: OperatorMap<string>;
14
- $and?: AdminGetApiKeysParams[];
15
- $or?: AdminGetApiKeysParams[];
16
41
  }
17
42
  //# sourceMappingURL=queries.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,qBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,qBAAqB,CAAC;IACvC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,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;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAC9B,GAAG,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC9B"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,qBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,qBAAqB,CAAC;IACvC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB;;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;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
@@ -1,21 +1,66 @@
1
1
  import { ApiKeyType } from "../../../api-key";
2
2
  import { DeleteResponse, PaginatedResponse } from "../../common";
3
3
  interface AdminApiKey {
4
+ /**
5
+ * The API key's ID.
6
+ */
4
7
  id: string;
8
+ /**
9
+ * The API key's token.
10
+ */
5
11
  token: string;
12
+ /**
13
+ * The redacted form of the token, useful
14
+ * for displaying the API key.
15
+ */
6
16
  redacted: string;
17
+ /**
18
+ * The API key's title.
19
+ */
7
20
  title: string;
21
+ /**
22
+ * The API key's type.
23
+ */
8
24
  type: ApiKeyType;
25
+ /**
26
+ * The date the API key was last used.
27
+ */
9
28
  last_used_at: Date | null;
29
+ /**
30
+ * The ID of the user that created the API key.
31
+ */
10
32
  created_by: string;
33
+ /**
34
+ * The date the API key was created.
35
+ */
11
36
  created_at: Date;
37
+ /**
38
+ * The date the API key was updated.
39
+ */
40
+ updated_at: Date;
41
+ /**
42
+ * The ID of the user that revoked the API key.
43
+ */
12
44
  revoked_by: string | null;
45
+ /**
46
+ * The date the API key was revoked.
47
+ */
13
48
  revoked_at: Date | null;
49
+ /**
50
+ * The date the API key was deleted.
51
+ */
52
+ deleted_at: Date | null;
14
53
  }
15
54
  export interface AdminApiKeyResponse {
55
+ /**
56
+ * The API key's details.
57
+ */
16
58
  api_key: AdminApiKey;
17
59
  }
18
60
  export type AdminApiKeyListResponse = PaginatedResponse<{
61
+ /**
62
+ * The list of API keys.
63
+ */
19
64
  api_keys: AdminApiKey[];
20
65
  }>;
21
66
  export type AdminApiKeyDeleteResponse = DeleteResponse<"api_key">;
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhE,UAAU,WAAW;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;IAChB,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACtD,QAAQ,EAAE,WAAW,EAAE,CAAA;CACxB,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/api-key/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhE,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAChB;;OAEG;IACH,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACtD;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAA;CACxB,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA"}
@@ -1,27 +1,101 @@
1
1
  import { CampaignBudgetTypeValues } from "../../../promotion";
2
2
  export interface AdminCreateCampaign {
3
+ /**
4
+ * The campaign's name.
5
+ */
3
6
  name?: string;
7
+ /**
8
+ * The campaign's description.
9
+ */
4
10
  description?: string;
11
+ /**
12
+ * The campaign's currency code.
13
+ *
14
+ * @example
15
+ * usd
16
+ */
5
17
  currency?: string | null;
18
+ /**
19
+ * The campaign's identifier.
20
+ */
6
21
  campaign_identifier?: string;
22
+ /**
23
+ * The date the campaign and its promotions start at.
24
+ */
7
25
  starts_at?: Date | null;
26
+ /**
27
+ * The date the campaign and its promotions end at.
28
+ */
8
29
  ends_at?: Date | null;
30
+ /**
31
+ * The campaign's budget.
32
+ */
9
33
  budget?: {
34
+ /**
35
+ * The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions;
36
+ * `usage` means the limit is set on the total number of times the campaign's promotions can be used.
37
+ */
10
38
  type?: CampaignBudgetTypeValues;
39
+ /**
40
+ * The budget's currency code.
41
+ *
42
+ * @example
43
+ * usd
44
+ */
11
45
  currency_code?: string | null;
46
+ /**
47
+ * The budget's limit.
48
+ */
12
49
  limit?: number | null;
13
50
  } | null;
14
51
  }
15
52
  export interface AdminUpdateCampaign {
53
+ /**
54
+ * The campaign's name.
55
+ */
16
56
  name?: string;
57
+ /**
58
+ * The campaign's description.
59
+ */
17
60
  description?: string;
61
+ /**
62
+ * The campaign's currency code.
63
+ *
64
+ * @example
65
+ * usd
66
+ */
18
67
  currency?: string | null;
68
+ /**
69
+ * The campaign's identifier.
70
+ */
19
71
  campaign_identifier?: string;
72
+ /**
73
+ * The date the campaign and its promotions start at.
74
+ */
20
75
  starts_at?: Date | null;
76
+ /**
77
+ * The date the campaign and its promotions end at.
78
+ */
21
79
  ends_at?: Date | null;
80
+ /**
81
+ * The campaign's budget.
82
+ */
22
83
  budget?: {
84
+ /**
85
+ * The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions;
86
+ * `usage` means the limit is set on the total number of times the campaign's promotions can be used.
87
+ */
23
88
  type?: CampaignBudgetTypeValues;
89
+ /**
90
+ * The budget's currency code.
91
+ *
92
+ * @example
93
+ * usd
94
+ */
24
95
  currency_code?: string | null;
96
+ /**
97
+ * The budget's limit.
98
+ */
25
99
  limit?: number | null;
26
100
  } | null;
27
101
  }
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/campaign/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAE7D,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE;QACP,IAAI,CAAC,EAAE,wBAAwB,CAAA;QAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACtB,GAAG,IAAI,CAAA;CACT;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE;QACP,IAAI,CAAC,EAAE,wBAAwB,CAAA;QAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACtB,GAAG,IAAI,CAAA;CACT"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/campaign/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAE7D,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;QAC/B;;;;;WAKG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACtB,GAAG,IAAI,CAAA;CACT;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;QAC/B;;;;;WAKG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAC7B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACtB,GAAG,IAAI,CAAA;CACT"}
@@ -1,25 +1,79 @@
1
1
  import { CampaignBudgetTypeValues } from "../../../promotion";
2
2
  import { DeleteResponse, PaginatedResponse } from "../../common";
3
3
  export interface AdminCampaign {
4
+ /**
5
+ * The campaign's ID.
6
+ */
4
7
  id: string;
8
+ /**
9
+ * The campaign's name.
10
+ */
5
11
  name: string;
12
+ /**
13
+ * The campaign's description.
14
+ */
6
15
  description: string;
16
+ /**
17
+ * The campaign's currency code.
18
+ *
19
+ * @example
20
+ * usd
21
+ */
7
22
  currency: string;
23
+ /**
24
+ * The campaign's identifier.
25
+ */
8
26
  campaign_identifier: string;
27
+ /**
28
+ * The date the campaign and its promotions start at.
29
+ */
9
30
  starts_at: string;
31
+ /**
32
+ * The date the campaign and its promotions end at.
33
+ */
10
34
  ends_at: string;
35
+ /**
36
+ * The campaign's budget.
37
+ */
11
38
  budget: {
39
+ /**
40
+ * The budget's ID.
41
+ */
12
42
  id: string;
43
+ /**
44
+ * The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions;
45
+ * `usage` means the limit is set on the total number of times the campaign's promotions can be used.
46
+ */
13
47
  type: CampaignBudgetTypeValues;
48
+ /**
49
+ * The budget's currency code.
50
+ *
51
+ * @example
52
+ * usd
53
+ */
14
54
  currency_code: string;
55
+ /**
56
+ * The budget's limit.
57
+ */
15
58
  limit: number;
59
+ /**
60
+ * How much of the budget has been used. If the limit is `spend`, this property holds the total amount
61
+ * discounted so far. If the limit is `usage`, it holds the number of times the campaign's
62
+ * promotions have been used so far.
63
+ */
16
64
  used: number;
17
65
  };
66
+ created_at: string;
67
+ updated_at: string;
68
+ deleted_at: string | null;
18
69
  }
19
70
  export type AdminCampaignListResponse = PaginatedResponse<{
20
71
  campaigns: AdminCampaign[];
21
72
  }>;
22
73
  export interface AdminCampaignResponse {
74
+ /**
75
+ * The campaign's details.
76
+ */
23
77
  campaign: AdminCampaign;
24
78
  }
25
79
  export type AdminCampaignDeleteResponse = DeleteResponse<"campaign">;
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/campaign/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhE,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,wBAAwB,CAAA;QAC9B,aAAa,EAAE,MAAM,CAAA;QACrB,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACxD,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAC,CAAA;AAEF,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/campaign/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhE,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,EAAE;QACN;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;;WAGG;QACH,IAAI,EAAE,wBAAwB,CAAA;QAC9B;;;;;WAKG;QACH,aAAa,EAAE,MAAM,CAAA;QACrB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACxD,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAC,CAAA;AAEF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA"}
@@ -3,20 +3,53 @@ import { StoreProduct, StoreProductVariant } from "../../product";
3
3
  import { StoreRegion } from "../../region";
4
4
  import { BaseCart, BaseCartAddress, BaseCartLineItem, BaseCartShippingMethod, BaseLineItemAdjustment, BaseLineItemTaxLine, BaseShippingMethodAdjustment, BaseShippingMethodTaxLine } from "../common";
5
5
  export interface StoreCart extends Omit<BaseCart, "items"> {
6
+ /**
7
+ * The cart's shipping address.
8
+ */
6
9
  shipping_address?: StoreCartAddress;
10
+ /**
11
+ * The cart's billing address.
12
+ */
7
13
  billing_address?: StoreCartAddress;
14
+ /**
15
+ * The cart's items.
16
+ */
8
17
  items?: StoreCartLineItem[];
18
+ /**
19
+ * The cart's shipping methods.
20
+ */
9
21
  shipping_methods?: StoreCartShippingMethod[];
22
+ /**
23
+ * The cart's payment collection.
24
+ */
10
25
  payment_collection?: StorePaymentCollection;
26
+ /**
27
+ * The cart's region
28
+ */
11
29
  region?: StoreRegion;
12
30
  }
13
31
  export interface StoreCartLineItem extends Omit<BaseCartLineItem, "product" | "variant" | "cart"> {
32
+ /**
33
+ * The product this item is created for.
34
+ */
14
35
  product?: StoreProduct;
36
+ /**
37
+ * The variant added to the cart.
38
+ */
15
39
  variant?: StoreProductVariant;
40
+ /**
41
+ * The cart this item belongs to.
42
+ */
16
43
  cart: StoreCart;
44
+ /**
45
+ * The item's tax lines.
46
+ */
17
47
  tax_lines?: (BaseLineItemTaxLine & {
18
48
  item: StoreCartLineItem;
19
49
  })[];
50
+ /**
51
+ * The item's adjustments.
52
+ */
20
53
  adjustments?: (BaseLineItemAdjustment & {
21
54
  item: StoreCartLineItem;
22
55
  })[];
@@ -24,9 +57,15 @@ export interface StoreCartLineItem extends Omit<BaseCartLineItem, "product" | "v
24
57
  export interface StoreCartAddress extends BaseCartAddress {
25
58
  }
26
59
  export interface StoreCartShippingMethod extends BaseCartShippingMethod {
60
+ /**
61
+ * The shipping method's tax lines.
62
+ */
27
63
  tax_lines?: (BaseShippingMethodTaxLine & {
28
64
  shipping_method: StoreCartShippingMethod;
29
65
  })[];
66
+ /**
67
+ * The shipping method's adjustments.
68
+ */
30
69
  adjustments?: (BaseShippingMethodAdjustment & {
31
70
  shipping_method: StoreCartShippingMethod;
32
71
  })[];
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EACL,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,4BAA4B,EAC5B,yBAAyB,EAC1B,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,SAAU,SAAQ,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;IACxD,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C,kBAAkB,CAAC,EAAE,sBAAsB,CAAA;IAC3C,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AACD,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9D,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,OAAO,CAAC,EAAE,mBAAmB,CAAA;IAC7B,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,CAAC,EAAE,CAAC,mBAAmB,GAAG;QACjC,IAAI,EAAE,iBAAiB,CAAA;KACxB,CAAC,EAAE,CAAA;IACJ,WAAW,CAAC,EAAE,CAAC,sBAAsB,GAAG;QACtC,IAAI,EAAE,iBAAiB,CAAA;KACxB,CAAC,EAAE,CAAA;CACL;AACD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;CAAG;AAC5D,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE,SAAS,CAAC,EAAE,CAAC,yBAAyB,GAAG;QACvC,eAAe,EAAE,uBAAuB,CAAA;KACzC,CAAC,EAAE,CAAA;IACJ,WAAW,CAAC,EAAE,CAAC,4BAA4B,GAAG;QAC5C,eAAe,EAAE,uBAAuB,CAAA;KACzC,CAAC,EAAE,CAAA;CACL"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/cart/store/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EACL,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,4BAA4B,EAC5B,yBAAyB,EAC1B,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,SAAU,SAAQ,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC;IACxD;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C;;OAEG;IACH,kBAAkB,CAAC,EAAE,sBAAsB,CAAA;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AACD,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;IAC7B;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,mBAAmB,GAAG;QACjC,IAAI,EAAE,iBAAiB,CAAA;KACxB,CAAC,EAAE,CAAA;IACJ;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,sBAAsB,GAAG;QACtC,IAAI,EAAE,iBAAiB,CAAA;KACxB,CAAC,EAAE,CAAA;CACL;AACD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;CAAG;AAC5D,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,yBAAyB,GAAG;QACvC,eAAe,EAAE,uBAAuB,CAAA;KACzC,CAAC,EAAE,CAAA;IACJ;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,4BAA4B,GAAG;QAC5C,eAAe,EAAE,uBAAuB,CAAA;KACzC,CAAC,EAAE,CAAA;CACL"}
@@ -1,34 +1,108 @@
1
1
  export interface StoreCreateCart {
2
+ /**
3
+ * The ID of the region that the cart is created in.
4
+ */
2
5
  region_id?: string;
6
+ /**
7
+ * The cart's shipping address.
8
+ */
3
9
  shipping_address?: StoreAddAddress;
10
+ /**
11
+ * The cart's billing address.
12
+ */
4
13
  billing_address?: StoreAddAddress;
14
+ /**
15
+ * The email of the customer associated with the cart.
16
+ */
5
17
  email?: string;
18
+ /**
19
+ * The cart's currency code. If not provided, the region's currency
20
+ * code is used.
21
+ */
6
22
  currency_code?: string;
23
+ /**
24
+ * The cart's items.
25
+ */
7
26
  items?: StoreAddCartLineItem[];
27
+ /**
28
+ * The ID of the associated sales channel. Only products in the same sales channel
29
+ * can be added to the cart.
30
+ */
8
31
  sales_channel_id?: string;
32
+ /**
33
+ * The promotion codes to apply on the cart.
34
+ */
9
35
  promo_codes?: string[];
36
+ /**
37
+ * Key-value pairs of custom data.
38
+ */
10
39
  metadata?: Record<string, unknown>;
11
40
  }
12
41
  export interface StoreUpdateCart {
42
+ /**
43
+ * The ID of the region that the cart is in.
44
+ */
13
45
  region_id?: string;
46
+ /**
47
+ * The cart's shipping address.
48
+ */
14
49
  shipping_address?: StoreAddAddress | string;
50
+ /**
51
+ * The cart's billing address.
52
+ */
15
53
  billing_address?: StoreAddAddress | string;
54
+ /**
55
+ * The email of the customer associated with the cart.
56
+ */
16
57
  email?: string;
58
+ /**
59
+ * The ID of the associated sales channel. Only products in the same sales channel
60
+ * can be added to the cart.
61
+ */
17
62
  sales_channel_id?: string;
63
+ /**
64
+ * Key-value pairs of custom data.
65
+ */
18
66
  metadata?: Record<string, unknown>;
67
+ /**
68
+ * The promotion codes to apply on the cart.
69
+ */
19
70
  promo_codes?: string[];
20
71
  }
21
72
  export interface StoreAddCartLineItem {
73
+ /**
74
+ * The ID of the product variant to add to the cart.
75
+ */
22
76
  variant_id: string;
77
+ /**
78
+ * The item's quantity in the cart.
79
+ */
23
80
  quantity: number;
81
+ /**
82
+ * Key-value pairs of custom data.
83
+ */
24
84
  metadata?: Record<string, unknown>;
25
85
  }
26
86
  export interface StoreUpdateCartLineItem {
87
+ /**
88
+ * The item's quantity.
89
+ */
27
90
  quantity: number;
91
+ /**
92
+ * Key-value pairs of custom data.
93
+ */
28
94
  metadata?: Record<string, unknown>;
29
95
  }
30
96
  export interface StoreAddCartShippingMethods {
97
+ /**
98
+ * The id of the chosen shipping option.
99
+ */
31
100
  option_id: string;
101
+ /**
102
+ * Data useful for the associated fulfillment provider.
103
+ *
104
+ * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
105
+ */
32
106
  data?: Record<string, unknown>;
33
107
  }
34
108
  export interface StoreCompleteCart {