@medusajs/js-sdk 2.0.0 → 2.0.1-snapshot-20241025090810

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) 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/auth/index.d.ts +10 -10
  32. package/dist/auth/index.js +10 -10
  33. package/dist/esm/admin/api-key.d.ts +8 -8
  34. package/dist/esm/admin/api-key.js +8 -8
  35. package/dist/esm/admin/campaign.d.ts +8 -8
  36. package/dist/esm/admin/campaign.js +8 -8
  37. package/dist/esm/admin/claim.d.ts +22 -22
  38. package/dist/esm/admin/claim.js +22 -22
  39. package/dist/esm/admin/currency.d.ts +4 -4
  40. package/dist/esm/admin/currency.js +4 -4
  41. package/dist/esm/admin/customer-group.d.ts +8 -8
  42. package/dist/esm/admin/customer-group.js +8 -8
  43. package/dist/esm/admin/customer.d.ts +27 -7
  44. package/dist/esm/admin/customer.d.ts.map +1 -1
  45. package/dist/esm/admin/customer.js +35 -7
  46. package/dist/esm/admin/customer.js.map +1 -1
  47. package/dist/esm/admin/exchange.d.ts +21 -21
  48. package/dist/esm/admin/exchange.js +21 -21
  49. package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
  50. package/dist/esm/admin/fulfillment-provider.js +2 -2
  51. package/dist/esm/admin/fulfillment-set.d.ts +6 -6
  52. package/dist/esm/admin/fulfillment-set.js +6 -6
  53. package/dist/esm/admin/fulfillment.d.ts +3 -3
  54. package/dist/esm/admin/fulfillment.js +3 -3
  55. package/dist/esm/admin/inventory-item.d.ts +12 -12
  56. package/dist/esm/admin/inventory-item.js +12 -12
  57. package/dist/esm/admin/invite.d.ts +8 -8
  58. package/dist/esm/admin/invite.js +8 -8
  59. package/dist/esm/admin/payment-collection.d.ts +0 -2
  60. package/dist/esm/admin/payment-collection.d.ts.map +1 -1
  61. package/dist/esm/admin/payment-collection.js +0 -16
  62. package/dist/esm/admin/payment-collection.js.map +1 -1
  63. package/dist/esm/auth/index.d.ts +10 -10
  64. package/dist/esm/auth/index.js +10 -10
  65. package/dist/esm/store/index.d.ts +73 -73
  66. package/dist/esm/store/index.js +73 -73
  67. package/dist/store/index.d.ts +73 -73
  68. package/dist/store/index.js +73 -73
  69. package/package.json +2 -2
@@ -10,7 +10,7 @@ class Claim {
10
10
  }
11
11
  /**
12
12
  * This method retrieves a paginated list of claims. It sends a request to the
13
- * [List Claims](https://docs.medusajs.com/v2/api/admin#claims_getclaims) API route.
13
+ * [List Claims](https://docs.medusajs.com/api/admin#claims_getclaims) API route.
14
14
  *
15
15
  * @param query - Filters and pagination configurations.
16
16
  * @param headers - Headers to pass in the request.
@@ -52,7 +52,7 @@ class Claim {
52
52
  * })
53
53
  * ```
54
54
  *
55
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
55
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
56
56
  */
