@acmekit/js-sdk 2.13.2 → 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,180 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ShippingOptionType = void 0;
|
|
4
|
-
class ShippingOptionType {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
constructor(client) {
|
|
9
|
-
this.client = client;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* This method creates a shipping option type. It sends a request to the
|
|
13
|
-
* [Create Shipping Option Type](https://docs.acmekit.com/api/admin#shipping-option-types_postshippingoptiontypes)
|
|
14
|
-
* API route.
|
|
15
|
-
*
|
|
16
|
-
* @param body - The shipping option type's details.
|
|
17
|
-
* @param query - Configure the fields to retrieve in the shipping option type.
|
|
18
|
-
* @param headers - Headers to pass in the request
|
|
19
|
-
* @returns The shipping option type's details.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* sdk.admin.shippingOptionType.create({
|
|
23
|
-
* label: "Standard",
|
|
24
|
-
* code: "standard",
|
|
25
|
-
* description: "Ship in 2-3 days."
|
|
26
|
-
* })
|
|
27
|
-
* .then(({ shipping_option_type }) => {
|
|
28
|
-
* console.log(shipping_option_type)
|
|
29
|
-
* })
|
|
30
|
-
*/
|
|
31
|
-
async create(body, query, headers) {
|
|
32
|
-
return this.client.fetch(`/admin/shipping-option-types`, {
|
|
33
|
-
method: "POST",
|
|
34
|
-
headers,
|
|
35
|
-
body,
|
|
36
|
-
query,
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* This method updates a shipping option type. It sends a request to the
|
|
41
|
-
* [Update Shipping Option Type](https://docs.acmekit.com/api/admin#shipping-option-types_postshippingoptiontypesid)
|
|
42
|
-
* API route.
|
|
43
|
-
*
|
|
44
|
-
* @param id - The shipping option type's ID.
|
|
45
|
-
* @param body - The data to update in the shipping option type.
|
|
46
|
-
* @param query - Configure the fields to retrieve in the shipping option type.
|
|
47
|
-
* @param headers - Headers to pass in the request
|
|
48
|
-
* @returns The shipping option type's details.
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* sdk.admin.shippingOptionType.update("sotype_123", {
|
|
52
|
-
* code: "express"
|
|
53
|
-
* })
|
|
54
|
-
* .then(({ shipping_option_type }) => {
|
|
55
|
-
* console.log(shipping_option_type)
|
|
56
|
-
* })
|
|
57
|
-
*/
|
|
58
|
-
async update(id, body, query, headers) {
|
|
59
|
-
return this.client.fetch(`/admin/shipping-option-types/${id}`, {
|
|
60
|
-
method: "POST",
|
|
61
|
-
headers,
|
|
62
|
-
body,
|
|
63
|
-
query,
|
|
64
|
-
});
|
|
65
|
-
}
|
|
66
|
-
/**
|
|
67
|
-
* This method retrieves a paginated list of shipping option types. It sends a request to the
|
|
68
|
-
* [List Shipping Option Types](https://docs.acmekit.com/api/admin#shipping-option-types_getshippingoptiontypes) API route.
|
|
69
|
-
*
|
|
70
|
-
* @param query - Filters and pagination configurations.
|
|
71
|
-
* @param headers - Headers to pass in the request.
|
|
72
|
-
* @returns The paginated list of shipping option types.
|
|
73
|
-
*
|
|
74
|
-
* @example
|
|
75
|
-
* To retrieve the list of shipping option types:
|
|
76
|
-
*
|
|
77
|
-
* ```ts
|
|
78
|
-
* sdk.admin.shippingOptionType.list()
|
|
79
|
-
* .then(({ shipping_option_types, count, limit, offset }) => {
|
|
80
|
-
* console.log(shipping_option_types)
|
|
81
|
-
* })
|
|
82
|
-
* ```
|
|
83
|
-
*
|
|
84
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
85
|
-
*
|
|
86
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
87
|
-
*
|
|
88
|
-
* ```ts
|
|
89
|
-
* sdk.admin.shippingOptionType.list({
|
|
90
|
-
* limit: 10,
|
|
91
|
-
* offset: 10
|
|
92
|
-
* })
|
|
93
|
-
* .then(({ shipping_option_types, count, limit, offset }) => {
|
|
94
|
-
* console.log(shipping_option_types)
|
|
95
|
-
* })
|
|
96
|
-
* ```
|
|
97
|
-
*
|
|
98
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
99
|
-
* in each shipping option type:
|
|
100
|
-
*
|
|
101
|
-
* ```ts
|
|
102
|
-
* sdk.admin.shippingOptionType.list({
|
|
103
|
-
* fields: "id,*shippingOptions"
|
|
104
|
-
* })
|
|
105
|
-
* .then(({ shipping_option_types, count, limit, offset }) => {
|
|
106
|
-
* console.log(shipping_option_types)
|
|
107
|
-
* })
|
|
108
|
-
* ```
|
|
109
|
-
*
|
|
110
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
111
|
-
*/
|
|
112
|
-
async list(query, headers) {
|
|
113
|
-
return this.client.fetch(`/admin/shipping-option-types`, {
|
|
114
|
-
headers,
|
|
115
|
-
query: query,
|
|
116
|
-
});
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* This method retrieves a shipping option type by its ID. It sends a request to the
|
|
120
|
-
* [Get Shipping Option Type](https://docs.acmekit.com/api/admin#shipping-option-types_getshippingoptiontypesid)
|
|
121
|
-
* API route.
|
|
122
|
-
*
|
|
123
|
-
* @param id - The shipping option type's ID.
|
|
124
|
-
* @param query - Configure the fields to retrieve in the shipping option type.
|
|
125
|
-
* @param headers - Headers to pass in the request
|
|
126
|
-
* @returns The shipping option type's details.
|
|
127
|
-
*
|
|
128
|
-
* @example
|
|
129
|
-
* To retrieve a shipping option type by its ID:
|
|
130
|
-
*
|
|
131
|
-
* ```ts
|
|
132
|
-
* sdk.admin.shippingOptionType.retrieve("sotype_123")
|
|
133
|
-
* .then(({ shipping_option_type }) => {
|
|
134
|
-
* console.log(shipping_option_type)
|
|
135
|
-
* })
|
|
136
|
-
* ```
|
|
137
|
-
*
|
|
138
|
-
* To specify the fields and relations to retrieve:
|
|
139
|
-
*
|
|
140
|
-
* ```ts
|
|
141
|
-
* sdk.admin.shippingOptionType.retrieve("sotype_123", {
|
|
142
|
-
* fields: "id,*shippingOptions"
|
|
143
|
-
* })
|
|
144
|
-
* .then(({ shipping_option_type }) => {
|
|
145
|
-
* console.log(shipping_option_type)
|
|
146
|
-
* })
|
|
147
|
-
* ```
|
|
148
|
-
*
|
|
149
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
150
|
-
*/
|
|
151
|
-
async retrieve(id, query, headers) {
|
|
152
|
-
return this.client.fetch(`/admin/shipping-option-types/${id}`, {
|
|
153
|
-
query,
|
|
154
|
-
headers,
|
|
155
|
-
});
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* This method deletes a shipping option type. It sends a request to the
|
|
159
|
-
* [Delete Shipping Option Type](https://docs.acmekit.com/api/admin#shipping-option-types_deleteshippingoptiontypesid)
|
|
160
|
-
* API route.
|
|
161
|
-
*
|
|
162
|
-
* @param id - The shipping option type's ID.
|
|
163
|
-
* @param headers - Headers to pass in the request
|
|
164
|
-
* @returns The shipping option type's details.
|
|
165
|
-
*
|
|
166
|
-
* @example
|
|
167
|
-
* sdk.admin.shippingOptionType.delete("sotype_123")
|
|
168
|
-
* .then(({ deleted }) => {
|
|
169
|
-
* console.log(deleted)
|
|
170
|
-
* })
|
|
171
|
-
*/
|
|
172
|
-
async delete(id, headers) {
|
|
173
|
-
return this.client.fetch(`/admin/shipping-option-types/${id}`, {
|
|
174
|
-
method: "DELETE",
|
|
175
|
-
headers,
|
|
176
|
-
});
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
exports.ShippingOptionType = ShippingOptionType;
|
|
180
|
-
//# sourceMappingURL=shipping-option-type.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"shipping-option-type.js","sourceRoot":"","sources":["../../src/admin/shipping-option-type.ts"],"names":[],"mappings":";;;AAIA,MAAa,kBAAkB;IAK7B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,8BAA8B,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gCAAgC,EAAE,EAAE,EACpC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAAmD,EACnD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,8BAA8B,EAC9B;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gCAAgC,EAAE,EAAE,EACpC;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gCAAgC,EAAE,EAAE,EACpC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAtND,gDAsNC"}
|
|
@@ -1,171 +0,0 @@
|
|
|
1
|
-
import { HttpTypes } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class ShippingOption {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method creates a shipping option. It sends a request to the
|
|
15
|
-
* [Create Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptions)
|
|
16
|
-
* API route.
|
|
17
|
-
*
|
|
18
|
-
* @param body - The details of the shipping option to create.
|
|
19
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
20
|
-
* @param headers - Headers to pass in the request.
|
|
21
|
-
* @returns The shipping option's details.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* sdk.admin.shippingOption.create({
|
|
25
|
-
* name: "Standard Shipping",
|
|
26
|
-
* profile_id: "shp_123",
|
|
27
|
-
* })
|
|
28
|
-
* .then(({ shipping_option }) => {
|
|
29
|
-
* console.log(shipping_option)
|
|
30
|
-
* })
|
|
31
|
-
*/
|
|
32
|
-
create(body: HttpTypes.AdminCreateShippingOption, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* This method retrieves a shipping option. It sends a request to the
|
|
35
|
-
* [Get Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_getshippingoptionsid)
|
|
36
|
-
* API route.
|
|
37
|
-
*
|
|
38
|
-
* @param id - The ID of the shipping option to retrieve.
|
|
39
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
40
|
-
* @param headers - Headers to pass in the request.
|
|
41
|
-
* @returns The shipping option's details.
|
|
42
|
-
*
|
|
43
|
-
* @example
|
|
44
|
-
* To retrieve a shipping option by its ID:
|
|
45
|
-
*
|
|
46
|
-
* ```ts
|
|
47
|
-
* sdk.admin.shippingOption.retrieve("so_123")
|
|
48
|
-
* .then(({ shipping_option }) => {
|
|
49
|
-
* console.log(shipping_option)
|
|
50
|
-
* })
|
|
51
|
-
* ```
|
|
52
|
-
*
|
|
53
|
-
* To specify the fields and relations to retrieve:
|
|
54
|
-
*
|
|
55
|
-
* ```ts
|
|
56
|
-
* sdk.admin.shippingOption.retrieve("so_123", {
|
|
57
|
-
* fields: "id,*service_zone"
|
|
58
|
-
* })
|
|
59
|
-
* .then(({ shipping_option }) => {
|
|
60
|
-
* console.log(shipping_option)
|
|
61
|
-
* })
|
|
62
|
-
* ```
|
|
63
|
-
*
|
|
64
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
65
|
-
*/
|
|
66
|
-
retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
|
|
67
|
-
/**
|
|
68
|
-
* This method updates a shipping option. It sends a request to the
|
|
69
|
-
* [Update Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsid)
|
|
70
|
-
* API route.
|
|
71
|
-
*
|
|
72
|
-
* @param id - The ID of the shipping option to update.
|
|
73
|
-
* @param body - The details of the shipping option to update.
|
|
74
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
75
|
-
* @param headers - Headers to pass in the request.
|
|
76
|
-
* @returns The shipping option's details.
|
|
77
|
-
*
|
|
78
|
-
* @example
|
|
79
|
-
* sdk.admin.shippingOption.update("so_123", {
|
|
80
|
-
* name: "Standard Shipping",
|
|
81
|
-
* })
|
|
82
|
-
* .then(({ shipping_option }) => {
|
|
83
|
-
* console.log(shipping_option)
|
|
84
|
-
* })
|
|
85
|
-
*/
|
|
86
|
-
update(id: string, body: HttpTypes.AdminUpdateShippingOption, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
|
|
87
|
-
/**
|
|
88
|
-
* This method deletes a shipping option. It sends a request to the
|
|
89
|
-
* [Delete Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_deleteshippingoptionsid)
|
|
90
|
-
* API route.
|
|
91
|
-
*
|
|
92
|
-
* @param id - The ID of the shipping option to delete.
|
|
93
|
-
* @param headers - Headers to pass in the request.
|
|
94
|
-
* @returns The deletion's details.
|
|
95
|
-
*
|
|
96
|
-
* @example
|
|
97
|
-
* sdk.admin.shippingOption.delete("so_123")
|
|
98
|
-
* .then(({ deleted }) => {
|
|
99
|
-
* console.log(deleted)
|
|
100
|
-
* })
|
|
101
|
-
*/
|
|
102
|
-
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionDeleteResponse>;
|
|
103
|
-
/**
|
|
104
|
-
* This method retrieves a list of shipping options. It sends a request to the
|
|
105
|
-
* [List Shipping Options](https://docs.acmekit.com/api/admin#shipping-options_getshippingoptions)
|
|
106
|
-
* API route.
|
|
107
|
-
*
|
|
108
|
-
* @param query - Filters and pagination configurations.
|
|
109
|
-
* @param headers - Headers to pass in the request.
|
|
110
|
-
* @returns The list of shipping options.
|
|
111
|
-
*
|
|
112
|
-
* @example
|
|
113
|
-
* To retrieve the list of shipping options:
|
|
114
|
-
*
|
|
115
|
-
* ```ts
|
|
116
|
-
* sdk.admin.shippingOption.list()
|
|
117
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
118
|
-
* console.log(shipping_options)
|
|
119
|
-
* })
|
|
120
|
-
* ```
|
|
121
|
-
*
|
|
122
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
123
|
-
*
|
|
124
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
125
|
-
*
|
|
126
|
-
* ```ts
|
|
127
|
-
* sdk.admin.shippingOption.list({
|
|
128
|
-
* limit: 10,
|
|
129
|
-
* offset: 10
|
|
130
|
-
* })
|
|
131
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
132
|
-
* console.log(shipping_options)
|
|
133
|
-
* })
|
|
134
|
-
* ```
|
|
135
|
-
*
|
|
136
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
137
|
-
* in each shipping option:
|
|
138
|
-
*
|
|
139
|
-
* ```ts
|
|
140
|
-
* sdk.admin.shippingOption.list({
|
|
141
|
-
* fields: "id,*service_zone"
|
|
142
|
-
* })
|
|
143
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
144
|
-
* console.log(shipping_options)
|
|
145
|
-
* })
|
|
146
|
-
* ```
|
|
147
|
-
*
|
|
148
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
149
|
-
*/
|
|
150
|
-
list(query?: HttpTypes.AdminShippingOptionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionListResponse>;
|
|
151
|
-
/**
|
|
152
|
-
* This method manages the rules of a shipping option to create, update, or remove them. It sends a request to the
|
|
153
|
-
* [Manage Rules of a Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsidrulesbatch)
|
|
154
|
-
* API route.
|
|
155
|
-
*
|
|
156
|
-
* @param id - The ID of the shipping option to manage the rules for.
|
|
157
|
-
* @param body - The details of the shipping option rules to manage.
|
|
158
|
-
* @param headers - Headers to pass in the request.
|
|
159
|
-
* @returns The shipping option's details.
|
|
160
|
-
*
|
|
161
|
-
* @example
|
|
162
|
-
* sdk.admin.shippingOption.updateRules("so_123", {
|
|
163
|
-
* create: [{ attribute: "enabled_in_store", operator: "eq", value: "true" }],
|
|
164
|
-
* })
|
|
165
|
-
* .then(({ shipping_option }) => {
|
|
166
|
-
* console.log(shipping_option)
|
|
167
|
-
* })
|
|
168
|
-
*/
|
|
169
|
-
updateRules(id: string, body: HttpTypes.AdminUpdateShippingOptionRules, headers?: ClientHeaders): Promise<HttpTypes.AdminUpdateShippingOptionRulesResponse>;
|
|
170
|
-
}
|
|
171
|
-
//# sourceMappingURL=shipping-option.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../src/admin/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAG1B;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,6BAA6B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
|
|
@@ -1,207 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ShippingOption = void 0;
|
|
4
|
-
class ShippingOption {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
constructor(client) {
|
|
9
|
-
this.client = client;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* This method creates a shipping option. It sends a request to the
|
|
13
|
-
* [Create Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptions)
|
|
14
|
-
* API route.
|
|
15
|
-
*
|
|
16
|
-
* @param body - The details of the shipping option to create.
|
|
17
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
18
|
-
* @param headers - Headers to pass in the request.
|
|
19
|
-
* @returns The shipping option's details.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* sdk.admin.shippingOption.create({
|
|
23
|
-
* name: "Standard Shipping",
|
|
24
|
-
* profile_id: "shp_123",
|
|
25
|
-
* })
|
|
26
|
-
* .then(({ shipping_option }) => {
|
|
27
|
-
* console.log(shipping_option)
|
|
28
|
-
* })
|
|
29
|
-
*/
|
|
30
|
-
async create(body, query, headers) {
|
|
31
|
-
return await this.client.fetch(`/admin/shipping-options`, {
|
|
32
|
-
method: "POST",
|
|
33
|
-
headers,
|
|
34
|
-
body,
|
|
35
|
-
query,
|
|
36
|
-
});
|
|
37
|
-
}
|
|
38
|
-
/**
|
|
39
|
-
* This method retrieves a shipping option. It sends a request to the
|
|
40
|
-
* [Get Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_getshippingoptionsid)
|
|
41
|
-
* API route.
|
|
42
|
-
*
|
|
43
|
-
* @param id - The ID of the shipping option to retrieve.
|
|
44
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
45
|
-
* @param headers - Headers to pass in the request.
|
|
46
|
-
* @returns The shipping option's details.
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* To retrieve a shipping option by its ID:
|
|
50
|
-
*
|
|
51
|
-
* ```ts
|
|
52
|
-
* sdk.admin.shippingOption.retrieve("so_123")
|
|
53
|
-
* .then(({ shipping_option }) => {
|
|
54
|
-
* console.log(shipping_option)
|
|
55
|
-
* })
|
|
56
|
-
* ```
|
|
57
|
-
*
|
|
58
|
-
* To specify the fields and relations to retrieve:
|
|
59
|
-
*
|
|
60
|
-
* ```ts
|
|
61
|
-
* sdk.admin.shippingOption.retrieve("so_123", {
|
|
62
|
-
* fields: "id,*service_zone"
|
|
63
|
-
* })
|
|
64
|
-
* .then(({ shipping_option }) => {
|
|
65
|
-
* console.log(shipping_option)
|
|
66
|
-
* })
|
|
67
|
-
* ```
|
|
68
|
-
*
|
|
69
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
70
|
-
*/
|
|
71
|
-
async retrieve(id, query, headers) {
|
|
72
|
-
return await this.client.fetch(`/admin/shipping-options/${id}`, {
|
|
73
|
-
method: "GET",
|
|
74
|
-
headers,
|
|
75
|
-
query,
|
|
76
|
-
});
|
|
77
|
-
}
|
|
78
|
-
/**
|
|
79
|
-
* This method updates a shipping option. It sends a request to the
|
|
80
|
-
* [Update Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsid)
|
|
81
|
-
* API route.
|
|
82
|
-
*
|
|
83
|
-
* @param id - The ID of the shipping option to update.
|
|
84
|
-
* @param body - The details of the shipping option to update.
|
|
85
|
-
* @param query - Configure the fields and relations to retrieve in the shipping option.
|
|
86
|
-
* @param headers - Headers to pass in the request.
|
|
87
|
-
* @returns The shipping option's details.
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* sdk.admin.shippingOption.update("so_123", {
|
|
91
|
-
* name: "Standard Shipping",
|
|
92
|
-
* })
|
|
93
|
-
* .then(({ shipping_option }) => {
|
|
94
|
-
* console.log(shipping_option)
|
|
95
|
-
* })
|
|
96
|
-
*/
|
|
97
|
-
async update(id, body, query, headers) {
|
|
98
|
-
return await this.client.fetch(`/admin/shipping-options/${id}`, {
|
|
99
|
-
method: "POST",
|
|
100
|
-
headers,
|
|
101
|
-
body,
|
|
102
|
-
query,
|
|
103
|
-
});
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* This method deletes a shipping option. It sends a request to the
|
|
107
|
-
* [Delete Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_deleteshippingoptionsid)
|
|
108
|
-
* API route.
|
|
109
|
-
*
|
|
110
|
-
* @param id - The ID of the shipping option to delete.
|
|
111
|
-
* @param headers - Headers to pass in the request.
|
|
112
|
-
* @returns The deletion's details.
|
|
113
|
-
*
|
|
114
|
-
* @example
|
|
115
|
-
* sdk.admin.shippingOption.delete("so_123")
|
|
116
|
-
* .then(({ deleted }) => {
|
|
117
|
-
* console.log(deleted)
|
|
118
|
-
* })
|
|
119
|
-
*/
|
|
120
|
-
async delete(id, headers) {
|
|
121
|
-
return await this.client.fetch(`/admin/shipping-options/${id}`, {
|
|
122
|
-
method: "DELETE",
|
|
123
|
-
headers,
|
|
124
|
-
});
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* This method retrieves a list of shipping options. It sends a request to the
|
|
128
|
-
* [List Shipping Options](https://docs.acmekit.com/api/admin#shipping-options_getshippingoptions)
|
|
129
|
-
* API route.
|
|
130
|
-
*
|
|
131
|
-
* @param query - Filters and pagination configurations.
|
|
132
|
-
* @param headers - Headers to pass in the request.
|
|
133
|
-
* @returns The list of shipping options.
|
|
134
|
-
*
|
|
135
|
-
* @example
|
|
136
|
-
* To retrieve the list of shipping options:
|
|
137
|
-
*
|
|
138
|
-
* ```ts
|
|
139
|
-
* sdk.admin.shippingOption.list()
|
|
140
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
141
|
-
* console.log(shipping_options)
|
|
142
|
-
* })
|
|
143
|
-
* ```
|
|
144
|
-
*
|
|
145
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
146
|
-
*
|
|
147
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
148
|
-
*
|
|
149
|
-
* ```ts
|
|
150
|
-
* sdk.admin.shippingOption.list({
|
|
151
|
-
* limit: 10,
|
|
152
|
-
* offset: 10
|
|
153
|
-
* })
|
|
154
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
155
|
-
* console.log(shipping_options)
|
|
156
|
-
* })
|
|
157
|
-
* ```
|
|
158
|
-
*
|
|
159
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
160
|
-
* in each shipping option:
|
|
161
|
-
*
|
|
162
|
-
* ```ts
|
|
163
|
-
* sdk.admin.shippingOption.list({
|
|
164
|
-
* fields: "id,*service_zone"
|
|
165
|
-
* })
|
|
166
|
-
* .then(({ shipping_options, count, limit, offset }) => {
|
|
167
|
-
* console.log(shipping_options)
|
|
168
|
-
* })
|
|
169
|
-
* ```
|
|
170
|
-
*
|
|
171
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
172
|
-
*/
|
|
173
|
-
async list(query, headers) {
|
|
174
|
-
return await this.client.fetch(`/admin/shipping-options`, {
|
|
175
|
-
method: "GET",
|
|
176
|
-
headers,
|
|
177
|
-
query,
|
|
178
|
-
});
|
|
179
|
-
}
|
|
180
|
-
/**
|
|
181
|
-
* This method manages the rules of a shipping option to create, update, or remove them. It sends a request to the
|
|
182
|
-
* [Manage Rules of a Shipping Option](https://docs.acmekit.com/api/admin#shipping-options_postshippingoptionsidrulesbatch)
|
|
183
|
-
* API route.
|
|
184
|
-
*
|
|
185
|
-
* @param id - The ID of the shipping option to manage the rules for.
|
|
186
|
-
* @param body - The details of the shipping option rules to manage.
|
|
187
|
-
* @param headers - Headers to pass in the request.
|
|
188
|
-
* @returns The shipping option's details.
|
|
189
|
-
*
|
|
190
|
-
* @example
|
|
191
|
-
* sdk.admin.shippingOption.updateRules("so_123", {
|
|
192
|
-
* create: [{ attribute: "enabled_in_store", operator: "eq", value: "true" }],
|
|
193
|
-
* })
|
|
194
|
-
* .then(({ shipping_option }) => {
|
|
195
|
-
* console.log(shipping_option)
|
|
196
|
-
* })
|
|
197
|
-
*/
|
|
198
|
-
async updateRules(id, body, headers) {
|
|
199
|
-
return await this.client.fetch(`/admin/shipping-options/${id}/rules/batch`, {
|
|
200
|
-
method: "POST",
|
|
201
|
-
headers,
|
|
202
|
-
body,
|
|
203
|
-
});
|
|
204
|
-
}
|
|
205
|
-
}
|
|
206
|
-
exports.ShippingOption = ShippingOption;
|
|
207
|
-
//# sourceMappingURL=shipping-option.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../src/admin/shipping-option.ts"],"names":[],"mappings":";;;AAIA,MAAa,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAA8C,EAC9C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,cAAc,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAxPD,wCAwPC"}
|