@medusajs/js-sdk 1.0.0-rc-20241016093905 → 1.0.0-rc-20241022152047
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/admin/api-key.d.ts +150 -1
- package/dist/admin/api-key.d.ts.map +1 -1
- package/dist/admin/api-key.js +146 -0
- package/dist/admin/api-key.js.map +1 -1
- package/dist/admin/campaign.d.ts +141 -0
- package/dist/admin/campaign.d.ts.map +1 -1
- package/dist/admin/campaign.js +138 -0
- package/dist/admin/campaign.js.map +1 -1
- package/dist/admin/claim.d.ts +548 -20
- package/dist/admin/claim.d.ts.map +1 -1
- package/dist/admin/claim.js +526 -7
- package/dist/admin/claim.js.map +1 -1
- package/dist/admin/currency.d.ts +86 -1
- package/dist/admin/currency.d.ts.map +1 -1
- package/dist/admin/currency.js +84 -2
- package/dist/admin/currency.js.map +1 -1
- package/dist/admin/customer-group.d.ts +158 -2
- package/dist/admin/customer-group.d.ts.map +1 -1
- package/dist/admin/customer-group.js +153 -0
- package/dist/admin/customer-group.js.map +1 -1
- package/dist/admin/customer.d.ts +141 -13
- package/dist/admin/customer.d.ts.map +1 -1
- package/dist/admin/customer.js +133 -0
- package/dist/admin/customer.js.map +1 -1
- package/dist/admin/exchange.d.ts +477 -20
- package/dist/admin/exchange.d.ts.map +1 -1
- package/dist/admin/exchange.js +458 -30
- package/dist/admin/exchange.js.map +1 -1
- package/dist/admin/fulfillment-provider.d.ts +53 -0
- package/dist/admin/fulfillment-provider.d.ts.map +1 -1
- package/dist/admin/fulfillment-provider.js +50 -0
- package/dist/admin/fulfillment-provider.js.map +1 -1
- package/dist/admin/fulfillment-set.d.ts +128 -0
- package/dist/admin/fulfillment-set.d.ts.map +1 -1
- package/dist/admin/fulfillment-set.js +125 -0
- package/dist/admin/fulfillment-set.js.map +1 -1
- package/dist/admin/fulfillment.d.ts +80 -0
- package/dist/admin/fulfillment.d.ts.map +1 -1
- package/dist/admin/fulfillment.js +78 -0
- package/dist/admin/fulfillment.js.map +1 -1
- package/dist/admin/inventory-item.d.ts +258 -1
- package/dist/admin/inventory-item.d.ts.map +1 -1
- package/dist/admin/inventory-item.js +254 -0
- package/dist/admin/inventory-item.js.map +1 -1
- package/dist/admin/invite.d.ts +176 -15
- package/dist/admin/invite.d.ts.map +1 -1
- package/dist/admin/invite.js +165 -0
- package/dist/admin/invite.js.map +1 -1
- package/dist/admin/notification.d.ts +6 -0
- package/dist/admin/notification.d.ts.map +1 -1
- package/dist/admin/notification.js +3 -0
- package/dist/admin/notification.js.map +1 -1
- package/dist/admin/order-edit.d.ts +6 -0
- package/dist/admin/order-edit.d.ts.map +1 -1
- package/dist/admin/order-edit.js +3 -0
- package/dist/admin/order-edit.js.map +1 -1
- package/dist/admin/order.d.ts +7 -0
- package/dist/admin/order.d.ts.map +1 -1
- package/dist/admin/order.js +9 -0
- package/dist/admin/order.js.map +1 -1
- package/dist/admin/payment-collection.d.ts +6 -0
- package/dist/admin/payment-collection.d.ts.map +1 -1
- package/dist/admin/payment-collection.js +3 -0
- package/dist/admin/payment-collection.js.map +1 -1
- package/dist/admin/payment.d.ts +6 -0
- package/dist/admin/payment.d.ts.map +1 -1
- package/dist/admin/payment.js +3 -0
- package/dist/admin/payment.js.map +1 -1
- package/dist/admin/price-list.d.ts +6 -0
- package/dist/admin/price-list.d.ts.map +1 -1
- package/dist/admin/price-list.js +3 -0
- package/dist/admin/price-list.js.map +1 -1
- package/dist/admin/price-preference.d.ts +6 -0
- package/dist/admin/price-preference.d.ts.map +1 -1
- package/dist/admin/price-preference.js +3 -0
- package/dist/admin/price-preference.js.map +1 -1
- package/dist/admin/product-category.d.ts +6 -0
- package/dist/admin/product-category.d.ts.map +1 -1
- package/dist/admin/product-category.js +3 -0
- package/dist/admin/product-category.js.map +1 -1
- package/dist/admin/product-collection.d.ts +6 -0
- package/dist/admin/product-collection.d.ts.map +1 -1
- package/dist/admin/product-collection.js +3 -0
- package/dist/admin/product-collection.js.map +1 -1
- package/dist/admin/product-tag.d.ts +6 -0
- package/dist/admin/product-tag.d.ts.map +1 -1
- package/dist/admin/product-tag.js +3 -0
- package/dist/admin/product-tag.js.map +1 -1
- package/dist/admin/product-type.d.ts +6 -0
- package/dist/admin/product-type.d.ts.map +1 -1
- package/dist/admin/product-type.js +3 -0
- package/dist/admin/product-type.js.map +1 -1
- package/dist/admin/product-variant.d.ts +6 -0
- package/dist/admin/product-variant.d.ts.map +1 -1
- package/dist/admin/product-variant.js +3 -0
- package/dist/admin/product-variant.js.map +1 -1
- package/dist/admin/product.d.ts +6 -0
- package/dist/admin/product.d.ts.map +1 -1
- package/dist/admin/product.js +3 -0
- package/dist/admin/product.js.map +1 -1
- package/dist/admin/promotion.d.ts +6 -0
- package/dist/admin/promotion.d.ts.map +1 -1
- package/dist/admin/promotion.js +3 -0
- package/dist/admin/promotion.js.map +1 -1
- package/dist/admin/refund-reasons.d.ts +6 -0
- package/dist/admin/refund-reasons.d.ts.map +1 -1
- package/dist/admin/refund-reasons.js +3 -0
- package/dist/admin/refund-reasons.js.map +1 -1
- package/dist/admin/region.d.ts +6 -0
- package/dist/admin/region.d.ts.map +1 -1
- package/dist/admin/region.js +3 -0
- package/dist/admin/region.js.map +1 -1
- package/dist/admin/reservation.d.ts +6 -0
- package/dist/admin/reservation.d.ts.map +1 -1
- package/dist/admin/reservation.js +3 -0
- package/dist/admin/reservation.js.map +1 -1
- package/dist/admin/return-reason.d.ts +6 -0
- package/dist/admin/return-reason.d.ts.map +1 -1
- package/dist/admin/return-reason.js +3 -0
- package/dist/admin/return-reason.js.map +1 -1
- package/dist/admin/return.d.ts +6 -0
- package/dist/admin/return.d.ts.map +1 -1
- package/dist/admin/return.js +3 -0
- package/dist/admin/return.js.map +1 -1
- package/dist/admin/sales-channel.d.ts +6 -0
- package/dist/admin/sales-channel.d.ts.map +1 -1
- package/dist/admin/sales-channel.js +3 -0
- package/dist/admin/sales-channel.js.map +1 -1
- package/dist/admin/shipping-option.d.ts +6 -0
- package/dist/admin/shipping-option.d.ts.map +1 -1
- package/dist/admin/shipping-option.js +3 -0
- package/dist/admin/shipping-option.js.map +1 -1
- package/dist/admin/shipping-profile.d.ts +6 -0
- package/dist/admin/shipping-profile.d.ts.map +1 -1
- package/dist/admin/shipping-profile.js +3 -0
- package/dist/admin/shipping-profile.js.map +1 -1
- package/dist/admin/stock-location.d.ts +6 -0
- package/dist/admin/stock-location.d.ts.map +1 -1
- package/dist/admin/stock-location.js +3 -0
- package/dist/admin/stock-location.js.map +1 -1
- package/dist/admin/store.d.ts +6 -0
- package/dist/admin/store.d.ts.map +1 -1
- package/dist/admin/store.js +3 -0
- package/dist/admin/store.js.map +1 -1
- package/dist/admin/tax-rate.d.ts +6 -0
- package/dist/admin/tax-rate.d.ts.map +1 -1
- package/dist/admin/tax-rate.js +3 -0
- package/dist/admin/tax-rate.js.map +1 -1
- package/dist/admin/tax-region.d.ts +6 -0
- package/dist/admin/tax-region.d.ts.map +1 -1
- package/dist/admin/tax-region.js +3 -0
- package/dist/admin/tax-region.js.map +1 -1
- package/dist/admin/upload.d.ts +6 -0
- package/dist/admin/upload.d.ts.map +1 -1
- package/dist/admin/upload.js +3 -0
- package/dist/admin/upload.js.map +1 -1
- package/dist/admin/user.d.ts +6 -0
- package/dist/admin/user.d.ts.map +1 -1
- package/dist/admin/user.js +3 -0
- package/dist/admin/user.js.map +1 -1
- package/dist/admin/workflow-execution.d.ts +6 -0
- package/dist/admin/workflow-execution.d.ts.map +1 -1
- package/dist/admin/workflow-execution.js +3 -0
- package/dist/admin/workflow-execution.js.map +1 -1
- package/dist/auth/index.d.ts +156 -0
- package/dist/auth/index.d.ts.map +1 -1
- package/dist/auth/index.js +152 -1
- package/dist/auth/index.js.map +1 -1
- package/dist/client.d.ts +1 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +2 -1
- package/dist/client.js.map +1 -1
- package/dist/esm/admin/api-key.d.ts +150 -1
- package/dist/esm/admin/api-key.d.ts.map +1 -1
- package/dist/esm/admin/api-key.js +146 -0
- package/dist/esm/admin/api-key.js.map +1 -1
- package/dist/esm/admin/campaign.d.ts +141 -0
- package/dist/esm/admin/campaign.d.ts.map +1 -1
- package/dist/esm/admin/campaign.js +138 -0
- package/dist/esm/admin/campaign.js.map +1 -1
- package/dist/esm/admin/claim.d.ts +548 -20
- package/dist/esm/admin/claim.d.ts.map +1 -1
- package/dist/esm/admin/claim.js +526 -9
- package/dist/esm/admin/claim.js.map +1 -1
- package/dist/esm/admin/currency.d.ts +86 -1
- package/dist/esm/admin/currency.d.ts.map +1 -1
- package/dist/esm/admin/currency.js +84 -2
- package/dist/esm/admin/currency.js.map +1 -1
- package/dist/esm/admin/customer-group.d.ts +158 -2
- package/dist/esm/admin/customer-group.d.ts.map +1 -1
- package/dist/esm/admin/customer-group.js +153 -0
- package/dist/esm/admin/customer-group.js.map +1 -1
- package/dist/esm/admin/customer.d.ts +141 -13
- package/dist/esm/admin/customer.d.ts.map +1 -1
- package/dist/esm/admin/customer.js +133 -0
- package/dist/esm/admin/customer.js.map +1 -1
- package/dist/esm/admin/exchange.d.ts +477 -20
- package/dist/esm/admin/exchange.d.ts.map +1 -1
- package/dist/esm/admin/exchange.js +458 -38
- package/dist/esm/admin/exchange.js.map +1 -1
- package/dist/esm/admin/fulfillment-provider.d.ts +53 -0
- package/dist/esm/admin/fulfillment-provider.d.ts.map +1 -1
- package/dist/esm/admin/fulfillment-provider.js +50 -0
- package/dist/esm/admin/fulfillment-provider.js.map +1 -1
- package/dist/esm/admin/fulfillment-set.d.ts +128 -0
- package/dist/esm/admin/fulfillment-set.d.ts.map +1 -1
- package/dist/esm/admin/fulfillment-set.js +125 -0
- package/dist/esm/admin/fulfillment-set.js.map +1 -1
- package/dist/esm/admin/fulfillment.d.ts +80 -0
- package/dist/esm/admin/fulfillment.d.ts.map +1 -1
- package/dist/esm/admin/fulfillment.js +78 -0
- package/dist/esm/admin/fulfillment.js.map +1 -1
- package/dist/esm/admin/inventory-item.d.ts +258 -1
- package/dist/esm/admin/inventory-item.d.ts.map +1 -1
- package/dist/esm/admin/inventory-item.js +254 -0
- package/dist/esm/admin/inventory-item.js.map +1 -1
- package/dist/esm/admin/invite.d.ts +176 -15
- package/dist/esm/admin/invite.d.ts.map +1 -1
- package/dist/esm/admin/invite.js +165 -0
- package/dist/esm/admin/invite.js.map +1 -1
- package/dist/esm/admin/notification.d.ts +6 -0
- package/dist/esm/admin/notification.d.ts.map +1 -1
- package/dist/esm/admin/notification.js +3 -0
- package/dist/esm/admin/notification.js.map +1 -1
- package/dist/esm/admin/order-edit.d.ts +6 -0
- package/dist/esm/admin/order-edit.d.ts.map +1 -1
- package/dist/esm/admin/order-edit.js +3 -0
- package/dist/esm/admin/order-edit.js.map +1 -1
- package/dist/esm/admin/order.d.ts +7 -0
- package/dist/esm/admin/order.d.ts.map +1 -1
- package/dist/esm/admin/order.js +11 -0
- package/dist/esm/admin/order.js.map +1 -1
- package/dist/esm/admin/payment-collection.d.ts +6 -0
- package/dist/esm/admin/payment-collection.d.ts.map +1 -1
- package/dist/esm/admin/payment-collection.js +3 -0
- package/dist/esm/admin/payment-collection.js.map +1 -1
- package/dist/esm/admin/payment.d.ts +6 -0
- package/dist/esm/admin/payment.d.ts.map +1 -1
- package/dist/esm/admin/payment.js +3 -0
- package/dist/esm/admin/payment.js.map +1 -1
- package/dist/esm/admin/price-list.d.ts +6 -0
- package/dist/esm/admin/price-list.d.ts.map +1 -1
- package/dist/esm/admin/price-list.js +3 -0
- package/dist/esm/admin/price-list.js.map +1 -1
- package/dist/esm/admin/price-preference.d.ts +6 -0
- package/dist/esm/admin/price-preference.d.ts.map +1 -1
- package/dist/esm/admin/price-preference.js +3 -0
- package/dist/esm/admin/price-preference.js.map +1 -1
- package/dist/esm/admin/product-category.d.ts +6 -0
- package/dist/esm/admin/product-category.d.ts.map +1 -1
- package/dist/esm/admin/product-category.js +3 -0
- package/dist/esm/admin/product-category.js.map +1 -1
- package/dist/esm/admin/product-collection.d.ts +6 -0
- package/dist/esm/admin/product-collection.d.ts.map +1 -1
- package/dist/esm/admin/product-collection.js +3 -0
- package/dist/esm/admin/product-collection.js.map +1 -1
- package/dist/esm/admin/product-tag.d.ts +6 -0
- package/dist/esm/admin/product-tag.d.ts.map +1 -1
- package/dist/esm/admin/product-tag.js +3 -0
- package/dist/esm/admin/product-tag.js.map +1 -1
- package/dist/esm/admin/product-type.d.ts +6 -0
- package/dist/esm/admin/product-type.d.ts.map +1 -1
- package/dist/esm/admin/product-type.js +3 -0
- package/dist/esm/admin/product-type.js.map +1 -1
- package/dist/esm/admin/product-variant.d.ts +6 -0
- package/dist/esm/admin/product-variant.d.ts.map +1 -1
- package/dist/esm/admin/product-variant.js +3 -0
- package/dist/esm/admin/product-variant.js.map +1 -1
- package/dist/esm/admin/product.d.ts +6 -0
- package/dist/esm/admin/product.d.ts.map +1 -1
- package/dist/esm/admin/product.js +3 -0
- package/dist/esm/admin/product.js.map +1 -1
- package/dist/esm/admin/promotion.d.ts +6 -0
- package/dist/esm/admin/promotion.d.ts.map +1 -1
- package/dist/esm/admin/promotion.js +3 -0
- package/dist/esm/admin/promotion.js.map +1 -1
- package/dist/esm/admin/refund-reasons.d.ts +6 -0
- package/dist/esm/admin/refund-reasons.d.ts.map +1 -1
- package/dist/esm/admin/refund-reasons.js +3 -0
- package/dist/esm/admin/refund-reasons.js.map +1 -1
- package/dist/esm/admin/region.d.ts +6 -0
- package/dist/esm/admin/region.d.ts.map +1 -1
- package/dist/esm/admin/region.js +3 -0
- package/dist/esm/admin/region.js.map +1 -1
- package/dist/esm/admin/reservation.d.ts +6 -0
- package/dist/esm/admin/reservation.d.ts.map +1 -1
- package/dist/esm/admin/reservation.js +3 -0
- package/dist/esm/admin/reservation.js.map +1 -1
- package/dist/esm/admin/return-reason.d.ts +6 -0
- package/dist/esm/admin/return-reason.d.ts.map +1 -1
- package/dist/esm/admin/return-reason.js +3 -0
- package/dist/esm/admin/return-reason.js.map +1 -1
- package/dist/esm/admin/return.d.ts +6 -0
- package/dist/esm/admin/return.d.ts.map +1 -1
- package/dist/esm/admin/return.js +3 -0
- package/dist/esm/admin/return.js.map +1 -1
- package/dist/esm/admin/sales-channel.d.ts +6 -0
- package/dist/esm/admin/sales-channel.d.ts.map +1 -1
- package/dist/esm/admin/sales-channel.js +3 -0
- package/dist/esm/admin/sales-channel.js.map +1 -1
- package/dist/esm/admin/shipping-option.d.ts +6 -0
- package/dist/esm/admin/shipping-option.d.ts.map +1 -1
- package/dist/esm/admin/shipping-option.js +3 -0
- package/dist/esm/admin/shipping-option.js.map +1 -1
- package/dist/esm/admin/shipping-profile.d.ts +6 -0
- package/dist/esm/admin/shipping-profile.d.ts.map +1 -1
- package/dist/esm/admin/shipping-profile.js +3 -0
- package/dist/esm/admin/shipping-profile.js.map +1 -1
- package/dist/esm/admin/stock-location.d.ts +6 -0
- package/dist/esm/admin/stock-location.d.ts.map +1 -1
- package/dist/esm/admin/stock-location.js +3 -0
- package/dist/esm/admin/stock-location.js.map +1 -1
- package/dist/esm/admin/store.d.ts +6 -0
- package/dist/esm/admin/store.d.ts.map +1 -1
- package/dist/esm/admin/store.js +3 -0
- package/dist/esm/admin/store.js.map +1 -1
- package/dist/esm/admin/tax-rate.d.ts +6 -0
- package/dist/esm/admin/tax-rate.d.ts.map +1 -1
- package/dist/esm/admin/tax-rate.js +3 -0
- package/dist/esm/admin/tax-rate.js.map +1 -1
- package/dist/esm/admin/tax-region.d.ts +6 -0
- package/dist/esm/admin/tax-region.d.ts.map +1 -1
- package/dist/esm/admin/tax-region.js +3 -0
- package/dist/esm/admin/tax-region.js.map +1 -1
- package/dist/esm/admin/upload.d.ts +6 -0
- package/dist/esm/admin/upload.d.ts.map +1 -1
- package/dist/esm/admin/upload.js +3 -0
- package/dist/esm/admin/upload.js.map +1 -1
- package/dist/esm/admin/user.d.ts +6 -0
- package/dist/esm/admin/user.d.ts.map +1 -1
- package/dist/esm/admin/user.js +3 -0
- package/dist/esm/admin/user.js.map +1 -1
- package/dist/esm/admin/workflow-execution.d.ts +6 -0
- package/dist/esm/admin/workflow-execution.d.ts.map +1 -1
- package/dist/esm/admin/workflow-execution.js +3 -0
- package/dist/esm/admin/workflow-execution.js.map +1 -1
- package/dist/esm/auth/index.d.ts +156 -0
- package/dist/esm/auth/index.d.ts.map +1 -1
- package/dist/esm/auth/index.js +152 -1
- package/dist/esm/auth/index.js.map +1 -1
- package/dist/esm/client.d.ts +1 -1
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +2 -1
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/store/index.d.ts +973 -83
- package/dist/esm/store/index.d.ts.map +1 -1
- package/dist/esm/store/index.js +946 -0
- package/dist/esm/store/index.js.map +1 -1
- package/dist/esm/types.d.ts +6 -1
- package/dist/esm/types.d.ts.map +1 -1
- package/dist/store/index.d.ts +973 -83
- package/dist/store/index.d.ts.map +1 -1
- package/dist/store/index.js +946 -0
- package/dist/store/index.js.map +1 -1
- package/dist/types.d.ts +6 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/dist/admin/exchange.js
CHANGED
@@ -2,21 +2,121 @@
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
3
3
|
exports.Exchange = void 0;
|
4
4
|
class Exchange {
|
5
|
+
/**
|
6
|
+
* @ignore
|
7
|
+
*/
|
5
8
|
constructor(client) {
|
6
9
|
this.client = client;
|
7
10
|
}
|
11
|
+
/**
|
12
|
+
* This method retrieves a paginated list of exchanges. It sends a request to the
|
13
|
+
* [List Exchanges](https://docs.medusajs.com/v2/api/admin#exchanges_getexchanges)
|
14
|
+
* API route.
|
15
|
+
*
|
16
|
+
* @param query - Filters and pagination configurations.
|
17
|
+
* @param headers - Headers to pass in the request.
|
18
|
+
* @returns The paginated list of exchanges.
|
19
|
+
*
|
20
|
+
* @example
|
21
|
+
* To retrieve the list of exchanges:
|
22
|
+
*
|
23
|
+
* ```ts
|
24
|
+
* sdk.admin.exchange.list()
|
25
|
+
* .then(({ exchanges, count, limit, offset }) => {
|
26
|
+
* console.log(exchanges)
|
27
|
+
* })
|
28
|
+
* ```
|
29
|
+
*
|
30
|
+
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
31
|
+
*
|
32
|
+
* For example, to retrieve only 10 items and skip 10 items:
|
33
|
+
*
|
34
|
+
* ```ts
|
35
|
+
* sdk.admin.exchange.list({
|
36
|
+
* limit: 10,
|
37
|
+
* offset: 10
|
38
|
+
* })
|
39
|
+
* .then(({ exchanges, count, limit, offset }) => {
|
40
|
+
* console.log(exchanges)
|
41
|
+
* })
|
42
|
+
* ```
|
43
|
+
*
|
44
|
+
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
45
|
+
* in each exchange:
|
46
|
+
*
|
47
|
+
* ```ts
|
48
|
+
* sdk.admin.exchange.list({
|
49
|
+
* fields: "id,*order"
|
50
|
+
* })
|
51
|
+
* .then(({ exchanges, count, limit, offset }) => {
|
52
|
+
* console.log(exchanges)
|
53
|
+
* })
|
54
|
+
* ```
|
55
|
+
*
|
56
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
|
57
|
+
*/
|
8
58
|
async list(query, headers) {
|
9
59
|
return await this.client.fetch(`/admin/exchanges`, {
|
10
60
|
query,
|
11
61
|
headers,
|
12
62
|
});
|
13
63
|
}
|
64
|
+
/**
|
65
|
+
* This method retrieves an exchange by its ID. It sends a request to the
|
66
|
+
* [Get Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_getexchangesid)
|
67
|
+
* API route.
|
68
|
+
*
|
69
|
+
* @param id - The exchange's ID.
|
70
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
71
|
+
* @param headers - Headers to pass in the request.
|
72
|
+
* @returns The exchange's details.
|
73
|
+
*
|
74
|
+
* @example
|
75
|
+
* To retrieve an exchange by its ID:
|
76
|
+
*
|
77
|
+
* ```ts
|
78
|
+
* sdk.admin.exchange.retrieve("exchange_123")
|
79
|
+
* .then(({ exchange }) => {
|
80
|
+
* console.log(exchange)
|
81
|
+
* })
|
82
|
+
* ```
|
83
|
+
*
|
84
|
+
* To specify the fields and relations to retrieve:
|
85
|
+
*
|
86
|
+
* ```ts
|
87
|
+
* sdk.admin.exchange.retrieve("exchange_123", {
|
88
|
+
* fields: "id,*order"
|
89
|
+
* })
|
90
|
+
* .then(({ exchange }) => {
|
91
|
+
* console.log(exchange)
|
92
|
+
* })
|
93
|
+
* ```
|
94
|
+
*
|
95
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
|
96
|
+
*/
|
14
97
|
async retrieve(id, query, headers) {
|
15
98
|
return await this.client.fetch(`/admin/exchanges/${id}`, {
|
16
99
|
query,
|
17
100
|
headers,
|
18
101
|
});
|
19
102
|
}
|
103
|
+
/**
|
104
|
+
* This method creates an admin exchange. It sends a request to the
|
105
|
+
* [Create Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchanges) API route.
|
106
|
+
*
|
107
|
+
* @param body - The exchange's details.
|
108
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
109
|
+
* @param headers - Headers to pass in the request.
|
110
|
+
* @returns The exchange's details.
|
111
|
+
*
|
112
|
+
* @example
|
113
|
+
* sdk.admin.exchange.create({
|
114
|
+
* order_id: "order_123"
|
115
|
+
* })
|
116
|
+
* .then(({ exchange }) => {
|
117
|
+
* console.log(exchange)
|
118
|
+
* })
|
119
|
+
*/
|
20
120
|
async create(body, query, headers) {
|
21
121
|
return await this.client.fetch(`/admin/exchanges`, {
|
22
122
|
method: "POST",
|
@@ -25,6 +125,21 @@ class Exchange {
|
|
25
125
|
query,
|
26
126
|
});
|
27
127
|
}
|
128
|
+
/**
|
129
|
+
* This method cancels an exchange. It sends a request to the
|
130
|
+
* [Cancel Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidcancel) API route.
|
131
|
+
*
|
132
|
+
* @param id - The exchange's ID.
|
133
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
134
|
+
* @param headers - Headers to pass in the request.
|
135
|
+
* @returns The exchange's details.
|
136
|
+
*
|
137
|
+
* @example
|
138
|
+
* sdk.admin.exchange.cancel("exchange_123")
|
139
|
+
* .then(({ exchange }) => {
|
140
|
+
* console.log(exchange)
|
141
|
+
* })
|
142
|
+
*/
|
28
143
|
async cancel(id, query, headers) {
|
29
144
|
return await this.client.fetch(`/admin/exchanges/${id}/cancel`, {
|
30
145
|
method: "POST",
|
@@ -32,36 +147,30 @@ class Exchange {
|
|
32
147
|
query,
|
33
148
|
});
|
34
149
|
}
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
return await this.client.fetch(`/admin/exchanges/${id}/exchange-items/${actionId}`, {
|
60
|
-
method: "DELETE",
|
61
|
-
headers,
|
62
|
-
query,
|
63
|
-
});
|
64
|
-
}
|
150
|
+
/**
|
151
|
+
* This method adds inbound (or return) items to an exchange. These inbound items will
|
152
|
+
* have the action `RETURN_ITEM`.
|
153
|
+
*
|
154
|
+
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditems)
|
155
|
+
* API route.
|
156
|
+
*
|
157
|
+
* @param id - The exchange's ID.
|
158
|
+
* @param body - The items to add.
|
159
|
+
* @param query - Configure the fields to retrieve in the return.
|
160
|
+
* @param headers - Headers to pass in the request.
|
161
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
162
|
+
*
|
163
|
+
* @example
|
164
|
+
* sdk.admin.exchange.addInboundItems("exchange_123", {
|
165
|
+
* items: [{
|
166
|
+
* id: "orli_123",
|
167
|
+
* quantity: 1
|
168
|
+
* }]
|
169
|
+
* })
|
170
|
+
* .then(({ return: returnData }) => {
|
171
|
+
* console.log(returnData)
|
172
|
+
* })
|
173
|
+
*/
|
65
174
|
async addInboundItems(id, body, query, headers) {
|
66
175
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/items`, {
|
67
176
|
method: "POST",
|
@@ -70,6 +179,35 @@ class Exchange {
|
|
70
179
|
query,
|
71
180
|
});
|
72
181
|
}
|
182
|
+
/**
|
183
|
+
* This method updates an inbound (or return) item from an exchange using the ID of
|
184
|
+
* the item's `RETURN_ITEM` action.
|
185
|
+
*
|
186
|
+
* Every item has an `actions` property, whose value is an array of actions. You can
|
187
|
+
* check the action's name using its `action` property, and use the value of the `id` property.
|
188
|
+
*
|
189
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinbounditemsaction_id)
|
190
|
+
* API route.
|
191
|
+
*
|
192
|
+
* @param id - The exchange's ID.
|
193
|
+
* @param actionId - The id of the return item's `RETURN_ITEM` action.
|
194
|
+
* @param body - The details to update.
|
195
|
+
* @param query - Configure the fields to retrieve in the return.
|
196
|
+
* @param headers - Headers to pass in the request.
|
197
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
198
|
+
*
|
199
|
+
* @example
|
200
|
+
* sdk.admin.exchange.updateInboundItem(
|
201
|
+
* "exchange_123",
|
202
|
+
* "ordchact_123",
|
203
|
+
* {
|
204
|
+
* quantity: 1
|
205
|
+
* }
|
206
|
+
* )
|
207
|
+
* .then(({ return: returnData }) => {
|
208
|
+
* console.log(returnData)
|
209
|
+
* })
|
210
|
+
*/
|
73
211
|
async updateInboundItem(id, actionId, body, query, headers) {
|
74
212
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
|
75
213
|
method: "POST",
|
@@ -78,6 +216,31 @@ class Exchange {
|
|
78
216
|
query,
|
79
217
|
});
|
80
218
|
}
|
219
|
+
/**
|
220
|
+
* This method removes an inbound (or return) item from an exchange using the ID of the
|
221
|
+
* item's `RETURN_ITEM` action.
|
222
|
+
*
|
223
|
+
* Every item has an `actions` property, whose value is an array of actions.
|
224
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
225
|
+
*
|
226
|
+
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
|
227
|
+
* API route.
|
228
|
+
*
|
229
|
+
* @param id - The exchange's ID.
|
230
|
+
* @param actionId - The id of the return item's `RETURN_ITEM` action.
|
231
|
+
* @param query - Configure the fields to retrieve in the return.
|
232
|
+
* @param headers - Headers to pass in the request.
|
233
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
234
|
+
*
|
235
|
+
* @example
|
236
|
+
* sdk.admin.exchange.removeInboundItem(
|
237
|
+
* "exchange_123",
|
238
|
+
* "ordchact_123",
|
239
|
+
* )
|
240
|
+
* .then(({ return: returnData }) => {
|
241
|
+
* console.log(returnData)
|
242
|
+
* })
|
243
|
+
*/
|
81
244
|
async removeInboundItem(id, actionId, query, headers) {
|
82
245
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/items/${actionId}`, {
|
83
246
|
method: "DELETE",
|
@@ -85,6 +248,30 @@ class Exchange {
|
|
85
248
|
query,
|
86
249
|
});
|
87
250
|
}
|
251
|
+
/**
|
252
|
+
* This method adds an inbound (or return) shipping method to an exchange.
|
253
|
+
* The inbound shipping method will have a `SHIPPING_ADD` action.
|
254
|
+
*
|
255
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
256
|
+
* API route.
|
257
|
+
*
|
258
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
259
|
+
* API route.
|
260
|
+
*
|
261
|
+
* @param id - The exchange's ID.
|
262
|
+
* @param body - The shipping method's details.
|
263
|
+
* @param query - Configure the fields to retrieve in the return.
|
264
|
+
* @param headers - Headers to pass in the request.
|
265
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
266
|
+
*
|
267
|
+
* @example
|
268
|
+
* sdk.admin.exchange.addInboundShipping("exchange_123", {
|
269
|
+
* shipping_option_id: "so_123"
|
270
|
+
* })
|
271
|
+
* .then(({ return: returnData }) => {
|
272
|
+
* console.log(returnData)
|
273
|
+
* })
|
274
|
+
*/
|
88
275
|
async addInboundShipping(id, body, query, headers) {
|
89
276
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method`, {
|
90
277
|
method: "POST",
|
@@ -93,6 +280,35 @@ class Exchange {
|
|
93
280
|
query,
|
94
281
|
});
|
95
282
|
}
|
283
|
+
/**
|
284
|
+
* This method updates the shipping method for returning items in the exchange using the ID
|
285
|
+
* of the method's `SHIPPING_ADD` action.
|
286
|
+
*
|
287
|
+
* Every shipping method has an `actions` property, whose value is an array of actions.
|
288
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
289
|
+
*
|
290
|
+
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
|
291
|
+
* API route.
|
292
|
+
*
|
293
|
+
* @param id - The exchange's ID.
|
294
|
+
* @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
|
295
|
+
* @param body - The details to update.
|
296
|
+
* @param query - Configure the fields to retrieve in the return.
|
297
|
+
* @param headers - Headers to pass in the request.
|
298
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
299
|
+
*
|
300
|
+
* @example
|
301
|
+
* sdk.admin.exchange.updateInboundShipping(
|
302
|
+
* "exchange_123",
|
303
|
+
* "ordchact_123",
|
304
|
+
* {
|
305
|
+
* custom_amount: 10
|
306
|
+
* }
|
307
|
+
* )
|
308
|
+
* .then(({ return: returnData }) => {
|
309
|
+
* console.log(returnData)
|
310
|
+
* })
|
311
|
+
*/
|
96
312
|
async updateInboundShipping(id, actionId, body, query, headers) {
|
97
313
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
|
98
314
|
method: "POST",
|
@@ -101,6 +317,31 @@ class Exchange {
|
|
101
317
|
query,
|
102
318
|
});
|
103
319
|
}
|
320
|
+
/**
|
321
|
+
* This method removes the shipping method for returning items in the exchange using the ID
|
322
|
+
* of the method's `SHIPPING_ADD` action.
|
323
|
+
*
|
324
|
+
* Every shipping method has an `actions` property, whose value is an array of actions.
|
325
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
326
|
+
*
|
327
|
+
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
|
328
|
+
* API route.
|
329
|
+
*
|
330
|
+
* @param id - The exchange's ID.
|
331
|
+
* @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
|
332
|
+
* @param query - Configure the fields to retrieve in the return.
|
333
|
+
* @param headers - Headers to pass in the request.
|
334
|
+
* @returns The details of the return associated with the exchange, with a preview of the order when the exchange is applied.
|
335
|
+
*
|
336
|
+
* @example
|
337
|
+
* sdk.admin.exchange.deleteInboundShipping(
|
338
|
+
* "exchange_123",
|
339
|
+
* "ordchact_123",
|
340
|
+
* )
|
341
|
+
* .then(({ return: returnData }) => {
|
342
|
+
* console.log(returnData)
|
343
|
+
* })
|
344
|
+
*/
|
104
345
|
async deleteInboundShipping(id, actionId, query, headers) {
|
105
346
|
return await this.client.fetch(`/admin/exchanges/${id}/inbound/shipping-method/${actionId}`, {
|
106
347
|
method: "DELETE",
|
@@ -108,6 +349,30 @@ class Exchange {
|
|
108
349
|
query,
|
109
350
|
});
|
110
351
|
}
|
352
|
+
/**
|
353
|
+
* This method adds outbound (or new) items to an exchange.
|
354
|
+
* These outbound items will have the action `ITEM_ADD`.
|
355
|
+
*
|
356
|
+
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditems)
|
357
|
+
* API route.
|
358
|
+
*
|
359
|
+
* @param id - The exchange's ID.
|
360
|
+
* @param body - The items to add.
|
361
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
362
|
+
* @param headers - Headers to pass in the request
|
363
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
364
|
+
*
|
365
|
+
* @example
|
366
|
+
* sdk.admin.exchange.addOutboundItems("exchange_123", {
|
367
|
+
* items: [{
|
368
|
+
* id: "variant_123",
|
369
|
+
* quantity: 1
|
370
|
+
* }]
|
371
|
+
* })
|
372
|
+
* .then(({ exchange }) => {
|
373
|
+
* console.log(exchange)
|
374
|
+
* })
|
375
|
+
*/
|
111
376
|
async addOutboundItems(id, body, query, headers) {
|
112
377
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/items`, {
|
113
378
|
method: "POST",
|
@@ -116,6 +381,35 @@ class Exchange {
|
|
116
381
|
query,
|
117
382
|
});
|
118
383
|
}
|
384
|
+
/**
|
385
|
+
* This method updates an outbound (or new) item from an exchange using the ID
|
386
|
+
* of the item's `ITEM_ADD` action.
|
387
|
+
*
|
388
|
+
* Every item has an `actions` property, whose value is an array of actions.
|
389
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
390
|
+
*
|
391
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
|
392
|
+
* API route.
|
393
|
+
*
|
394
|
+
* @param id - The exchange's ID.
|
395
|
+
* @param actionId - The id of the new exchange item's `ITEM_ADD` action.
|
396
|
+
* @param body - The item's details to update.
|
397
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
398
|
+
* @param headers - Headers to pass in the request
|
399
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
400
|
+
*
|
401
|
+
* @example
|
402
|
+
* sdk.admin.exchange.updateOutboundItem(
|
403
|
+
* "exchange_123",
|
404
|
+
* "ordchact_123",
|
405
|
+
* {
|
406
|
+
* quantity: 1
|
407
|
+
* }
|
408
|
+
* )
|
409
|
+
* .then(({ exchange }) => {
|
410
|
+
* console.log(exchange)
|
411
|
+
* })
|
412
|
+
*/
|
119
413
|
async updateOutboundItem(id, actionId, body, query, headers) {
|
120
414
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
|
121
415
|
method: "POST",
|
@@ -124,6 +418,31 @@ class Exchange {
|
|
124
418
|
query,
|
125
419
|
});
|
126
420
|
}
|
421
|
+
/**
|
422
|
+
* This method removes an outbound (or new) item from an exchange using the ID
|
423
|
+
* of the item's `ITEM_ADD` action.
|
424
|
+
*
|
425
|
+
* Every item has an `actions` property, whose value is an array of actions.
|
426
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
427
|
+
*
|
428
|
+
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
|
429
|
+
* API route.
|
430
|
+
*
|
431
|
+
* @param id - The exchange's ID.
|
432
|
+
* @param actionId - The id of the new exchange item's `ITEM_ADD` action.
|
433
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
434
|
+
* @param headers - Headers to pass in the request
|
435
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
436
|
+
*
|
437
|
+
* @example
|
438
|
+
* sdk.admin.exchange.removeOutboundItem(
|
439
|
+
* "exchange_123",
|
440
|
+
* "ordchact_123",
|
441
|
+
* )
|
442
|
+
* .then(({ exchange }) => {
|
443
|
+
* console.log(exchange)
|
444
|
+
* })
|
445
|
+
*/
|
127
446
|
async removeOutboundItem(id, actionId, query, headers) {
|
128
447
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/items/${actionId}`, {
|
129
448
|
method: "DELETE",
|
@@ -131,6 +450,27 @@ class Exchange {
|
|
131
450
|
query,
|
132
451
|
});
|
133
452
|
}
|
453
|
+
/**
|
454
|
+
* This method adds an outbound shipping method to an exchange. The outbound shipping method
|
455
|
+
* will have a `SHIPPING_ADD` action.
|
456
|
+
*
|
457
|
+
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethod)
|
458
|
+
* API route.
|
459
|
+
*
|
460
|
+
* @param id - The exchange's ID.
|
461
|
+
* @param body - The shipping method's details.
|
462
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
463
|
+
* @param headers - Headers to pass in the request
|
464
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
465
|
+
*
|
466
|
+
* @example
|
467
|
+
* sdk.admin.exchange.addOutboundShipping("exchange_123", {
|
468
|
+
* shipping_option_id: "so_123"
|
469
|
+
* })
|
470
|
+
* .then(({ exchange }) => {
|
471
|
+
* console.log(exchange)
|
472
|
+
* })
|
473
|
+
*/
|
134
474
|
async addOutboundShipping(id, body, query, headers) {
|
135
475
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method`, {
|
136
476
|
method: "POST",
|
@@ -139,6 +479,35 @@ class Exchange {
|
|
139
479
|
query,
|
140
480
|
});
|
141
481
|
}
|
482
|
+
/**
|
483
|
+
* This method updates the shipping method for delivering outbound items in the exchange using
|
484
|
+
* the ID of the method's `SHIPPING_ADD` action.
|
485
|
+
*
|
486
|
+
* Every shipping method has an `actions` property, whose value is an array of actions.
|
487
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
488
|
+
*
|
489
|
+
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
|
490
|
+
* API route.
|
491
|
+
*
|
492
|
+
* @param id - The exchange's ID.
|
493
|
+
* @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
|
494
|
+
* @param body - The details to update.
|
495
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
496
|
+
* @param headers - Headers to pass in the request
|
497
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
498
|
+
*
|
499
|
+
* @example
|
500
|
+
* sdk.admin.exchange.updateOutboundShipping(
|
501
|
+
* "exchange_123",
|
502
|
+
* "ordchact_123",
|
503
|
+
* {
|
504
|
+
* custom_amount: 10
|
505
|
+
* }
|
506
|
+
* )
|
507
|
+
* .then(({ exchange }) => {
|
508
|
+
* console.log(exchange)
|
509
|
+
* })
|
510
|
+
*/
|
142
511
|
async updateOutboundShipping(id, actionId, body, query, headers) {
|
143
512
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
|
144
513
|
method: "POST",
|
@@ -147,6 +516,31 @@ class Exchange {
|
|
147
516
|
query,
|
148
517
|
});
|
149
518
|
}
|
519
|
+
/**
|
520
|
+
* This method removes the shipping method for delivering outbound items in the exchange using
|
521
|
+
* the ID of the method's `SHIPPING_ADD` action.
|
522
|
+
*
|
523
|
+
* Every shipping method has an `actions` property, whose value is an array of actions.
|
524
|
+
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
525
|
+
*
|
526
|
+
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
|
527
|
+
* API route.
|
528
|
+
*
|
529
|
+
* @param id - The exchange's ID.
|
530
|
+
* @param actionId - The id of the shipping method's `SHIPPING_ADD` action.
|
531
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
532
|
+
* @param headers - Headers to pass in the request
|
533
|
+
* @returns The exchange's details with a preview of the order when the exchange is applied.
|
534
|
+
*
|
535
|
+
* @example
|
536
|
+
* sdk.admin.exchange.deleteOutboundShipping(
|
537
|
+
* "exchange_123",
|
538
|
+
* "ordchact_123",
|
539
|
+
* )
|
540
|
+
* .then(({ exchange }) => {
|
541
|
+
* console.log(exchange)
|
542
|
+
* })
|
543
|
+
*/
|
150
544
|
async deleteOutboundShipping(id, actionId, query, headers) {
|
151
545
|
return await this.client.fetch(`/admin/exchanges/${id}/outbound/shipping-method/${actionId}`, {
|
152
546
|
method: "DELETE",
|
@@ -154,6 +548,24 @@ class Exchange {
|
|
154
548
|
query,
|
155
549
|
});
|
156
550
|
}
|
551
|
+
/**
|
552
|
+
* This method confirms an exchange request, applying its changes on the associated order.
|
553
|
+
*
|
554
|
+
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/v2/api/admin#exchanges_postexchangesidrequest)
|
555
|
+
* API route.
|
556
|
+
*
|
557
|
+
* @param id - The exchange's ID.
|
558
|
+
* @param body - The confirmation's details.
|
559
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
560
|
+
* @param headers - Headers to pass in the request
|
561
|
+
* @returns The exchange and associated return's details with a preview of the order when the exchange is applied.
|
562
|
+
*
|
563
|
+
* @example
|
564
|
+
* sdk.admin.exchange.request("exchange_123", {})
|
565
|
+
* .then(({ exchange }) => {
|
566
|
+
* console.log(exchange)
|
567
|
+
* })
|
568
|
+
*/
|
157
569
|
async request(id, body, query, headers) {
|
158
570
|
return await this.client.fetch(`/admin/exchanges/${id}/request`, {
|
159
571
|
method: "POST",
|
@@ -162,6 +574,22 @@ class Exchange {
|
|
162
574
|
query,
|
163
575
|
});
|
164
576
|
}
|
577
|
+
/**
|
578
|
+
* This method cancels an exchange request. It sends a request to the
|
579
|
+
* [Cancel Exchange Request](https://docs.medusajs.com/v2/api/admin#exchanges_deleteexchangesidrequest)
|
580
|
+
* API route.
|
581
|
+
*
|
582
|
+
* @param id - The exchange's ID.
|
583
|
+
* @param query - Configure the fields to retrieve in the exchange.
|
584
|
+
* @param headers - Headers to pass in the request
|
585
|
+
* @returns The cancelation's details.
|
586
|
+
*
|
587
|
+
* @example
|
588
|
+
* sdk.admin.exchange.cancel("exchange_123")
|
589
|
+
* .then(({ deleted }) => {
|
590
|
+
* console.log(deleted)
|
591
|
+
* })
|
592
|
+
*/
|
165
593
|
async cancelRequest(id, query, headers) {
|
166
594
|
return await this.client.fetch(`/admin/exchanges/${id}/request`, {
|
167
595
|
method: "DELETE",
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"exchange.js","sourceRoot":"","sources":["../../src/admin/exchange.ts"],"names":[],"mappings":";;;AAKA,MAAa,QAAQ;
|
1
|
+
{"version":3,"file":"exchange.js","sourceRoot":"","sources":["../../src/admin/exchange.ts"],"names":[],"mappings":";;;AAKA,MAAa,QAAQ;IAKnB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,EAAE,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,MAAM,CACV,IAAmC,EACnC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAClB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,SAAS,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,IAA4C,EAC5C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,gBAAgB,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,IAA8C,EAC9C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,kBAAkB,QAAQ,EAAE,EAClD;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,0BAA0B,EAChD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,IAAkD,EAClD,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,qBAAqB,CACzB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,4BAA4B,QAAQ,EAAE,EAC5D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,iBAAiB,EACvC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,IAA+C,EAC/C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,mBAAmB,QAAQ,EAAE,EACnD;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,IAAgD,EAChD,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,2BAA2B,EACjD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,IAAmD,EACnD,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,6BAA6B,QAAQ,EAAE,EAC7D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EAAE,UAAU,EAChC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxvBD,4BAwvBC"}
|