57
57
  async list(query, headers) {
58
58
  return await this.client.fetch(`/admin/claims`, {
@@ -62,7 +62,7 @@ class Claim {
62
62
  }
63
63
  /**
64
64
  * This method retrieves a claim. It sends a request to the
65
- * [Get Claim](https://docs.medusajs.com/v2/api/admin#claims_getclaimsid) API route.
65
+ * [Get Claim](https://docs.medusajs.com/api/admin#claims_getclaimsid) API route.
66
66
  *
67
67
  * @param id - The claim's ID.
68
68
  * @param query - Configure the fields to retrieve in the claim.
@@ -90,7 +90,7 @@ class Claim {
90
90
  * })
91
91
  * ```
92
92
  *
93
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
93
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
94
94
  */
95
95
  async retrieve(id, query, headers) {
96
96
  return await this.client.fetch(`/admin/claims/${id}`, {
@@ -100,7 +100,7 @@ class Claim {
100
100
  }
101
101
  /**
102
102
  * This method creates a claim. It sends a request to the
103
- * [Create Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaims) API route.
103
+ * [Create Claim](https://docs.medusajs.com/api/admin#claims_postclaims) API route.
104
104
  *
105
105
  * @param body - The claim's details.
106
106
  * @param query - Configure the fields to retrieve in the claim.
@@ -126,7 +126,7 @@ class Claim {
126
126
  }
127
127
  /**
128
128
  * This method cancels a claim. It sends a request to the
129
- * [Cancel Claim](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidcancel) API route.
129
+ * [Cancel Claim](https://docs.medusajs.com/api/admin#claims_postclaimsidcancel) API route.
130
130
  *
131
131
  * @param id - The claim's ID.
132
132
  * @param query - Configure the fields to retrieve in the claim.
@@ -148,7 +148,7 @@ class Claim {
148
148
  }
149
149
  /**
150
150
  * This method adds items to the claim. It sends a request to the
151
- * [Add Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitems) API route.
151
+ * [Add Items](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitems) API route.
152
152
  *
153
153
  * @param id - The ID of the claim to add the items to.
154
154
  * @param body - The items' details.
@@ -179,7 +179,7 @@ class Claim {
179
179
  }
180
180
  /**
181
181
  * This method updates a claim item by the ID of the item's `WRITE_OFF_ITEM` action. It
182
- * sends a request to the [Update Claim Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
182
+ * sends a request to the [Update Claim Item](https://docs.medusajs.com/api/admin#claims_postclaimsidclaimitemsaction_id) API route.
183
183
  *
184
184
  * Every item has an `actions` property, whose value is an array of actions.
185
185
  * You can check the action's name using its `action` property, and use the value of the `id` property.
@@ -213,7 +213,7 @@ class Claim {
213
213
  }
214
214
  /**
215
215
  * This method removes a claim item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
216
- * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidclaimitemsaction_id)
216
+ * It sends a request to the [Remove Claim Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidclaimitemsaction_id)
217
217
  * API route.
218
218
  *
219
219
  * Every item has an `actions` property, whose value is an array of actions.
@@ -244,7 +244,7 @@ class Claim {
244
244
  /**
245
245
  * This method adds inbound (or return) items to the claim. These inbound items will have a `RETURN_ITEM` action.
246
246
  *
247
- * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditems)
247
+ * This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditems)
248
248
  * API route.
249
249
  *
250
250
  * @param id - The ID of the claim to add the inbound items to.
@@ -279,7 +279,7 @@ class Claim {
279
279
  }
280
280
  /**
281
281
  * This method updates an inbound (or return) item of a claim using the ID of the item's `RETURN_ITEM` action.
282
- * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinbounditemsaction_id)
282
+ * It sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidinbounditemsaction_id)
283
283
  * API route.
284
284
  *
285
285
  * Every item has an `actions` property, whose value is an array of actions.
@@ -314,7 +314,7 @@ class Claim {
314
314
  }
315
315
  /**
316
316
  * This method removes an inbound (or return) item from a claim using the ID of the item's `RETURN_ITEM` action.
317
- * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinbounditemsaction_id)
317
+ * It sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinbounditemsaction_id)
318
318
  * API route.
319
319
  *
320
320
  * Every item has an `actions` property, whose value is an array of actions.
@@ -346,7 +346,7 @@ class Claim {
346
346
  * This method adds an inbound (or return) shipping method to a claim.
347
347
  * The inbound shipping method will have a `SHIPPING_ADD` action.
348
348
  *
349
- * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethod)
349
+ * This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod)
350
350
  * API route.
351
351
  *
352
352
  * @param id - The claim's ID.
@@ -377,7 +377,7 @@ class Claim {
377
377
  }
378
378
  /**
379
379
  * This method updates a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
380
- * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
380
+ * It sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethodaction_id)
381
381
  * API route.
382
382
  *
383
383
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -412,7 +412,7 @@ class Claim {
412
412
  }
413
413
  /**
414
414
  * This method deletes a shipping method for returning items in the claim using the ID of the method's `SHIPPING_ADD` action.
415
- * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
415
+ * It sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#claims_deleteclaimsidinboundshippingmethodaction_id)
416
416
  * API route.
417
417
  *
418
418
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -442,7 +442,7 @@ class Claim {
442
442
  }
443
443
  /**
444
444
  * This method adds outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.
445
- * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditems)
445
+ * It sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems)
446
446
  * API route.
447
447
  *
448
448
  * @param id - The ID of the claim to add the outbound items to.
@@ -475,7 +475,7 @@ class Claim {
475
475
  }
476
476
  /**
477
477
  * This method updates an outbound (or new) item of a claim using the ID of the item's `ITEM_ADD` action.
478
- * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutbounditemsaction_id)
478
+ * It sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id)
479
479
  * API route.
480
480
  *
481
481
  * Every item has an `actions` property, whose value is an array of actions.
@@ -510,7 +510,7 @@ class Claim {
510
510
  }
511
511
  /**
512
512
  * This method removes an outbound (or new) item from a claim using the ID of the item's `ITEM_ADD` action.
513
- * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
513
+ * It sends a request to the [Remove Outbound Item](https://docs.medusajs.com/api/admin#claims_deleteclaimsidoutbounditemsaction_id)
514
514
  * API route.
515
515
  *
516
516
  * Every item has an `actions` property, whose value is an array of actions.
@@ -543,7 +543,7 @@ class Claim {
543
543
  * The outbound shipping method will have a `SHIPPING_ADD` action.
544
544
  *
545
545
  * This method sends a request to the
546
- * [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethod)
546
+ * [Add Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod)
547
547
  * API route.
548
548
  *
549
549
  * @param id - The claim's ID.
@@ -574,7 +574,7 @@ class Claim {
574
574
  }
575
575
  /**
576
576
  * This method updates the shipping method for delivering outbound items in a claim using the ID of the method's `SHIPPING_ADD` action.
577
- * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
577
+ * It sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethodaction_id)
578
578
  * API route.
579
579
  *
580
580
  * Every shipping method has an `actions` property, whose value is an array of actions.
@@ -637,7 +637,7 @@ class Claim {
637
637
  }
638
638
  /**
639
639
  * This method confirms a claim request, applying its changes on the associated order.
640
- * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/v2/api/admin#claims_postclaimsidrequest)
640
+ * It sends a request to the [Confirm Claim Request](https://docs.medusajs.com/api/admin#claims_postclaimsidrequest)
641
641
  * API route.
642
642
  *
643
643
  * @param id - The claim's ID.
@@ -665,7 +665,7 @@ class Claim {
665
665
  }
666
666
  /**
667
667
  * This method cancels a requested claim. It sends a request to the
668
- * [Cancel Claim Request](https://docs.medusajs.com/v2/api/admin#claims_deleteclaimsidrequest)
668
+ * [Cancel Claim Request](https://docs.medusajs.com/api/admin#claims_deleteclaimsidrequest)
669
669
  * API route.
670
670
  *
671
671
  * @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
  }
@@ -10,7 +10,7 @@ class Currency {
10
10
  }
11
11
  /**
12
12
  * This method retrieves a paginated list of currencies. It sends a request to the
13
- * [List Currencies](https://docs.medusajs.com/v2/api/admin#currencies_getcurrencies)
13
+ * [List Currencies](https://docs.medusajs.com/api/admin#currencies_getcurrencies)
14
14
  * API route.
15
15
  *
16
16
  * @param query - Filters and pagination configurations.
@@ -53,7 +53,7 @@ class Currency {
53
53
  * })
54
54
  * ```
55
55
  *
56
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
56
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
57
57
  */
58
58
  async list(query, headers) {
59
59
  return this.client.fetch(`/admin/currencies`, {
@@ -63,7 +63,7 @@ class Currency {
63
63
  }
64
64
  /**
65
65
  * This method retrieves a currency by its code. It sends a request to the
66
- * [Get Currency](https://docs.medusajs.com/v2/api/admin#currencies_getcurrenciescode) API route.
66
+ * [Get Currency](https://docs.medusajs.com/api/admin#currencies_getcurrenciescode) API route.
67
67
  *
68
68
  * @param code - The currency's code.
69
69
  * @param query - Configure the fields to retrieve in the currency.
@@ -91,7 +91,7 @@ class Currency {
91
91
  * })
92
92
  * ```
93
93
  *
94
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
94
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
95
95
  */
96
96
  async retrieve(code, query, headers) {
97
97
  return this.client.fetch(`/admin/currencies/${code}`, {
@@ -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.
@@ -10,7 +10,7 @@ class CustomerGroup {
10
10
  }
11
11
  /**
12
12
  * This method retrieves a customer group by its ID. It sends a request to the
13
- * [Get Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroupsid) API route.
13
+ * [Get Customer Group](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroupsid) API route.
14
14
  *
15
15
  * @param id - The customer group's ID.
16
16
  * @param query - Configure the fields to retrieve in the customer group.
@@ -38,7 +38,7 @@ class CustomerGroup {
38
38
  * })
39
39
  * ```
40
40
  *
41
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
41
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
42
42
  */
43
43
  async retrieve(id, query, headers) {
44
44
  return await this.client.fetch(`/admin/customer-groups/${id}`, {
@@ -49,7 +49,7 @@ class CustomerGroup {
49
49
  }
50
50
  /**
51
51
  * This method retrieves a paginated list of customer groups. It sends a request to the
52
- * [List Customer Groups](https://docs.medusajs.com/v2/api/admin#customer-groups_getcustomergroups)
52
+ * [List Customer Groups](https://docs.medusajs.com/api/admin#customer-groups_getcustomergroups)
53
53
  * API route.
54
54
  *
55
55
  * @param query - Filters and pagination configurations.
@@ -92,7 +92,7 @@ class CustomerGroup {
92
92
  * })
93
93
  * ```
94
94
  *
95
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
95
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
96
96
  */
97
97
  async list(query, headers) {
98
98
  return await this.client.fetch(`/admin/customer-groups`, {
@@ -103,7 +103,7 @@ class CustomerGroup {
103
103
  }
104
104
  /**
105
105
  * This method creates a customer group. It sends a request to the
106
- * [Create Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroups)
106
+ * [Create Customer Group](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroups)
107
107
  * API route.
108
108
  *
109
109
  * @param body - The customer group's details.
@@ -129,7 +129,7 @@ class CustomerGroup {
129
129
  }
130
130
  /**
131
131
  * This method updates a customer group's details. It sends a request to the
132
- * [Update Customer](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsid)
132
+ * [Update Customer](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsid)
133
133
  * API route.
134
134
  *
135
135
  * @param id - The customer group's ID.
@@ -156,7 +156,7 @@ class CustomerGroup {
156
156
  }
157
157
  /**
158
158
  * This method deletes a customer group. This method sends a request to the
159
- * [Delete Customer Group](https://docs.medusajs.com/v2/api/admin#customer-groups_deletecustomergroupsid)
159
+ * [Delete Customer Group](https://docs.medusajs.com/api/admin#customer-groups_deletecustomergroupsid)
160
160
  * API route.
161
161
  *
162
162
  * @param id - The customer group's ID.
@@ -177,7 +177,7 @@ class CustomerGroup {
177
177
  }
178
178
  /**
179
179
  * This method manages customers of a group to add or remove them from the group.
180
- * It sends a request to the [Manage Customers](https://docs.medusajs.com/v2/api/admin#customer-groups_postcustomergroupsidcustomers)
180
+ * It sends a request to the [Manage Customers](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroupsidcustomers)
181
181
  * API route.
182
182
  *
183
183
  * @param id - The group's ID.
@@ -12,7 +12,7 @@ export declare class Customer {
12
12
  constructor(client: Client);
13
13
  /**
14
14
  * This method creates a customer. It sends a request to the
15
- * [Create Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomers) API route.
15
+ * [Create Customer](https://docs.medusajs.com/api/admin#customers_postcustomers) API route.
16
16
  *
17
17
  * @param body - The customer's details.
18
18
  * @param query - Configure the fields to retrieve in the customer.
@@ -30,7 +30,7 @@ export declare class Customer {
30
30
  create(body: HttpTypes.AdminCreateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
31
31
  /**
32
32
  * This method updates a customer's details. It sends a request to the
33
- * [Update Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomersid) API route.
33
+ * [Update Customer](https://docs.medusajs.com/api/admin#customers_postcustomersid) API route.
34
34
  *
35
35
  * @param id - The customer's ID.
36
36
  * @param body - The details to update of the customer.
@@ -49,7 +49,7 @@ export declare class Customer {
49
49
  update(id: string, body: HttpTypes.AdminUpdateCustomer, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
50
50
  /**
51
51
  * This method retrieves a paginated list of customers. It sends a request to the
52
- * [List Customers](https://docs.medusajs.com/v2/api/admin#customers_getcustomers)
52
+ * [List Customers](https://docs.medusajs.com/api/admin#customers_getcustomers)
53
53
  * API route.
54
54
  *
55
55
  * @param queryParams - Filters and pagination configurations.
@@ -92,12 +92,12 @@ export declare class Customer {
92
92
  * })
93
93
  * ```
94
94
  *
95
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
95
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
96
96
  */
97
97
  list(queryParams?: HttpTypes.AdminCustomerFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerListResponse>;
98
98
  /**
99
99
  * This method retrieves a customer by its ID. It sends a request to the
100
- * [Get Customer](https://docs.medusajs.com/v2/api/admin#customers_getcustomersid)
100
+ * [Get Customer](https://docs.medusajs.com/api/admin#customers_getcustomersid)
101
101
  * API route.
102
102
  *
103
103
  * @param id - The customer's ID.
@@ -126,12 +126,12 @@ export declare class Customer {
126
126
  * })
127
127
  * ```
128
128
  *
129
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
129
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
130
130
  */
131
131
  retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
132
132
  /**
133
133
  * This method deletes a customer by its ID. It sends a request to the
134
- * [Delete Customer](https://docs.medusajs.com/v2/api/admin#customers_deletecustomersid)
134
+ * [Delete Customer](https://docs.medusajs.com/api/admin#customers_deletecustomersid)
135
135
  * API route.
136
136
  *
137
137
  * @param id - The customer's ID.
@@ -145,5 +145,25 @@ export declare class Customer {
145
145
  * })
146
146
  */
147
147
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerDeleteResponse>;
148
+ /**
149
+ * This method manages customer groups for a customer.
150
+ * It sends a request to the [Manage Customers](https://docs.medusajs.com/api/admin#customers_postcustomersidcustomergroups)
151
+ * API route.
152
+ *
153
+ * @param id - The customer's ID.
154
+ * @param body - The groups to add customer to or remove customer from.
155
+ * @param headers - Headers to pass in the request
156
+ * @returns The customers details.
157
+ *
158
+ * @example
159
+ * sdk.admin.customer.batchCustomerGroups("cus_123", {
160
+ * add: ["cusgroup_123"],
161
+ * remove: ["cusgroup_321"]
162
+ * })
163
+ * .then(({ customer }) => {
164
+ * console.log(customer)
165
+ * })
166
+ */
167
+ batchCustomerGroups(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminCustomerResponse>;
148
168
  }
149
169
  //# sourceMappingURL=customer.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
1
+ {"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,QAAQ;IACnB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,mBAAmB,EACnC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,mBAAmB,CACvB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
@@ -10,7 +10,7 @@ class Customer {
10
10
  }
11
11
  /**
12
12
  * This method creates a customer. It sends a request to the
13
- * [Create Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomers) API route.
13
+ * [Create Customer](https://docs.medusajs.com/api/admin#customers_postcustomers) API route.
14
14
  *
15
15
  * @param body - The customer's details.
16
16
  * @param query - Configure the fields to retrieve in the customer.
@@ -35,7 +35,7 @@ class Customer {
35
35
  }
36
36
  /**
37
37
  * This method updates a customer's details. It sends a request to the
38
- * [Update Customer](https://docs.medusajs.com/v2/api/admin#customers_postcustomersid) API route.
38
+ * [Update Customer](https://docs.medusajs.com/api/admin#customers_postcustomersid) API route.
39
39
  *
40
40
  * @param id - The customer's ID.
41
41
  * @param body - The details to update of the customer.
@@ -61,7 +61,7 @@ class Customer {
61
61
  }
62
62
  /**
63
63
  * This method retrieves a paginated list of customers. It sends a request to the
64
- * [List Customers](https://docs.medusajs.com/v2/api/admin#customers_getcustomers)
64
+ * [List Customers](https://docs.medusajs.com/api/admin#customers_getcustomers)
65
65
  * API route.
66
66
  *
67
67
  * @param queryParams - Filters and pagination configurations.
@@ -104,7 +104,7 @@ class Customer {
104
104
  * })
105
105
  * ```
106
106
  *
107
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
107
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
108
108
  */
109
109
  async list(queryParams, headers) {
110
110
  return this.client.fetch(`/admin/customers`, {
@@ -114,7 +114,7 @@ class Customer {
114
114
  }
115
115
  /**
116
116
  * This method retrieves a customer by its ID. It sends a request to the
117
- * [Get Customer](https://docs.medusajs.com/v2/api/admin#customers_getcustomersid)
117
+ * [Get Customer](https://docs.medusajs.com/api/admin#customers_getcustomersid)
118
118
  * API route.
119
119
  *
120
120
  * @param id - The customer's ID.
@@ -143,7 +143,7 @@ class Customer {
143
143
  * })
144
144
  * ```
145
145
  *
146
- * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
146
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
147
147
  */
148
148
  async retrieve(id, query, headers) {
149
149
  return this.client.fetch(`/admin/customers/${id}`, {
@@ -153,7 +153,7 @@ class Customer {
153
153
  }
154
154
  /**
155
155
  * This method deletes a customer by its ID. It sends a request to the
156
- * [Delete Customer](https://docs.medusajs.com/v2/api/admin#customers_deletecustomersid)
156
+ * [Delete Customer](https://docs.medusajs.com/api/admin#customers_deletecustomersid)
157
157
  * API route.
158
158
  *
159
159
  * @param id - The customer's ID.
@@ -172,6 +172,32 @@ class Customer {
172
172
  headers,
173
173
  });
174
174
  }
175
+ /**
176
+ * This method manages customer groups for a customer.
177
+ * It sends a request to the [Manage Customers](https://docs.medusajs.com/api/admin#customers_postcustomersidcustomergroups)
178
+ * API route.
179
+ *
180
+ * @param id - The customer's ID.
181
+ * @param body - The groups to add customer to or remove customer from.
182
+ * @param headers - Headers to pass in the request
183
+ * @returns The customers details.
184
+ *
185
+ * @example
186
+ * sdk.admin.customer.batchCustomerGroups("cus_123", {
187
+ * add: ["cusgroup_123"],
188
+ * remove: ["cusgroup_321"]
189
+ * })
190
+ * .then(({ customer }) => {
191
+ * console.log(customer)
192
+ * })
193
+ */
194
+ async batchCustomerGroups(id, body, headers) {
195
+ return await this.client.fetch(`/admin/customers/${id}/customer-groups`, {
196
+ method: "POST",
197
+ headers,
198
+ body,
199
+ });
200
+ }
175
201
  }
176
202
  exports.Customer = Customer;
177
203
  //# sourceMappingURL=customer.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"customer.js","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":";;;AAOA,MAAa,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,WAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AA7MD,4BA6MC"}
1
+ {"version":3,"file":"customer.js","sourceRoot":"","sources":["../../src/admin/customer.ts"],"names":[],"mappings":";;;AAOA,MAAa,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAmC,EACnC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,WAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAEtB,kBAAkB,EAAE;YACpB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EAAE,EAAE,EACxB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,EACxC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA/OD,4BA+OC"}