@medusajs/js-sdk 2.0.0 → 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
@@ -12,7 +12,7 @@ export declare class Claim {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a paginated list of claims. It sends a request to the
15
- * [List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route.
15
+ * [List Claims](https://docs.medusajs.com/api/admin#claims_getclaims) API route.
16
16
  *
17
17
  * @param query - Filters and pagination configurations.
18
18
  * @param headers - Headers to pass in the request.
@@ -54,12 +54,12 @@ export declare class Claim {
54
54
  * })
55
55
  * ```
56
56
  *
57
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
57
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
58
58
  */
59
59
  list(query?: HttpTypes.AdminClaimListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimListResponse>;
60
60
  /**
61
61
  * This method retrieves a claim. It sends a request to the
62
- * [Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route.
62
+ * [Get Claim](https://docs.medusajs.com/api/admin#claims_getclaimsid) API route.
63
63
  *
64
64
  * @param id - The claim's ID.
65
65
  * @param query - Configure the fields to retrieve in the claim.
@@ -87,12 +87,12 @@ export declare class Claim {
87
87
  * })
88
88
  * ```
89
89
  *
90
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
90
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
91
91
  */
92
92
  retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
93
93
  /**
94
94
  * This method creates a claim. It sends a request to the
95
- * [Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route.
95
+ * [Create Claim](https://docs.medusajs.com/api/admin#claims_postclaims) API route.
96
96
  *
97
97
  * @param body - The claim's details.
98
98
  * @param query - Configure the fields to retrieve in the claim.
@@ -111,7 +111,7 @@ export declare class Claim {
111
111
  create(body: HttpTypes.AdminCreateClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimOrderResponse>;
112
112
  /**
113
113
  * This method cancels a claim. It sends a request to the
114
- * [Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route.
114
+ * [Cancel Claim](https://docs.medusajs.com/api/admin#claims_postclaimsidcancel) API route.
115
115
  *
116
116
  * @param id - The claim's ID.
117
117
  * @param query - Configure the fields to retrieve in the claim.
@@ -127,7 +127,7 @@ export declare class Claim {
127
127
  cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimResponse>;
128
128
  /**
129
129
  * This method adds items to the claim. It sends a request to the
130
- * [Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route.
130
+ * [Add Items](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitems) API route.
131
131
  *
132
132
  * @param id - The ID of the claim to add the items to.
133
133
  * @param body - The items' details.
@@ -151,7 +151,7 @@ export declare class Claim {
151
151
  addItems(id: string, body: HttpTypes.AdminAddClaimItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
152
152
  /**
153
153
  * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
154
- * sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
154
+ * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
155
155
  *
156
156
  * Every item has an `actions` property, whose value is an array of actions.
157
157
  * You can check the action's name using its `action` property, and use the value of the `id` property.
@@ -178,7 +178,7 @@ export declare class Claim {
178
178
  updateItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
179
179
  /**
180
180
  * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
181
- * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)
181
+ * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidclaimitemsaction_id)
182
182
  * API route.
183
183
  *
184
184
  * Every item has an `actions` property, whose value is an array of actions.
@@ -203,7 +203,7 @@ export declare class Claim {
203
203
  /**
204
204
  * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
205
205
  *
206
- * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)
206
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditems)
207
207
  * API route.
208
208
  *
209
209
  * @param id - The ID of the claim to add the inbound items to.
@@ -231,7 +231,7 @@ export declare class Claim {
231
231
  addInboundItems(id: string, body: HttpTypes.AdminAddClaimInboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
232
232
  /**
233
233
  * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
234
- * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)
234
+ * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditemsaction_id)
235
235
  * API route.
236
236
  *
237
237
  * Every item has an `actions` property, whose value is an array of actions.
@@ -259,7 +259,7 @@ export declare class Claim {
259
259
  updateInboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimInboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
260
260
  /**
261
261
  * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
262
- * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)
262
+ * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinbounditemsaction_id)
263
263
  * API route.
264
264
  *
265
265
  * Every item has an `actions` property, whose value is an array of actions.
@@ -285,7 +285,7 @@ export declare class Claim {
285
285
  * This method adds an inbound (or return) shipping method to a claim.
286
286
  * The inbound shipping method will have a `SHIPPING_ADD` action.
287
287
  *
288
- * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)
288
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod)
289
289
  * API route.
290
290
  *
291
291
  * @param id - The claim's ID.
@@ -309,7 +309,7 @@ export declare class Claim {
309
309
  addInboundShipping(id: string, body: HttpTypes.AdminClaimAddInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
310
310
  /**
311
311
  * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
312
- * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
312
+ * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
313
313
  * API route.
314
314
  *
315
315
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -337,7 +337,7 @@ export declare class Claim {
337
337
  updateInboundShipping(id: string, actionId: string, body: HttpTypes.AdminClaimUpdateInboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
338
338
  /**
339
339
  * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
340
- * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
340
+ * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
341
341
  * API route.
342
342
  *
343
343
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -361,7 +361,7 @@ export declare class Claim {
361
361
  deleteInboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimReturnPreviewResponse>;
362
362
  /**
363
363
  * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
364
- * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)
364
+ * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems)
365
365
  * API route.
366
366
  *
367
367
  * @param id - The ID of the claim to add the outbound items to.
@@ -387,7 +387,7 @@ export declare class Claim {
387
387
  addOutboundItems(id: string, body: HttpTypes.AdminAddClaimOutboundItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
388
388
  /**
389
389
  * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
390
- * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)
390
+ * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id)
391
391
  * API route.
392
392
  *
393
393
  * Every item has an `actions` property, whose value is an array of actions.
@@ -415,7 +415,7 @@ export declare class Claim {
415
415
  updateOutboundItem(id: string, actionId: string, body: HttpTypes.AdminUpdateClaimOutboundItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
416
416
  /**
417
417
  * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
418
- * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
418
+ * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
419
419
  * API route.
420
420
  *
421
421
  * Every item has an `actions` property, whose value is an array of actions.
@@ -442,7 +442,7 @@ export declare class Claim {
442
442
  * The outbound shipping method will have a `SHIPPING_ADD` action.
443
443
  *
444
444
  * This method sends a request to the
445
- * [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)
445
+ * [Add Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod)
446
446
  * API route.
447
447
  *
448
448
  * @param id - The claim's ID.
@@ -466,7 +466,7 @@ export declare class Claim {
466
466
  addOutboundShipping(id: string, body: HttpTypes.AdminClaimAddOutboundShipping, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
467
467
  /**
468
468
  * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
469
- * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
469
+ * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
470
470
  * API route.
471
471
  *
472
472
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -516,7 +516,7 @@ export declare class Claim {
516
516
  deleteOutboundShipping(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimPreviewResponse>;
517
517
  /**
518
518
  * This method confirms a claim request, applying its changes on the associated order.
519
- * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)
519
+ * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin#claims_postclaimsidrequest)
520
520
  * API route.
521
521
  *
522
522
  * @param id - The claim's ID.
@@ -537,7 +537,7 @@ export declare class Claim {
537
537
  request(id: string, body: HttpTypes.AdminRequestClaim, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminClaimRequestResponse>;
538
538
  /**
539
539
  * This method cancels a requested claim. It sends a request to the
540
- * [Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)
540
+ * [Cancel Claim Request](https://docs.medusajs.com/api/admin#claims_deleteclaimsidrequest)
541
541
  * API route.
542
542
  *
543
543
  * @param id - The claim's ID.
@@ -16,7 +16,7 @@ export class Claim {
16
16
  }
17
17
  /**
18
18
  * This method retrieves a paginated list of claims. It sends a request to the
19
- * [List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route.
19
+ * [List Claims](https://docs.medusajs.com/api/admin#claims_getclaims) API route.
20
20
  *
21
21
  * @param query - Filters and pagination configurations.
22
22
  * @param headers - Headers to pass in the request.
@@ -58,7 +58,7 @@ export class Claim {
58
58
  * })
59
59
  * ```
60
60
  *
61
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
61
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
62
62
  */
63
63
  list(query, headers) {
64
64
  return __awaiter(this, void 0, void 0, function* () {
@@ -70,7 +70,7 @@ export class Claim {
70
70
  }
71
71
  /**
72
72
  * This method retrieves a claim. It sends a request to the
73
- * [Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route.
73
+ * [Get Claim](https://docs.medusajs.com/api/admin#claims_getclaimsid) API route.
74
74
  *
75
75
  * @param id - The claim's ID.
76
76
  * @param query - Configure the fields to retrieve in the claim.
@@ -98,7 +98,7 @@ export class Claim {
98
98
  * })
99
99
  * ```
100
100
  *
101
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
101
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
102
102
  */
103
103
  retrieve(id, query, headers) {
104
104
  return __awaiter(this, void 0, void 0, function* () {
@@ -110,7 +110,7 @@ export class Claim {
110
110
  }
111
111
  /**
112
112
  * This method creates a claim. It sends a request to the
113
- * [Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route.
113
+ * [Create Claim](https://docs.medusajs.com/api/admin#claims_postclaims) API route.
114
114
  *
115
115
  * @param body - The claim's details.
116
116
  * @param query - Configure the fields to retrieve in the claim.
@@ -138,7 +138,7 @@ export class Claim {
138
138
  }
139
139
  /**
140
140
  * This method cancels a claim. It sends a request to the
141
- * [Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route.
141
+ * [Cancel Claim](https://docs.medusajs.com/api/admin#claims_postclaimsidcancel) API route.
142
142
  *
143
143
  * @param id - The claim's ID.
144
144
  * @param query - Configure the fields to retrieve in the claim.
@@ -162,7 +162,7 @@ export class Claim {
162
162
  }
163
163
  /**
164
164
  * This method adds items to the claim. It sends a request to the
165
- * [Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route.
165
+ * [Add Items](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitems) API route.
166
166
  *
167
167
  * @param id - The ID of the claim to add the items to.
168
168
  * @param body - The items' details.
@@ -195,7 +195,7 @@ export class Claim {
195
195
  }
196
196
  /**
197
197
  * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
198
- * sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
198
+ * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
199
199
  *
200
200
  * Every item has an `actions` property, whose value is an array of actions.
201
201
  * You can check the action's name using its `action` property, and use the value of the `id` property.
@@ -231,7 +231,7 @@ export class Claim {
231
231
  }
232
232
  /**
233
233
  * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
234
- * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)
234
+ * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidclaimitemsaction_id)
235
235
  * API route.
236
236
  *
237
237
  * Every item has an `actions` property, whose value is an array of actions.
@@ -264,7 +264,7 @@ export class Claim {
264
264
  /**
265
265
  * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
266
266
  *
267
- * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)
267
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditems)
268
268
  * API route.
269
269
  *
270
270
  * @param id - The ID of the claim to add the inbound items to.
@@ -301,7 +301,7 @@ export class Claim {
301
301
  }
302
302
  /**
303
303
  * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
304
- * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)
304
+ * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditemsaction_id)
305
305
  * API route.
306
306
  *
307
307
  * Every item has an `actions` property, whose value is an array of actions.
@@ -338,7 +338,7 @@ export class Claim {
338
338
  }
339
339
  /**
340
340
  * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
341
- * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)
341
+ * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinbounditemsaction_id)
342
342
  * API route.
343
343
  *
344
344
  * Every item has an `actions` property, whose value is an array of actions.
@@ -372,7 +372,7 @@ export class Claim {
372
372
  * This method adds an inbound (or return) shipping method to a claim.
373
373
  * The inbound shipping method will have a `SHIPPING_ADD` action.
374
374
  *
375
- * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)
375
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod)
376
376
  * API route.
377
377
  *
378
378
  * @param id - The claim's ID.
@@ -405,7 +405,7 @@ export class Claim {
405
405
  }
406
406
  /**
407
407
  * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
408
- * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
408
+ * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
409
409
  * API route.
410
410
  *
411
411
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -442,7 +442,7 @@ export class Claim {
442
442
  }
443
443
  /**
444
444
  * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
445
- * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
445
+ * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
446
446
  * API route.
447
447
  *
448
448
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -474,7 +474,7 @@ export class Claim {
474
474
  }
475
475
  /**
476
476
  * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
477
- * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)
477
+ * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems)
478
478
  * API route.
479
479
  *
480
480
  * @param id - The ID of the claim to add the outbound items to.
@@ -509,7 +509,7 @@ export class Claim {
509
509
  }
510
510
  /**
511
511
  * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
512
- * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)
512
+ * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id)
513
513
  * API route.
514
514
  *
515
515
  * Every item has an `actions` property, whose value is an array of actions.
@@ -546,7 +546,7 @@ export class Claim {
546
546
  }
547
547
  /**
548
548
  * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
549
- * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
549
+ * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
550
550
  * API route.
551
551
  *
552
552
  * Every item has an `actions` property, whose value is an array of actions.
@@ -581,7 +581,7 @@ export class Claim {
581
581
  * The outbound shipping method will have a `SHIPPING_ADD` action.
582
582
  *
583
583
  * This method sends a request to the
584
- * [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)
584
+ * [Add Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod)
585
585
  * API route.
586
586
  *
587
587
  * @param id - The claim's ID.
@@ -614,7 +614,7 @@ export class Claim {
614
614
  }
615
615
  /**
616
616
  * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
617
- * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
617
+ * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
618
618
  * API route.
619
619
  *
620
620
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -681,7 +681,7 @@ export class Claim {
681
681
  }
682
682
  /**
683
683
  * This method confirms a claim request, applying its changes on the associated order.
684
- * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)
684
+ * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin#claims_postclaimsidrequest)
685
685
  * API route.
686
686
  *
687
687
  * @param id - The claim's ID.
@@ -711,7 +711,7 @@ export class Claim {
711
711
  }
712
712
  /**
713
713
  * This method cancels a requested claim. It sends a request to the
714
- * [Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)
714
+ * [Cancel Claim Request](https://docs.medusajs.com/api/admin#claims_deleteclaimsidrequest)
715
715
  * API route.
716
716
  *
717
717
  * @param id - The claim's ID.
@@ -12,7 +12,7 @@ export declare class Currency {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a paginated list of currencies. It sends a request to the
15
- * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
15
+ * [List Currencies](https://docs.medusajs.com/api/admin#currencies_getcurrencies)
16
16
  * API route.
17
17
  *
18
18
  * @param query - Filters and pagination configurations.
@@ -55,12 +55,12 @@ export declare class Currency {
55
55
  * })
56
56
  * ```
57
57
  *
58
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
58
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
59
59
  */
60
60
  list(query?: HttpTypes.AdminCurrencyListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyListResponse>;
61
61
  /**
62
62
  * This method retrieves a currency by its code. It sends a request to the
63
- * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
63
+ * [Get Currency](https://docs.medusajs.com/api/admin#currencies_getcurrenciescode) API route.
64
64
  *
65
65
  * @param code - The currency's code.
66
66
  * @param query - Configure the fields to retrieve in the currency.
@@ -88,7 +88,7 @@ export declare class Currency {
88
88
  * })
89
89
  * ```
90
90
  *
91
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
91
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
92
92
  */
93
93
  retrieve(code: string, query?: HttpTypes.AdminCurrencyParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCurrencyResponse>;
94
94
  }
@@ -16,7 +16,7 @@ export class Currency {
16
16
  }
17
17
  /**
18
18
  * This method retrieves a paginated list of currencies. It sends a request to the
19
- * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
19
+ * [List Currencies](https://docs.medusajs.com/api/admin#currencies_getcurrencies)
20
20
  * API route.
21
21
  *
22
22
  * @param query - Filters and pagination configurations.
@@ -59,7 +59,7 @@ export class Currency {
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) {
65
65
  return __awaiter(this, void 0, void 0, function* () {
@@ -71,7 +71,7 @@ export class Currency {
71
71
  }
72
72
  /**
73
73
  * This method retrieves a currency by its code. It sends a request to the
74
- * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
74
+ * [Get Currency](https://docs.medusajs.com/api/admin#currencies_getcurrenciescode) API route.
75
75
  *
76
76
  * @param code - The currency's code.
77
77
  * @param query - Configure the fields to retrieve in the currency.
@@ -99,7 +99,7 @@ export class Currency {
99
99
  * })
100
100
  * ```
101
101
  *
102
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
102
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
103
103
  */
104
104
  retrieve(code, query, headers) {
105
105
  return __awaiter(this, void 0, void 0, function* () {
@@ -12,7 +12,7 @@ export declare class CustomerGroup {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method retrieves a customer group by its ID. It sends a request to the
15
- * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
15
+ * [Get Customer Group](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroupsid) API route.
16
16
  *
17
17
  * @param id - The customer group's ID.
18
18
  * @param query - Configure the fields to retrieve in the customer group.
@@ -40,12 +40,12 @@ export declare class CustomerGroup {
40
40
  * })
41
41
  * ```
42
42
  *
43
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
43
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
44
44
  */
45
45
  retrieve(id: string, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
46
46
  /**
47
47
  * This method retrieves a paginated list of customer groups. It sends a request to the
48
- * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
48
+ * [List Customer Groups](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroups)
49
49
  * API route.
50
50
  *
51
51
  * @param query - Filters and pagination configurations.
@@ -88,12 +88,12 @@ export declare class CustomerGroup {
88
88
  * })
89
89
  * ```
90
90
  *
91
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
91
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
92
92
  */
93
93
  list(query?: HttpTypes.AdminGetCustomerGroupsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupListResponse>;
94
94
  /**
95
95
  * This method creates a customer group. It sends a request to the
96
- * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
96
+ * [Create Customer Group](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroups)
97
97
  * API route.
98
98
  *
99
99
  * @param body - The customer group's details.
@@ -112,7 +112,7 @@ export declare class CustomerGroup {
112
112
  create(body: HttpTypes.AdminCreateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
113
113
  /**
114
114
  * This method updates a customer group's details. It sends a request to the
115
- * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
115
+ * [Update Customer](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsid)
116
116
  * API route.
117
117
  *
118
118
  * @param id - The customer group's ID.
@@ -132,7 +132,7 @@ export declare class CustomerGroup {
132
132
  update(id: string, body: HttpTypes.AdminUpdateCustomerGroup, query?: HttpTypes.AdminGetCustomerGroupParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupResponse>;
133
133
  /**
134
134
  * This method deletes a customer group. This method sends a request to the
135
- * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
135
+ * [Delete Customer Group](https://docs.medusajs.com/api/admin#customer-groups_deletecustomergroupsid)
136
136
  * API route.
137
137
  *
138
138
  * @param id - The customer group's ID.
@@ -148,7 +148,7 @@ export declare class CustomerGroup {
148
148
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerGroupDeleteResponse>;
149
149
  /**
150
150
  * This method manages customers of a group to add or remove them from the group.
151
- * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
151
+ * It sends a request to the [Manage Customers](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsidcustomers)
152
152
  * API route.
153
153
  *
154
154
  * @param id - The group's ID.
@@ -16,7 +16,7 @@ export class CustomerGroup {
16
16
  }
17
17
  /**
18
18
  * This method retrieves a customer group by its ID. It sends a request to the
19
- * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
19
+ * [Get Customer Group](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroupsid) API route.
20
20
  *
21
21
  * @param id - The customer group's ID.
22
22
  * @param query - Configure the fields to retrieve in the customer group.
@@ -44,7 +44,7 @@ export class CustomerGroup {
44
44
  * })
45
45
  * ```
46
46
  *
47
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
47
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
48
48
  */
49
49
  retrieve(id, query, headers) {
50
50
  return __awaiter(this, void 0, void 0, function* () {
@@ -57,7 +57,7 @@ export class CustomerGroup {
57
57
  }
58
58
  /**
59
59
  * This method retrieves a paginated list of customer groups. It sends a request to the
60
- * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
60
+ * [List Customer Groups](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroups)
61
61
  * API route.
62
62
  *
63
63
  * @param query - Filters and pagination configurations.
@@ -100,7 +100,7 @@ export class CustomerGroup {
100
100
  * })
101
101
  * ```
102
102
  *
103
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
103
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
104
104
  */
105
105
  list(query, headers) {
106
106
  return __awaiter(this, void 0, void 0, function* () {
@@ -113,7 +113,7 @@ export class CustomerGroup {
113
113
  }
114
114
  /**
115
115
  * This method creates a customer group. It sends a request to the
116
- * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
116
+ * [Create Customer Group](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroups)
117
117
  * API route.
118
118
  *
119
119
  * @param body - The customer group's details.
@@ -141,7 +141,7 @@ export class CustomerGroup {
141
141
  }
142
142
  /**
143
143
  * This method updates a customer group's details. It sends a request to the
144
- * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
144
+ * [Update Customer](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsid)
145
145
  * API route.
146
146
  *
147
147
  * @param id - The customer group's ID.
@@ -170,7 +170,7 @@ export class CustomerGroup {
170
170
  }
171
171
  /**
172
172
  * This method deletes a customer group. This method sends a request to the
173
- * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
173
+ * [Delete Customer Group](https://docs.medusajs.com/api/admin#customer-groups_deletecustomergroupsid)
174
174
  * API route.
175
175
  *
176
176
  * @param id - The customer group's ID.
@@ -193,7 +193,7 @@ export class CustomerGroup {
193
193
  }
194
194
  /**
195
195
  * This method manages customers of a group to add or remove them from the group.
196
- * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
196
+ * It sends a request to the [Manage Customers](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsidcustomers)
197
197
  * API route.
198
198
  *
199
199
  * @param id - The group's ID.