@medusajs/types 2.0.0-rc-20241022183311 → 2.0.1-preview-20241025120203

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. package/dist/common/config-module.d.ts +1 -1
  2. package/dist/http/cart/store/payloads.d.ts +1 -1
  3. package/dist/http/collection/admin/payloads.d.ts +24 -0
  4. package/dist/http/collection/admin/payloads.d.ts.map +1 -1
  5. package/dist/http/collection/admin/queries.d.ts +3 -0
  6. package/dist/http/collection/admin/queries.d.ts.map +1 -1
  7. package/dist/http/collection/admin/responses.d.ts +6 -0
  8. package/dist/http/collection/admin/responses.d.ts.map +1 -1
  9. package/dist/http/common/request.d.ts +2 -2
  10. package/dist/http/fulfillment/admin/entitites.d.ts +1 -1
  11. package/dist/http/fulfillment/admin/payloads.d.ts +1 -1
  12. package/dist/http/fulfillment/store/index.d.ts +1 -1
  13. package/dist/http/order/admin/queries.d.ts +2 -1
  14. package/dist/http/order/admin/queries.d.ts.map +1 -1
  15. package/dist/http/order/common.d.ts +2 -2
  16. package/dist/http/payment/store/payloads.d.ts +1 -1
  17. package/dist/http/price-list/admin/entities.d.ts +42 -0
  18. package/dist/http/price-list/admin/entities.d.ts.map +1 -1
  19. package/dist/http/price-list/admin/payloads.d.ts +102 -0
  20. package/dist/http/price-list/admin/payloads.d.ts.map +1 -1
  21. package/dist/http/price-list/admin/queries.d.ts +18 -0
  22. package/dist/http/price-list/admin/queries.d.ts.map +1 -1
  23. package/dist/http/price-list/admin/responses.d.ts +15 -0
  24. package/dist/http/price-list/admin/responses.d.ts.map +1 -1
  25. package/dist/http/pricing/admin/entities.d.ts +63 -0
  26. package/dist/http/pricing/admin/entities.d.ts.map +1 -1
  27. package/dist/http/pricing/admin/payloads.d.ts +28 -0
  28. package/dist/http/pricing/admin/payloads.d.ts.map +1 -1
  29. package/dist/http/pricing/admin/queries.d.ts +12 -0
  30. package/dist/http/pricing/admin/queries.d.ts.map +1 -1
  31. package/dist/http/pricing/admin/responses.d.ts +6 -0
  32. package/dist/http/pricing/admin/responses.d.ts.map +1 -1
  33. package/dist/http/product-category/admin/entities.d.ts +9 -0
  34. package/dist/http/product-category/admin/entities.d.ts.map +1 -1
  35. package/dist/http/product-category/admin/payloads.d.ts +60 -0
  36. package/dist/http/product-category/admin/payloads.d.ts.map +1 -1
  37. package/dist/http/product-category/admin/queries.d.ts +6 -0
  38. package/dist/http/product-category/admin/queries.d.ts.map +1 -1
  39. package/dist/http/product-category/admin/responses.d.ts +6 -0
  40. package/dist/http/product-category/admin/responses.d.ts.map +1 -1
  41. package/dist/http/product-category/common.d.ts +2 -1
  42. package/dist/http/product-category/common.d.ts.map +1 -1
  43. package/dist/tax/common.d.ts +1 -1
  44. package/dist/tax/mutations.d.ts +1 -1
  45. package/package.json +1 -1
