@acmekit/js-sdk 2.13.1 → 2.13.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/admin/index.d.ts +2 -177
- package/dist/admin/index.d.ts.map +1 -1
- package/dist/admin/index.js +3 -76
- package/dist/admin/index.js.map +1 -1
- package/dist/esm/admin/index.d.ts +2 -177
- package/dist/esm/admin/index.d.ts.map +1 -1
- package/dist/esm/admin/index.js +3 -73
- package/dist/esm/admin/index.js.map +1 -1
- package/dist/esm/store/index.d.ts +5 -1193
- package/dist/esm/store/index.d.ts.map +1 -1
- package/dist/esm/store/index.js +6 -1418
- package/dist/esm/store/index.js.map +1 -1
- package/dist/store/index.d.ts +5 -1193
- package/dist/store/index.d.ts.map +1 -1
- package/dist/store/index.js +6 -1408
- package/dist/store/index.js.map +1 -1
- package/package.json +2 -2
- package/dist/admin/campaign.d.ts +0 -164
- package/dist/admin/campaign.d.ts.map +0 -1
- package/dist/admin/campaign.js +0 -196
- package/dist/admin/campaign.js.map +0 -1
- package/dist/admin/claim.d.ts +0 -558
- package/dist/admin/claim.d.ts.map +0 -1
- package/dist/admin/claim.js +0 -693
- package/dist/admin/claim.js.map +0 -1
- package/dist/admin/currency.d.ts +0 -95
- package/dist/admin/currency.d.ts.map +0 -1
- package/dist/admin/currency.js +0 -104
- package/dist/admin/currency.js.map +0 -1
- package/dist/admin/draft-order.d.ts +0 -430
- package/dist/admin/draft-order.d.ts.map +0 -1
- package/dist/admin/draft-order.js +0 -547
- package/dist/admin/draft-order.js.map +0 -1
- package/dist/admin/exchange.d.ts +0 -487
- package/dist/admin/exchange.d.ts.map +0 -1
- package/dist/admin/exchange.js +0 -602
- package/dist/admin/exchange.js.map +0 -1
- package/dist/admin/fulfillment-provider.d.ts +0 -78
- package/dist/admin/fulfillment-provider.d.ts.map +0 -1
- package/dist/admin/fulfillment-provider.js +0 -88
- package/dist/admin/fulfillment-provider.js.map +0 -1
- package/dist/admin/fulfillment-set.d.ts +0 -141
- package/dist/admin/fulfillment-set.d.ts.map +0 -1
- package/dist/admin/fulfillment-set.js +0 -170
- package/dist/admin/fulfillment-set.js.map +0 -1
- package/dist/admin/fulfillment.d.ts +0 -91
- package/dist/admin/fulfillment.d.ts.map +0 -1
- package/dist/admin/fulfillment.js +0 -111
- package/dist/admin/fulfillment.js.map +0 -1
- package/dist/admin/inventory-item.d.ts +0 -320
- package/dist/admin/inventory-item.d.ts.map +0 -1
- package/dist/admin/inventory-item.js +0 -384
- package/dist/admin/inventory-item.js.map +0 -1
- package/dist/admin/order-edit.d.ts +0 -189
- package/dist/admin/order-edit.d.ts.map +0 -1
- package/dist/admin/order-edit.js +0 -240
- package/dist/admin/order-edit.js.map +0 -1
- package/dist/admin/order.d.ts +0 -452
- package/dist/admin/order.d.ts.map +0 -1
- package/dist/admin/order.js +0 -560
- package/dist/admin/order.js.map +0 -1
- package/dist/admin/payment-collection.d.ts +0 -72
- package/dist/admin/payment-collection.d.ts.map +0 -1
- package/dist/admin/payment-collection.js +0 -90
- package/dist/admin/payment-collection.js.map +0 -1
- package/dist/admin/payment.d.ts +0 -180
- package/dist/admin/payment.d.ts.map +0 -1
- package/dist/admin/payment.js +0 -208
- package/dist/admin/payment.js.map +0 -1
- package/dist/admin/price-list.d.ts +0 -234
- package/dist/admin/price-list.d.ts.map +0 -1
- package/dist/admin/price-list.js +0 -284
- package/dist/admin/price-list.js.map +0 -1
- package/dist/admin/price-preference.d.ts +0 -152
- package/dist/admin/price-preference.d.ts.map +0 -1
- package/dist/admin/price-preference.js +0 -182
- package/dist/admin/price-preference.js.map +0 -1
- package/dist/admin/product-category.d.ts +0 -170
- package/dist/admin/product-category.d.ts.map +0 -1
- package/dist/admin/product-category.js +0 -205
- package/dist/admin/product-category.js.map +0 -1
- package/dist/admin/product-collection.d.ts +0 -169
- package/dist/admin/product-collection.d.ts.map +0 -1
- package/dist/admin/product-collection.js +0 -203
- package/dist/admin/product-collection.js.map +0 -1
- package/dist/admin/product-tag.d.ts +0 -149
- package/dist/admin/product-tag.d.ts.map +0 -1
- package/dist/admin/product-tag.js +0 -177
- package/dist/admin/product-tag.js.map +0 -1
- package/dist/admin/product-type.d.ts +0 -150
- package/dist/admin/product-type.d.ts.map +0 -1
- package/dist/admin/product-type.js +0 -178
- package/dist/admin/product-type.js.map +0 -1
- package/dist/admin/product-variant.d.ts +0 -62
- package/dist/admin/product-variant.d.ts.map +0 -1
- package/dist/admin/product-variant.js +0 -66
- package/dist/admin/product-variant.js.map +0 -1
- package/dist/admin/product.d.ts +0 -740
- package/dist/admin/product.d.ts.map +0 -1
- package/dist/admin/product.js +0 -948
- package/dist/admin/product.js.map +0 -1
- package/dist/admin/promotion.d.ts +0 -310
- package/dist/admin/promotion.d.ts.map +0 -1
- package/dist/admin/promotion.js +0 -374
- package/dist/admin/promotion.js.map +0 -1
- package/dist/admin/refund-reasons.d.ts +0 -163
- package/dist/admin/refund-reasons.d.ts.map +0 -1
- package/dist/admin/refund-reasons.js +0 -192
- package/dist/admin/refund-reasons.js.map +0 -1
- package/dist/admin/region.d.ts +0 -152
- package/dist/admin/region.d.ts.map +0 -1
- package/dist/admin/region.js +0 -180
- package/dist/admin/region.js.map +0 -1
- package/dist/admin/reservation.d.ts +0 -154
- package/dist/admin/reservation.d.ts.map +0 -1
- package/dist/admin/reservation.js +0 -182
- package/dist/admin/reservation.js.map +0 -1
- package/dist/admin/return-reason.d.ts +0 -154
- package/dist/admin/return-reason.d.ts.map +0 -1
- package/dist/admin/return-reason.js +0 -183
- package/dist/admin/return-reason.js.map +0 -1
- package/dist/admin/return.d.ts +0 -558
- package/dist/admin/return.d.ts.map +0 -1
- package/dist/admin/return.js +0 -700
- package/dist/admin/return.js.map +0 -1
- package/dist/admin/sales-channel.d.ts +0 -196
- package/dist/admin/sales-channel.d.ts.map +0 -1
- package/dist/admin/sales-channel.js +0 -238
- package/dist/admin/sales-channel.js.map +0 -1
- package/dist/admin/shipping-option-type.d.ts +0 -152
- package/dist/admin/shipping-option-type.d.ts.map +0 -1
- package/dist/admin/shipping-option-type.js +0 -180
- package/dist/admin/shipping-option-type.js.map +0 -1
- package/dist/admin/shipping-option.d.ts +0 -171
- package/dist/admin/shipping-option.d.ts.map +0 -1
- package/dist/admin/shipping-option.js +0 -207
- package/dist/admin/shipping-option.js.map +0 -1
- package/dist/admin/shipping-profile.d.ts +0 -151
- package/dist/admin/shipping-profile.d.ts.map +0 -1
- package/dist/admin/shipping-profile.js +0 -181
- package/dist/admin/shipping-profile.js.map +0 -1
- package/dist/admin/stock-location.d.ts +0 -212
- package/dist/admin/stock-location.d.ts.map +0 -1
- package/dist/admin/stock-location.js +0 -260
- package/dist/admin/stock-location.js.map +0 -1
- package/dist/admin/tax-provider.d.ts +0 -64
- package/dist/admin/tax-provider.d.ts.map +0 -1
- package/dist/admin/tax-provider.js +0 -70
- package/dist/admin/tax-provider.js.map +0 -1
- package/dist/admin/tax-rate.d.ts +0 -155
- package/dist/admin/tax-rate.d.ts.map +0 -1
- package/dist/admin/tax-rate.js +0 -186
- package/dist/admin/tax-rate.js.map +0 -1
- package/dist/admin/tax-region.d.ts +0 -165
- package/dist/admin/tax-region.d.ts.map +0 -1
- package/dist/admin/tax-region.js +0 -196
- package/dist/admin/tax-region.js.map +0 -1
- package/dist/esm/admin/campaign.d.ts +0 -164
- package/dist/esm/admin/campaign.d.ts.map +0 -1
- package/dist/esm/admin/campaign.js +0 -213
- package/dist/esm/admin/campaign.js.map +0 -1
- package/dist/esm/admin/claim.d.ts +0 -558
- package/dist/esm/admin/claim.d.ts.map +0 -1
- package/dist/esm/admin/claim.js +0 -740
- package/dist/esm/admin/claim.js.map +0 -1
- package/dist/esm/admin/currency.d.ts +0 -95
- package/dist/esm/admin/currency.d.ts.map +0 -1
- package/dist/esm/admin/currency.js +0 -113
- package/dist/esm/admin/currency.js.map +0 -1
- package/dist/esm/admin/draft-order.d.ts +0 -430
- package/dist/esm/admin/draft-order.d.ts.map +0 -1
- package/dist/esm/admin/draft-order.js +0 -594
- package/dist/esm/admin/draft-order.js.map +0 -1
- package/dist/esm/admin/exchange.d.ts +0 -487
- package/dist/esm/admin/exchange.d.ts.map +0 -1
- package/dist/esm/admin/exchange.js +0 -643
- package/dist/esm/admin/exchange.js.map +0 -1
- package/dist/esm/admin/fulfillment-provider.d.ts +0 -78
- package/dist/esm/admin/fulfillment-provider.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment-provider.js +0 -97
- package/dist/esm/admin/fulfillment-provider.js.map +0 -1
- package/dist/esm/admin/fulfillment-set.d.ts +0 -141
- package/dist/esm/admin/fulfillment-set.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment-set.js +0 -185
- package/dist/esm/admin/fulfillment-set.js.map +0 -1
- package/dist/esm/admin/fulfillment.d.ts +0 -91
- package/dist/esm/admin/fulfillment.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment.js +0 -122
- package/dist/esm/admin/fulfillment.js.map +0 -1
- package/dist/esm/admin/inventory-item.d.ts +0 -320
- package/dist/esm/admin/inventory-item.d.ts.map +0 -1
- package/dist/esm/admin/inventory-item.js +0 -411
- package/dist/esm/admin/inventory-item.js.map +0 -1
- package/dist/esm/admin/order-edit.d.ts +0 -189
- package/dist/esm/admin/order-edit.d.ts.map +0 -1
- package/dist/esm/admin/order-edit.js +0 -261
- package/dist/esm/admin/order-edit.js.map +0 -1
- package/dist/esm/admin/order.d.ts +0 -452
- package/dist/esm/admin/order.d.ts.map +0 -1
- package/dist/esm/admin/order.js +0 -603
- package/dist/esm/admin/order.js.map +0 -1
- package/dist/esm/admin/payment-collection.d.ts +0 -72
- package/dist/esm/admin/payment-collection.d.ts.map +0 -1
- package/dist/esm/admin/payment-collection.js +0 -101
- package/dist/esm/admin/payment-collection.js.map +0 -1
- package/dist/esm/admin/payment.d.ts +0 -180
- package/dist/esm/admin/payment.d.ts.map +0 -1
- package/dist/esm/admin/payment.js +0 -223
- package/dist/esm/admin/payment.js.map +0 -1
- package/dist/esm/admin/price-list.d.ts +0 -234
- package/dist/esm/admin/price-list.d.ts.map +0 -1
- package/dist/esm/admin/price-list.js +0 -305
- package/dist/esm/admin/price-list.js.map +0 -1
- package/dist/esm/admin/price-preference.d.ts +0 -152
- package/dist/esm/admin/price-preference.d.ts.map +0 -1
- package/dist/esm/admin/price-preference.js +0 -197
- package/dist/esm/admin/price-preference.js.map +0 -1
- package/dist/esm/admin/product-category.d.ts +0 -170
- package/dist/esm/admin/product-category.d.ts.map +0 -1
- package/dist/esm/admin/product-category.js +0 -222
- package/dist/esm/admin/product-category.js.map +0 -1
- package/dist/esm/admin/product-collection.d.ts +0 -169
- package/dist/esm/admin/product-collection.d.ts.map +0 -1
- package/dist/esm/admin/product-collection.js +0 -220
- package/dist/esm/admin/product-collection.js.map +0 -1
- package/dist/esm/admin/product-tag.d.ts +0 -149
- package/dist/esm/admin/product-tag.d.ts.map +0 -1
- package/dist/esm/admin/product-tag.js +0 -192
- package/dist/esm/admin/product-tag.js.map +0 -1
- package/dist/esm/admin/product-type.d.ts +0 -150
- package/dist/esm/admin/product-type.d.ts.map +0 -1
- package/dist/esm/admin/product-type.js +0 -193
- package/dist/esm/admin/product-type.js.map +0 -1
- package/dist/esm/admin/product-variant.d.ts +0 -62
- package/dist/esm/admin/product-variant.d.ts.map +0 -1
- package/dist/esm/admin/product-variant.js +0 -73
- package/dist/esm/admin/product-variant.js.map +0 -1
- package/dist/esm/admin/product.d.ts +0 -740
- package/dist/esm/admin/product.d.ts.map +0 -1
- package/dist/esm/admin/product.js +0 -995
- package/dist/esm/admin/product.js.map +0 -1
- package/dist/esm/admin/promotion.d.ts +0 -310
- package/dist/esm/admin/promotion.d.ts.map +0 -1
- package/dist/esm/admin/promotion.js +0 -401
- package/dist/esm/admin/promotion.js.map +0 -1
- package/dist/esm/admin/refund-reasons.d.ts +0 -163
- package/dist/esm/admin/refund-reasons.d.ts.map +0 -1
- package/dist/esm/admin/refund-reasons.js +0 -207
- package/dist/esm/admin/refund-reasons.js.map +0 -1
- package/dist/esm/admin/region.d.ts +0 -152
- package/dist/esm/admin/region.d.ts.map +0 -1
- package/dist/esm/admin/region.js +0 -195
- package/dist/esm/admin/region.js.map +0 -1
- package/dist/esm/admin/reservation.d.ts +0 -154
- package/dist/esm/admin/reservation.d.ts.map +0 -1
- package/dist/esm/admin/reservation.js +0 -199
- package/dist/esm/admin/reservation.js.map +0 -1
- package/dist/esm/admin/return-reason.d.ts +0 -154
- package/dist/esm/admin/return-reason.d.ts.map +0 -1
- package/dist/esm/admin/return-reason.js +0 -198
- package/dist/esm/admin/return-reason.js.map +0 -1
- package/dist/esm/admin/return.d.ts +0 -558
- package/dist/esm/admin/return.d.ts.map +0 -1
- package/dist/esm/admin/return.js +0 -749
- package/dist/esm/admin/return.js.map +0 -1
- package/dist/esm/admin/sales-channel.d.ts +0 -196
- package/dist/esm/admin/sales-channel.d.ts.map +0 -1
- package/dist/esm/admin/sales-channel.js +0 -257
- package/dist/esm/admin/sales-channel.js.map +0 -1
- package/dist/esm/admin/shipping-option-type.d.ts +0 -152
- package/dist/esm/admin/shipping-option-type.d.ts.map +0 -1
- package/dist/esm/admin/shipping-option-type.js +0 -195
- package/dist/esm/admin/shipping-option-type.js.map +0 -1
- package/dist/esm/admin/shipping-option.d.ts +0 -171
- package/dist/esm/admin/shipping-option.d.ts.map +0 -1
- package/dist/esm/admin/shipping-option.js +0 -224
- package/dist/esm/admin/shipping-option.js.map +0 -1
- package/dist/esm/admin/shipping-profile.d.ts +0 -151
- package/dist/esm/admin/shipping-profile.d.ts.map +0 -1
- package/dist/esm/admin/shipping-profile.js +0 -196
- package/dist/esm/admin/shipping-profile.js.map +0 -1
- package/dist/esm/admin/stock-location.d.ts +0 -212
- package/dist/esm/admin/stock-location.d.ts.map +0 -1
- package/dist/esm/admin/stock-location.js +0 -281
- package/dist/esm/admin/stock-location.js.map +0 -1
- package/dist/esm/admin/tax-provider.d.ts +0 -64
- package/dist/esm/admin/tax-provider.d.ts.map +0 -1
- package/dist/esm/admin/tax-provider.js +0 -77
- package/dist/esm/admin/tax-provider.js.map +0 -1
- package/dist/esm/admin/tax-rate.d.ts +0 -155
- package/dist/esm/admin/tax-rate.d.ts.map +0 -1
- package/dist/esm/admin/tax-rate.js +0 -201
- package/dist/esm/admin/tax-rate.js.map +0 -1
- package/dist/esm/admin/tax-region.d.ts +0 -165
- package/dist/esm/admin/tax-region.d.ts.map +0 -1
- package/dist/esm/admin/tax-region.js +0 -211
- package/dist/esm/admin/tax-region.js.map +0 -1
|
@@ -1,207 +0,0 @@
|
|
|
1
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
-
});
|
|
9
|
-
};
|
|
10
|
-
export class RefundReason {
|
|
11
|
-
/**
|
|
12
|
-
* @ignore
|
|
13
|
-
*/
|
|
14
|
-
constructor(client) {
|
|
15
|
-
this.client = client;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* This method retrieves a list of refund reasons. It sends a request to the
|
|
19
|
-
* [List Refund Reasons](https://docs.acmekit.com/api/admin#refund-reasons_getrefundreasons)
|
|
20
|
-
* API route.
|
|
21
|
-
*
|
|
22
|
-
* @param query - Filters and pagination configurations.
|
|
23
|
-
* @param headers - Headers to pass in the request.
|
|
24
|
-
* @returns The paginated list of refund reasons.
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* To retrieve the list of refund reasons:
|
|
28
|
-
*
|
|
29
|
-
* ```ts
|
|
30
|
-
* sdk.admin.refundReason.list()
|
|
31
|
-
* .then(({ refund_reasons, count, limit, offset }) => {
|
|
32
|
-
* console.log(refund_reasons)
|
|
33
|
-
* })
|
|
34
|
-
* ```
|
|
35
|
-
*
|
|
36
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
37
|
-
*
|
|
38
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
39
|
-
*
|
|
40
|
-
* ```ts
|
|
41
|
-
* sdk.admin.refundReason.list({
|
|
42
|
-
* limit: 10,
|
|
43
|
-
* offset: 10
|
|
44
|
-
* })
|
|
45
|
-
* .then(({ refund_reasons, count, limit, offset }) => {
|
|
46
|
-
* console.log(refund_reasons)
|
|
47
|
-
* })
|
|
48
|
-
* ```
|
|
49
|
-
*
|
|
50
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
51
|
-
* in each refund reason:
|
|
52
|
-
*
|
|
53
|
-
* ```ts
|
|
54
|
-
* sdk.admin.refundReason.list({
|
|
55
|
-
* fields: "id,label"
|
|
56
|
-
* })
|
|
57
|
-
* .then(({ refund_reasons, count, limit, offset }) => {
|
|
58
|
-
* console.log(refund_reasons)
|
|
59
|
-
* })
|
|
60
|
-
* ```
|
|
61
|
-
*
|
|
62
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
63
|
-
*
|
|
64
|
-
*/
|
|
65
|
-
list(query, headers) {
|
|
66
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
-
return yield this.client.fetch(`/admin/refund-reasons`, {
|
|
68
|
-
query,
|
|
69
|
-
headers,
|
|
70
|
-
});
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* This method retrieves a refund reason by ID. It sends a request to the
|
|
75
|
-
* [Get Refund Reason](https://docs.acmekit.com/api/admin#refund-reasons_getrefundreasonsid)
|
|
76
|
-
* API route.
|
|
77
|
-
*
|
|
78
|
-
* @since 2.11.0
|
|
79
|
-
*
|
|
80
|
-
* @param id - The refund reason's ID.
|
|
81
|
-
* @param query - Configure the fields and relations to retrieve in the refund reason.
|
|
82
|
-
* @param headers - Headers to pass in the request.
|
|
83
|
-
* @returns The refund reason's details.
|
|
84
|
-
*
|
|
85
|
-
* @example
|
|
86
|
-
* To retrieve a refund reason by its ID:
|
|
87
|
-
*
|
|
88
|
-
* ```ts
|
|
89
|
-
* sdk.admin.refundReason.retrieve("refr_123")
|
|
90
|
-
* .then(({ refund_reason }) => {
|
|
91
|
-
* console.log(refund_reason)
|
|
92
|
-
* })
|
|
93
|
-
* ```
|
|
94
|
-
*
|
|
95
|
-
* To specify the fields and relations to retrieve:
|
|
96
|
-
*
|
|
97
|
-
* ```ts
|
|
98
|
-
* sdk.admin.refundReason.retrieve("refr_123", {
|
|
99
|
-
* fields: "id,code"
|
|
100
|
-
* })
|
|
101
|
-
* .then(({ refund_reason }) => {
|
|
102
|
-
* console.log(refund_reason)
|
|
103
|
-
* })
|
|
104
|
-
* ```
|
|
105
|
-
*
|
|
106
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
107
|
-
*/
|
|
108
|
-
retrieve(id, query, headers) {
|
|
109
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
110
|
-
return yield this.client.fetch(`/admin/refund-reasons/${id}`, {
|
|
111
|
-
query,
|
|
112
|
-
headers,
|
|
113
|
-
});
|
|
114
|
-
});
|
|
115
|
-
}
|
|
116
|
-
/**
|
|
117
|
-
* This method creates a refund reason. It sends a request to the
|
|
118
|
-
* [Create Refund Reason](https://docs.acmekit.com/api/admin#refund-reasons_postrefundreasons)
|
|
119
|
-
* API route.
|
|
120
|
-
*
|
|
121
|
-
* @since 2.11.0
|
|
122
|
-
*
|
|
123
|
-
* @param body - The details of the refund reason to create.
|
|
124
|
-
* @param query - Configure the fields and relations to retrieve in the refund reason.
|
|
125
|
-
* @param headers - Headers to pass in the request.
|
|
126
|
-
* @returns The refund reason's details.
|
|
127
|
-
*
|
|
128
|
-
* @example
|
|
129
|
-
* sdk.admin.refundReason.create({
|
|
130
|
-
* code: "refund",
|
|
131
|
-
* label: "Refund",
|
|
132
|
-
* })
|
|
133
|
-
* .then(({ refund_reason }) => {
|
|
134
|
-
* console.log(refund_reason)
|
|
135
|
-
* })
|
|
136
|
-
*/
|
|
137
|
-
create(body, query, headers) {
|
|
138
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
139
|
-
return this.client.fetch(`/admin/refund-reasons`, {
|
|
140
|
-
method: "POST",
|
|
141
|
-
headers,
|
|
142
|
-
body,
|
|
143
|
-
query,
|
|
144
|
-
});
|
|
145
|
-
});
|
|
146
|
-
}
|
|
147
|
-
/**
|
|
148
|
-
* This method updates a refund reason. It sends a request to the
|
|
149
|
-
* [Update Refund Reason](https://docs.acmekit.com/api/admin#refund-reasons_postrefundreasonsid)
|
|
150
|
-
* API route.
|
|
151
|
-
*
|
|
152
|
-
* @since 2.11.0
|
|
153
|
-
*
|
|
154
|
-
* @param id - The refund reason's ID.
|
|
155
|
-
* @param body - The details of the refund reason to update.
|
|
156
|
-
* @param query - Configure the fields and relations to retrieve in the refund reason.
|
|
157
|
-
* @param headers - Headers to pass in the request.
|
|
158
|
-
* @returns The refund reason's details.
|
|
159
|
-
*
|
|
160
|
-
* @example
|
|
161
|
-
* sdk.admin.refundReason.update("ret_123", {
|
|
162
|
-
* code: "refund",
|
|
163
|
-
* label: "Refund",
|
|
164
|
-
* })
|
|
165
|
-
* .then(({ refund_reason }) => {
|
|
166
|
-
* console.log(refund_reason)
|
|
167
|
-
* })
|
|
168
|
-
*/
|
|
169
|
-
update(id, body, query, headers) {
|
|
170
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
171
|
-
return this.client.fetch(`/admin/refund-reasons/${id}`, {
|
|
172
|
-
method: "POST",
|
|
173
|
-
headers,
|
|
174
|
-
body,
|
|
175
|
-
query,
|
|
176
|
-
});
|
|
177
|
-
});
|
|
178
|
-
}
|
|
179
|
-
/**
|
|
180
|
-
* This method deletes a refund reason. It sends a request to the
|
|
181
|
-
* [Delete Refund Reason](https://docs.acmekit.com/api/admin#refund-reasons_deleterefundreasonsid)
|
|
182
|
-
* API route.
|
|
183
|
-
*
|
|
184
|
-
* @since 2.11.0
|
|
185
|
-
*
|
|
186
|
-
* @param id - The refund reason's ID.
|
|
187
|
-
* @param query - Query parameters to pass to the request.
|
|
188
|
-
* @param headers - Headers to pass in the request.
|
|
189
|
-
* @returns The deletion's details.
|
|
190
|
-
*
|
|
191
|
-
* @example
|
|
192
|
-
* sdk.admin.refundReason.delete("ret_123")
|
|
193
|
-
* .then(({ deleted }) => {
|
|
194
|
-
* console.log(deleted)
|
|
195
|
-
* })
|
|
196
|
-
*/
|
|
197
|
-
delete(id, query, headers) {
|
|
198
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
199
|
-
return yield this.client.fetch(`/admin/refund-reasons/${id}`, {
|
|
200
|
-
method: "DELETE",
|
|
201
|
-
headers,
|
|
202
|
-
query,
|
|
203
|
-
});
|
|
204
|
-
});
|
|
205
|
-
}
|
|
206
|
-
}
|
|
207
|
-
//# sourceMappingURL=refund-reasons.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"refund-reasons.js","sourceRoot":"","sources":["../../../src/admin/refund-reasons.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,IAAI,CACR,KAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAU,EACV,KAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
|
|
@@ -1,152 +0,0 @@
|
|
|
1
|
-
import { FindParams, HttpTypes, SelectParams } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class Region {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method creates a new region. It sends a request to the
|
|
15
|
-
* [Create Region](https://docs.acmekit.com/api/admin#regions_postregions)
|
|
16
|
-
* API route.
|
|
17
|
-
*
|
|
18
|
-
* @param body - The details of the region to create.
|
|
19
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
20
|
-
* @param headers - Headers to pass in the request.
|
|
21
|
-
* @returns The created region's details.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* sdk.admin.region.create({
|
|
25
|
-
* name: "United States",
|
|
26
|
-
* currency_code: "usd",
|
|
27
|
-
* })
|
|
28
|
-
* .then(({ region }) => {
|
|
29
|
-
* console.log(region)
|
|
30
|
-
* })
|
|
31
|
-
*/
|
|
32
|
-
create(body: HttpTypes.AdminCreateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* This method updates a region. It sends a request to the
|
|
35
|
-
* [Update Region](https://docs.acmekit.com/api/admin#regions_postregionsid)
|
|
36
|
-
* API route.
|
|
37
|
-
*
|
|
38
|
-
* @param id - The ID of the region to update.
|
|
39
|
-
* @param body - The details of the region to update.
|
|
40
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
41
|
-
* @param headers - Headers to pass in the request.
|
|
42
|
-
* @returns The updated region's details.
|
|
43
|
-
*
|
|
44
|
-
* @example
|
|
45
|
-
* sdk.admin.region.update("region_123", {
|
|
46
|
-
* name: "United States",
|
|
47
|
-
* })
|
|
48
|
-
* .then(({ region }) => {
|
|
49
|
-
* console.log(region)
|
|
50
|
-
* })
|
|
51
|
-
*/
|
|
52
|
-
update(id: string, body: HttpTypes.AdminUpdateRegion, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
|
|
53
|
-
/**
|
|
54
|
-
* This method retrieves a list of regions. It sends a request to the
|
|
55
|
-
* [List Regions](https://docs.acmekit.com/api/admin#regions_getregions)
|
|
56
|
-
* API route.
|
|
57
|
-
*
|
|
58
|
-
* @param queryParams - Filters and pagination configurations.
|
|
59
|
-
* @param headers - Headers to pass in the request.
|
|
60
|
-
* @returns The paginated list of regions.
|
|
61
|
-
*
|
|
62
|
-
* @example
|
|
63
|
-
* To retrieve the list of regions:
|
|
64
|
-
*
|
|
65
|
-
* ```ts
|
|
66
|
-
* sdk.admin.region.list()
|
|
67
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
68
|
-
* console.log(regions)
|
|
69
|
-
* })
|
|
70
|
-
* ```
|
|
71
|
-
*
|
|
72
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
73
|
-
*
|
|
74
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
75
|
-
*
|
|
76
|
-
* ```ts
|
|
77
|
-
* sdk.admin.region.list({
|
|
78
|
-
* limit: 10,
|
|
79
|
-
* offset: 10
|
|
80
|
-
* })
|
|
81
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
82
|
-
* console.log(regions)
|
|
83
|
-
* })
|
|
84
|
-
* ```
|
|
85
|
-
*
|
|
86
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
87
|
-
* in each region:
|
|
88
|
-
*
|
|
89
|
-
* ```ts
|
|
90
|
-
* sdk.admin.region.list({
|
|
91
|
-
* fields: "id,*countries"
|
|
92
|
-
* })
|
|
93
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
94
|
-
* console.log(regions)
|
|
95
|
-
* })
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
99
|
-
*/
|
|
100
|
-
list(queryParams?: FindParams & HttpTypes.AdminRegionFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionListResponse>;
|
|
101
|
-
/**
|
|
102
|
-
* This method retrieves a region by ID. It sends a request to the
|
|
103
|
-
* [Get Region](https://docs.acmekit.com/api/admin#regions_getregionsid)
|
|
104
|
-
* API route.
|
|
105
|
-
*
|
|
106
|
-
* @param id - The ID of the region to retrieve.
|
|
107
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
108
|
-
* @param headers - Headers to pass in the request.
|
|
109
|
-
* @returns The region's details.
|
|
110
|
-
*
|
|
111
|
-
* @example
|
|
112
|
-
* To retrieve a region by its ID:
|
|
113
|
-
*
|
|
114
|
-
* ```ts
|
|
115
|
-
* sdk.admin.region.retrieve("region_123")
|
|
116
|
-
* .then(({ region }) => {
|
|
117
|
-
* console.log(region)
|
|
118
|
-
* })
|
|
119
|
-
* ```
|
|
120
|
-
*
|
|
121
|
-
* To specify the fields and relations to retrieve:
|
|
122
|
-
*
|
|
123
|
-
* ```ts
|
|
124
|
-
* sdk.admin.region.retrieve("region_123", {
|
|
125
|
-
* fields: "id,*countries"
|
|
126
|
-
* })
|
|
127
|
-
* .then(({ region }) => {
|
|
128
|
-
* console.log(region)
|
|
129
|
-
* })
|
|
130
|
-
* ```
|
|
131
|
-
*
|
|
132
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
133
|
-
*/
|
|
134
|
-
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionResponse>;
|
|
135
|
-
/**
|
|
136
|
-
* This method deletes a region by ID. It sends a request to the
|
|
137
|
-
* [Delete Region](https://docs.acmekit.com/api/admin#regions_deleteregionsid)
|
|
138
|
-
* API route.
|
|
139
|
-
*
|
|
140
|
-
* @param id - The ID of the region to delete.
|
|
141
|
-
* @param headers - Headers to pass in the request.
|
|
142
|
-
* @returns The deletion's details.
|
|
143
|
-
*
|
|
144
|
-
* @example
|
|
145
|
-
* sdk.admin.region.delete("region_123")
|
|
146
|
-
* .then(({ deleted }) => {
|
|
147
|
-
* console.log(deleted)
|
|
148
|
-
* })
|
|
149
|
-
*/
|
|
150
|
-
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminRegionDeleteResponse>;
|
|
151
|
-
}
|
|
152
|
-
//# sourceMappingURL=region.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"region.d.ts","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACb,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC,kBAAkB,EACvD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
|
package/dist/esm/admin/region.js
DELETED
|
@@ -1,195 +0,0 @@
|
|
|
1
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
-
});
|
|
9
|
-
};
|
|
10
|
-
export class Region {
|
|
11
|
-
/**
|
|
12
|
-
* @ignore
|
|
13
|
-
*/
|
|
14
|
-
constructor(client) {
|
|
15
|
-
this.client = client;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* This method creates a new region. It sends a request to the
|
|
19
|
-
* [Create Region](https://docs.acmekit.com/api/admin#regions_postregions)
|
|
20
|
-
* API route.
|
|
21
|
-
*
|
|
22
|
-
* @param body - The details of the region to create.
|
|
23
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
24
|
-
* @param headers - Headers to pass in the request.
|
|
25
|
-
* @returns The created region's details.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* sdk.admin.region.create({
|
|
29
|
-
* name: "United States",
|
|
30
|
-
* currency_code: "usd",
|
|
31
|
-
* })
|
|
32
|
-
* .then(({ region }) => {
|
|
33
|
-
* console.log(region)
|
|
34
|
-
* })
|
|
35
|
-
*/
|
|
36
|
-
create(body, query, headers) {
|
|
37
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
-
return yield this.client.fetch(`/admin/regions`, {
|
|
39
|
-
method: "POST",
|
|
40
|
-
headers,
|
|
41
|
-
body,
|
|
42
|
-
query,
|
|
43
|
-
});
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* This method updates a region. It sends a request to the
|
|
48
|
-
* [Update Region](https://docs.acmekit.com/api/admin#regions_postregionsid)
|
|
49
|
-
* API route.
|
|
50
|
-
*
|
|
51
|
-
* @param id - The ID of the region to update.
|
|
52
|
-
* @param body - The details of the region to update.
|
|
53
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
54
|
-
* @param headers - Headers to pass in the request.
|
|
55
|
-
* @returns The updated region's details.
|
|
56
|
-
*
|
|
57
|
-
* @example
|
|
58
|
-
* sdk.admin.region.update("region_123", {
|
|
59
|
-
* name: "United States",
|
|
60
|
-
* })
|
|
61
|
-
* .then(({ region }) => {
|
|
62
|
-
* console.log(region)
|
|
63
|
-
* })
|
|
64
|
-
*/
|
|
65
|
-
update(id, body, query, headers) {
|
|
66
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
-
return yield this.client.fetch(`/admin/regions/${id}`, {
|
|
68
|
-
method: "POST",
|
|
69
|
-
headers,
|
|
70
|
-
body,
|
|
71
|
-
query,
|
|
72
|
-
});
|
|
73
|
-
});
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* This method retrieves a list of regions. It sends a request to the
|
|
77
|
-
* [List Regions](https://docs.acmekit.com/api/admin#regions_getregions)
|
|
78
|
-
* API route.
|
|
79
|
-
*
|
|
80
|
-
* @param queryParams - Filters and pagination configurations.
|
|
81
|
-
* @param headers - Headers to pass in the request.
|
|
82
|
-
* @returns The paginated list of regions.
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* To retrieve the list of regions:
|
|
86
|
-
*
|
|
87
|
-
* ```ts
|
|
88
|
-
* sdk.admin.region.list()
|
|
89
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
90
|
-
* console.log(regions)
|
|
91
|
-
* })
|
|
92
|
-
* ```
|
|
93
|
-
*
|
|
94
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
95
|
-
*
|
|
96
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
97
|
-
*
|
|
98
|
-
* ```ts
|
|
99
|
-
* sdk.admin.region.list({
|
|
100
|
-
* limit: 10,
|
|
101
|
-
* offset: 10
|
|
102
|
-
* })
|
|
103
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
104
|
-
* console.log(regions)
|
|
105
|
-
* })
|
|
106
|
-
* ```
|
|
107
|
-
*
|
|
108
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
109
|
-
* in each region:
|
|
110
|
-
*
|
|
111
|
-
* ```ts
|
|
112
|
-
* sdk.admin.region.list({
|
|
113
|
-
* fields: "id,*countries"
|
|
114
|
-
* })
|
|
115
|
-
* .then(({ regions, count, limit, offset }) => {
|
|
116
|
-
* console.log(regions)
|
|
117
|
-
* })
|
|
118
|
-
* ```
|
|
119
|
-
*
|
|
120
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
121
|
-
*/
|
|
122
|
-
list(queryParams, headers) {
|
|
123
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
124
|
-
return yield this.client.fetch(`/admin/regions`, {
|
|
125
|
-
query: queryParams,
|
|
126
|
-
headers,
|
|
127
|
-
});
|
|
128
|
-
});
|
|
129
|
-
}
|
|
130
|
-
/**
|
|
131
|
-
* This method retrieves a region by ID. It sends a request to the
|
|
132
|
-
* [Get Region](https://docs.acmekit.com/api/admin#regions_getregionsid)
|
|
133
|
-
* API route.
|
|
134
|
-
*
|
|
135
|
-
* @param id - The ID of the region to retrieve.
|
|
136
|
-
* @param query - Configure the fields and relations to retrieve in the region.
|
|
137
|
-
* @param headers - Headers to pass in the request.
|
|
138
|
-
* @returns The region's details.
|
|
139
|
-
*
|
|
140
|
-
* @example
|
|
141
|
-
* To retrieve a region by its ID:
|
|
142
|
-
*
|
|
143
|
-
* ```ts
|
|
144
|
-
* sdk.admin.region.retrieve("region_123")
|
|
145
|
-
* .then(({ region }) => {
|
|
146
|
-
* console.log(region)
|
|
147
|
-
* })
|
|
148
|
-
* ```
|
|
149
|
-
*
|
|
150
|
-
* To specify the fields and relations to retrieve:
|
|
151
|
-
*
|
|
152
|
-
* ```ts
|
|
153
|
-
* sdk.admin.region.retrieve("region_123", {
|
|
154
|
-
* fields: "id,*countries"
|
|
155
|
-
* })
|
|
156
|
-
* .then(({ region }) => {
|
|
157
|
-
* console.log(region)
|
|
158
|
-
* })
|
|
159
|
-
* ```
|
|
160
|
-
*
|
|
161
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
162
|
-
*/
|
|
163
|
-
retrieve(id, query, headers) {
|
|
164
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
165
|
-
return yield this.client.fetch(`/admin/regions/${id}`, {
|
|
166
|
-
query,
|
|
167
|
-
headers,
|
|
168
|
-
});
|
|
169
|
-
});
|
|
170
|
-
}
|
|
171
|
-
/**
|
|
172
|
-
* This method deletes a region by ID. It sends a request to the
|
|
173
|
-
* [Delete Region](https://docs.acmekit.com/api/admin#regions_deleteregionsid)
|
|
174
|
-
* API route.
|
|
175
|
-
*
|
|
176
|
-
* @param id - The ID of the region to delete.
|
|
177
|
-
* @param headers - Headers to pass in the request.
|
|
178
|
-
* @returns The deletion's details.
|
|
179
|
-
*
|
|
180
|
-
* @example
|
|
181
|
-
* sdk.admin.region.delete("region_123")
|
|
182
|
-
* .then(({ deleted }) => {
|
|
183
|
-
* console.log(deleted)
|
|
184
|
-
* })
|
|
185
|
-
*/
|
|
186
|
-
delete(id, headers) {
|
|
187
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
188
|
-
return yield this.client.fetch(`/admin/regions/${id}`, {
|
|
189
|
-
method: "DELETE",
|
|
190
|
-
headers,
|
|
191
|
-
});
|
|
192
|
-
});
|
|
193
|
-
}
|
|
194
|
-
}
|
|
195
|
-
//# sourceMappingURL=region.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"region.js","sourceRoot":"","sources":["../../../src/admin/region.ts"],"names":[],"mappings":";;;;;;;;;AAQA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAuD,EACvD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
|