@medusajs/js-sdk 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 (101) hide show
  1. package/dist/admin/api-key.d.ts +8 -8
  2. package/dist/admin/api-key.js +8 -8
  3. package/dist/admin/campaign.d.ts +8 -8
  4. package/dist/admin/campaign.js +8 -8
  5. package/dist/admin/claim.d.ts +22 -22
  6. package/dist/admin/claim.js +22 -22
  7. package/dist/admin/currency.d.ts +4 -4
  8. package/dist/admin/currency.js +4 -4
  9. package/dist/admin/customer-group.d.ts +8 -8
  10. package/dist/admin/customer-group.js +8 -8
  11. package/dist/admin/customer.d.ts +27 -7
  12. package/dist/admin/customer.d.ts.map +1 -1
  13. package/dist/admin/customer.js +33 -7
  14. package/dist/admin/customer.js.map +1 -1
  15. package/dist/admin/exchange.d.ts +21 -21
  16. package/dist/admin/exchange.js +21 -21
  17. package/dist/admin/fulfillment-provider.d.ts +2 -2
  18. package/dist/admin/fulfillment-provider.js +2 -2
  19. package/dist/admin/fulfillment-set.d.ts +6 -6
  20. package/dist/admin/fulfillment-set.js +6 -6
  21. package/dist/admin/fulfillment.d.ts +3 -3
  22. package/dist/admin/fulfillment.js +3 -3
  23. package/dist/admin/inventory-item.d.ts +12 -12
  24. package/dist/admin/inventory-item.js +12 -12
  25. package/dist/admin/invite.d.ts +8 -8
  26. package/dist/admin/invite.js +8 -8
  27. package/dist/admin/payment-collection.d.ts +0 -2
  28. package/dist/admin/payment-collection.d.ts.map +1 -1
  29. package/dist/admin/payment-collection.js +0 -12
  30. package/dist/admin/payment-collection.js.map +1 -1
  31. package/dist/admin/price-list.d.ts +195 -1
  32. package/dist/admin/price-list.d.ts.map +1 -1
  33. package/dist/admin/price-list.js +194 -0
  34. package/dist/admin/price-list.js.map +1 -1
  35. package/dist/admin/price-preference.d.ts +133 -0
  36. package/dist/admin/price-preference.d.ts.map +1 -1
  37. package/dist/admin/price-preference.js +133 -0
  38. package/dist/admin/price-preference.js.map +1 -1
  39. package/dist/admin/product-category.d.ts +150 -0
  40. package/dist/admin/product-category.d.ts.map +1 -1
  41. package/dist/admin/product-category.js +150 -0
  42. package/dist/admin/product-category.js.map +1 -1
  43. package/dist/admin/product-collection.d.ts +149 -0
  44. package/dist/admin/product-collection.d.ts.map +1 -1
  45. package/dist/admin/product-collection.js +149 -0
  46. package/dist/admin/product-collection.js.map +1 -1
  47. package/dist/auth/index.d.ts +10 -10
  48. package/dist/auth/index.js +10 -10
  49. package/dist/esm/admin/api-key.d.ts +8 -8
  50. package/dist/esm/admin/api-key.js +8 -8
  51. package/dist/esm/admin/campaign.d.ts +8 -8
  52. package/dist/esm/admin/campaign.js +8 -8
  53. package/dist/esm/admin/claim.d.ts +22 -22
  54. package/dist/esm/admin/claim.js +22 -22
  55. package/dist/esm/admin/currency.d.ts +4 -4
  56. package/dist/esm/admin/currency.js +4 -4
  57. package/dist/esm/admin/customer-group.d.ts +8 -8
  58. package/dist/esm/admin/customer-group.js +8 -8
  59. package/dist/esm/admin/customer.d.ts +27 -7
  60. package/dist/esm/admin/customer.d.ts.map +1 -1
  61. package/dist/esm/admin/customer.js +35 -7
  62. package/dist/esm/admin/customer.js.map +1 -1
  63. package/dist/esm/admin/exchange.d.ts +21 -21
  64. package/dist/esm/admin/exchange.js +21 -21
  65. package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
  66. package/dist/esm/admin/fulfillment-provider.js +2 -2
  67. package/dist/esm/admin/fulfillment-set.d.ts +6 -6
  68. package/dist/esm/admin/fulfillment-set.js +6 -6
  69. package/dist/esm/admin/fulfillment.d.ts +3 -3
  70. package/dist/esm/admin/fulfillment.js +3 -3
  71. package/dist/esm/admin/inventory-item.d.ts +12 -12
  72. package/dist/esm/admin/inventory-item.js +12 -12
  73. package/dist/esm/admin/invite.d.ts +8 -8
  74. package/dist/esm/admin/invite.js +8 -8
  75. package/dist/esm/admin/payment-collection.d.ts +0 -2
  76. package/dist/esm/admin/payment-collection.d.ts.map +1 -1
  77. package/dist/esm/admin/payment-collection.js +0 -16
  78. package/dist/esm/admin/payment-collection.js.map +1 -1
  79. package/dist/esm/admin/price-list.d.ts +195 -1
  80. package/dist/esm/admin/price-list.d.ts.map +1 -1
  81. package/dist/esm/admin/price-list.js +194 -0
  82. package/dist/esm/admin/price-list.js.map +1 -1
  83. package/dist/esm/admin/price-preference.d.ts +133 -0
  84. package/dist/esm/admin/price-preference.d.ts.map +1 -1
  85. package/dist/esm/admin/price-preference.js +133 -0
  86. package/dist/esm/admin/price-preference.js.map +1 -1
  87. package/dist/esm/admin/product-category.d.ts +150 -0
  88. package/dist/esm/admin/product-category.d.ts.map +1 -1
  89. package/dist/esm/admin/product-category.js +150 -0
  90. package/dist/esm/admin/product-category.js.map +1 -1
  91. package/dist/esm/admin/product-collection.d.ts +149 -0
  92. package/dist/esm/admin/product-collection.d.ts.map +1 -1
  93. package/dist/esm/admin/product-collection.js +149 -0
  94. package/dist/esm/admin/product-collection.js.map +1 -1
  95. package/dist/esm/auth/index.d.ts +10 -10
  96. package/dist/esm/auth/index.js +10 -10
  97. package/dist/esm/store/index.d.ts +73 -73
  98. package/dist/esm/store/index.js +73 -73
  99. package/dist/store/index.d.ts +73 -73
  100. package/dist/store/index.js +73 -73
  101. package/package.json +2 -2