@@ -548,7 +548,7 @@ export type ProjectConfigOptions = {
548
548
  * However, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.
549
549
  *
550
550
  * If you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `"x-no-compression": true`.
551
- * Learn more in the [API Reference](https://docs.medusajs.com/v2/api/store#http-compression).
551
+ * Learn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).
552
552
  *
553
553
  * @example
554
554
  * ```js title="medusa-config.js"
@@ -101,7 +101,7 @@ export interface StoreAddCartShippingMethods {
101
101
  /**
102
102
  * Data useful for the associated fulfillment provider.
103
103
  *
104
- * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
104
+ * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property).
105
105
  */
106
106
  data?: Record<string, unknown>;
107
107
  }
@@ -1,15 +1,39 @@
1
1
  export interface AdminCreateCollection {
2
+ /**
3
+ * The collection's title.
4
+ */
2
5
  title: string;
6
+ /**
7
+ * The collection's handle.
8
+ */
3
9
  handle?: string;
10
+ /**
11
+ * Key-value pairs of custom data.
12
+ */
4
13
  metadata?: Record<string, any>;
5
14
  }
6
15
  export interface AdminUpdateCollection {
16
+ /**
17
+ * The collection's title.
18
+ */
7
19
  title?: string;
20
+ /**
21
+ * The collection's handle.
22
+ */
8
23
  handle?: string;
24
+ /**
25
+ * Key-value pairs of custom data.
26
+ */
9
27
  metadata?: Record<string, any>;
10
28
  }
11
29
  export interface AdminUpdateCollectionProducts {
30
+ /**
31
+ * IDs of products to add to the collection.
32
+ */
12
33
  add?: string[];
34
+ /**
35
+ * IDs of products to remove from the collection.
36
+ */
13
37
  remove?: string[];
14
38
  }
15
39
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,6BAA6B;IAC5C,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
@@ -1,6 +1,9 @@
1
1
  import { OperatorMap } from "../../../dal";
2
2
  import { BaseCollectionListParams, BaseCollectionParams } from "../common";
3
3
  export interface AdminCollectionListParams extends BaseCollectionListParams {
4
+ /**
5
+ * Apply filters on the collection's deletion date.
6
+ */
4
7
  deleted_at?: OperatorMap<string>;
5
8
  }
6
9
  export interface AdminCollectionParams extends BaseCollectionParams {
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAE1E,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AACD,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;CAAG"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAE1E,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AACD,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;CAAG"}
@@ -1,9 +1,15 @@
1
1
  import { DeleteResponse, PaginatedResponse } from "../../common";
2
2
  import { AdminCollection } from "./entities";
3
3
  export interface AdminCollectionResponse {
4
+ /**
5
+ * The collection's details.
6
+ */
4
7
  collection: AdminCollection;
5
8
  }
6
9
  export interface AdminCollectionListResponse extends PaginatedResponse<{
10
+ /**
11
+ * The list of collections.
12
+ */
7
13
  collections: AdminCollection[];
8
14
  }> {
9
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,CAAC;IACxB,WAAW,EAAE,eAAe,EAAE,CAAA;CAC/B,CAAC;CAAG;AAEP,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/collection/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,eAAe,EAAE,CAAA;CAC/B,CAAC;CAAG;AAEP,MAAM,WAAW,6BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG"}
@@ -1,8 +1,8 @@
1
1
  export interface SelectParams {
2
2
  /**
3
- * The fields and relations to retrieve.
3
+ * The fields and relations to retrieve separated by commas.
4
4
  *
5
- * Learn more in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
5
+ * Learn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
6
6
  */
7
7
  fields?: string;
8
8
  }
@@ -178,7 +178,7 @@ export interface AdminFulfillment {
178
178
  /**
179
179
  * Data useful for the fulfillment provider handling the fulfillment.
180
180
  *
181
- * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment#data-property).
181
+ * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment#data-property).
182
182
  */
183
183
  data: Record<string, unknown> | null;
184
184
  /**
@@ -119,7 +119,7 @@ export interface AdminCreateFulfillment {
119
119
  /**
120
120
  * Data useful for the fulfillment provider handling the fulfillment.
121
121
  *
122
- * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment#data-property).
122
+ * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment#data-property).
123
123
  */
124
124
  data?: Record<string, unknown> | null;
125
125
  /**
@@ -29,7 +29,7 @@ export interface StoreCartShippingOption {
29
29
  /**
30
30
  * The data useful for the fulfillment provider when handling the shipment and fulfillment.
31
31
  *
32
- * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
32
+ * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property).
33
33
  */
34
34
  data: Record<string, unknown> | null;
35
35
  /**
@@ -7,7 +7,8 @@ export interface AdminOrderFilters extends FindParams, BaseOrderFilters {
7
7
  sales_channel_id?: string[];
8
8
  fulfillment_status?: FulfillmentStatus[];
9
9
  payment_status?: PaymentStatus[];
10
- region_id?: string[];
10
+ region_id?: string[] | string;
11
+ customer_id?: string[] | string;
11
12
  q?: string;
12
13
  created_at?: OperatorMap<string>;
13
14
  updated_at?: OperatorMap<string>;
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/order/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAErE,MAAM,WAAW,iBAAkB,SAAQ,UAAU,EAAE,gBAAgB;IACrE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACxC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAE5E,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC5B"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/order/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAErE,MAAM,WAAW,iBAAkB,SAAQ,UAAU,EAAE,gBAAgB;IACrE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACxC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC/B,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAE5E,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC5B"}
@@ -272,7 +272,7 @@ export interface BaseOrderShippingMethod {
272
272
  /**
273
273
  * Data relevant for the fulfillment provider handling the shipping.
274
274
  *
275
- * Learn more in [this guide](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
275
+ * Learn more in [this guide](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property).
276
276
  */
277
277
  data: Record<string, unknown> | null;
278
278
  /**
@@ -671,7 +671,7 @@ export interface BaseOrderFulfillment {
671
671
  /**
672
672
  * Data necessary for the provider handling the fulfillment.
673
673
  *
674
- * Learn more in [this guide](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
674
+ * Learn more in [this guide](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property).
675
675
  */
676
676
  data: Record<string, unknown> | null;
677
677
  /**
@@ -15,7 +15,7 @@ export interface StoreInitializePaymentSession {
15
15
  /**
16
16
  * Any data necessary for the payment provider to process the payment.
17
17
  *
18
- * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property).
18
+ * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property).
19
19
  */
20
20
  data?: Record<string, unknown>;
21
21
  }
@@ -1,21 +1,63 @@
1
1
  import { PriceListStatus, PriceListType } from "../../../pricing";
2
2
  import { AdminPrice } from "../../pricing";
3
3
  export interface AdminPriceListPrice extends AdminPrice {
4
+ /**
5
+ * The ID of the variant that this price is for.
6
+ */
4
7
  variant_id: string;
8
+ /**
9
+ * The price's rules.
10
+ */
5
11
  rules: Record<string, unknown>;
6
12
  }
7
13
  export interface AdminPriceList {
14
+ /**
15
+ * The price list's ID.
16
+ */
8
17
  id: string;
18
+ /**
19
+ * The price list's title.
20
+ */
9
21
  title: string;
22
+ /**
23
+ * The price list's description.
24
+ */
10
25
  description: string;
26
+ /**
27
+ * The price list's rules.
28
+ */
11
29
  rules: Record<string, any>;
30
+ /**
31
+ * The price list's start date.
32
+ */
12
33
  starts_at: string | null;
34
+ /**
35
+ * The price list's end date.
36
+ */
13
37
  ends_at: string | null;
38
+ /**
39
+ * The price list's status.
40
+ */
14
41
  status: PriceListStatus;
42
+ /**
43
+ * The price list's type.
44
+ */
15
45
  type: PriceListType;
46
+ /**
47
+ * The price list's prices.
48
+ */
16
49
  prices: AdminPriceListPrice[];
50
+ /**
51
+ * The date the price list was created.
52
+ */
17
53
  created_at: string;
54
+ /**
55
+ * The date the price list was updated.
56
+ */
18
57
  updated_at: string;
58
+ /**
59
+ * The date the price list was deleted.
60
+ */
19
61
  deleted_at: string | null;
20
62
  }
21
63
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,eAAe,CAAA;IACvB,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,mBAAmB,EAAE,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IACvB;;OAEG;IACH,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAA;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}
@@ -1,46 +1,148 @@
1
1
  import { PriceListStatus, PriceListType } from "../../../pricing";
2
2
  export interface AdminCreatePriceListPrice {
3
+ /**
4
+ * The price's currency code.
5
+ *
6
+ * @example
7
+ * usd
8
+ */
3
9
  currency_code: string;
10
+ /**
11
+ * The price's amount.
12
+ */
4
13
  amount: number;
14
+ /**
15
+ * The ID of the variant this price applies to.
16
+ */
5
17
  variant_id: string;
18
+ /**
19
+ * The minimum quantity that must be available in the cart for the price to be applied.
20
+ */
6
21
  min_quantity?: number | null;
22
+ /**
23
+ * The maximum quantity allowed to be available in the cart for the price to be applied.
24
+ */
7
25
  max_quantity?: number | null;
26
+ /**
27
+ * The price's rules.
28
+ */
8
29
  rules?: Record<string, string>;
9
30
  }
10
31
  export interface AdminCreatePriceList {
32
+ /**
33
+ * The price list's title.
34
+ */
11
35
  title: string;
36
+ /**
37
+ * The price list's description.
38
+ */
12
39
  description?: string | null;
40
+ /**
41
+ * The price list's start date.
42
+ */
13
43
  starts_at?: string | null;
44
+ /**
45
+ * The price list's end date.
46
+ */
14
47
  ends_at?: string | null;
48
+ /**
49
+ * The price list's status.
50
+ */
15
51
  status: PriceListStatus;
52
+ /**
53
+ * The price list's type.
54
+ */
16
55
  type: PriceListType;
56
+ /**
57
+ * The price list's rules.
58
+ */
17
59
  rules?: Record<string, string[]>;
60
+ /**
61
+ * The price list's prices.
62
+ */
18
63
  prices?: AdminCreatePriceListPrice[];
19
64
  }
20
65
  export interface AdminUpdatePriceListPrice {
66
+ /**
67
+ * The ID of the price to update.
68
+ */
21
69
  id: string;
70
+ /**
71
+ * The price's currency code.
72
+ *
73
+ * @example
74
+ * usd
75
+ */
22
76
  currency_code?: string;
77
+ /**
78
+ * The price's amount.
79
+ */
23
80
  amount?: number;
81
+ /**
82
+ * The ID of the variant this price applies to.
83
+ */
24
84
  variant_id: string;
85
+ /**
86
+ * The minimum quantity that must be available in the cart for the price to be applied.
87
+ */
25
88
  min_quantity?: number | null;
89
+ /**
90
+ * The maximum quantity allowed to be available in the cart for the price to be applied.
91
+ */
26
92
  max_quantity?: number | null;
93
+ /**
94
+ * The price's rules.
95
+ */
27
96
  rules?: Record<string, string>;
28
97
  }
29
98
  export interface AdminUpdatePriceList {
99
+ /**
100
+ * The price list's title.
101
+ */
30
102
  title?: string;
103
+ /**
104
+ * The price list's description.
105
+ */
31
106
  description?: string;
107
+ /**
108
+ * The price list's start date.
109
+ */
32
110
  starts_at?: string | null;
111
+ /**
112
+ * The price list's end date.
113
+ */
33
114
  ends_at?: string | null;
115
+ /**
116
+ * The price list's status.
117
+ */
34
118
  status?: PriceListStatus;
119
+ /**
120
+ * The price list's type.
121
+ */
35
122
  type?: PriceListType;
123
+ /**
124
+ * The price list's rules.
125
+ */
36
126
  rules?: Record<string, string[]>;
37
127
  }
38
128
  export interface AdminBatchPriceListPrice {
129
+ /**
130
+ * The prices to create and add to the price list.
131
+ */
39
132
  create?: AdminCreatePriceListPrice[];
133
+ /**
134
+ * The prices to update in the price list.
135
+ */
40
136
  update?: AdminUpdatePriceListPrice[];
137
+ /**
138
+ * The prices to delete from the price list.
139
+ */
41
140
  delete?: string[];
42
141
  }
43
142
  export interface AdminLinkPriceListProducts {
143
+ /**
144
+ * The IDs of products to remove from the price list.
145
+ */
44
146
  remove?: string[];
45
147
  }
46
148
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEjE,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,eAAe,CAAA;IACvB,IAAI,EAAE,aAAa,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAChC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACpC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEjE,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;IACvB;;OAEG;IACH,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
@@ -2,11 +2,29 @@ import { BaseFilterable, OperatorMap } from "../../../dal";
2
2
  import { PriceListStatus } from "../../../pricing";
3
3
  import { FindParams, SelectParams } from "../../common";
4
4
  export interface AdminPriceListListParams extends FindParams, BaseFilterable<AdminPriceListListParams> {
5
+ /**
6
+ * Query or keyword to filter the price list's searchable fields.
7
+ */
5
8
  q?: string;
9
+ /**
10
+ * Filter by price list ID(s).
11
+ */
6
12
  id?: string | string[];
13
+ /**
14
+ * Apply filters on the price list's start date.
15
+ */
7
16
  starts_at?: OperatorMap<string>;
17
+ /**
18
+ * Apply filters on the price list's end date.
19
+ */
8
20
  ends_at?: OperatorMap<string>;
21
+ /**
22
+ * Filter by statuses.
23
+ */
9
24
  status?: PriceListStatus[];
25
+ /**
26
+ * Filter by the number of rules.
27
+ */
10
28
  rules_count?: number[];
11
29
  }
12
30
  export interface AdminPriceListParams extends SelectParams {
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,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,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/B,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC7B,MAAM,CAAC,EAAE,eAAe,EAAE,CAAA;IAC1B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,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,SAAS,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,EAAE,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG"}
@@ -2,17 +2,32 @@ import { DeleteResponse, PaginatedResponse } from "../../common";
2
2
  import { AdminPrice } from "../../pricing";
3
3
  import { AdminPriceList } from "./entities";
4
4
  export interface AdminPriceListResponse {
5
+ /**
6
+ * The price list's details.
7
+ */
5
8
  price_list: AdminPriceList;
6
9
  }
7
10
  export interface AdminPriceListListResponse extends PaginatedResponse<{
11
+ /**
12
+ * The list of price lists.
13
+ */
8
14
  price_lists: AdminPriceList[];
9
15
  }> {
10
16
  }
11
17
  export interface AdminPriceListDeleteResponse extends DeleteResponse<"price_list"> {
12
18
  }
13
19
  export interface AdminPriceListBatchResponse {
20
+ /**
21
+ * The created prices.
22
+ */
14
23
  created: AdminPrice[];
24
+ /**
25
+ * The updated prices.
26
+ */
15
27
  updated: AdminPrice[];
28
+ /**
29
+ * Details about the deleted prices.
30
+ */
16
31
  deleted: {
17
32
  ids: string[];
18
33
  object: "price";
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,WAAW,0BACf,SAAQ,iBAAiB,CAAC;IACxB,WAAW,EAAE,cAAc,EAAE,CAAA;CAC9B,CAAC;CAAG;AAEP,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG;AAEzC,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,UAAU,EAAE,CAAA;IACrB,OAAO,EAAE,UAAU,EAAE,CAAA;IACrB,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,EAAE,CAAA;QACb,MAAM,EAAE,OAAO,CAAA;QACf,OAAO,EAAE,OAAO,CAAA;KACjB,CAAA;CACF"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/price-list/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,WAAW,0BACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,cAAc,EAAE,CAAA;CAC9B,CAAC;CAAG;AAEP,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG;AAEzC,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,UAAU,EAAE,CAAA;IACrB;;OAEG;IACH,OAAO,EAAE,UAAU,EAAE,CAAA;IACrB;;OAEG;IACH,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,EAAE,CAAA;QACb,MAAM,EAAE,OAAO,CAAA;QACf,OAAO,EAAE,OAAO,CAAA;KACjB,CAAA;CACF"}
@@ -1,4 +1,5 @@
1
1
  /**
2
+ * @privateRemarks
2
3
  * TODO: Not sure how to type this properly, as it's unclear to me what is returned
3
4
  * by our API. As an example we return `price_list: null` but `price_list_id` is missing.
4
5
  *
@@ -17,25 +18,87 @@
17
18
  * ```
18
19
  */
19
20
  export interface AdminPrice {
21
+ /**
22
+ * The price's ID.
23
+ */
20
24
  id: string;
25
+ /**
26
+ * The price's title.
27
+ */
21
28
  title: string;
29
+ /**
30
+ * The price's currency code.
31
+ *
32
+ * @example
33
+ * usd
34
+ */
22
35
  currency_code: string;
36
+ /**
37
+ * The price's amount.
38
+ */
23
39
  amount: number;
40
+ /**
41
+ * The price's raw amount.
42
+ */
24
43
  raw_amount: Record<string, unknown>;
44
+ /**
45
+ * The minimum quantity that must be available in the cart for the price to be applied.
46
+ */
25
47
  min_quantity: number | null;
48
+ /**
49
+ * The maximum quantity allowed to be available in the cart for the price to be applied.
50
+ */
26
51
  max_quantity: number | null;
52
+ /**
53
+ * The ID of the price set this price belongs to.
54
+ */
27
55
  price_set_id: string;
56
+ /**
57
+ * The date the price was created.
58
+ */
28
59
  created_at: string;
60
+ /**
61
+ * The date the price was updated.
62
+ */
29
63
  updated_at: string;
64
+ /**
65
+ * The date the price was deleted.
66
+ */
30
67
  deleted_at: string | null;
31
68
  }
32
69
  export interface AdminPricePreference {
70
+ /**
71
+ * The price preference's ID.
72
+ */
33
73
  id: string;
74
+ /**
75
+ * The attribute that the price preference refers to.
76
+ *
77
+ * Current supported values: `region_id` and `currency_code`.
78
+ */
34
79
  attribute: string | null;
80
+ /**
81
+ * The attribute's value. For example, if the `attribute` is `region_id`,
82
+ * the value is a region's ID. Prices in that region use this price
83
+ * preference.
84
+ */
35
85
  value: string | null;
86
+ /**
87
+ * Whether prices matching this price preference have
88
+ * taxes included in their amount.
89
+ */
36
90
  is_tax_inclusive: boolean;
91
+ /**
92
+ * The date that the price preference was created.
93
+ */
37
94
  created_at: string;
95
+ /**
96
+ * The date that the price preference was updated.
97
+ */
38
98
  updated_at: string;
99
+ /**
100
+ * The date that the price preference was deleted.
101
+ */
39
102
  deleted_at: null | string;
40
103
  }
41
104
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/entities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;CAC1B"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/entities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;OAIG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;;;OAIG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;CAC1B"}
@@ -1,11 +1,39 @@
1
1
  export interface AdminCreatePricePreference {
2
+ /**
3
+ * The attribute that the price preference refers to.
4
+ *
5
+ * Current supported values: `region_id` and `currency_code`.
6
+ */
2
7
  attribute?: string;
8
+ /**
9
+ * The attribute's value. For example, if the `attribute` is `region_id`,
10
+ * the value is a region's ID. Prices in that region use this price
11
+ * preference.
12
+ */
3
13
  value?: string;
14
+ /**
15
+ * Whether prices matching this price preference have
16
+ * taxes included in their amount.
17
+ */
4
18
  is_tax_inclusive?: boolean;
5
19
  }
