@medusajs/types 1.12.0-snapshot-20241016151300 → 2.0.0-preview-20241022094107

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) 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/index.d.ts +3 -3
  4. package/dist/common/index.d.ts.map +1 -1
  5. package/dist/common/index.js +3 -3
  6. package/dist/common/index.js.map +1 -1
  7. package/dist/http/api-key/admin/responses.d.ts +2 -0
  8. package/dist/http/api-key/admin/responses.d.ts.map +1 -1
  9. package/dist/http/campaign/admin/responses.d.ts +3 -0
  10. package/dist/http/campaign/admin/responses.d.ts.map +1 -1
  11. package/dist/http/cart/store/entities.d.ts +39 -0
  12. package/dist/http/cart/store/entities.d.ts.map +1 -1
  13. package/dist/http/cart/store/payloads.d.ts +74 -0
  14. package/dist/http/cart/store/payloads.d.ts.map +1 -1
  15. package/dist/http/cart/store/responses.d.ts +28 -0
  16. package/dist/http/cart/store/responses.d.ts.map +1 -1
  17. package/dist/http/collection/common.d.ts +44 -2
  18. package/dist/http/collection/common.d.ts.map +1 -1
  19. package/dist/http/collection/store/entities.d.ts +3 -0
  20. package/dist/http/collection/store/entities.d.ts.map +1 -1
  21. package/dist/http/collection/store/queries.d.ts +0 -2
  22. package/dist/http/collection/store/queries.d.ts.map +1 -1
  23. package/dist/http/collection/store/responses.d.ts +6 -0
  24. package/dist/http/collection/store/responses.d.ts.map +1 -1
  25. package/dist/http/common/request.d.ts +17 -0
  26. package/dist/http/common/request.d.ts.map +1 -1
  27. package/dist/http/common/response.d.ts +9 -0
  28. package/dist/http/common/response.d.ts.map +1 -1
  29. package/dist/http/customer/common.d.ts +240 -0
  30. package/dist/http/customer/common.d.ts.map +1 -1
  31. package/dist/http/customer/store/entities.d.ts +3 -0
  32. package/dist/http/customer/store/entities.d.ts.map +1 -1
  33. package/dist/http/customer/store/responses.d.ts +9 -0
  34. package/dist/http/customer/store/responses.d.ts.map +1 -1
  35. package/dist/http/exchange/admin/payloads.d.ts +0 -4
  36. package/dist/http/exchange/admin/payloads.d.ts.map +1 -1
  37. package/dist/http/fulfillment/store/index.d.ts +54 -1
  38. package/dist/http/fulfillment/store/index.d.ts.map +1 -1
  39. package/dist/http/order/admin/entities.d.ts +24 -0
  40. package/dist/http/order/admin/entities.d.ts.map +1 -1
  41. package/dist/http/order/admin/queries.d.ts +12 -0
  42. package/dist/http/order/admin/queries.d.ts.map +1 -1
  43. package/dist/http/order/admin/responses.d.ts +4 -1
  44. package/dist/http/order/admin/responses.d.ts.map +1 -1
  45. package/dist/http/order/common.d.ts +630 -0
  46. package/dist/http/order/common.d.ts.map +1 -1
  47. package/dist/http/order/store/entities.d.ts +39 -0
  48. package/dist/http/order/store/entities.d.ts.map +1 -1
  49. package/dist/http/order/store/queries.d.ts +6 -0
  50. package/dist/http/order/store/queries.d.ts.map +1 -1
  51. package/dist/http/order/store/responses.d.ts +6 -0
  52. package/dist/http/order/store/responses.d.ts.map +1 -1
  53. package/dist/http/payment/common.d.ts +3 -0
  54. package/dist/http/payment/common.d.ts.map +1 -1
  55. package/dist/http/payment/store/entities.d.ts +9 -0
  56. package/dist/http/payment/store/entities.d.ts.map +1 -1
  57. package/dist/http/payment/store/payloads.d.ts +18 -0
  58. package/dist/http/payment/store/payloads.d.ts.map +1 -1
  59. package/dist/http/payment/store/queries.d.ts +3 -0
  60. package/dist/http/payment/store/queries.d.ts.map +1 -1
  61. package/dist/http/payment/store/responses.d.ts +6 -0
  62. package/dist/http/payment/store/responses.d.ts.map +1 -1
  63. package/dist/http/product/admin/payloads.d.ts +3 -1
  64. package/dist/http/product/admin/payloads.d.ts.map +1 -1
  65. package/dist/http/product/common.d.ts +268 -0
  66. package/dist/http/product/common.d.ts.map +1 -1
  67. package/dist/http/product/store/entitites.d.ts +36 -0
  68. package/dist/http/product/store/entitites.d.ts.map +1 -1
  69. package/dist/http/product/store/queries.d.ts +19 -1
  70. package/dist/http/product/store/queries.d.ts.map +1 -1
  71. package/dist/http/product/store/responses.d.ts +6 -0
  72. package/dist/http/product/store/responses.d.ts.map +1 -1
  73. package/dist/http/product-category/common.d.ts +94 -0
  74. package/dist/http/product-category/common.d.ts.map +1 -1
  75. package/dist/http/product-category/store/entities.d.ts +9 -0
  76. package/dist/http/product-category/store/entities.d.ts.map +1 -1
  77. package/dist/http/product-category/store/queries.d.ts +1 -1
  78. package/dist/http/product-category/store/queries.d.ts.map +1 -1
  79. package/dist/http/product-category/store/responses.d.ts +6 -0
  80. package/dist/http/product-category/store/responses.d.ts.map +1 -1
  81. package/dist/http/promotion/common.d.ts +3 -0
  82. package/dist/http/promotion/common.d.ts.map +1 -1
  83. package/dist/http/region/common.d.ts +69 -0
  84. package/dist/http/region/common.d.ts.map +1 -1
  85. package/dist/http/region/store/responses.d.ts +6 -0
  86. package/dist/http/region/store/responses.d.ts.map +1 -1
  87. package/dist/http/shipping-option/store/queries.d.ts +8 -0
  88. package/dist/http/shipping-option/store/queries.d.ts.map +1 -1
  89. package/dist/http/shipping-option/store/responses.d.ts +2 -2
  90. package/dist/http/shipping-option/store/responses.d.ts.map +1 -1
  91. package/dist/index-data/common.d.ts +1 -1
  92. package/dist/inventory/service.d.ts +41 -9
  93. package/dist/inventory/service.d.ts.map +1 -1
  94. package/dist/modules-sdk/index.d.ts +0 -1
  95. package/dist/modules-sdk/index.d.ts.map +1 -1
  96. package/dist/modules-sdk/module-provider.d.ts +1 -1
  97. package/dist/modules-sdk/module-provider.d.ts.map +1 -1
  98. package/dist/notification/common.d.ts +19 -0
  99. package/dist/notification/common.d.ts.map +1 -1
  100. package/dist/notification/mutations.d.ts +5 -0
  101. package/dist/notification/mutations.d.ts.map +1 -1
  102. package/dist/notification/provider.d.ts +5 -1
  103. package/dist/notification/provider.d.ts.map +1 -1
  104. package/dist/order/common.d.ts +0 -49
  105. package/dist/order/common.d.ts.map +1 -1
  106. package/dist/product/common.d.ts +8 -0
  107. package/dist/product/common.d.ts.map +1 -1
  108. package/dist/tax/mutations.d.ts +17 -0
  109. package/dist/tax/mutations.d.ts.map +1 -1
  110. package/dist/tax/service.d.ts +34 -1
  111. package/dist/tax/service.d.ts.map +1 -1
  112. 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"}