@@ -15,9 +15,9 @@ export class Store {
15
15
  this.region = {
16
16
  /**
17
17
  * This method retrieves the paginated list of regions in the store. It sends a request to the
18
- * [List Regions API route](https://docs.medusajs.com/v2/api/store#regions_getregions).
18
+ * [List Regions API route](https://docs.medusajs.com/api/store#regions_getregions).
19
19
  *
20
- * Related guide: [How to list regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/list).
20
+ * Related guide: [How to list regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/list).
21
21
  *
22
22
  * @param query - Filters and pagination configurations.
23
23
  * @param headers - Headers to pass in the request
@@ -59,7 +59,7 @@ export class Store {
59
59
  * })
60
60
  * ```
61
61
  *
62
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
62
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
63
63
  */
64
64
  list: (query, headers) => __awaiter(this, void 0, void 0, function* () {
65
65
  return this.client.fetch(`/store/regions`, {
@@ -68,10 +68,10 @@ export class Store {
68
68
  });
69
69
  }),
70
70
  /**
71
- * This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/v2/api/store#regions_getregionsid)
71
+ * This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/api/store#regions_getregionsid)
72
72
  * API route.
73
73
  *
74
- * Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/store-retrieve-region).
74
+ * Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region).
75
75
  *
76
76
  * @param id - The region's ID.
77
77
  * @param query - Configure the fields to retrieve in the region.
@@ -102,7 +102,7 @@ export class Store {
102
102
  * })
103
103
  * ```
104
104
  *
105
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
105
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
106
106
  */
107
107
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
108
108
  return this.client.fetch(`/store/regions/${id}`, {
@@ -114,9 +114,9 @@ export class Store {
114
114
  this.collection = {
115
115
  /**
116
116
  * This method retrieves a paginated list of product collections. It sends a request to the
117
- * [List Collections](https://docs.medusajs.com/v2/api/store#collections_getcollections) API route.
117
+ * [List Collections](https://docs.medusajs.com/api/store#collections_getcollections) API route.
118
118
  *
119
- * Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list).
119
+ * Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/list).
120
120
  *
121
121
  * @param query - Filters and pagination configurations.
122
122
  * @param headers - Headers to pass in the request
@@ -158,7 +158,7 @@ export class Store {
158
158
  * })
159
159
  * ```
160
160
  *
161
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
161
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
162
162
  */
163
163
  list: (query, headers) => __awaiter(this, void 0, void 0, function* () {
164
164
  return this.client.fetch(`/store/collections`, {
@@ -167,10 +167,10 @@ export class Store {
167
167
  });
168
168
  }),
169
169
  /**
170
- * This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/v2/api/store#collections_getcollectionsid)
170
+ * This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/api/store#collections_getcollectionsid)
171
171
  * API route.
172
172
  *
173
- * Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve).
173
+ * Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve).
174
174
  *
175
175
  * @param id - The ID of the collection to retrieve.
176
176
  * @param query - Configure the fields to retrieve in the collection.
@@ -198,7 +198,7 @@ export class Store {
198
198
  * })
199
199
  * ```
200
200
  *
201
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
201
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
202
202
  */
203
203
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
204
204
  return this.client.fetch(`/store/collections/${id}`, {
@@ -210,9 +210,9 @@ export class Store {
210
210
  this.category = {
211
211
  /**
212
212
  * This method retrieves a paginated list of product categories. It sends a request to the
213
- * [List Categories](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategories) API route.
213
+ * [List Categories](https://docs.medusajs.com/api/store#product-categories_getproductcategories) API route.
214
214
  *
215
- * Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list).
215
+ * Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/list).
216
216
  *
217
217
  * @param query - Filters and pagination configurations.
218
218
  * @param headers - Headers to pass in the request.
@@ -254,7 +254,7 @@ export class Store {
254
254
  * })
255
255
  * ```
256
256
  *
257
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
257
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
258
258
  */
259
259
  list: (query, headers) => __awaiter(this, void 0, void 0, function* () {
260
260
  return this.client.fetch(`/store/product-categories`, {
@@ -264,9 +264,9 @@ export class Store {
264
264
  }),
265
265
  /**
266
266
  * This method retrieves a category by its ID. It sends a request to the
267
- * [Retrieve Product Category](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategoriesid).
267
+ * [Retrieve Product Category](https://docs.medusajs.com/api/store#product-categories_getproductcategoriesid).
268
268
  *
269
- * Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve).
269
+ * Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve).
270
270
  *
271
271
  * @param id - The ID of the category to retrieve.
272
272
  * @param query - Configure the fields to retrieve in the category.
@@ -294,7 +294,7 @@ export class Store {
294
294
  * })
295
295
  * ```
296
296
  *
297
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
297
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
298
298
  */
299
299
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
300
300
  return this.client.fetch(`/store/product-categories/${id}`, {
@@ -306,12 +306,12 @@ export class Store {
306
306
  this.product = {
307
307
  /**
308
308
  * This method retrieves a list of products. It sends a request to the
309
- * [List Products API route](https://docs.medusajs.com/v2/api/store#products_getproducts).
309
+ * [List Products API route](https://docs.medusajs.com/api/store#products_getproducts).
310
310
  *
311
311
  * Related guides:
312
312
  *
313
- * - [How to list products in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/list).
314
- * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)
313
+ * - [How to list products in a storefront](https://docs.medusajs.com/resources/storefront-development/products/list).
314
+ * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
315
315
  *
316
316
  * @param query - Filters and pagination configurations.
317
317
  * @param headers - Headers to pass in the request.
@@ -353,7 +353,7 @@ export class Store {
353
353
  * })
354
354
  * ```
355
355
  *
356
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
356
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
357
357
  */
358
358
  list: (query, headers) => __awaiter(this, void 0, void 0, function* () {
359
359
  return this.client.fetch(`/store/products`, {
@@ -363,12 +363,12 @@ export class Store {
363
363
  }),
364
364
  /**
365
365
  * This method is used to retrieve a product by its ID. It sends a request to the
366
- * [Get Product](https://docs.medusajs.com/v2/api/store#products_getproductsid) API route.
366
+ * [Get Product](https://docs.medusajs.com/api/store#products_getproductsid) API route.
367
367
  *
368
368
  * Related guides:
369
369
  *
370
- * - [How to retrieve a product in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/retrieve).
371
- * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)
370
+ * - [How to retrieve a product in the storefront](https://docs.medusajs.com/resources/storefront-development/products/retrieve).
371
+ * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
372
372
  *
373
373
  * @param id - The product's ID.
374
374
  * @param query - Configure the fields to retrieve in the product.
@@ -396,7 +396,7 @@ export class Store {
396
396
  * })
397
397
  * ```
398
398
  *
399
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
399
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
400
400
  */
401
401
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
402
402
  return this.client.fetch(`/store/products/${id}`, {
@@ -406,14 +406,14 @@ export class Store {
406
406
  }),
407
407
  };
408
408
  /**
409
- * Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart).
409
+ * Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/resources/storefront-development/cart).
410
410
  */
411
411
  this.cart = {
412
412
  /**
413
- * This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/v2/api/store#carts_postcarts)
413
+ * This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/api/store#carts_postcarts)
414
414
  * API route.
415
415
  *
416
- * Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/create).
416
+ * Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/create).
417
417
  *
418
418
  * @param body - The details of the cart to create.
419
419
  * @param query - Configure the fields to retrieve in the cart.
@@ -438,9 +438,9 @@ export class Store {
438
438
  }),
439
439
  /**
440
440
  * This method updates a cart. It sends a request to the
441
- * [Update Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsid) API route.
441
+ * [Update Cart](https://docs.medusajs.com/api/store#carts_postcartsid) API route.
442
442
  *
443
- * Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/update).
443
+ * Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/update).
444
444
  *
445
445
  * @param id - The cart's ID.
446
446
  * @param body - The data to update in the cart.
@@ -466,9 +466,9 @@ export class Store {
466
466
  }),
467
467
  /**
468
468
  * This method retrieves a cart by its ID. It sends a request to the
469
- * [Get Cart](https://docs.medusajs.com/v2/api/store#carts_getcartsid) API route.
469
+ * [Get Cart](https://docs.medusajs.com/api/store#carts_getcartsid) API route.
470
470
  *
471
- * Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/retrieve).
471
+ * Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/retrieve).
472
472
  *
473
473
  * @param id - The cart's ID.
474
474
  * @param query - Configure the fields to retrieve in the cart.
@@ -496,7 +496,7 @@ export class Store {
496
496
  * })
497
497
  * ```
498
498
  *
499
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
499
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
500
500
  */
501
501
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
502
502
  return this.client.fetch(`/store/carts/${id}`, {
@@ -506,9 +506,9 @@ export class Store {
506
506
  }),
507
507
  /**
508
508
  * This methods adds a product variant to the cart as a line item. It sends a request to the
509
- * [Add Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitems) API route.
509
+ * [Add Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitems) API route.
510
510
  *
511
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
511
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
512
512
  *
513
513
  * @param cartId - The cart's ID.
514
514
  * @param body - The details of the item to add.
@@ -535,9 +535,9 @@ export class Store {
535
535
  }),
536
536
  /**
537
537
  * This method updates a line item in a cart. It sends a request to the
538
- * [Update Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitemsline_id) API route.
538
+ * [Update Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitemsline_id) API route.
539
539
  *
540
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
540
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
541
541
  *
542
542
  * @param cartId - The cart's ID.
543
543
  * @param lineItemId - The line item's ID.
@@ -568,9 +568,9 @@ export class Store {
568
568
  }),
569
569
  /**
570
570
  * This method deletes a line item from a cart. It sends a request to the
571
- * [Remove Line Item](https://docs.medusajs.com/v2/api/store#carts_deletecartsidlineitemsline_id) API route.
571
+ * [Remove Line Item](https://docs.medusajs.com/api/store#carts_deletecartsidlineitemsline_id) API route.
572
572
  *
573
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
573
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
574
574
  *
575
575
  * @param cartId - The cart's ID.
576
576
  * @param lineItemId - The item's ID.
@@ -594,9 +594,9 @@ export class Store {
594
594
  }),
595
595
  /**
596
596
  * This method adds a shipping method to a cart. It sends a request to
597
- * the [Add Shipping Method](https://docs.medusajs.com/v2/api/store#carts_postcartsidshippingmethods) API routes.
597
+ * the [Add Shipping Method](https://docs.medusajs.com/api/store#carts_postcartsidshippingmethods) API routes.
598
598
  *
599
- * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping).
599
+ * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
600
600
  *
601
601
  * @param cartId - The cart's ID.
602
602
  * @param body - The shipping method's details.
@@ -625,10 +625,10 @@ export class Store {
625
625
  }),
626
626
  /**
627
627
  * This method completes a cart and places the order. It's the last step of the checkout flow.
628
- * The method sends a request to the [Complete Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsidcomplete)
628
+ * The method sends a request to the [Complete Cart](https://docs.medusajs.com/api/store#carts_postcartsidcomplete)
629
629
  * API route.
630
630
  *
631
- * Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart).
631
+ * Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart).
632
632
  *
633
633
  * @param cartId - The cart's ID.
634
634
  * @param query - Configure the fields to retrieve in the created order.
@@ -658,10 +658,10 @@ export class Store {
658
658
  this.fulfillment = {
659
659
  /**
660
660
  * This method retrieves the list of shipping options for a cart. It sends a request to
661
- * the [List Shipping Options](https://docs.medusajs.com/v2/api/store#shipping-options_getshippingoptions)
661
+ * the [List Shipping Options](https://docs.medusajs.com/api/store#shipping-options_getshippingoptions)
662
662
  * API route.
663
663
  *
664
- * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping).
664
+ * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
665
665
  *
666
666
  * @param query - The cart's details along with configurations of the fields to retrieve in the options.
667
667
  * @param headers - Headers to pass in the request.
@@ -685,10 +685,10 @@ export class Store {
685
685
  this.payment = {
686
686
  /**
687
687
  * This method retrieves the payment providers available in a region, which is useful during checkout.
688
- * It sends a request to the [List Payment Providers](https://docs.medusajs.com/v2/api/store#payment-providers_getpaymentproviders)
688
+ * It sends a request to the [List Payment Providers](https://docs.medusajs.com/api/store#payment-providers_getpaymentproviders)
689
689
  * API route.
690
690
  *
691
- * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment).
691
+ * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/payment).
692
692
  *
693
693
  * @param query - The filters to apply on the retrieved providers, along with configurations of the
694
694
  * fields to retrieve in the options.
@@ -737,7 +737,7 @@ export class Store {
737
737
  * })
738
738
  * ```
739
739
  *
740
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
740
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
741
741
  */
742
742
  listPaymentProviders: (query, headers) => __awaiter(this, void 0, void 0, function* () {
743
743
  return this.client.fetch(`/store/payment-providers`, {
@@ -747,14 +747,14 @@ export class Store {
747
747
  }),
748
748
  /**
749
749
  * This method creates a payment session of a cart's payment collection, selecting a payment provider.
750
- * It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollectionsidpaymentsessions)
750
+ * It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/api/store#payment-collections_postpaymentcollectionsidpaymentsessions)
751
751
  * API route.
752
752
  *
753
753
  * If the cart doesn't have a payment collection, a payment collection is created for the cart by
754
- * sending a request to the [Create Payment Collection](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollections)
754
+ * sending a request to the [Create Payment Collection](https://docs.medusajs.com/api/store#payment-collections_postpaymentcollections)
755
755
  * API route.
756
756
  *
757
- * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment).
757
+ * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/payment).
758
758
  *
759
759
  * @param cart - The cart's details.
760
760
  * @param body - The payment session's details.
@@ -800,7 +800,7 @@ export class Store {
800
800
  this.order = {
801
801
  /**
802
802
  * This method retrieves a paginated list of orders matching the specified filters. It
803
- * sends a request to the [List Orders](https://docs.medusajs.com/v2/api/store#orders_getorders)
803
+ * sends a request to the [List Orders](https://docs.medusajs.com/api/store#orders_getorders)
804
804
  * API route.
805
805
  *
806
806
  * @param query - Configure the fields to retrieve in the orders.
@@ -843,7 +843,7 @@ export class Store {
843
843
  * })
844
844
  * ```
845
845
  *
846
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
846
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
847
847
  */
848
848
  list: (query, headers) => __awaiter(this, void 0, void 0, function* () {
849
849
  return this.client.fetch(`/store/orders`, {
@@ -853,7 +853,7 @@ export class Store {
853
853
  }),
854
854
  /**
855
855
  * This method retrieves an order by its ID. It sends a request to the
856
- * [Get Order](https://docs.medusajs.com/v2/api/store#orders_getordersid) API route.
856
+ * [Get Order](https://docs.medusajs.com/api/store#orders_getordersid) API route.
857
857
  *
858
858
  * @param id - The order's ID.
859
859
  * @param query - Configure the fields to retrieve in the order.
@@ -881,7 +881,7 @@ export class Store {
881
881
  * })
882
882
  * ```
883
883
  *
884
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
884
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
885
885
  */
886
886
  retrieve: (id, query, headers) => __awaiter(this, void 0, void 0, function* () {
887
887
  return this.client.fetch(`/store/orders/${id}`, {
@@ -892,13 +892,13 @@ export class Store {
892
892
  };
893
893
  this.customer = {
894
894
  /**
895
- * This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomers)
895
+ * This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/api/store#customers_postcustomers)
896
896
  * API route.
897
897
  *
898
898
  * You must use the {@link Auth.register} method first to retrieve a registration token. Then, pass that
899
899
  * registration token in the `headers` parameter of this method as an authorization bearer header.
900
900
  *
901
- * Related guide: [How to register customer in storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/register)
901
+ * Related guide: [How to register customer in storefront](https://docs.medusajs.com/resources/storefront-development/customers/register)
902
902
  *
903
903
  * @param body - The customer's details.
904
904
  * @param query - Configure the fields to retrieve in the customer.
@@ -937,9 +937,9 @@ export class Store {
937
937
  * first with the {@link Auth.login} method.
938
938
  *
939
939
  * It sends a request to the
940
- * [Update Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomersme) API route.
940
+ * [Update Customer](https://docs.medusajs.com/api/store#customers_postcustomersme) API route.
941
941
  *
942
- * Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/profile).
942
+ * Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/profile).
943
943
  *
944
944
  * @param body - The customer's details to update.
945
945
  * @param query - Configure the fields to retrieve in the customer.
@@ -966,7 +966,7 @@ export class Store {
966
966
  * This method retrieves the logged-in customer's details. The customer must be logged in
967
967
  * first with the {@link Auth.login} method.
968
968
  *
969
- * It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/v2/api/store#customers_getcustomersme)
969
+ * It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/api/store#customers_getcustomersme)
970
970
  * API route.
971
971
  *
972
972
  * @param query - Configure the fields to retrieve in the customer.
@@ -989,10 +989,10 @@ export class Store {
989
989
  * This method creates an address for the logged-in customer. The customer must be logged in
990
990
  * first with the {@link Auth.login} method.
991
991
  *
992
- * It sends a request to the [Create Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddresses)
992
+ * It sends a request to the [Create Address](https://docs.medusajs.com/api/store#customers_postcustomersmeaddresses)
993
993
  * API route.
994
994
  *
995
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
995
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
996
996
  *
997
997
  * @param body - The address's details.
998
998
  * @param query - Configure the fields to retrieve in the customer.
@@ -1019,10 +1019,10 @@ export class Store {
1019
1019
  * This method updates the address of the logged-in customer. The customer must be logged in
1020
1020
  * first with the {@link Auth.login} method.
1021
1021
  *
1022
- * It sends a request to the [Update Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddressesaddress_id)
1022
+ * It sends a request to the [Update Address](https://docs.medusajs.com/api/store#customers_postcustomersmeaddressesaddress_id)
1023
1023
  * API route.
1024
1024
  *
1025
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
1025
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
1026
1026
  *
1027
1027
  * @param addressId - The ID of the address to update.
1028
1028
  * @param body - The details to update in the address.
@@ -1053,10 +1053,10 @@ export class Store {
1053
1053
  * This method retrieves the logged-in customer's address. The customer must be logged in
1054
1054
  * first with the {@link Auth.login} method.
1055
1055
  *
1056
- * It sends a request to the [List Customer's Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddresses)
1056
+ * It sends a request to the [List Customer's Address](https://docs.medusajs.com/api/store#customers_getcustomersmeaddresses)
1057
1057
  * API route.
1058
1058
  *
1059
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
1059
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
1060
1060
  *
1061
1061
  * @param query - Configure the fields to retrieve in the addresses.
1062
1062
  * @param headers - Headers to pass in the request.
@@ -1098,7 +1098,7 @@ export class Store {
1098
1098
  * })
1099
1099
  * ```
1100
1100
  *
1101
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
1101
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
1102
1102
  */
1103
1103
  listAddress: (query, headers) => __awaiter(this, void 0, void 0, function* () {
1104
1104
  return this.client.fetch(`/store/customers/me/addresses`, {
@@ -1110,10 +1110,10 @@ export class Store {
1110
1110
  * This method retrieves an address of the logged-in customer. The customer must be logged in
1111
1111
  * first with the {@link Auth.login} method.
1112
1112
  *
1113
- * It sends a request to the [Get Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddressesaddress_id)
1113
+ * It sends a request to the [Get Address](https://docs.medusajs.com/api/store#customers_getcustomersmeaddressesaddress_id)
1114
1114
  * API route.
1115
1115
  *
1116
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
1116
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
1117
1117
  *
1118
1118
  * @param addressId - The address's ID.
1119
1119
  * @param query - Configure the fields to retrieve in the address.
@@ -1146,7 +1146,7 @@ export class Store {
1146
1146
  * })
1147
1147
  * ```
1148
1148
  *
1149
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
1149
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
1150
1150
  */
1151
1151
  retrieveAddress: (addressId, query, headers) => __awaiter(this, void 0, void 0, function* () {
1152
1152
  return this.client.fetch(`/store/customers/me/addresses/${addressId}`, {
@@ -1158,10 +1158,10 @@ export class Store {
1158
1158
  * This method deletes an address of the logged-in customer. The customer must be logged in
1159
1159
  * first with the {@link Auth.login} method.
1160
1160
  *
1161
- * It sends a request to the [Remove Address](https://docs.medusajs.com/v2/api/store#customers_deletecustomersmeaddressesaddress_id)
1161
+ * It sends a request to the [Remove Address](https://docs.medusajs.com/api/store#customers_deletecustomersmeaddressesaddress_id)
1162
1162
  * API route.
1163
1163
  *
1164
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
1164
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
1165
1165
  *
1166
1166
  * @param addressId - The address's ID.
1167
1167
  * @param headers - Headers to pass in the request.