6
20
  export interface AdminUpdatePricePreference {
21
+ /**
22
+ * The attribute that the price preference refers to.
23
+ *
24
+ * Current supported values: `region_id` and `currency_code`.
25
+ */
7
26
  attribute?: string | null;
27
+ /**
28
+ * The attribute's value. For example, if the `attribute` is `region_id`,
29
+ * the value is a region's ID. Prices in that region use this price
30
+ * preference.
31
+ */
8
32
  value?: string | null;
33
+ /**
34
+ * Whether prices matching this price preference have
35
+ * taxes included in their amount.
36
+ */
9
37
  is_tax_inclusive?: boolean;
10
38
  }
11
39
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B"}
@@ -1,9 +1,21 @@
1
1
  import { BaseFilterable } from "../../../dal";
2
2
  import { FindParams, SelectParams } from "../../common";
3
3
  export interface AdminPricePreferenceListParams extends FindParams, BaseFilterable<AdminPricePreferenceListParams> {
4
+ /**
5
+ * Filter by price preference ID(s).
6
+ */
4
7
  id?: string | string[];
8
+ /**
9
+ * Filter by attribute(s).
10
+ */
5
11
  attribute?: string | string[];
12
+ /**
13
+ * Filter by value(s).
14
+ */
6
15
  value?: string | string[];
16
+ /**
17
+ * Query or keyword to filter the price preference's searchable fields.
18
+ */
7
19
  q?: string;
8
20
  }
