@medusajs/js-sdk 2.0.0 → 2.0.1-preview-20241025150152

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
@@ -13,9 +13,9 @@ export declare class Store {
13
13
  region: {
14
14
  /**
15
15
  * This method retrieves the paginated list of regions in the store. It sends a request to the
16
- * [List Regions API route](https://docs.medusajs.com/v2/api/store#regions_getregions).
16
+ * [List Regions API route](https://docs.medusajs.com/api/store#regions_getregions).
17
17
  *
18
- * Related guide: [How to list regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/list).
18
+ * Related guide: [How to list regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/list).
19
19
  *
20
20
  * @param query - Filters and pagination configurations.
21
21
  * @param headers - Headers to pass in the request
@@ -57,14 +57,14 @@ export declare class Store {
57
57
  * })
58
58
  * ```
59
59
  *
60
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
60
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
61
61
  */
62
62
  list: (query?: FindParams & HttpTypes.StoreRegionFilters, headers?: ClientHeaders) => Promise<HttpTypes.StoreRegionListResponse>;
63
63
  /**
64
- * 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)
64
+ * This method retrieves a region by its ID. It sends a request to the [Get Region](https://docs.medusajs.com/api/store#regions_getregionsid)
65
65
  * API route.
66
66
  *
67
- * Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/regions/store-retrieve-region).
67
+ * Related guide: [Store and retrieve regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region).
68
68
  *
69
69
  * @param id - The region's ID.
70
70
  * @param query - Configure the fields to retrieve in the region.
@@ -95,16 +95,16 @@ export declare class Store {
95
95
  * })
96
96
  * ```
97
97
  *
98
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
98
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
99
99
  */
100
100
  retrieve: (id: string, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreRegionResponse>;
101
101
  };
102
102
  collection: {
103
103
  /**
104
104
  * This method retrieves a paginated list of product collections. It sends a request to the
105
- * [List Collections](https://docs.medusajs.com/v2/api/store#collections_getcollections) API route.
105
+ * [List Collections](https://docs.medusajs.com/api/store#collections_getcollections) API route.
106
106
  *
107
- * Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list).
107
+ * Related guide: [How to retrieve collections in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/list).
108
108
  *
109
109
  * @param query - Filters and pagination configurations.
110
110
  * @param headers - Headers to pass in the request
@@ -146,14 +146,14 @@ export declare class Store {
146
146
  * })
147
147
  * ```
148
148
  *
149
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
149
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
150
150
  */
151
151
  list: (query?: FindParams & HttpTypes.StoreCollectionFilters, headers?: ClientHeaders) => Promise<HttpTypes.StoreCollectionListResponse>;
152
152
  /**
153
- * 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)
153
+ * This method retrieves a collection by its ID. It sends a request to the [Get Collection](https://docs.medusajs.com/api/store#collections_getcollectionsid)
154
154
  * API route.
155
155
  *
156
- * Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve).
156
+ * Related guide: [How to retrieve a collection in a storefront](https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve).
157
157
  *
158
158
  * @param id - The ID of the collection to retrieve.
159
159
  * @param query - Configure the fields to retrieve in the collection.
@@ -181,16 +181,16 @@ export declare class Store {
181
181
  * })
182
182
  * ```
183
183
  *
184
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
184
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
185
185
  */
186
186
  retrieve: (id: string, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCollectionResponse>;
187
187
  };
188
188
  category: {
189
189
  /**
190
190
  * This method retrieves a paginated list of product categories. It sends a request to the
191
- * [List Categories](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategories) API route.
191
+ * [List Categories](https://docs.medusajs.com/api/store#product-categories_getproductcategories) API route.
192
192
  *
193
- * Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list).
193
+ * Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/list).
194
194
  *
195
195
  * @param query - Filters and pagination configurations.
196
196
  * @param headers - Headers to pass in the request.
@@ -232,14 +232,14 @@ export declare class Store {
232
232
  * })
233
233
  * ```
234
234
  *
235
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
235
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
236
236
  */
237
237
  list: (query?: FindParams & HttpTypes.StoreProductCategoryListParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreProductCategoryListResponse>;
238
238
  /**
239
239
  * This method retrieves a category by its ID. It sends a request to the
240
- * [Retrieve Product Category](https://docs.medusajs.com/v2/api/store#product-categories_getproductcategoriesid).
240
+ * [Retrieve Product Category](https://docs.medusajs.com/api/store#product-categories_getproductcategoriesid).
241
241
  *
242
- * Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve).
242
+ * Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve).
243
243
  *
244
244
  * @param id - The ID of the category to retrieve.
245
245
  * @param query - Configure the fields to retrieve in the category.
@@ -267,19 +267,19 @@ export declare class Store {
267
267
  * })
268
268
  * ```
269
269
  *
270
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
270
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
271
271
  */
272
272
  retrieve: (id: string, query?: HttpTypes.StoreProductCategoryParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreProductCategoryResponse>;
273
273
  };
274
274
  product: {
275
275
  /**
276
276
  * This method retrieves a list of products. It sends a request to the
277
- * [List Products API route](https://docs.medusajs.com/v2/api/store#products_getproducts).
277
+ * [List Products API route](https://docs.medusajs.com/api/store#products_getproducts).
278
278
  *
279
279
  * Related guides:
280
280
  *
281
- * - [How to list products in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/list).
282
- * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)
281
+ * - [How to list products in a storefront](https://docs.medusajs.com/resources/storefront-development/products/list).
282
+ * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
283
283
  *
284
284
  * @param query - Filters and pagination configurations.
285
285
  * @param headers - Headers to pass in the request.
@@ -321,17 +321,17 @@ export declare class Store {
321
321
  * })
322
322
  * ```
323
323
  *
324
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
324
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
325
325
  */
326
326
  list: (query?: HttpTypes.StoreProductParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreProductListResponse>;
327
327
  /**
328
328
  * This method is used to retrieve a product by its ID. It sends a request to the
329
- * [Get Product](https://docs.medusajs.com/v2/api/store#products_getproductsid) API route.
329
+ * [Get Product](https://docs.medusajs.com/api/store#products_getproductsid) API route.
330
330
  *
331
331
  * Related guides:
332
332
  *
333
- * - [How to retrieve a product in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/retrieve).
334
- * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/products/price)
333
+ * - [How to retrieve a product in the storefront](https://docs.medusajs.com/resources/storefront-development/products/retrieve).
334
+ * - [How to retrieve a product variant's prices in the storefront](https://docs.medusajs.com/resources/storefront-development/products/price)
335
335
  *
336
336
  * @param id - The product's ID.
337
337
  * @param query - Configure the fields to retrieve in the product.
@@ -359,19 +359,19 @@ export declare class Store {
359
359
  * })
360
360
  * ```
361
361
  *
362
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
362
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
363
363
  */
364
364
  retrieve: (id: string, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreProductResponse>;
365
365
  };
366
366
  /**
367
- * Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart).
367
+ * Related guides: [How to implement carts in the storefront](https://docs.medusajs.com/resources/storefront-development/cart).
368
368
  */
369
369
  cart: {
370
370
  /**
371
- * This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/v2/api/store#carts_postcarts)
371
+ * This method creates a cart. It sends a request to the [Create Cart](https://docs.medusajs.com/api/store#carts_postcarts)
372
372
  * API route.
373
373
  *
374
- * Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/create).
374
+ * Related guide: [How to create a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/create).
375
375
  *
376
376
  * @param body - The details of the cart to create.
377
377
  * @param query - Configure the fields to retrieve in the cart.
@@ -389,9 +389,9 @@ export declare class Store {
389
389
  create: (body: HttpTypes.StoreCreateCart, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
390
390
  /**
391
391
  * This method updates a cart. It sends a request to the
392
- * [Update Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsid) API route.
392
+ * [Update Cart](https://docs.medusajs.com/api/store#carts_postcartsid) API route.
393
393
  *
394
- * Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/update).
394
+ * Related guide: [How to update a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/update).
395
395
  *
396
396
  * @param id - The cart's ID.
397
397
  * @param body - The data to update in the cart.
@@ -410,9 +410,9 @@ export declare class Store {
410
410
  update: (id: string, body: HttpTypes.StoreUpdateCart, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
411
411
  /**
412
412
  * This method retrieves a cart by its ID. It sends a request to the
413
- * [Get Cart](https://docs.medusajs.com/v2/api/store#carts_getcartsid) API route.
413
+ * [Get Cart](https://docs.medusajs.com/api/store#carts_getcartsid) API route.
414
414
  *
415
- * Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/retrieve).
415
+ * Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/retrieve).
416
416
  *
417
417
  * @param id - The cart's ID.
418
418
  * @param query - Configure the fields to retrieve in the cart.
@@ -440,14 +440,14 @@ export declare class Store {
440
440
  * })
441
441
  * ```
442
442
  *
443
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
443
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
444
444
  */
445
445
  retrieve: (id: string, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
446
446
  /**
447
447
  * This methods adds a product variant to the cart as a line item. It sends a request to the
448
- * [Add Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitems) API route.
448
+ * [Add Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitems) API route.
449
449
  *
450
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
450
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
451
451
  *
452
452
  * @param cartId - The cart's ID.
453
453
  * @param body - The details of the item to add.
@@ -467,9 +467,9 @@ export declare class Store {
467
467
  createLineItem: (cartId: string, body: HttpTypes.StoreAddCartLineItem, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
468
468
  /**
469
469
  * This method updates a line item in a cart. It sends a request to the
470
- * [Update Line Item](https://docs.medusajs.com/v2/api/store#carts_postcartsidlineitemsline_id) API route.
470
+ * [Update Line Item](https://docs.medusajs.com/api/store#carts_postcartsidlineitemsline_id) API route.
471
471
  *
472
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
472
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
473
473
  *
474
474
  * @param cartId - The cart's ID.
475
475
  * @param lineItemId - The line item's ID.
@@ -493,9 +493,9 @@ export declare class Store {
493
493
  updateLineItem: (cartId: string, lineItemId: string, body: HttpTypes.StoreUpdateCartLineItem, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
494
494
  /**
495
495
  * This method deletes a line item from a cart. It sends a request to the
496
- * [Remove Line Item](https://docs.medusajs.com/v2/api/store#carts_deletecartsidlineitemsline_id) API route.
496
+ * [Remove Line Item](https://docs.medusajs.com/api/store#carts_deletecartsidlineitemsline_id) API route.
497
497
  *
498
- * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items).
498
+ * Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
499
499
  *
500
500
  * @param cartId - The cart's ID.
501
501
  * @param lineItemId - The item's ID.
@@ -514,9 +514,9 @@ export declare class Store {
514
514
  deleteLineItem: (cartId: string, lineItemId: string, headers?: ClientHeaders) => Promise<HttpTypes.StoreLineItemDeleteResponse>;
515
515
  /**
516
516
  * This method adds a shipping method to a cart. It sends a request to
517
- * the [Add Shipping Method](https://docs.medusajs.com/v2/api/store#carts_postcartsidshippingmethods) API routes.
517
+ * the [Add Shipping Method](https://docs.medusajs.com/api/store#carts_postcartsidshippingmethods) API routes.
518
518
  *
519
- * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping).
519
+ * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
520
520
  *
521
521
  * @param cartId - The cart's ID.
522
522
  * @param body - The shipping method's details.
@@ -538,10 +538,10 @@ export declare class Store {
538
538
  addShippingMethod: (cartId: string, body: HttpTypes.StoreAddCartShippingMethods, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCartResponse>;
539
539
  /**
540
540
  * This method completes a cart and places the order. It's the last step of the checkout flow.
541
- * The method sends a request to the [Complete Cart](https://docs.medusajs.com/v2/api/store#carts_postcartsidcomplete)
541
+ * The method sends a request to the [Complete Cart](https://docs.medusajs.com/api/store#carts_postcartsidcomplete)
542
542
  * API route.
543
543
  *
544
- * Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart).
544
+ * Related guide: [Learn how to complete cart in checkout flow](https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart).
545
545
  *
546
546
  * @param cartId - The cart's ID.
547
547
  * @param query - Configure the fields to retrieve in the created order.
@@ -565,10 +565,10 @@ export declare class Store {
565
565
  fulfillment: {
566
566
  /**
567
567
  * This method retrieves the list of shipping options for a cart. It sends a request to
568
- * the [List Shipping Options](https://docs.medusajs.com/v2/api/store#shipping-options_getshippingoptions)
568
+ * the [List Shipping Options](https://docs.medusajs.com/api/store#shipping-options_getshippingoptions)
569
569
  * API route.
570
570
  *
571
- * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping).
571
+ * Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
572
572
  *
573
573
  * @param query - The cart's details along with configurations of the fields to retrieve in the options.
574
574
  * @param headers - Headers to pass in the request.
@@ -587,10 +587,10 @@ export declare class Store {
587
587
  payment: {
588
588
  /**
589
589
  * This method retrieves the payment providers available in a region, which is useful during checkout.
590
- * It sends a request to the [List Payment Providers](https://docs.medusajs.com/v2/api/store#payment-providers_getpaymentproviders)
590
+ * It sends a request to the [List Payment Providers](https://docs.medusajs.com/api/store#payment-providers_getpaymentproviders)
591
591
  * API route.
592
592
  *
593
- * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment).
593
+ * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/payment).
594
594
  *
595
595
  * @param query - The filters to apply on the retrieved providers, along with configurations of the
596
596
  * fields to retrieve in the options.
@@ -639,19 +639,19 @@ export declare class Store {
639
639
  * })
640
640
  * ```
641
641
  *
642
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
642
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
643
643
  */
644
644
  listPaymentProviders: (query?: FindParams & HttpTypes.StorePaymentProviderFilters, headers?: ClientHeaders) => Promise<HttpTypes.StorePaymentProviderListResponse>;
645
645
  /**
646
646
  * This method creates a payment session of a cart's payment collection, selecting a payment provider.
647
- * It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollectionsidpaymentsessions)
647
+ * It sends a request to the [Initialize Payment Session](https://docs.medusajs.com/api/store#payment-collections_postpaymentcollectionsidpaymentsessions)
648
648
  * API route.
649
649
  *
650
650
  * If the cart doesn't have a payment collection, a payment collection is created for the cart by
651
- * sending a request to the [Create Payment Collection](https://docs.medusajs.com/v2/api/store#payment-collections_postpaymentcollections)
651
+ * sending a request to the [Create Payment Collection](https://docs.medusajs.com/api/store#payment-collections_postpaymentcollections)
652
652
  * API route.
653
653
  *
654
- * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment).
654
+ * Related guide: [Implement payment step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/payment).
655
655
  *
656
656
  * @param cart - The cart's details.
657
657
  * @param body - The payment session's details.
@@ -678,7 +678,7 @@ export declare class Store {
678
678
  order: {
679
679
  /**
680
680
  * This method retrieves a paginated list of orders matching the specified filters. It
681
- * sends a request to the [List Orders](https://docs.medusajs.com/v2/api/store#orders_getorders)
681
+ * sends a request to the [List Orders](https://docs.medusajs.com/api/store#orders_getorders)
682
682
  * API route.
683
683
  *
684
684
  * @param query - Configure the fields to retrieve in the orders.
@@ -721,12 +721,12 @@ export declare class Store {
721
721
  * })
722
722
  * ```
723
723
  *
724
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
724
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
725
725
  */
726
726
  list: (query?: HttpTypes.StoreOrderFilters, headers?: ClientHeaders) => Promise<HttpTypes.StoreOrderListResponse>;
727
727
  /**
728
728
  * This method retrieves an order by its ID. It sends a request to the
729
- * [Get Order](https://docs.medusajs.com/v2/api/store#orders_getordersid) API route.
729
+ * [Get Order](https://docs.medusajs.com/api/store#orders_getordersid) API route.
730
730
  *
731
731
  * @param id - The order's ID.
732
732
  * @param query - Configure the fields to retrieve in the order.
@@ -754,7 +754,7 @@ export declare class Store {
754
754
  * })
755
755
  * ```
756
756
  *
757
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
757
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
758
758
  */
759
759
  retrieve: (id: string, query?: SelectParams, headers?: ClientHeaders) => Promise<{
760
760
  order: HttpTypes.StoreOrder;
@@ -762,13 +762,13 @@ export declare class Store {
762
762
  };
763
763
  customer: {
764
764
  /**
765
- * This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomers)
765
+ * This method registers a customer. It sends a request to the [Register Customer](https://docs.medusajs.com/api/store#customers_postcustomers)
766
766
  * API route.
767
767
  *
768
768
  * You must use the {@link Auth.register} method first to retrieve a registration token. Then, pass that
769
769
  * registration token in the `headers` parameter of this method as an authorization bearer header.
770
770
  *
771
- * Related guide: [How to register customer in storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/register)
771
+ * Related guide: [How to register customer in storefront](https://docs.medusajs.com/resources/storefront-development/customers/register)
772
772
  *
773
773
  * @param body - The customer's details.
774
774
  * @param query - Configure the fields to retrieve in the customer.
@@ -800,9 +800,9 @@ export declare class Store {
800
800
  * first with the {@link Auth.login} method.
801
801
  *
802
802
  * It sends a request to the
803
- * [Update Customer](https://docs.medusajs.com/v2/api/store#customers_postcustomersme) API route.
803
+ * [Update Customer](https://docs.medusajs.com/api/store#customers_postcustomersme) API route.
804
804
  *
805
- * Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/profile).
805
+ * Related guide: [How to edit customer's profile in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/profile).
806
806
  *
807
807
  * @param body - The customer's details to update.
808
808
  * @param query - Configure the fields to retrieve in the customer.
@@ -822,7 +822,7 @@ export declare class Store {
822
822
  * This method retrieves the logged-in customer's details. The customer must be logged in
823
823
  * first with the {@link Auth.login} method.
824
824
  *
825
- * It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/v2/api/store#customers_getcustomersme)
825
+ * It sends a request to the [Get Logged-In Customer](https://docs.medusajs.com/api/store#customers_getcustomersme)
826
826
  * API route.
827
827
  *
828
828
  * @param query - Configure the fields to retrieve in the customer.
@@ -840,10 +840,10 @@ export declare class Store {
840
840
  * This method creates an address for the logged-in customer. The customer must be logged in
841
841
  * first with the {@link Auth.login} method.
842
842
  *
843
- * It sends a request to the [Create Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddresses)
843
+ * It sends a request to the [Create Address](https://docs.medusajs.com/api/store#customers_postcustomersmeaddresses)
844
844
  * API route.
845
845
  *
846
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
846
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
847
847
  *
848
848
  * @param body - The address's details.
849
849
  * @param query - Configure the fields to retrieve in the customer.
@@ -863,10 +863,10 @@ export declare class Store {
863
863
  * This method updates the address of the logged-in customer. The customer must be logged in
864
864
  * first with the {@link Auth.login} method.
865
865
  *
866
- * It sends a request to the [Update Address](https://docs.medusajs.com/v2/api/store#customers_postcustomersmeaddressesaddress_id)
866
+ * It sends a request to the [Update Address](https://docs.medusajs.com/api/store#customers_postcustomersmeaddressesaddress_id)
867
867
  * API route.
868
868
  *
869
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
869
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
870
870
  *
871
871
  * @param addressId - The ID of the address to update.
872
872
  * @param body - The details to update in the address.
@@ -890,10 +890,10 @@ export declare class Store {
890
890
  * This method retrieves the logged-in customer's address. The customer must be logged in
891
891
  * first with the {@link Auth.login} method.
892
892
  *
893
- * It sends a request to the [List Customer's Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddresses)
893
+ * It sends a request to the [List Customer's Address](https://docs.medusajs.com/api/store#customers_getcustomersmeaddresses)
894
894
  * API route.
895
895
  *
896
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
896
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
897
897
  *
898
898
  * @param query - Configure the fields to retrieve in the addresses.
899
899
  * @param headers - Headers to pass in the request.
@@ -935,17 +935,17 @@ export declare class Store {
935
935
  * })
936
936
  * ```
937
937
  *
938
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
938
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
939
939
  */
940
940
  listAddress: (query?: FindParams & HttpTypes.StoreCustomerAddressFilters, headers?: ClientHeaders) => Promise<HttpTypes.StoreCustomerAddressListResponse>;
941
941
  /**
942
942
  * This method retrieves an address of the logged-in customer. The customer must be logged in
943
943
  * first with the {@link Auth.login} method.
944
944
  *
945
- * It sends a request to the [Get Address](https://docs.medusajs.com/v2/api/store#customers_getcustomersmeaddressesaddress_id)
945
+ * It sends a request to the [Get Address](https://docs.medusajs.com/api/store#customers_getcustomersmeaddressesaddress_id)
946
946
  * API route.
947
947
  *
948
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
948
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
949
949
  *
950
950
  * @param addressId - The address's ID.
951
951
  * @param query - Configure the fields to retrieve in the address.
@@ -978,17 +978,17 @@ export declare class Store {
978
978
  * })
979
979
  * ```
980
980
  *
981
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
981
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
982
982
  */
983
983
  retrieveAddress: (addressId: string, query?: SelectParams, headers?: ClientHeaders) => Promise<HttpTypes.StoreCustomerAddressResponse>;
984
984
  /**
985
985
  * This method deletes an address of the logged-in customer. The customer must be logged in
986
986
  * first with the {@link Auth.login} method.
987
987
  *
988
- * It sends a request to the [Remove Address](https://docs.medusajs.com/v2/api/store#customers_deletecustomersmeaddressesaddress_id)
988
+ * It sends a request to the [Remove Address](https://docs.medusajs.com/api/store#customers_deletecustomersmeaddressesaddress_id)
989
989
  * API route.
990
990
  *
991
- * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses)
991
+ * Related guides: [How to manage customer's addresses in the storefront](https://docs.medusajs.com/resources/storefront-development/customers/addresses)
992
992
  *
993
993
  * @param addressId - The address's ID.
994
994
  * @param headers - Headers to pass in the request.