@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,281 +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 StockLocation {
|
|
11
|
-
/**
|
|
12
|
-
* @ignore
|
|
13
|
-
*/
|
|
14
|
-
constructor(client) {
|
|
15
|
-
this.client = client;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* This method creates a new stock location. It sends a request to the
|
|
19
|
-
* [Create Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocations)
|
|
20
|
-
* API route.
|
|
21
|
-
*
|
|
22
|
-
* @param body - The details of the stock location to create.
|
|
23
|
-
* @param query - Configure the fields and relations to retrieve in the stock location.
|
|
24
|
-
* @param headers - Headers to pass in the request.
|
|
25
|
-
* @returns The stock location's details.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* sdk.admin.stockLocation.create({
|
|
29
|
-
* name: "Main Warehouse",
|
|
30
|
-
* address_id: "addr_123",
|
|
31
|
-
* })
|
|
32
|
-
* .then(({ stock_location }) => {
|
|
33
|
-
* console.log(stock_location)
|
|
34
|
-
* })
|
|
35
|
-
*/
|
|
36
|
-
create(body, query, headers) {
|
|
37
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
-
return yield this.client.fetch(`/admin/stock-locations`, {
|
|
39
|
-
method: "POST",
|
|
40
|
-
headers,
|
|
41
|
-
body,
|
|
42
|
-
query,
|
|
43
|
-
});
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* This method updates a stock location. It sends a request to the
|
|
48
|
-
* [Update Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsid)
|
|
49
|
-
* API route.
|
|
50
|
-
*
|
|
51
|
-
* @param id - The ID of the stock location to update.
|
|
52
|
-
* @param body - The details of the stock location to update.
|
|
53
|
-
* @param query - Configure the fields and relations to retrieve in the stock location.
|
|
54
|
-
* @param headers - Headers to pass in the request.
|
|
55
|
-
* @returns The stock location's details.
|
|
56
|
-
*
|
|
57
|
-
* @example
|
|
58
|
-
* sdk.admin.stockLocation.update("sloc_123", {
|
|
59
|
-
* name: "European Warehouse",
|
|
60
|
-
* })
|
|
61
|
-
* .then(({ stock_location }) => {
|
|
62
|
-
* console.log(stock_location)
|
|
63
|
-
* })
|
|
64
|
-
*/
|
|
65
|
-
update(id, body, query, headers) {
|
|
66
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}`, {
|
|
68
|
-
method: "POST",
|
|
69
|
-
headers,
|
|
70
|
-
body,
|
|
71
|
-
query,
|
|
72
|
-
});
|
|
73
|
-
});
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* This method deletes a stock location. It sends a request to the
|
|
77
|
-
* [Delete Stock Location](https://docs.acmekit.com/api/admin#stock-locations_deletestocklocationsid)
|
|
78
|
-
* API route.
|
|
79
|
-
*
|
|
80
|
-
* @param id - The ID of the stock location to delete.
|
|
81
|
-
* @param headers - Headers to pass in the request.
|
|
82
|
-
* @returns The deletion's details.
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* sdk.admin.stockLocation.delete("sloc_123")
|
|
86
|
-
* .then(({ deleted }) => {
|
|
87
|
-
* console.log(deleted)
|
|
88
|
-
* })
|
|
89
|
-
*/
|
|
90
|
-
delete(id, headers) {
|
|
91
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
92
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}`, {
|
|
93
|
-
method: "DELETE",
|
|
94
|
-
headers,
|
|
95
|
-
});
|
|
96
|
-
});
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* This method retrieves a stock location. It sends a request to the
|
|
100
|
-
* [Get Stock Location](https://docs.acmekit.com/api/admin#stock-locations_getstocklocationsid)
|
|
101
|
-
* API route.
|
|
102
|
-
*
|
|
103
|
-
* @param id - The ID of the stock location to retrieve.
|
|
104
|
-
* @param query - Configure the fields and relations to retrieve in the stock location.
|
|
105
|
-
* @param headers - Headers to pass in the request.
|
|
106
|
-
* @returns The stock location's details.
|
|
107
|
-
*
|
|
108
|
-
* @example
|
|
109
|
-
* To retrieve a stock location by its ID:
|
|
110
|
-
*
|
|
111
|
-
* ```ts
|
|
112
|
-
* sdk.admin.stockLocation.retrieve("sloc_123")
|
|
113
|
-
* .then(({ stock_location }) => {
|
|
114
|
-
* console.log(stock_location)
|
|
115
|
-
* })
|
|
116
|
-
* ```
|
|
117
|
-
*
|
|
118
|
-
* To specify the fields and relations to retrieve:
|
|
119
|
-
*
|
|
120
|
-
* ```ts
|
|
121
|
-
* sdk.admin.stockLocation.retrieve("sloc_123", {
|
|
122
|
-
* fields: "id,*sales_channels"
|
|
123
|
-
* })
|
|
124
|
-
* .then(({ stock_location }) => {
|
|
125
|
-
* console.log(stock_location)
|
|
126
|
-
* })
|
|
127
|
-
* ```
|
|
128
|
-
*
|
|
129
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
130
|
-
*/
|
|
131
|
-
retrieve(id, query, headers) {
|
|
132
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
133
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}`, {
|
|
134
|
-
method: "GET",
|
|
135
|
-
headers,
|
|
136
|
-
query,
|
|
137
|
-
});
|
|
138
|
-
});
|
|
139
|
-
}
|
|
140
|
-
/**
|
|
141
|
-
* This method retrieves a list of stock locations. It sends a request to the
|
|
142
|
-
* [List Stock Locations](https://docs.acmekit.com/api/admin#stock-locations_getstocklocations)
|
|
143
|
-
* API route.
|
|
144
|
-
*
|
|
145
|
-
* @param query - Filters and pagination configurations.
|
|
146
|
-
* @param headers - Headers to pass in the request.
|
|
147
|
-
* @returns The list of stock locations.
|
|
148
|
-
*
|
|
149
|
-
* @example
|
|
150
|
-
* To retrieve the list of stock locations:
|
|
151
|
-
*
|
|
152
|
-
* ```ts
|
|
153
|
-
* sdk.admin.stockLocation.list()
|
|
154
|
-
* .then(({ stock_locations, count, limit, offset }) => {
|
|
155
|
-
* console.log(stock_locations)
|
|
156
|
-
* })
|
|
157
|
-
* ```
|
|
158
|
-
*
|
|
159
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
160
|
-
*
|
|
161
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
162
|
-
*
|
|
163
|
-
* ```ts
|
|
164
|
-
* sdk.admin.stockLocation.list({
|
|
165
|
-
* limit: 10,
|
|
166
|
-
* offset: 10
|
|
167
|
-
* })
|
|
168
|
-
* .then(({ stock_locations, count, limit, offset }) => {
|
|
169
|
-
* console.log(stock_locations)
|
|
170
|
-
* })
|
|
171
|
-
* ```
|
|
172
|
-
*
|
|
173
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
174
|
-
* in each stock location:
|
|
175
|
-
*
|
|
176
|
-
* ```ts
|
|
177
|
-
* sdk.admin.stockLocation.list({
|
|
178
|
-
* fields: "id,*sales_channels"
|
|
179
|
-
* })
|
|
180
|
-
* .then(({ stock_locations, count, limit, offset }) => {
|
|
181
|
-
* console.log(stock_locations)
|
|
182
|
-
* })
|
|
183
|
-
* ```
|
|
184
|
-
*
|
|
185
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
186
|
-
*/
|
|
187
|
-
list(query, headers) {
|
|
188
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
189
|
-
return yield this.client.fetch(`/admin/stock-locations`, {
|
|
190
|
-
method: "GET",
|
|
191
|
-
headers,
|
|
192
|
-
query,
|
|
193
|
-
});
|
|
194
|
-
});
|
|
195
|
-
}
|
|
196
|
-
/**
|
|
197
|
-
* This method manages the sales channels of a stock location by adding or removing them. It sends a request to the
|
|
198
|
-
* [Manage Stock Location Sales Channels](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidsaleschannels)
|
|
199
|
-
* API route.
|
|
200
|
-
*
|
|
201
|
-
* @param id - The ID of the stock location to update the sales channels for.
|
|
202
|
-
* @param body - The details of the sales channels to update.
|
|
203
|
-
* @param headers - Headers to pass in the request.
|
|
204
|
-
* @returns The stock location's details.
|
|
205
|
-
*
|
|
206
|
-
* @example
|
|
207
|
-
* sdk.admin.stockLocation.updateSalesChannels("sloc_123", {
|
|
208
|
-
* add: ["sc_123"],
|
|
209
|
-
* remove: ["sc_456"],
|
|
210
|
-
* })
|
|
211
|
-
* .then(({ stock_location }) => {
|
|
212
|
-
* console.log(stock_location)
|
|
213
|
-
* })
|
|
214
|
-
*/
|
|
215
|
-
updateSalesChannels(id, body, headers) {
|
|
216
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
217
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}/sales-channels`, {
|
|
218
|
-
method: "POST",
|
|
219
|
-
headers,
|
|
220
|
-
body,
|
|
221
|
-
});
|
|
222
|
-
});
|
|
223
|
-
}
|
|
224
|
-
/**
|
|
225
|
-
* This method adds a new fulfillment set to a stock location. It sends a request to the
|
|
226
|
-
* [Add Fulfillment Set to Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidfulfillmentsets)
|
|
227
|
-
* API route.
|
|
228
|
-
*
|
|
229
|
-
* @param id - The ID of the stock location to add the fulfillment set to.
|
|
230
|
-
* @param body - The details of the fulfillment set to add.
|
|
231
|
-
* @param headers - Headers to pass in the request.
|
|
232
|
-
* @returns The stock location's details.
|
|
233
|
-
*
|
|
234
|
-
* @example
|
|
235
|
-
* sdk.admin.stockLocation.createFulfillmentSet("sloc_123", {
|
|
236
|
-
* name: "Shipping",
|
|
237
|
-
* type: "shipping",
|
|
238
|
-
* })
|
|
239
|
-
* .then(({ stock_location }) => {
|
|
240
|
-
* console.log(stock_location)
|
|
241
|
-
* })
|
|
242
|
-
*/
|
|
243
|
-
createFulfillmentSet(id, body, headers) {
|
|
244
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
245
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}/fulfillment-sets`, {
|
|
246
|
-
method: "POST",
|
|
247
|
-
headers,
|
|
248
|
-
body,
|
|
249
|
-
});
|
|
250
|
-
});
|
|
251
|
-
}
|
|
252
|
-
/**
|
|
253
|
-
* This method manages the fulfillment providers of a stock location by adding or removing them. It sends a request to the
|
|
254
|
-
* [Manage Fulfillment Providers of Stock Location](https://docs.acmekit.com/api/admin#stock-locations_poststocklocationsidfulfillmentproviders)
|
|
255
|
-
* API route.
|
|
256
|
-
*
|
|
257
|
-
* @param id - The ID of the stock location to manage the fulfillment providers for.
|
|
258
|
-
* @param body - The details of the fulfillment providers to manage.
|
|
259
|
-
* @param headers - Headers to pass in the request.
|
|
260
|
-
* @returns The stock location's details.
|
|
261
|
-
*
|
|
262
|
-
* @example
|
|
263
|
-
* sdk.admin.stockLocation.updateFulfillmentProviders("sloc_123", {
|
|
264
|
-
* add: ["fp_manual_manual"],
|
|
265
|
-
* remove: ["fp_shipstation_shipstation"],
|
|
266
|
-
* })
|
|
267
|
-
* .then(({ stock_location }) => {
|
|
268
|
-
* console.log(stock_location)
|
|
269
|
-
* })
|
|
270
|
-
*/
|
|
271
|
-
updateFulfillmentProviders(id, body, headers) {
|
|
272
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
273
|
-
return yield this.client.fetch(`/admin/stock-locations/${id}/fulfillment-providers`, {
|
|
274
|
-
method: "POST",
|
|
275
|
-
headers,
|
|
276
|
-
body,
|
|
277
|
-
});
|
|
278
|
-
});
|
|
279
|
-
}
|
|
280
|
-
}
|
|
281
|
-
//# sourceMappingURL=stock-location.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"stock-location.js","sourceRoot":"","sources":["../../../src/admin/stock-location.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,QAAQ;gBAChB,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,0BAA0B,EAAE,EAAE,EAC9B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA8C,EAC9C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,mBAAmB,CACvB,EAAU,EACV,IAAqD,EACrD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,iBAAiB,EAC7C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,oBAAoB,CACxB,EAAU,EACV,IAAsD,EACtD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,mBAAmB,EAC/C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,0BAA0B,CAC9B,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
import { HttpTypes } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class TaxProvider {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method retrieves a list of tax providers. It sends a request to the
|
|
15
|
-
* [List Tax Providers](https://docs.acmekit.com/api/admin#tax-providers_gettaxproviders)
|
|
16
|
-
* API route.
|
|
17
|
-
*
|
|
18
|
-
* @since 2.8.0
|
|
19
|
-
*
|
|
20
|
-
* @param query - Filters and pagination configurations.
|
|
21
|
-
* @param headers - Headers to pass in the request.
|
|
22
|
-
* @returns The list of tax providers.
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* To retrieve the list of tax providers:
|
|
26
|
-
*
|
|
27
|
-
* ```ts
|
|
28
|
-
* sdk.admin.taxProvider.list()
|
|
29
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
30
|
-
* console.log(tax_providers)
|
|
31
|
-
* })
|
|
32
|
-
* ```
|
|
33
|
-
*
|
|
34
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
35
|
-
*
|
|
36
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
37
|
-
*
|
|
38
|
-
* ```ts
|
|
39
|
-
* sdk.admin.taxProvider.list({
|
|
40
|
-
* limit: 10,
|
|
41
|
-
* offset: 10,
|
|
42
|
-
* })
|
|
43
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
44
|
-
* console.log(tax_providers)
|
|
45
|
-
* })
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
49
|
-
* in each products:
|
|
50
|
-
*
|
|
51
|
-
* ```ts
|
|
52
|
-
* sdk.admin.taxProvider.list({
|
|
53
|
-
* fields: "id,*regions"
|
|
54
|
-
* })
|
|
55
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
56
|
-
* console.log(tax_providers)
|
|
57
|
-
* })
|
|
58
|
-
* ```
|
|
59
|
-
*
|
|
60
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
61
|
-
*/
|
|
62
|
-
list(query?: HttpTypes.AdminGetTaxProvidersParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxProviderListResponse>;
|
|
63
|
-
}
|
|
64
|
-
//# sourceMappingURL=tax-provider.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tax-provider.d.ts","sourceRoot":"","sources":["../../../src/admin/tax-provider.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;AAIxC,qBAAa,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
|
|
@@ -1,77 +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
|
-
const taxProviderUrl = "/admin/tax-providers";
|
|
11
|
-
export class TaxProvider {
|
|
12
|
-
/**
|
|
13
|
-
* @ignore
|
|
14
|
-
*/
|
|
15
|
-
constructor(client) {
|
|
16
|
-
this.client = client;
|
|
17
|
-
}
|
|
18
|
-
/**
|
|
19
|
-
* This method retrieves a list of tax providers. It sends a request to the
|
|
20
|
-
* [List Tax Providers](https://docs.acmekit.com/api/admin#tax-providers_gettaxproviders)
|
|
21
|
-
* API route.
|
|
22
|
-
*
|
|
23
|
-
* @since 2.8.0
|
|
24
|
-
*
|
|
25
|
-
* @param query - Filters and pagination configurations.
|
|
26
|
-
* @param headers - Headers to pass in the request.
|
|
27
|
-
* @returns The list of tax providers.
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* To retrieve the list of tax providers:
|
|
31
|
-
*
|
|
32
|
-
* ```ts
|
|
33
|
-
* sdk.admin.taxProvider.list()
|
|
34
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
35
|
-
* console.log(tax_providers)
|
|
36
|
-
* })
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
40
|
-
*
|
|
41
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
42
|
-
*
|
|
43
|
-
* ```ts
|
|
44
|
-
* sdk.admin.taxProvider.list({
|
|
45
|
-
* limit: 10,
|
|
46
|
-
* offset: 10,
|
|
47
|
-
* })
|
|
48
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
49
|
-
* console.log(tax_providers)
|
|
50
|
-
* })
|
|
51
|
-
* ```
|
|
52
|
-
*
|
|
53
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
54
|
-
* in each products:
|
|
55
|
-
*
|
|
56
|
-
* ```ts
|
|
57
|
-
* sdk.admin.taxProvider.list({
|
|
58
|
-
* fields: "id,*regions"
|
|
59
|
-
* })
|
|
60
|
-
* .then(({ tax_providers, count, limit, offset }) => {
|
|
61
|
-
* console.log(tax_providers)
|
|
62
|
-
* })
|
|
63
|
-
* ```
|
|
64
|
-
*
|
|
65
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
66
|
-
*/
|
|
67
|
-
list(query, headers) {
|
|
68
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
69
|
-
return yield this.client.fetch(taxProviderUrl, {
|
|
70
|
-
method: "GET",
|
|
71
|
-
headers,
|
|
72
|
-
query,
|
|
73
|
-
});
|
|
74
|
-
});
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
//# sourceMappingURL=tax-provider.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tax-provider.js","sourceRoot":"","sources":["../../../src/admin/tax-provider.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,cAAc,GAAG,sBAAsB,CAAA;AAE7C,MAAM,OAAO,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,IAAI,CACR,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,cAAc,EACd;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
|
|
@@ -1,155 +0,0 @@
|
|
|
1
|
-
import { HttpTypes } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class TaxRate {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method creates a tax rate. It sends a request to the
|
|
15
|
-
* [Create Tax Rate](https://docs.acmekit.com/api/admin#tax-rates_posttaxrates)
|
|
16
|
-
* API route.
|
|
17
|
-
*
|
|
18
|
-
* @param body - The details of the tax rate to create.
|
|
19
|
-
* @param query - Configure the fields and relations to retrieve in the tax rate.
|
|
20
|
-
* @param headers - Headers to pass in the request.
|
|
21
|
-
* @returns The tax rate's details.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* sdk.admin.taxRate.create({
|
|
25
|
-
* name: "VAT",
|
|
26
|
-
* tax_region_id: "txreg_123",
|
|
27
|
-
* code: "VAT",
|
|
28
|
-
* rate: 2, // 2%
|
|
29
|
-
* })
|
|
30
|
-
* .then(({ tax_rate }) => {
|
|
31
|
-
* console.log(tax_rate)
|
|
32
|
-
* })
|
|
33
|
-
*/
|
|
34
|
-
create(body: HttpTypes.AdminCreateTaxRate, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateResponse>;
|
|
35
|
-
/**
|
|
36
|
-
* This method updates a tax rate. It sends a request to the
|
|
37
|
-
* [Update Tax Rate](https://docs.acmekit.com/api/admin#tax-rates_posttaxratesid)
|
|
38
|
-
* API route.
|
|
39
|
-
*
|
|
40
|
-
* @param id - The ID of the tax rate to update.
|
|
41
|
-
* @param body - The details of the tax rate to update.
|
|
42
|
-
* @param query - Configure the fields and relations to retrieve in the tax rate.
|
|
43
|
-
* @param headers - Headers to pass in the request.
|
|
44
|
-
* @returns The tax rate's details.
|
|
45
|
-
*
|
|
46
|
-
* @example
|
|
47
|
-
* sdk.admin.taxRate.update("txrat_123", {
|
|
48
|
-
* name: "VAT",
|
|
49
|
-
* code: "VAT",
|
|
50
|
-
* })
|
|
51
|
-
* .then(({ tax_rate }) => {
|
|
52
|
-
* console.log(tax_rate)
|
|
53
|
-
* })
|
|
54
|
-
*/
|
|
55
|
-
update(id: string, body: HttpTypes.AdminUpdateTaxRate, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateResponse>;
|
|
56
|
-
/**
|
|
57
|
-
* This method deletes a tax rate. It sends a request to the
|
|
58
|
-
* [Delete Tax Rate](https://docs.acmekit.com/api/admin#tax-rates_deletetaxratesid)
|
|
59
|
-
* API route.
|
|
60
|
-
*
|
|
61
|
-
* @param id - The ID of the tax rate to delete.
|
|
62
|
-
* @param headers - Headers to pass in the request.
|
|
63
|
-
* @returns The deletion's details.
|
|
64
|
-
*
|
|
65
|
-
* @example
|
|
66
|
-
* sdk.admin.taxRate.delete("txrat_123")
|
|
67
|
-
* .then(({ deleted }) => {
|
|
68
|
-
* console.log(deleted)
|
|
69
|
-
* })
|
|
70
|
-
*/
|
|
71
|
-
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateDeleteResponse>;
|
|
72
|
-
/**
|
|
73
|
-
* This method retrieves a tax rate. It sends a request to the
|
|
74
|
-
* [Get Tax Rate](https://docs.acmekit.com/api/admin#tax-rates_gettaxratesid)
|
|
75
|
-
* API route.
|
|
76
|
-
*
|
|
77
|
-
* @param id - The ID of the tax rate to retrieve.
|
|
78
|
-
* @param query - Configure the fields and relations to retrieve in the tax rate.
|
|
79
|
-
* @param headers - Headers to pass in the request.
|
|
80
|
-
* @returns The tax rate's details.
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* To retrieve a tax rate by its ID:
|
|
84
|
-
*
|
|
85
|
-
* ```ts
|
|
86
|
-
* sdk.admin.taxRate.retrieve("txrat_123")
|
|
87
|
-
* .then(({ tax_rate }) => {
|
|
88
|
-
* console.log(tax_rate)
|
|
89
|
-
* })
|
|
90
|
-
* ```
|
|
91
|
-
*
|
|
92
|
-
* To specify the fields and relations to retrieve:
|
|
93
|
-
*
|
|
94
|
-
* ```ts
|
|
95
|
-
* sdk.admin.taxRate.retrieve("txrat_123", {
|
|
96
|
-
* fields: "id,*tax_region"
|
|
97
|
-
* })
|
|
98
|
-
* .then(({ tax_rate }) => {
|
|
99
|
-
* console.log(tax_rate)
|
|
100
|
-
* })
|
|
101
|
-
* ```
|
|
102
|
-
*
|
|
103
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
104
|
-
*/
|
|
105
|
-
retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateResponse>;
|
|
106
|
-
/**
|
|
107
|
-
* This method retrieves a list of tax rates. It sends a request to the
|
|
108
|
-
* [List Tax Rates](https://docs.acmekit.com/api/admin#tax-rates_gettaxrates)
|
|
109
|
-
* API route.
|
|
110
|
-
*
|
|
111
|
-
* @param query - Filters and pagination configurations.
|
|
112
|
-
* @param headers - Headers to pass in the request.
|
|
113
|
-
* @returns The list of tax rates.
|
|
114
|
-
*
|
|
115
|
-
* @example
|
|
116
|
-
* To retrieve the list of tax rates:
|
|
117
|
-
*
|
|
118
|
-
* ```ts
|
|
119
|
-
* sdk.admin.taxRate.list()
|
|
120
|
-
* .then(({ tax_rates, count, limit, offset }) => {
|
|
121
|
-
* console.log(tax_rates)
|
|
122
|
-
* })
|
|
123
|
-
* ```
|
|
124
|
-
*
|
|
125
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
126
|
-
*
|
|
127
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
128
|
-
*
|
|
129
|
-
* ```ts
|
|
130
|
-
* sdk.admin.taxRate.list({
|
|
131
|
-
* limit: 10,
|
|
132
|
-
* offset: 10
|
|
133
|
-
* })
|
|
134
|
-
* .then(({ tax_rates, count, limit, offset }) => {
|
|
135
|
-
* console.log(tax_rates)
|
|
136
|
-
* })
|
|
137
|
-
* ```
|
|
138
|
-
*
|
|
139
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
140
|
-
* in each tax rate:
|
|
141
|
-
*
|
|
142
|
-
* ```ts
|
|
143
|
-
* sdk.admin.taxRate.list({
|
|
144
|
-
* fields: "id,*tax_region"
|
|
145
|
-
* })
|
|
146
|
-
* .then(({ tax_rates, count, limit, offset }) => {
|
|
147
|
-
* console.log(tax_rates)
|
|
148
|
-
* })
|
|
149
|
-
* ```
|
|
150
|
-
*
|
|
151
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
|
|
152
|
-
*/
|
|
153
|
-
list(query?: HttpTypes.AdminTaxRateListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateListResponse>;
|
|
154
|
-
}
|
|
155
|
-
//# sourceMappingURL=tax-rate.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tax-rate.d.ts","sourceRoot":"","sources":["../../../src/admin/tax-rate.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;AAIxC,qBAAa,OAAO;IAClB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;CAW1B"}
|