9
21
  export interface AdminPricePreferenceParams extends SelectParams {
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,8BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,8BAA8B,CAAC;IAChD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,CAAC,CAAC,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,0BAA2B,SAAQ,YAAY;CAAG"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,8BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,8BAA8B,CAAC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,0BAA2B,SAAQ,YAAY;CAAG"}
@@ -1,9 +1,15 @@
1
1
  import { DeleteResponse, PaginatedResponse } from "../../common";
2
2
  import { AdminPricePreference } from "./entities";
3
3
  export interface AdminPricePreferenceResponse {
4
+ /**
5
+ * The price preference's details.
6
+ */
4
7
  price_preference: AdminPricePreference;
5
8
  }
6
9
  export interface AdminPricePreferenceListResponse extends PaginatedResponse<{
10
+ /**
11
+ * The list of price preferences.
12
+ */
7
13
  price_preferences: AdminPricePreference[];
8
14
  }> {
9
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,WAAW,gCACf,SAAQ,iBAAiB,CAAC;IACxB,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAC;CAAG;AAEP,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/pricing/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,WAAW,gCACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAC;CAAG;AAEP,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}
@@ -1,8 +1,17 @@
1
1
  import { AdminProduct } from "../../product";
2
2
  import { BaseProductCategory } from "../common";
