@commercelayer/sdk 5.27.3 → 5.29.0-alfa.1
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/lib/cjs/api.d.ts +3 -2
- package/lib/cjs/api.js +5 -2
- package/lib/cjs/client.js +5 -5
- package/lib/cjs/commercelayer.d.ts +3 -2
- package/lib/cjs/commercelayer.js +5 -4
- package/lib/cjs/common.js +1 -1
- package/lib/cjs/error.js +1 -2
- package/lib/cjs/model.d.ts +1 -0
- package/lib/cjs/query.d.ts +1 -1
- package/lib/cjs/query.js +1 -1
- package/lib/cjs/resource.js +22 -25
- package/lib/cjs/resources/adjustments.d.ts +3 -0
- package/lib/cjs/resources/adyen_gateways.d.ts +2 -2
- package/lib/cjs/resources/avalara_accounts.d.ts +6 -6
- package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +11 -13
- package/lib/cjs/resources/buy_x_pay_y_promotions.js +6 -2
- package/lib/cjs/resources/external_gateways.d.ts +5 -1
- package/lib/cjs/resources/external_gateways.js +3 -0
- package/lib/cjs/resources/external_promotions.d.ts +15 -13
- package/lib/cjs/resources/external_promotions.js +9 -2
- package/lib/cjs/resources/external_tax_calculators.d.ts +4 -0
- package/lib/cjs/resources/external_tax_calculators.js +3 -0
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +11 -13
- package/lib/cjs/resources/fixed_amount_promotions.js +6 -2
- package/lib/cjs/resources/fixed_price_promotions.d.ts +11 -13
- package/lib/cjs/resources/fixed_price_promotions.js +6 -2
- package/lib/cjs/resources/free_gift_promotions.d.ts +11 -13
- package/lib/cjs/resources/free_gift_promotions.js +6 -2
- package/lib/cjs/resources/free_shipping_promotions.d.ts +17 -14
- package/lib/cjs/resources/free_shipping_promotions.js +6 -2
- package/lib/cjs/resources/gift_cards.d.ts +3 -0
- package/lib/cjs/resources/inventory_models.d.ts +3 -0
- package/lib/cjs/resources/line_items.d.ts +15 -4
- package/lib/cjs/resources/line_items.js +7 -0
- package/lib/cjs/resources/markets.d.ts +1 -1
- package/lib/cjs/resources/order_subscriptions.d.ts +1 -4
- package/lib/cjs/resources/orders.d.ts +16 -1
- package/lib/cjs/resources/orders.js +14 -0
- package/lib/cjs/resources/parcel_line_items.d.ts +0 -8
- package/lib/cjs/resources/payment_methods.d.ts +8 -5
- package/lib/cjs/resources/percentage_discount_promotions.d.ts +11 -13
- package/lib/cjs/resources/percentage_discount_promotions.js +6 -2
- package/lib/cjs/resources/promotions.d.ts +6 -3
- package/lib/cjs/resources/promotions.js +6 -2
- package/lib/cjs/resources/resource_errors.d.ts +22 -0
- package/lib/cjs/resources/resource_errors.js +16 -0
- package/lib/cjs/resources/shipments.d.ts +0 -4
- package/lib/cjs/resources/shipping_methods.d.ts +9 -5
- package/lib/cjs/resources/shipping_methods.js +3 -0
- package/lib/cjs/resources/stock_line_items.d.ts +6 -0
- package/lib/cjs/resources/stock_line_items.js +9 -0
- package/lib/cjs/resources/stock_reservations.d.ts +0 -1
- package/lib/cjs/resources/stock_transfers.d.ts +1 -1
- package/lib/cjs/resources/stripe_payments.d.ts +4 -1
- package/lib/cjs/resources/webhooks.d.ts +3 -3
- package/lib/cjs/resources/webhooks.js +3 -3
- package/lib/esm/api.d.ts +3 -2
- package/lib/esm/api.js +2 -0
- package/lib/esm/client.js +19 -30
- package/lib/esm/commercelayer.d.ts +3 -2
- package/lib/esm/commercelayer.js +261 -149
- package/lib/esm/common.js +1 -1
- package/lib/esm/error.js +10 -5
- package/lib/esm/model.d.ts +1 -0
- package/lib/esm/query.d.ts +1 -1
- package/lib/esm/query.js +1 -1
- package/lib/esm/resource.js +37 -50
- package/lib/esm/resources/addresses.js +1 -1
- package/lib/esm/resources/adjustments.d.ts +3 -0
- package/lib/esm/resources/adjustments.js +1 -1
- package/lib/esm/resources/adyen_gateways.d.ts +2 -2
- package/lib/esm/resources/adyen_gateways.js +1 -1
- package/lib/esm/resources/adyen_payments.js +1 -1
- package/lib/esm/resources/application.js +1 -1
- package/lib/esm/resources/attachments.js +1 -1
- package/lib/esm/resources/authorizations.js +1 -1
- package/lib/esm/resources/avalara_accounts.d.ts +6 -6
- package/lib/esm/resources/avalara_accounts.js +1 -1
- package/lib/esm/resources/axerve_gateways.js +1 -1
- package/lib/esm/resources/axerve_payments.js +1 -1
- package/lib/esm/resources/billing_info_validation_rules.js +1 -1
- package/lib/esm/resources/bing_geocoders.js +1 -1
- package/lib/esm/resources/braintree_gateways.js +1 -1
- package/lib/esm/resources/braintree_payments.js +1 -1
- package/lib/esm/resources/bundles.js +1 -1
- package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +11 -13
- package/lib/esm/resources/buy_x_pay_y_promotions.js +7 -3
- package/lib/esm/resources/captures.js +1 -1
- package/lib/esm/resources/carrier_accounts.js +1 -1
- package/lib/esm/resources/checkout_com_gateways.js +1 -1
- package/lib/esm/resources/checkout_com_payments.js +1 -1
- package/lib/esm/resources/cleanups.js +1 -1
- package/lib/esm/resources/coupon_codes_promotion_rules.js +1 -1
- package/lib/esm/resources/coupon_recipients.js +1 -1
- package/lib/esm/resources/coupons.js +1 -1
- package/lib/esm/resources/custom_promotion_rules.js +1 -1
- package/lib/esm/resources/customer_addresses.js +1 -1
- package/lib/esm/resources/customer_groups.js +1 -1
- package/lib/esm/resources/customer_password_resets.js +1 -1
- package/lib/esm/resources/customer_payment_sources.js +1 -1
- package/lib/esm/resources/customer_subscriptions.js +1 -1
- package/lib/esm/resources/customers.js +1 -1
- package/lib/esm/resources/delivery_lead_times.js +1 -1
- package/lib/esm/resources/event_callbacks.js +1 -1
- package/lib/esm/resources/events.js +1 -1
- package/lib/esm/resources/exports.js +1 -1
- package/lib/esm/resources/external_gateways.d.ts +5 -1
- package/lib/esm/resources/external_gateways.js +4 -1
- package/lib/esm/resources/external_payments.js +1 -1
- package/lib/esm/resources/external_promotions.d.ts +15 -13
- package/lib/esm/resources/external_promotions.js +10 -3
- package/lib/esm/resources/external_tax_calculators.d.ts +4 -0
- package/lib/esm/resources/external_tax_calculators.js +4 -1
- package/lib/esm/resources/fixed_amount_promotions.d.ts +11 -13
- package/lib/esm/resources/fixed_amount_promotions.js +7 -3
- package/lib/esm/resources/fixed_price_promotions.d.ts +11 -13
- package/lib/esm/resources/fixed_price_promotions.js +7 -3
- package/lib/esm/resources/free_gift_promotions.d.ts +11 -13
- package/lib/esm/resources/free_gift_promotions.js +7 -3
- package/lib/esm/resources/free_shipping_promotions.d.ts +17 -14
- package/lib/esm/resources/free_shipping_promotions.js +7 -3
- package/lib/esm/resources/geocoders.js +1 -1
- package/lib/esm/resources/gift_card_recipients.js +1 -1
- package/lib/esm/resources/gift_cards.d.ts +3 -0
- package/lib/esm/resources/gift_cards.js +1 -1
- package/lib/esm/resources/google_geocoders.js +1 -1
- package/lib/esm/resources/imports.js +1 -1
- package/lib/esm/resources/in_stock_subscriptions.js +1 -1
- package/lib/esm/resources/inventory_models.d.ts +3 -0
- package/lib/esm/resources/inventory_models.js +1 -1
- package/lib/esm/resources/inventory_return_locations.js +1 -1
- package/lib/esm/resources/inventory_stock_locations.js +1 -1
- package/lib/esm/resources/klarna_gateways.js +1 -1
- package/lib/esm/resources/klarna_payments.js +1 -1
- package/lib/esm/resources/line_item_options.js +1 -1
- package/lib/esm/resources/line_items.d.ts +15 -4
- package/lib/esm/resources/line_items.js +8 -1
- package/lib/esm/resources/manual_gateways.js +1 -1
- package/lib/esm/resources/manual_tax_calculators.js +1 -1
- package/lib/esm/resources/markets.d.ts +1 -1
- package/lib/esm/resources/markets.js +1 -1
- package/lib/esm/resources/merchants.js +1 -1
- package/lib/esm/resources/order_amount_promotion_rules.js +1 -1
- package/lib/esm/resources/order_copies.js +1 -1
- package/lib/esm/resources/order_factories.js +1 -1
- package/lib/esm/resources/order_subscription_items.js +1 -1
- package/lib/esm/resources/order_subscriptions.d.ts +1 -4
- package/lib/esm/resources/order_subscriptions.js +1 -1
- package/lib/esm/resources/order_validation_rules.js +1 -1
- package/lib/esm/resources/orders.d.ts +16 -1
- package/lib/esm/resources/orders.js +15 -1
- package/lib/esm/resources/organization.js +1 -1
- package/lib/esm/resources/packages.js +1 -1
- package/lib/esm/resources/parcel_line_items.d.ts +0 -8
- package/lib/esm/resources/parcel_line_items.js +1 -1
- package/lib/esm/resources/parcels.js +1 -1
- package/lib/esm/resources/payment_gateways.js +1 -1
- package/lib/esm/resources/payment_methods.d.ts +8 -5
- package/lib/esm/resources/payment_methods.js +1 -1
- package/lib/esm/resources/payment_options.js +1 -1
- package/lib/esm/resources/paypal_gateways.js +1 -1
- package/lib/esm/resources/paypal_payments.js +1 -1
- package/lib/esm/resources/percentage_discount_promotions.d.ts +11 -13
- package/lib/esm/resources/percentage_discount_promotions.js +7 -3
- package/lib/esm/resources/price_frequency_tiers.js +1 -1
- package/lib/esm/resources/price_lists.js +1 -1
- package/lib/esm/resources/price_tiers.js +1 -1
- package/lib/esm/resources/price_volume_tiers.js +1 -1
- package/lib/esm/resources/prices.js +1 -1
- package/lib/esm/resources/promotion_rules.js +1 -1
- package/lib/esm/resources/promotions.d.ts +6 -3
- package/lib/esm/resources/promotions.js +7 -3
- package/lib/esm/resources/recurring_order_copies.js +1 -1
- package/lib/esm/resources/refunds.js +1 -1
- package/lib/esm/resources/reserved_stocks.js +1 -1
- package/lib/esm/resources/resource_errors.d.ts +22 -0
- package/lib/esm/resources/resource_errors.js +14 -0
- package/lib/esm/resources/return_line_items.js +1 -1
- package/lib/esm/resources/returns.js +1 -1
- package/lib/esm/resources/satispay_gateways.js +1 -1
- package/lib/esm/resources/satispay_payments.js +1 -1
- package/lib/esm/resources/shipments.d.ts +0 -4
- package/lib/esm/resources/shipments.js +1 -1
- package/lib/esm/resources/shipping_categories.js +1 -1
- package/lib/esm/resources/shipping_method_tiers.js +1 -1
- package/lib/esm/resources/shipping_methods.d.ts +9 -5
- package/lib/esm/resources/shipping_methods.js +4 -1
- package/lib/esm/resources/shipping_weight_tiers.js +1 -1
- package/lib/esm/resources/shipping_zones.js +1 -1
- package/lib/esm/resources/sku_list_items.js +1 -1
- package/lib/esm/resources/sku_list_promotion_rules.js +1 -1
- package/lib/esm/resources/sku_lists.js +1 -1
- package/lib/esm/resources/sku_options.js +1 -1
- package/lib/esm/resources/skus.js +1 -1
- package/lib/esm/resources/stock_items.js +1 -1
- package/lib/esm/resources/stock_line_items.d.ts +6 -0
- package/lib/esm/resources/stock_line_items.js +10 -1
- package/lib/esm/resources/stock_locations.js +1 -1
- package/lib/esm/resources/stock_reservations.d.ts +0 -1
- package/lib/esm/resources/stock_reservations.js +1 -1
- package/lib/esm/resources/stock_transfers.d.ts +1 -1
- package/lib/esm/resources/stock_transfers.js +1 -1
- package/lib/esm/resources/stripe_gateways.js +1 -1
- package/lib/esm/resources/stripe_payments.d.ts +4 -1
- package/lib/esm/resources/stripe_payments.js +1 -1
- package/lib/esm/resources/subscription_models.js +1 -1
- package/lib/esm/resources/tags.js +1 -1
- package/lib/esm/resources/tax_calculators.js +1 -1
- package/lib/esm/resources/tax_categories.js +1 -1
- package/lib/esm/resources/tax_rules.js +1 -1
- package/lib/esm/resources/taxjar_accounts.js +1 -1
- package/lib/esm/resources/transactions.js +1 -1
- package/lib/esm/resources/versions.js +1 -1
- package/lib/esm/resources/voids.js +1 -1
- package/lib/esm/resources/webhooks.d.ts +3 -3
- package/lib/esm/resources/webhooks.js +4 -4
- package/lib/esm/resources/wire_transfers.js +1 -1
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +16 -16
@@ -44,6 +44,9 @@ interface StockLineItemCreate extends ResourceCreate {
|
|
44
44
|
interface StockLineItemUpdate extends ResourceUpdate {
|
45
45
|
sku_code?: string | null;
|
46
46
|
quantity?: number | null;
|
47
|
+
_reserve_stock?: boolean | null;
|
48
|
+
_release_stock?: boolean | null;
|
49
|
+
_decrement_stock?: boolean | null;
|
47
50
|
shipment?: ShipmentRel | null;
|
48
51
|
line_item?: LineItemRel | null;
|
49
52
|
stock_item?: StockItemRel | null;
|
@@ -59,6 +62,9 @@ declare class StockLineItems extends ApiResource<StockLineItem> {
|
|
59
62
|
stock_item(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
|
60
63
|
sku(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
|
61
64
|
versions(stockLineItemId: string | StockLineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
65
|
+
_reserve_stock(id: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
|
66
|
+
_release_stock(id: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
|
67
|
+
_decrement_stock(id: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
|
62
68
|
isStockLineItem(resource: any): resource is StockLineItem;
|
63
69
|
relationship(id: string | ResourceId | null): StockLineItemRel;
|
64
70
|
type(): StockLineItemType;
|
@@ -31,6 +31,15 @@ class StockLineItems extends resource_1.ApiResource {
|
|
31
31
|
const _stockLineItemId = stockLineItemId.id || stockLineItemId;
|
32
32
|
return this.resources.fetch({ type: 'versions' }, `stock_line_items/${_stockLineItemId}/versions`, params, options);
|
33
33
|
}
|
34
|
+
async _reserve_stock(id, params, options) {
|
35
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: StockLineItems.TYPE, _reserve_stock: true }, params, options);
|
36
|
+
}
|
37
|
+
async _release_stock(id, params, options) {
|
38
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: StockLineItems.TYPE, _release_stock: true }, params, options);
|
39
|
+
}
|
40
|
+
async _decrement_stock(id, params, options) {
|
41
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: StockLineItems.TYPE, _decrement_stock: true }, params, options);
|
42
|
+
}
|
34
43
|
isStockLineItem(resource) {
|
35
44
|
return resource.type && (resource.type === StockLineItems.TYPE);
|
36
45
|
}
|
@@ -31,7 +31,6 @@ interface StockReservationCreate extends ResourceCreate {
|
|
31
31
|
interface StockReservationUpdate extends ResourceUpdate {
|
32
32
|
quantity?: number | null;
|
33
33
|
_pending?: boolean | null;
|
34
|
-
stock_item?: StockItemRel | null;
|
35
34
|
}
|
36
35
|
declare class StockReservations extends ApiResource<StockReservation> {
|
37
36
|
static readonly TYPE: StockReservationType;
|
@@ -25,7 +25,7 @@ type LineItemRel = ResourceRel & {
|
|
25
25
|
};
|
26
26
|
interface StockTransfer extends Resource {
|
27
27
|
readonly type: StockTransferType;
|
28
|
-
number?:
|
28
|
+
number?: string | null;
|
29
29
|
sku_code?: string | null;
|
30
30
|
status: 'draft' | 'upcoming' | 'on_hold' | 'picking' | 'in_transit' | 'completed' | 'cancelled';
|
31
31
|
quantity: number;
|
@@ -13,7 +13,8 @@ type OrderRel = ResourceRel & {
|
|
13
13
|
};
|
14
14
|
interface StripePayment extends Resource {
|
15
15
|
readonly type: StripePaymentType;
|
16
|
-
|
16
|
+
stripe_id?: string | null;
|
17
|
+
client_secret?: string | null;
|
17
18
|
publishable_key?: string | null;
|
18
19
|
options?: Record<string, any> | null;
|
19
20
|
payment_method?: Record<string, any> | null;
|
@@ -29,6 +30,8 @@ interface StripePayment extends Resource {
|
|
29
30
|
versions?: Version[] | null;
|
30
31
|
}
|
31
32
|
interface StripePaymentCreate extends ResourceCreate {
|
33
|
+
stripe_id?: string | null;
|
34
|
+
client_secret?: string | null;
|
32
35
|
options?: Record<string, any> | null;
|
33
36
|
return_url?: string | null;
|
34
37
|
receipt_email?: string | null;
|
@@ -13,10 +13,10 @@ interface Webhook extends Resource {
|
|
13
13
|
topic: string;
|
14
14
|
callback_url: string;
|
15
15
|
include_resources?: string[] | null;
|
16
|
+
disabled_at?: string | null;
|
16
17
|
circuit_state?: string | null;
|
17
18
|
circuit_failure_count?: number | null;
|
18
19
|
shared_secret: string;
|
19
|
-
disabled_at?: string | null;
|
20
20
|
last_event_callbacks?: EventCallback[] | null;
|
21
21
|
versions?: Version[] | null;
|
22
22
|
}
|
@@ -33,9 +33,9 @@ interface WebhookUpdate extends ResourceUpdate {
|
|
33
33
|
topic?: string | null;
|
34
34
|
callback_url?: string | null;
|
35
35
|
include_resources?: string[] | null;
|
36
|
-
_reset_circuit?: boolean | null;
|
37
36
|
_disable?: boolean | null;
|
38
37
|
_enable?: boolean | null;
|
38
|
+
_reset_circuit?: boolean | null;
|
39
39
|
}
|
40
40
|
declare class Webhooks extends ApiResource<Webhook> {
|
41
41
|
static readonly TYPE: WebhookType;
|
@@ -44,9 +44,9 @@ declare class Webhooks extends ApiResource<Webhook> {
|
|
44
44
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
45
45
|
last_event_callbacks(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
|
46
46
|
versions(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
47
|
-
_reset_circuit(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
|
48
47
|
_disable(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
|
49
48
|
_enable(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
|
49
|
+
_reset_circuit(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
|
50
50
|
isWebhook(resource: any): resource is Webhook;
|
51
51
|
relationship(id: string | ResourceId | null): WebhookRel;
|
52
52
|
type(): WebhookType;
|
@@ -19,15 +19,15 @@ class Webhooks extends resource_1.ApiResource {
|
|
19
19
|
const _webhookId = webhookId.id || webhookId;
|
20
20
|
return this.resources.fetch({ type: 'versions' }, `webhooks/${_webhookId}/versions`, params, options);
|
21
21
|
}
|
22
|
-
async _reset_circuit(id, params, options) {
|
23
|
-
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _reset_circuit: true }, params, options);
|
24
|
-
}
|
25
22
|
async _disable(id, params, options) {
|
26
23
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _disable: true }, params, options);
|
27
24
|
}
|
28
25
|
async _enable(id, params, options) {
|
29
26
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _enable: true }, params, options);
|
30
27
|
}
|
28
|
+
async _reset_circuit(id, params, options) {
|
29
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _reset_circuit: true }, params, options);
|
30
|
+
}
|
31
31
|
isWebhook(resource) {
|
32
32
|
return resource.type && (resource.type === Webhooks.TYPE);
|
33
33
|
}
|
package/lib/esm/api.d.ts
CHANGED
@@ -91,6 +91,7 @@ export { default as Promotions } from './resources/promotions';
|
|
91
91
|
export { default as RecurringOrderCopies } from './resources/recurring_order_copies';
|
92
92
|
export { default as Refunds } from './resources/refunds';
|
93
93
|
export { default as ReservedStocks } from './resources/reserved_stocks';
|
94
|
+
export { default as ResourceErrors } from './resources/resource_errors';
|
94
95
|
export { default as ReturnLineItems } from './resources/return_line_items';
|
95
96
|
export { default as Returns } from './resources/returns';
|
96
97
|
export { default as SatispayGateways } from './resources/satispay_gateways';
|
@@ -124,8 +125,8 @@ export { default as Versions } from './resources/versions';
|
|
124
125
|
export { default as Voids } from './resources/voids';
|
125
126
|
export { default as Webhooks } from './resources/webhooks';
|
126
127
|
export { default as WireTransfers } from './resources/wire_transfers';
|
127
|
-
export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'custom_promotion_rules' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'reserved_stocks' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_reservations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'versions' | 'voids' | 'webhooks' | 'wire_transfers';
|
128
|
-
export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "buy_x_pay_y_promotions", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "custom_promotion_rules", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "payment_options", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_frequency_tiers", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "recurring_order_copies", "refunds", "reserved_stocks", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_reservations", "stock_transfers", "stripe_gateways", "stripe_payments", "subscription_models", "tags", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "versions", "voids", "webhooks", "wire_transfers"];
|
128
|
+
export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'custom_promotion_rules' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'reserved_stocks' | 'resource_errors' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_reservations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'versions' | 'voids' | 'webhooks' | 'wire_transfers';
|
129
|
+
export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "buy_x_pay_y_promotions", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "custom_promotion_rules", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "payment_options", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_frequency_tiers", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "recurring_order_copies", "refunds", "reserved_stocks", "resource_errors", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_reservations", "stock_transfers", "stripe_gateways", "stripe_payments", "subscription_models", "tags", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "versions", "voids", "webhooks", "wire_transfers"];
|
129
130
|
export declare const singletonList: readonly ["application", "organization"];
|
130
131
|
export type RetrievableResourceType = ResourceTypeLock;
|
131
132
|
export type RetrievableResource = Resource & {
|
package/lib/esm/api.js
CHANGED
@@ -90,6 +90,7 @@ export { default as Promotions } from './resources/promotions';
|
|
90
90
|
export { default as RecurringOrderCopies } from './resources/recurring_order_copies';
|
91
91
|
export { default as Refunds } from './resources/refunds';
|
92
92
|
export { default as ReservedStocks } from './resources/reserved_stocks';
|
93
|
+
export { default as ResourceErrors } from './resources/resource_errors';
|
93
94
|
export { default as ReturnLineItems } from './resources/return_line_items';
|
94
95
|
export { default as Returns } from './resources/returns';
|
95
96
|
export { default as SatispayGateways } from './resources/satispay_gateways';
|
@@ -213,6 +214,7 @@ export const resourceList = [
|
|
213
214
|
'recurring_order_copies',
|
214
215
|
'refunds',
|
215
216
|
'reserved_stocks',
|
217
|
+
'resource_errors',
|
216
218
|
'return_line_items',
|
217
219
|
'returns',
|
218
220
|
'satispay_gateways',
|
package/lib/esm/client.js
CHANGED
@@ -1,15 +1,3 @@
|
|
1
|
-
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
2
|
-
if (kind === "m") throw new TypeError("Private method is not writable");
|
3
|
-
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
4
|
-
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
|
5
|
-
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
6
|
-
};
|
7
|
-
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
8
|
-
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
9
|
-
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
10
|
-
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
11
|
-
};
|
12
|
-
var _ApiClient_accessToken, _ApiClient_client;
|
13
1
|
import axios from 'axios';
|
14
2
|
import { SdkError, handleError } from './error';
|
15
3
|
import config from './config';
|
@@ -28,12 +16,14 @@ class ApiClient {
|
|
28
16
|
throw new SdkError({ message: `Undefined '${attr}' parameter` });
|
29
17
|
return new ApiClient(options);
|
30
18
|
}
|
19
|
+
baseUrl;
|
20
|
+
#accessToken;
|
21
|
+
#client;
|
22
|
+
interceptors;
|
31
23
|
constructor(options) {
|
32
|
-
_ApiClient_accessToken.set(this, void 0);
|
33
|
-
_ApiClient_client.set(this, void 0);
|
34
24
|
debug('new client instance %O', options);
|
35
25
|
this.baseUrl = baseURL(options.organization, options.domain);
|
36
|
-
|
26
|
+
this.#accessToken = options.accessToken;
|
37
27
|
const axiosConfig = {
|
38
28
|
timeout: options.timeout || config.client.timeout,
|
39
29
|
proxy: options.proxy,
|
@@ -47,7 +37,7 @@ class ApiClient {
|
|
47
37
|
...customHeaders,
|
48
38
|
'Accept': 'application/vnd.api+json',
|
49
39
|
'Content-Type': 'application/vnd.api+json',
|
50
|
-
'Authorization': 'Bearer ' +
|
40
|
+
'Authorization': 'Bearer ' + this.#accessToken
|
51
41
|
};
|
52
42
|
// Set User-Agent
|
53
43
|
let userAgent = options.userAgent; // || `SDK-core axios/${axios.VERSION}`
|
@@ -65,12 +55,12 @@ class ApiClient {
|
|
65
55
|
if (options.adapter)
|
66
56
|
axiosOptions.adapter = options.adapter;
|
67
57
|
debug('axios options: %O', axiosOptions);
|
68
|
-
|
69
|
-
this.interceptors =
|
58
|
+
this.#client = axios.create(axiosOptions);
|
59
|
+
this.interceptors = this.#client.interceptors;
|
70
60
|
}
|
71
61
|
config(config) {
|
72
62
|
debug('config %o', config);
|
73
|
-
const def =
|
63
|
+
const def = this.#client.defaults;
|
74
64
|
// Axios config
|
75
65
|
if (config.timeout)
|
76
66
|
def.timeout = config.timeout;
|
@@ -88,8 +78,8 @@ class ApiClient {
|
|
88
78
|
if (config.organization)
|
89
79
|
this.baseUrl = baseURL(config.organization, config.domain);
|
90
80
|
if (config.accessToken) {
|
91
|
-
|
92
|
-
def.headers.common.Authorization = 'Bearer ' +
|
81
|
+
this.#accessToken = config.accessToken;
|
82
|
+
def.headers.common.Authorization = 'Bearer ' + this.#accessToken;
|
93
83
|
}
|
94
84
|
if (config.headers)
|
95
85
|
def.headers.common = this.customHeaders(config.headers);
|
@@ -103,34 +93,34 @@ class ApiClient {
|
|
103
93
|
if (axios.VERSION)
|
104
94
|
ua += ` axios/${axios.VERSION}`;
|
105
95
|
}
|
106
|
-
|
96
|
+
this.#client.defaults.headers['User-Agent'] = ua;
|
107
97
|
}
|
108
98
|
return this;
|
109
99
|
}
|
110
100
|
adapter(adapter) {
|
111
101
|
if (adapter)
|
112
|
-
|
102
|
+
this.#client.defaults.adapter = adapter;
|
113
103
|
return this;
|
114
104
|
}
|
115
105
|
async request(method, path, body, options) {
|
116
106
|
debug('request %s %s, %O, %O', method, path, body || {}, options || {});
|
117
107
|
// Ignored params alerts (in debug mode)
|
118
|
-
if (options
|
108
|
+
if (options?.adapter)
|
119
109
|
debug('Adapter ignored in request config');
|
120
|
-
if (options
|
110
|
+
if (options?.userAgent)
|
121
111
|
debug('User-Agent header ignored in request config');
|
122
112
|
const data = body ? { data: body } : undefined;
|
123
113
|
const url = path;
|
124
114
|
// Runtime request parameters
|
125
|
-
const baseUrl =
|
126
|
-
const accessToken =
|
127
|
-
const headers = this.customHeaders(options
|
115
|
+
const baseUrl = options?.organization ? baseURL(options.organization, options.domain) : undefined;
|
116
|
+
const accessToken = options?.accessToken || this.#accessToken;
|
117
|
+
const headers = this.customHeaders(options?.headers);
|
128
118
|
if (accessToken)
|
129
119
|
headers.Authorization = 'Bearer ' + accessToken;
|
130
120
|
const requestParams = { method, baseURL: baseUrl, url, data, ...options, headers };
|
131
121
|
debug('request params: %O', requestParams);
|
132
122
|
// const start = Date.now()
|
133
|
-
return
|
123
|
+
return this.#client.request(requestParams)
|
134
124
|
.then(response => response.data)
|
135
125
|
.catch((error) => handleError(error));
|
136
126
|
// .finally(() => console.log(`<<-- ${method} ${path} ${Date.now() - start}`))
|
@@ -145,5 +135,4 @@ class ApiClient {
|
|
145
135
|
return customHeaders;
|
146
136
|
}
|
147
137
|
}
|
148
|
-
_ApiClient_accessToken = new WeakMap(), _ApiClient_client = new WeakMap();
|
149
138
|
export default ApiClient;
|
@@ -2,14 +2,14 @@ import * as api from './api';
|
|
2
2
|
import type { ApiError } from './error';
|
3
3
|
import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
|
4
4
|
import { type ResourcesInitConfig } from './resource';
|
5
|
-
declare const OPEN_API_SCHEMA_VERSION = "
|
5
|
+
declare const OPEN_API_SCHEMA_VERSION = "5.0.0";
|
6
6
|
export { OPEN_API_SCHEMA_VERSION };
|
7
7
|
type SdkConfig = {};
|
8
8
|
type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
9
9
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
10
10
|
declare class CommerceLayerClient {
|
11
11
|
#private;
|
12
|
-
readonly openApiSchemaVersion = "
|
12
|
+
readonly openApiSchemaVersion = "5.0.0";
|
13
13
|
addresses: api.Addresses;
|
14
14
|
adjustments: api.Adjustments;
|
15
15
|
adyen_gateways: api.AdyenGateways;
|
@@ -97,6 +97,7 @@ declare class CommerceLayerClient {
|
|
97
97
|
recurring_order_copies: api.RecurringOrderCopies;
|
98
98
|
refunds: api.Refunds;
|
99
99
|
reserved_stocks: api.ReservedStocks;
|
100
|
+
resource_errors: api.ResourceErrors;
|
100
101
|
return_line_items: api.ReturnLineItems;
|
101
102
|
returns: api.Returns;
|
102
103
|
satispay_gateways: api.SatispayGateways;
|