@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.
- package/dist/admin/api-key.d.ts +8 -8
- package/dist/admin/api-key.js +8 -8
- package/dist/admin/campaign.d.ts +8 -8
- package/dist/admin/campaign.js +8 -8
- package/dist/admin/claim.d.ts +22 -22
- package/dist/admin/claim.js +22 -22
- package/dist/admin/currency.d.ts +4 -4
- package/dist/admin/currency.js +4 -4
- package/dist/admin/customer-group.d.ts +8 -8
- package/dist/admin/customer-group.js +8 -8
- package/dist/admin/customer.d.ts +27 -7
- package/dist/admin/customer.d.ts.map +1 -1
- package/dist/admin/customer.js +33 -7
- package/dist/admin/customer.js.map +1 -1
- package/dist/admin/exchange.d.ts +21 -21
- package/dist/admin/exchange.js +21 -21
- package/dist/admin/fulfillment-provider.d.ts +2 -2
- package/dist/admin/fulfillment-provider.js +2 -2
- package/dist/admin/fulfillment-set.d.ts +6 -6
- package/dist/admin/fulfillment-set.js +6 -6
- package/dist/admin/fulfillment.d.ts +3 -3
- package/dist/admin/fulfillment.js +3 -3
- package/dist/admin/inventory-item.d.ts +12 -12
- package/dist/admin/inventory-item.js +12 -12
- package/dist/admin/invite.d.ts +8 -8
- package/dist/admin/invite.js +8 -8
- package/dist/admin/payment-collection.d.ts +0 -2
- package/dist/admin/payment-collection.d.ts.map +1 -1
- package/dist/admin/payment-collection.js +0 -12
- package/dist/admin/payment-collection.js.map +1 -1
- package/dist/auth/index.d.ts +10 -10
- package/dist/auth/index.js +10 -10
- package/dist/esm/admin/api-key.d.ts +8 -8
- package/dist/esm/admin/api-key.js +8 -8
- package/dist/esm/admin/campaign.d.ts +8 -8
- package/dist/esm/admin/campaign.js +8 -8
- package/dist/esm/admin/claim.d.ts +22 -22
- package/dist/esm/admin/claim.js +22 -22
- package/dist/esm/admin/currency.d.ts +4 -4
- package/dist/esm/admin/currency.js +4 -4
- package/dist/esm/admin/customer-group.d.ts +8 -8
- package/dist/esm/admin/customer-group.js +8 -8
- package/dist/esm/admin/customer.d.ts +27 -7
- package/dist/esm/admin/customer.d.ts.map +1 -1
- package/dist/esm/admin/customer.js +35 -7
- package/dist/esm/admin/customer.js.map +1 -1
- package/dist/esm/admin/exchange.d.ts +21 -21
- package/dist/esm/admin/exchange.js +21 -21
- package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
- package/dist/esm/admin/fulfillment-provider.js +2 -2
- package/dist/esm/admin/fulfillment-set.d.ts +6 -6
- package/dist/esm/admin/fulfillment-set.js +6 -6
- package/dist/esm/admin/fulfillment.d.ts +3 -3
- package/dist/esm/admin/fulfillment.js +3 -3
- package/dist/esm/admin/inventory-item.d.ts +12 -12
- package/dist/esm/admin/inventory-item.js +12 -12
- package/dist/esm/admin/invite.d.ts +8 -8
- package/dist/esm/admin/invite.js +8 -8
- package/dist/esm/admin/payment-collection.d.ts +0 -2
- package/dist/esm/admin/payment-collection.d.ts.map +1 -1
- package/dist/esm/admin/payment-collection.js +0 -16
- package/dist/esm/admin/payment-collection.js.map +1 -1
- package/dist/esm/auth/index.d.ts +10 -10
- package/dist/esm/auth/index.js +10 -10
- package/dist/esm/store/index.d.ts +73 -73
- package/dist/esm/store/index.js +73 -73
- package/dist/store/index.d.ts +73 -73
- package/dist/store/index.js +73 -73
- package/package.json +2 -2
@@ -16,7 +16,7 @@ export class Exchange {
|
|
16
16
|
}
|
17
17
|
/**
|
18
18
|
* This method retrieves a paginated list of exchanges. It sends a request to the
|
19
|
-
* [List Exchanges](https://docs.medusajs.com/
|
19
|
+
* [List Exchanges](https://docs.medusajs.com/api/admin#exchanges_getexchanges)
|
20
20
|
* API route.
|
21
21
|
*
|
22
22
|
* @param query - Filters and pagination configurations.
|
@@ -59,7 +59,7 @@ export class Exchange {
|
|
59
59
|
* })
|
60
60
|
* ```
|
61
61
|
*
|
62
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
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 Exchange {
|
|
71
71
|
}
|
72
72
|
/**
|
73
73
|
* This method retrieves an exchange by its ID. It sends a request to the
|
74
|
-
* [Get Exchange](https://docs.medusajs.com/
|
74
|
+
* [Get Exchange](https://docs.medusajs.com/api/admin#exchanges_getexchangesid)
|
75
75
|
* API route.
|
76
76
|
*
|
77
77
|
* @param id - The exchange's ID.
|
@@ -100,7 +100,7 @@ export class Exchange {
|
|
100
100
|
* })
|
101
101
|
* ```
|
102
102
|
*
|
103
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
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
|
retrieve(id, query, headers) {
|
106
106
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -112,7 +112,7 @@ export class Exchange {
|
|
112
112
|
}
|
113
113
|
/**
|
114
114
|
* This method creates an admin exchange. It sends a request to the
|
115
|
-
* [Create Exchange](https://docs.medusajs.com/
|
115
|
+
* [Create Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchanges) API route.
|
116
116
|
*
|
117
117
|
* @param body - The exchange's details.
|
118
118
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -139,7 +139,7 @@ export class Exchange {
|
|
139
139
|
}
|
140
140
|
/**
|
141
141
|
* This method cancels an exchange. It sends a request to the
|
142
|
-
* [Cancel Exchange](https://docs.medusajs.com/
|
142
|
+
* [Cancel Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidcancel) API route.
|
143
143
|
*
|
144
144
|
* @param id - The exchange's ID.
|
145
145
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -165,7 +165,7 @@ export class Exchange {
|
|
165
165
|
* This method adds inbound (or return) items to an exchange. These inbound items will
|
166
166
|
* have the action `RETURN_ITEM`.
|
167
167
|
*
|
168
|
-
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/
|
168
|
+
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditems)
|
169
169
|
* API route.
|
170
170
|
*
|
171
171
|
* @param id - The exchange's ID.
|
@@ -202,7 +202,7 @@ export class Exchange {
|
|
202
202
|
* Every item has an `actions` property, whose value is an array of actions. You can
|
203
203
|
* check the action's name using its `action` property, and use the value of the `id` property.
|
204
204
|
*
|
205
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
205
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditemsaction_id)
|
206
206
|
* API route.
|
207
207
|
*
|
208
208
|
* @param id - The exchange's ID.
|
@@ -241,7 +241,7 @@ export class Exchange {
|
|
241
241
|
* Every item has an `actions` property, whose value is an array of actions.
|
242
242
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
243
243
|
*
|
244
|
-
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/
|
244
|
+
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
|
245
245
|
* API route.
|
246
246
|
*
|
247
247
|
* @param id - The exchange's ID.
|
@@ -272,10 +272,10 @@ export class Exchange {
|
|
272
272
|
* This method adds an inbound (or return) shipping method to an exchange.
|
273
273
|
* The inbound shipping method will have a `SHIPPING_ADD` action.
|
274
274
|
*
|
275
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
275
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
276
276
|
* API route.
|
277
277
|
*
|
278
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
278
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
279
279
|
* API route.
|
280
280
|
*
|
281
281
|
* @param id - The exchange's ID.
|
@@ -309,7 +309,7 @@ export class Exchange {
|
|
309
309
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
310
310
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
311
311
|
*
|
312
|
-
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/
|
312
|
+
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
|
313
313
|
* API route.
|
314
314
|
*
|
315
315
|
* @param id - The exchange's ID.
|
@@ -348,7 +348,7 @@ export class Exchange {
|
|
348
348
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
349
349
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
350
350
|
*
|
351
|
-
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/
|
351
|
+
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
|
352
352
|
* API route.
|
353
353
|
*
|
354
354
|
* @param id - The exchange's ID.
|
@@ -379,7 +379,7 @@ export class Exchange {
|
|
379
379
|
* This method adds outbound (or new) items to an exchange.
|
380
380
|
* These outbound items will have the action `ITEM_ADD`.
|
381
381
|
*
|
382
|
-
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/
|
382
|
+
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditems)
|
383
383
|
* API route.
|
384
384
|
*
|
385
385
|
* @param id - The exchange's ID.
|
@@ -416,7 +416,7 @@ export class Exchange {
|
|
416
416
|
* Every item has an `actions` property, whose value is an array of actions.
|
417
417
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
418
418
|
*
|
419
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
419
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
|
420
420
|
* API route.
|
421
421
|
*
|
422
422
|
* @param id - The exchange's ID.
|
@@ -455,7 +455,7 @@ export class Exchange {
|
|
455
455
|
* Every item has an `actions` property, whose value is an array of actions.
|
456
456
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
457
457
|
*
|
458
|
-
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/
|
458
|
+
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
|
459
459
|
* API route.
|
460
460
|
*
|
461
461
|
* @param id - The exchange's ID.
|
@@ -486,7 +486,7 @@ export class Exchange {
|
|
486
486
|
* This method adds an outbound shipping method to an exchange. The outbound shipping method
|
487
487
|
* will have a `SHIPPING_ADD` action.
|
488
488
|
*
|
489
|
-
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/
|
489
|
+
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethod)
|
490
490
|
* API route.
|
491
491
|
*
|
492
492
|
* @param id - The exchange's ID.
|
@@ -520,7 +520,7 @@ export class Exchange {
|
|
520
520
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
521
521
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
522
522
|
*
|
523
|
-
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/
|
523
|
+
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
|
524
524
|
* API route.
|
525
525
|
*
|
526
526
|
* @param id - The exchange's ID.
|
@@ -559,7 +559,7 @@ export class Exchange {
|
|
559
559
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
560
560
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
561
561
|
*
|
562
|
-
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/
|
562
|
+
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
|
563
563
|
* API route.
|
564
564
|
*
|
565
565
|
* @param id - The exchange's ID.
|
@@ -589,7 +589,7 @@ export class Exchange {
|
|
589
589
|
/**
|
590
590
|
* This method confirms an exchange request, applying its changes on the associated order.
|
591
591
|
*
|
592
|
-
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/
|
592
|
+
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidrequest)
|
593
593
|
* API route.
|
594
594
|
*
|
595
595
|
* @param id - The exchange's ID.
|
@@ -616,7 +616,7 @@ export class Exchange {
|
|
616
616
|
}
|
617
617
|
/**
|
618
618
|
* This method cancels an exchange request. It sends a request to the
|
619
|
-
* [Cancel Exchange Request](https://docs.medusajs.com/
|
619
|
+
* [Cancel Exchange Request](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidrequest)
|
620
620
|
* API route.
|
621
621
|
*
|
622
622
|
* @param id - The exchange's ID.
|
@@ -12,7 +12,7 @@ export declare class FulfillmentProvider {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method retrieves a paginated list of fulfillment providers. It sends a request to the
|
15
|
-
* [List Fulfillment Providers](https://docs.medusajs.com/
|
15
|
+
* [List Fulfillment Providers](https://docs.medusajs.com/api/admin#fulfillment-providers_getfulfillmentproviders)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param query - Filters and pagination configurations.
|
@@ -55,7 +55,7 @@ export declare class FulfillmentProvider {
|
|
55
55
|
* })
|
56
56
|
* ```
|
57
57
|
*
|
58
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
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.AdminFulfillmentProviderListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentProviderListResponse>;
|
61
61
|
}
|
@@ -16,7 +16,7 @@ export class FulfillmentProvider {
|
|
16
16
|
}
|
17
17
|
/**
|
18
18
|
* This method retrieves a paginated list of fulfillment providers. It sends a request to the
|
19
|
-
* [List Fulfillment Providers](https://docs.medusajs.com/
|
19
|
+
* [List Fulfillment Providers](https://docs.medusajs.com/api/admin#fulfillment-providers_getfulfillmentproviders)
|
20
20
|
* API route.
|
21
21
|
*
|
22
22
|
* @param query - Filters and pagination configurations.
|
@@ -59,7 +59,7 @@ export class FulfillmentProvider {
|
|
59
59
|
* })
|
60
60
|
* ```
|
61
61
|
*
|
62
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
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* () {
|
@@ -12,7 +12,7 @@ export declare class FulfillmentSet {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method deletes a fulfillment set. It sends a request to the
|
15
|
-
* [Delete Fulfillment Set](https://docs.medusajs.com/
|
15
|
+
* [Delete Fulfillment Set](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsid)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param id - The fulfillment set's ID.
|
@@ -28,7 +28,7 @@ export declare class FulfillmentSet {
|
|
28
28
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetDeleteResponse>;
|
29
29
|
/**
|
30
30
|
* This method adds a service zone to a fulfillment set. It uses the
|
31
|
-
* [Add Service Zone](https://docs.medusajs.com/
|
31
|
+
* [Add Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
|
32
32
|
* API route.
|
33
33
|
*
|
34
34
|
* @param id - The fulfillment set's ID.
|
@@ -52,7 +52,7 @@ export declare class FulfillmentSet {
|
|
52
52
|
createServiceZone(id: string, body: HttpTypes.AdminCreateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
|
53
53
|
/**
|
54
54
|
* This method retrieves a fulfillment set's service zone's details. It sends a request to the
|
55
|
-
* [Get Service Zone](https://docs.medusajs.com/
|
55
|
+
* [Get Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
|
56
56
|
* API route.
|
57
57
|
*
|
58
58
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -89,12 +89,12 @@ export declare class FulfillmentSet {
|
|
89
89
|
* })
|
90
90
|
* ```
|
91
91
|
*
|
92
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
92
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
93
93
|
*/
|
94
94
|
retrieveServiceZone(fulfillmentSetId: string, serviceZoneId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminServiceZoneResponse>;
|
95
95
|
/**
|
96
96
|
* This method updates a service zone in a fulfillment set. It sends a request to the
|
97
|
-
* [Update Service Zone](https://docs.medusajs.com/
|
97
|
+
* [Update Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
|
98
98
|
* API route.
|
99
99
|
*
|
100
100
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -119,7 +119,7 @@ export declare class FulfillmentSet {
|
|
119
119
|
updateServiceZone(fulfillmentSetId: string, serviceZoneId: string, body: HttpTypes.AdminUpdateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
|
120
120
|
/**
|
121
121
|
* This method deletes a service zone in a fulfillment set. It sends a request to the
|
122
|
-
* [Remove Service Zone](https://docs.medusajs.com/
|
122
|
+
* [Remove Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
|
123
123
|
* API route.
|
124
124
|
*
|
125
125
|
* @param fulfillmentSetId - The fulfullment set's ID.
|
@@ -16,7 +16,7 @@ export class FulfillmentSet {
|
|
16
16
|
}
|
17
17
|
/**
|
18
18
|
* This method deletes a fulfillment set. It sends a request to the
|
19
|
-
* [Delete Fulfillment Set](https://docs.medusajs.com/
|
19
|
+
* [Delete Fulfillment Set](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsid)
|
20
20
|
* API route.
|
21
21
|
*
|
22
22
|
* @param id - The fulfillment set's ID.
|
@@ -39,7 +39,7 @@ export class FulfillmentSet {
|
|
39
39
|
}
|
40
40
|
/**
|
41
41
|
* This method adds a service zone to a fulfillment set. It uses the
|
42
|
-
* [Add Service Zone](https://docs.medusajs.com/
|
42
|
+
* [Add Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
|
43
43
|
* API route.
|
44
44
|
*
|
45
45
|
* @param id - The fulfillment set's ID.
|
@@ -72,7 +72,7 @@ export class FulfillmentSet {
|
|
72
72
|
}
|
73
73
|
/**
|
74
74
|
* This method retrieves a fulfillment set's service zone's details. It sends a request to the
|
75
|
-
* [Get Service Zone](https://docs.medusajs.com/
|
75
|
+
* [Get Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
|
76
76
|
* API route.
|
77
77
|
*
|
78
78
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -109,7 +109,7 @@ export class FulfillmentSet {
|
|
109
109
|
* })
|
110
110
|
* ```
|
111
111
|
*
|
112
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
112
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
113
113
|
*/
|
114
114
|
retrieveServiceZone(fulfillmentSetId, serviceZoneId, query, headers) {
|
115
115
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -122,7 +122,7 @@ export class FulfillmentSet {
|
|
122
122
|
}
|
123
123
|
/**
|
124
124
|
* This method updates a service zone in a fulfillment set. It sends a request to the
|
125
|
-
* [Update Service Zone](https://docs.medusajs.com/
|
125
|
+
* [Update Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
|
126
126
|
* API route.
|
127
127
|
*
|
128
128
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -156,7 +156,7 @@ export class FulfillmentSet {
|
|
156
156
|
}
|
157
157
|
/**
|
158
158
|
* This method deletes a service zone in a fulfillment set. It sends a request to the
|
159
|
-
* [Remove Service Zone](https://docs.medusajs.com/
|
159
|
+
* [Remove Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
|
160
160
|
* API route.
|
161
161
|
*
|
162
162
|
* @param fulfillmentSetId - The fulfullment set's ID.
|
@@ -12,7 +12,7 @@ export declare class Fulfillment {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method creates a fulfillment. It sends a request to the
|
15
|
-
* [Create Fulfillment](https://docs.medusajs.com/
|
15
|
+
* [Create Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillments)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param body - The fulfillment's details.
|
@@ -46,7 +46,7 @@ export declare class Fulfillment {
|
|
46
46
|
create(body: HttpTypes.AdminCreateFulfillment, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
|
47
47
|
/**
|
48
48
|
* This method cancels a fulfillment. It sends a request to the
|
49
|
-
* [Cancel Fulfillment](https://docs.medusajs.com/
|
49
|
+
* [Cancel Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidcancel)
|
50
50
|
* API route.
|
51
51
|
*
|
52
52
|
* @param id - The fulfillment's ID.
|
@@ -63,7 +63,7 @@ export declare class Fulfillment {
|
|
63
63
|
cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
|
64
64
|
/**
|
65
65
|
* This method creates a shipment for a fulfillment. It sends a request to the
|
66
|
-
* [Create Shipment](https://docs.medusajs.com/
|
66
|
+
* [Create Shipment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidshipment)
|
67
67
|
* API route.
|
68
68
|
*
|
69
69
|
* @param id - The fulfillment's ID.
|
@@ -16,7 +16,7 @@ export class Fulfillment {
|
|
16
16
|
}
|
17
17
|
/**
|
18
18
|
* This method creates a fulfillment. It sends a request to the
|
19
|
-
* [Create Fulfillment](https://docs.medusajs.com/
|
19
|
+
* [Create Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillments)
|
20
20
|
* API route.
|
21
21
|
*
|
22
22
|
* @param body - The fulfillment's details.
|
@@ -59,7 +59,7 @@ export class Fulfillment {
|
|
59
59
|
}
|
60
60
|
/**
|
61
61
|
* This method cancels a fulfillment. It sends a request to the
|
62
|
-
* [Cancel Fulfillment](https://docs.medusajs.com/
|
62
|
+
* [Cancel Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidcancel)
|
63
63
|
* API route.
|
64
64
|
*
|
65
65
|
* @param id - The fulfillment's ID.
|
@@ -85,7 +85,7 @@ export class Fulfillment {
|
|
85
85
|
}
|
86
86
|
/**
|
87
87
|
* This method creates a shipment for a fulfillment. It sends a request to the
|
88
|
-
* [Create Shipment](https://docs.medusajs.com/
|
88
|
+
* [Create Shipment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidshipment)
|
89
89
|
* API route.
|
90
90
|
*
|
91
91
|
* @param id - The fulfillment's ID.
|
@@ -12,7 +12,7 @@ export declare class InventoryItem {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method creates an inventory item. It sends a request to the
|
15
|
-
* [Create Inventory Item](https://docs.medusajs.com/
|
15
|
+
* [Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitems)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param body - The inventory item's details.
|
@@ -31,7 +31,7 @@ export declare class InventoryItem {
|
|
31
31
|
create(body: HttpTypes.AdminCreateInventoryItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
32
32
|
/**
|
33
33
|
* This method updates an inventory level. It sends a request to the
|
34
|
-
* [Update Inventory Item](https://docs.medusajs.com/
|
34
|
+
* [Update Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsid)
|
35
35
|
* API route.
|
36
36
|
*
|
37
37
|
* @param id - The inventory item's ID.
|
@@ -51,7 +51,7 @@ export declare class InventoryItem {
|
|
51
51
|
update(id: string, body: HttpTypes.AdminUpdateInventoryItem, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
52
52
|
/**
|
53
53
|
* This method retrieves a paginated list of inventory items. It sends a request to the
|
54
|
-
* [List Inventory Items](https://docs.medusajs.com/
|
54
|
+
* [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
55
55
|
* API route.
|
56
56
|
*
|
57
57
|
* @param query - Filters and pagination configurations.
|
@@ -94,12 +94,12 @@ export declare class InventoryItem {
|
|
94
94
|
* })
|
95
95
|
* ```
|
96
96
|
*
|
97
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
97
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
98
98
|
*/
|
99
99
|
list(query?: HttpTypes.AdminInventoryItemParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemListResponse>;
|
100
100
|
/**
|
101
101
|
* This method retrieves an inventory item by its ID. It sends a request to the
|
102
|
-
* [Get Inventory Item](https://docs.medusajs.com/
|
102
|
+
* [Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitemsid) API route.
|
103
103
|
*
|
104
104
|
* @param id - The inventory item's ID.
|
105
105
|
* @param query - Configure the fields to retrieve in the inventory item.
|
@@ -127,12 +127,12 @@ export declare class InventoryItem {
|
|
127
127
|
* })
|
128
128
|
* ```
|
129
129
|
*
|
130
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
130
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
131
131
|
*/
|
132
132
|
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemResponse>;
|
133
133
|
/**
|
134
134
|
* This method deletes an inventory item. This sends a request to the
|
135
|
-
* [Delete Inventory Item](https://docs.medusajs.com/
|
135
|
+
* [Delete Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsid)
|
136
136
|
* API route.
|
137
137
|
*
|
138
138
|
* @param id - The inventory item's ID.
|
@@ -148,7 +148,7 @@ export declare class InventoryItem {
|
|
148
148
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryItemDeleteResponse>;
|
149
149
|
/**
|
150
150
|
* This method retrieves a paginated list of inventory levels that belong to an inventory item.
|
151
|
-
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/
|
151
|
+
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
152
152
|
* API route.
|
153
153
|
*
|
154
154
|
* @param id - The inventory item's ID.
|
@@ -192,7 +192,7 @@ export declare class InventoryItem {
|
|
192
192
|
* })
|
193
193
|
* ```
|
194
194
|
*
|
195
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
195
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
196
196
|
*/
|
197
197
|
listLevels(id: string, query?: HttpTypes.AdminInventoryLevelFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelListResponse>;
|
198
198
|
/**
|
@@ -200,7 +200,7 @@ export declare class InventoryItem {
|
|
200
200
|
* stock location.
|
201
201
|
*
|
202
202
|
* This method sends a request to the
|
203
|
-
* [Update Inventory Level](https://docs.medusajs.com/
|
203
|
+
* [Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
|
204
204
|
* API route.
|
205
205
|
*
|
206
206
|
* @param id - The inventory item's ID.
|
@@ -228,7 +228,7 @@ export declare class InventoryItem {
|
|
228
228
|
* and a stock location.
|
229
229
|
*
|
230
230
|
* This method sends a request to the
|
231
|
-
* [Remove Inventory Level](https://docs.medusajs.com/
|
231
|
+
* [Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
|
232
232
|
* API route.
|
233
233
|
*
|
234
234
|
* @param id - The inventory item's ID.
|
@@ -248,7 +248,7 @@ export declare class InventoryItem {
|
|
248
248
|
deleteLevel(id: string, locationId: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInventoryLevelDeleteResponse>;
|
249
249
|
/**
|
250
250
|
* This method manages the inventory levels of an inventory item. It sends a request to the
|
251
|
-
* [Manage Inventory Levels](https://docs.medusajs.com/
|
251
|
+
* [Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
252
252
|
* API route.
|
253
253
|
*
|
254
254
|
* @param id - The inventory item's ID.
|
@@ -16,7 +16,7 @@ export class InventoryItem {
|
|
16
16
|
}
|
17
17
|
/**
|
18
18
|
* This method creates an inventory item. It sends a request to the
|
19
|
-
* [Create Inventory Item](https://docs.medusajs.com/
|
19
|
+
* [Create Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitems)
|
20
20
|
* API route.
|
21
21
|
*
|
22
22
|
* @param body - The inventory item's details.
|
@@ -44,7 +44,7 @@ export class InventoryItem {
|
|
44
44
|
}
|
45
45
|
/**
|
46
46
|
* This method updates an inventory level. It sends a request to the
|
47
|
-
* [Update Inventory Item](https://docs.medusajs.com/
|
47
|
+
* [Update Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsid)
|
48
48
|
* API route.
|
49
49
|
*
|
50
50
|
* @param id - The inventory item's ID.
|
@@ -73,7 +73,7 @@ export class InventoryItem {
|
|
73
73
|
}
|
74
74
|
/**
|
75
75
|
* This method retrieves a paginated list of inventory items. It sends a request to the
|
76
|
-
* [List Inventory Items](https://docs.medusajs.com/
|
76
|
+
* [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
77
77
|
* API route.
|
78
78
|
*
|
79
79
|
* @param query - Filters and pagination configurations.
|
@@ -116,7 +116,7 @@ export class InventoryItem {
|
|
116
116
|
* })
|
117
117
|
* ```
|
118
118
|
*
|
119
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
119
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
120
120
|
*/
|
121
121
|
list(query, headers) {
|
122
122
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -128,7 +128,7 @@ export class InventoryItem {
|
|
128
128
|
}
|
129
129
|
/**
|
130
130
|
* This method retrieves an inventory item by its ID. It sends a request to the
|
131
|
-
* [Get Inventory Item](https://docs.medusajs.com/
|
131
|
+
* [Get Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitemsid) API route.
|
132
132
|
*
|
133
133
|
* @param id - The inventory item's ID.
|
134
134
|
* @param query - Configure the fields to retrieve in the inventory item.
|
@@ -156,7 +156,7 @@ export class InventoryItem {
|
|
156
156
|
* })
|
157
157
|
* ```
|
158
158
|
*
|
159
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
159
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
160
160
|
*/
|
161
161
|
retrieve(id, query, headers) {
|
162
162
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -168,7 +168,7 @@ export class InventoryItem {
|
|
168
168
|
}
|
169
169
|
/**
|
170
170
|
* This method deletes an inventory item. This sends a request to the
|
171
|
-
* [Delete Inventory Item](https://docs.medusajs.com/
|
171
|
+
* [Delete Inventory Item](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsid)
|
172
172
|
* API route.
|
173
173
|
*
|
174
174
|
* @param id - The inventory item's ID.
|
@@ -191,7 +191,7 @@ export class InventoryItem {
|
|
191
191
|
}
|
192
192
|
/**
|
193
193
|
* This method retrieves a paginated list of inventory levels that belong to an inventory item.
|
194
|
-
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/
|
194
|
+
* It sends a request to the [List Inventory Items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
|
195
195
|
* API route.
|
196
196
|
*
|
197
197
|
* @param id - The inventory item's ID.
|
@@ -235,7 +235,7 @@ export class InventoryItem {
|
|
235
235
|
* })
|
236
236
|
* ```
|
237
237
|
*
|
238
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
238
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
239
239
|
*/
|
240
240
|
listLevels(id, query, headers) {
|
241
241
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -250,7 +250,7 @@ export class InventoryItem {
|
|
250
250
|
* stock location.
|
251
251
|
*
|
252
252
|
* This method sends a request to the
|
253
|
-
* [Update Inventory Level](https://docs.medusajs.com/
|
253
|
+
* [Update Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
|
254
254
|
* API route.
|
255
255
|
*
|
256
256
|
* @param id - The inventory item's ID.
|
@@ -287,7 +287,7 @@ export class InventoryItem {
|
|
287
287
|
* and a stock location.
|
288
288
|
*
|
289
289
|
* This method sends a request to the
|
290
|
-
* [Remove Inventory Level](https://docs.medusajs.com/
|
290
|
+
* [Remove Inventory Level](https://docs.medusajs.com/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
|
291
291
|
* API route.
|
292
292
|
*
|
293
293
|
* @param id - The inventory item's ID.
|
@@ -314,7 +314,7 @@ export class InventoryItem {
|
|
314
314
|
}
|
315
315
|
/**
|
316
316
|
* This method manages the inventory levels of an inventory item. It sends a request to the
|
317
|
-
* [Manage Inventory Levels](https://docs.medusajs.com/
|
317
|
+
* [Manage Inventory Levels](https://docs.medusajs.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
318
318
|
* API route.
|
319
319
|
*
|
320
320
|
* @param id - The inventory item's ID.
|
@@ -15,7 +15,7 @@ export declare class Invite {
|
|
15
15
|
* the {@link Auth.register}.
|
16
16
|
*
|
17
17
|
* This method sends a request to the [Accept Invite]
|
18
|
-
* (https://docs.medusajs.com/
|
18
|
+
* (https://docs.medusajs.com/api/admin#invites_postinvitesaccept)
|
19
19
|
* API route.
|
20
20
|
*
|
21
21
|
* @param input - The details of the user to create.
|
@@ -52,7 +52,7 @@ export declare class Invite {
|
|
52
52
|
}, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminAcceptInviteResponse>;
|
53
53
|
/**
|
54
54
|
* This method creates an invite. It sends a request to the
|
55
|
-
* [Create Invite](https://docs.medusajs.com/
|
55
|
+
* [Create Invite](https://docs.medusajs.com/api/admin#invites_postinvites)
|
56
56
|
* API route.
|
57
57
|
*
|
58
58
|
* @param body - The invite's details.
|
@@ -71,7 +71,7 @@ export declare class Invite {
|
|
71
71
|
create(body: HttpTypes.AdminCreateInvite, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
72
72
|
/**
|
73
73
|
* This method retrieves an invite by its ID. It sends a request to the
|
74
|
-
* [Get Invite](https://docs.medusajs.com/
|
74
|
+
* [Get Invite](https://docs.medusajs.com/api/admin#invites_getinvitesid)
|
75
75
|
* API route.
|
76
76
|
*
|
77
77
|
* @param id - The invite's ID.
|
@@ -100,12 +100,12 @@ export declare class Invite {
|
|
100
100
|
* })
|
101
101
|
* ```
|
102
102
|
*
|
103
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
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
|
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
106
106
|
/**
|
107
107
|
* This method retrieves a paginated list of invites. It sends a request to the
|
108
|
-
* [List Invites](https://docs.medusajs.com/
|
108
|
+
* [List Invites](https://docs.medusajs.com/api/admin#invites_getinvites)
|
109
109
|
* API route.
|
110
110
|
*
|
111
111
|
* @param queryParams - Filters and pagination configurations.
|
@@ -148,12 +148,12 @@ export declare class Invite {
|
|
148
148
|
* })
|
149
149
|
* ```
|
150
150
|
*
|
151
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
151
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
152
152
|
*/
|
153
153
|
list(queryParams?: FindParams, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteListResponse>;
|
154
154
|
/**
|
155
155
|
* This method refreshes the token of an invite. It sends a request to the
|
156
|
-
* [Refresh Invite Token](https://docs.medusajs.com/
|
156
|
+
* [Refresh Invite Token](https://docs.medusajs.com/api/admin#invites_postinvitesidresend)
|
157
157
|
* API route.
|
158
158
|
*
|
159
159
|
* @param id - The invite's ID.
|
@@ -169,7 +169,7 @@ export declare class Invite {
|
|
169
169
|
resend(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminInviteResponse>;
|
170
170
|
/**
|
171
171
|
* This method deletes an invite. It sends a request to the
|
172
|
-
* [Delete Invite](https://docs.medusajs.com/
|
172
|
+
* [Delete Invite](https://docs.medusajs.com/api/admin#invites_deleteinvitesid)
|
173
173
|
* API route.
|
174
174
|
*
|
175
175
|
* @param id - The invite's ID.
|