3
3
  export interface AdminProductCategory extends Omit<BaseProductCategory, "products" | "category_children" | "parent_category"> {
4
+ /**
5
+ * The category's children.
6
+ */
4
7
  category_children: AdminProductCategory[];
8
+ /**
9
+ * The parent category's details.
10
+ */
5
11
  parent_category: AdminProductCategory | null;
12
+ /**
13
+ * The products that belong to this category.
14
+ */
6
15
  products?: AdminProduct[];
7
16
  }
8
17
  //# sourceMappingURL=entities.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE/C,MAAM,WAAW,oBACf,SAAQ,IAAI,CACV,mBAAmB,EACnB,UAAU,GAAG,mBAAmB,GAAG,iBAAiB,CACrD;IACD,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;IACzC,eAAe,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAC5C,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B"}
1
+ {"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE/C,MAAM,WAAW,oBACf,SAAQ,IAAI,CACV,mBAAmB,EACnB,UAAU,GAAG,mBAAmB,GAAG,iBAAiB,CACrD;IACD;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;IACzC;;OAEG;IACH,eAAe,EAAE,oBAAoB,GAAG,IAAI,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B"}
@@ -1,25 +1,85 @@
1
1
  export interface AdminCreateProductCategory {
2
+ /**
3
+ * The product category's name.
4
+ */
2
5
  name: string;
6
+ /**
7
+ * The product category's description.
8
+ */
3
9
  description?: string;
10
+ /**
11
+ * The product category's unique handle. Can be used to create
12
+ * human-readable URLs.
13
+ */
4
14
  handle?: string;
15
+ /**
16
+ * Whether the category is only available and viewable by
17
+ * admin users.
18
+ */
5
19
  is_internal?: boolean;
20
+ /**
21
+ * Whether the category is active. If disabled, the category
22
+ * isn't retrieved in the store API routes.
23
+ */
6
24
  is_active?: boolean;
25
+ /**
26
+ * The ID of the parent category.
27
+ */
7
28
  parent_category_id?: string;
29
+ /**
30
+ * The category's ranking among its sibling categories.
31
+ */
8
32
  rank?: number;
33
+ /**
34
+ * Key-value pairs of custom data.
35
+ */
9
36
  metadata?: Record<string, unknown>;
10
37
  }