@@ -1,9 +1,9 @@
1
- export * from "./common";
2
- export * from "./rule";
3
1
  export * from "./batch";
2
+ export * from "./camel-case";
3
+ export * from "./common";
4
4
  export * from "./config-module";
5
5
  export * from "./medusa-cli";
6
6
  export * from "./medusa-container";
7
+ export * from "./rule";
7
8
  export * from "./with-calculated";
8
- export * from "./camel-case";
9
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,QAAQ,CAAA;AACtB,cAAc,mBAAmB,CAAA"}
@@ -14,12 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./common"), exports);
18
- __exportStar(require("./rule"), exports);
19
17
  __exportStar(require("./batch"), exports);
18
+ __exportStar(require("./camel-case"), exports);
19
+ __exportStar(require("./common"), exports);
20
20
  __exportStar(require("./config-module"), exports);
21
21
  __exportStar(require("./medusa-cli"), exports);
22
22
  __exportStar(require("./medusa-container"), exports);
23
+ __exportStar(require("./rule"), exports);
23
24
  __exportStar(require("./with-calculated"), exports);
24
- __exportStar(require("./camel-case"), exports);
25
25
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,yCAAsB;AACtB,0CAAuB;AACvB,kDAA+B;AAC/B,+CAA4B;AAC5B,qDAAkC;AAClC,oDAAiC;AACjC,+CAA4B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,+CAA4B;AAC5B,2CAAwB;AACxB,kDAA+B;AAC/B,+CAA4B;AAC5B,qDAAkC;AAClC,yCAAsB;AACtB,oDAAiC"}
@@ -9,8 +9,10 @@ interface AdminApiKey {
9
9
  last_used_at: Date | null;
10
10
  created_by: string;
11
11
  created_at: Date;
12
+ updated_at: Date;
12
13
  revoked_by: string | null;
13
14
  revoked_at: Date | null;
15
+ deleted_at: Date | null;
14
16
  }
15
17
  export interface AdminApiKeyResponse {
16
18
  api_key: AdminApiKey;
@@ -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,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,IAAI,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,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"}
@@ -15,6 +15,9 @@ export interface AdminCampaign {
15
15
  limit: number;
16
16
  used: number;
17
17
  };
18
+ created_at: string;
19
+ updated_at: string;
20
+ deleted_at: string | null;
18
21
  }
19
22
  export type AdminCampaignListResponse = PaginatedResponse<{
20
23
  campaigns: AdminCampaign[];
@@ -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,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;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,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 {
@@ -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"}
@@ -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,9 +1,26 @@
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 {
@@ -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,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,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"}