11
38
  export interface AdminUpdateProductCategory {
39
+ /**
40
+ * The product category's name.
41
+ */
12
42
  name?: string;
43
+ /**
44
+ * The product category's description.
45
+ */
13
46
  description?: string;
47
+ /**
48
+ * The product category's unique handle. Can be used to create
49
+ * human-readable URLs.
50
+ */
14
51
  handle?: string;
52
+ /**
53
+ * Whether the category is only available and viewable by
54
+ * admin users.
55
+ */
15
56
  is_internal?: boolean;
57
+ /**
58
+ * Whether the category is active. If disabled, the category
59
+ * isn't retrieved in the store API routes.
60
+ */
16
61
  is_active?: boolean;
62
+ /**
63
+ * The ID of the parent category.
64
+ */
17
65
  parent_category_id?: string | null;
66
+ /**
67
+ * The category's ranking among its sibling categories.
68
+ */
18
69
  rank?: number;
70
+ /**
71
+ * Key-value pairs of custom data.
72
+ */
19
73
  metadata?: Record<string, unknown>;
20
74
  }
21
75
  export interface AdminUpdateProductCategoryProducts {
76
+ /**
77
+ * IDs of products to add to the category.
78
+ */
22
79
  add?: string[];
80
+ /**
81
+ * IDs of products to remove from the category.
82
+ */
23
83
  remove?: string[];
24
84
  }
25
85
  //# sourceMappingURL=payloads.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kCAAkC;IACjD,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
1
+ {"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
@@ -1,6 +1,12 @@
1
1
  import { BaseProductCategoryListParams, BaseProductCategoryParams } from "../common";
2
2
  export interface AdminProductCategoryListParams extends BaseProductCategoryListParams {
3
+ /**
4
+ * Filter by whether the category is only available internally.
5
+ */
3
6
  is_internal?: boolean;
7
+ /**
8
+ * Filter by whether the category is active.
9
+ */
4
10
  is_active?: boolean;
5
11
  }
6
12
  export interface AdminProductCategoryParams extends BaseProductCategoryParams {
@@ -1 +1 @@
1
- {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EAC1B,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,8BACf,SAAQ,6BAA6B;IACrC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;CAAG"}
1
+ {"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EAC1B,MAAM,WAAW,CAAA;AAElB,MAAM,WAAW,8BACf,SAAQ,6BAA6B;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;CAAG"}
@@ -1,9 +1,15 @@
1
1
  import { DeleteResponse, PaginatedResponse } from "../../common";
2
2
  import { AdminProductCategory } from "./entities";
3
3
  export interface AdminProductCategoryResponse {
4
+ /**
5
+ * The category's details.
6
+ */
4
7
  product_category: AdminProductCategory;
5
8
  }
6
9
  export interface AdminProductCategoryListResponse extends PaginatedResponse<{
10
+ /**
11
+ * The list of product categories.
12
+ */
7
13
  product_categories: AdminProductCategory[];
8
14
  }> {
9
15
  }
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,WAAW,gCACf,SAAQ,iBAAiB,CAAC;IACxB,kBAAkB,EAAE,oBAAoB,EAAE,CAAA;CAC3C,CAAC;CAAG;AAEP,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/product-category/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,WAAW,gCACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,EAAE,CAAA;CAC3C,CAAC;CAAG;AAEP,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}
@@ -15,7 +15,8 @@ export interface BaseProductCategory {
15
15
  */
16
16
  description: string;
17
17
  /**
18
- * The category's handle.
18
+ * The product category's unique handle. Can be used to create
19
+ * human-readable URLs.
19
20
  */
20
21
  handle: string;
21
22
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product-category/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,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC3C;;OAEG;IACH,iBAAiB,EAAE,mBAAmB,EAAE,CAAA;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,6BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,6BAA6B,CAAC;IAC/C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,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;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/product-category/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,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC3C;;OAEG;IACH,iBAAiB,EAAE,mBAAmB,EAAE,CAAA;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,6BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,6BAA6B,CAAC;IAC/C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,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;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC"}
@@ -36,7 +36,7 @@ export interface TaxRateDTO {
36
36
  /**
37
37
  * Whether the tax rate should be combined with parent rates.
38
38
  *
39
- * Learn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).
39
+ * Learn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).
40
40
  */
41
41
  is_combinable: boolean;
42
42
  /**
@@ -108,7 +108,7 @@ export interface UpdateTaxRateDTO {
108
108
  /**
109
109
  * Whether the tax rate is combinable.
110
110
  *
111
- * Learn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).
111
+ * Learn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).
112
112
  */
113
113
  is_combinable?: boolean;
114
114
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/types",
3
- "version": "2.0.0-rc-20241022183311",
3
+ "version": "2.0.1-preview-20241025120203",
4
4
  "description": "Medusa Types definition",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",