@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
@@ -16,6 +16,7 @@ interface InventoryModel extends Resource {
|
|
16
16
|
stock_locations_cutoff?: number | null;
|
17
17
|
stock_reservation_cutoff?: number | null;
|
18
18
|
put_stock_transfers_on_hold?: boolean | null;
|
19
|
+
manual_stock_decrement?: boolean | null;
|
19
20
|
inventory_stock_locations?: InventoryStockLocation[] | null;
|
20
21
|
inventory_return_locations?: InventoryReturnLocation[] | null;
|
21
22
|
attachments?: Attachment[] | null;
|
@@ -27,6 +28,7 @@ interface InventoryModelCreate extends ResourceCreate {
|
|
27
28
|
stock_locations_cutoff?: number | null;
|
28
29
|
stock_reservation_cutoff?: number | null;
|
29
30
|
put_stock_transfers_on_hold?: boolean | null;
|
31
|
+
manual_stock_decrement?: boolean | null;
|
30
32
|
}
|
31
33
|
interface InventoryModelUpdate extends ResourceUpdate {
|
32
34
|
name?: string | null;
|
@@ -34,6 +36,7 @@ interface InventoryModelUpdate extends ResourceUpdate {
|
|
34
36
|
stock_locations_cutoff?: number | null;
|
35
37
|
stock_reservation_cutoff?: number | null;
|
36
38
|
put_stock_transfers_on_hold?: boolean | null;
|
39
|
+
manual_stock_decrement?: boolean | null;
|
37
40
|
}
|
38
41
|
declare class InventoryModels extends ApiResource<InventoryModel> {
|
39
42
|
static readonly TYPE: InventoryModelType;
|
@@ -13,6 +13,7 @@ import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } fro
|
|
13
13
|
import type { Shipment, ShipmentType } from './shipments';
|
14
14
|
import type { Sku, SkuType } from './skus';
|
15
15
|
import type { LineItemOption } from './line_item_options';
|
16
|
+
import type { ReturnLineItem } from './return_line_items';
|
16
17
|
import type { StockReservation } from './stock_reservations';
|
17
18
|
import type { StockLineItem } from './stock_line_items';
|
18
19
|
import type { StockTransfer } from './stock_transfers';
|
@@ -91,15 +92,18 @@ interface LineItem extends Resource {
|
|
91
92
|
item_type?: 'skus' | 'bundles' | 'shipments' | 'payment_methods' | 'adjustments' | 'gift_cards' | 'percentage_discount_promotions' | 'free_shipping_promotions' | 'free_gift_promotions' | 'fixed_price_promotions' | 'external_promotions' | 'fixed_amount_promotions' | null;
|
92
93
|
frequency?: string | null;
|
93
94
|
coupon_code?: string | null;
|
95
|
+
circuit_state?: string | null;
|
96
|
+
circuit_failure_count?: number | null;
|
94
97
|
order?: Order | null;
|
95
98
|
item?: Adjustment | Bundle | ExternalPromotion | FixedAmountPromotion | FreeShippingPromotion | GiftCard | PaymentMethod | PercentageDiscountPromotion | Shipment | Sku | null;
|
96
99
|
sku?: Sku | null;
|
97
100
|
bundle?: Bundle | null;
|
101
|
+
adjustment?: Adjustment | null;
|
102
|
+
gift_card?: GiftCard | null;
|
103
|
+
shipment?: Shipment | null;
|
104
|
+
payment_method?: PaymentMethod | null;
|
98
105
|
line_item_options?: LineItemOption[] | null;
|
99
|
-
|
100
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
101
|
-
*/
|
102
|
-
shipment_line_items?: object[];
|
106
|
+
return_line_items?: ReturnLineItem[] | null;
|
103
107
|
stock_reservations?: StockReservation[] | null;
|
104
108
|
stock_line_items?: StockLineItem[] | null;
|
105
109
|
stock_transfers?: StockTransfer[] | null;
|
@@ -123,6 +127,10 @@ interface LineItemCreate extends ResourceCreate {
|
|
123
127
|
item?: AdjustmentRel | BundleRel | ExternalPromotionRel | FixedAmountPromotionRel | FreeShippingPromotionRel | GiftCardRel | PaymentMethodRel | PercentageDiscountPromotionRel | ShipmentRel | SkuRel | null;
|
124
128
|
sku?: SkuRel | null;
|
125
129
|
bundle?: BundleRel | null;
|
130
|
+
adjustment?: AdjustmentRel | null;
|
131
|
+
gift_card?: GiftCardRel | null;
|
132
|
+
shipment?: ShipmentRel | null;
|
133
|
+
payment_method?: PaymentMethodRel | null;
|
126
134
|
tags?: TagRel[] | null;
|
127
135
|
}
|
128
136
|
interface LineItemUpdate extends ResourceUpdate {
|
@@ -135,6 +143,7 @@ interface LineItemUpdate extends ResourceUpdate {
|
|
135
143
|
name?: string | null;
|
136
144
|
image_url?: string | null;
|
137
145
|
frequency?: string | null;
|
146
|
+
_reset_circuit?: boolean | null;
|
138
147
|
tags?: TagRel[] | null;
|
139
148
|
}
|
140
149
|
declare class LineItems extends ApiResource<LineItem> {
|
@@ -144,6 +153,7 @@ declare class LineItems extends ApiResource<LineItem> {
|
|
144
153
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
145
154
|
order(lineItemId: string | LineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
146
155
|
line_item_options(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItemOption>>;
|
156
|
+
return_line_items(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
|
147
157
|
stock_reservations(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
148
158
|
stock_line_items(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
|
149
159
|
stock_transfers(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
|
@@ -151,6 +161,7 @@ declare class LineItems extends ApiResource<LineItem> {
|
|
151
161
|
tags(lineItemId: string | LineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
152
162
|
_external_price(id: string | LineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
|
153
163
|
_reserve_stock(id: string | LineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
|
164
|
+
_reset_circuit(id: string | LineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
|
154
165
|
isLineItem(resource: any): resource is LineItem;
|
155
166
|
relationship(id: string | ResourceId | null): LineItemRel;
|
156
167
|
type(): LineItemType;
|
@@ -19,6 +19,10 @@ class LineItems extends resource_1.ApiResource {
|
|
19
19
|
const _lineItemId = lineItemId.id || lineItemId;
|
20
20
|
return this.resources.fetch({ type: 'line_item_options' }, `line_items/${_lineItemId}/line_item_options`, params, options);
|
21
21
|
}
|
22
|
+
async return_line_items(lineItemId, params, options) {
|
23
|
+
const _lineItemId = lineItemId.id || lineItemId;
|
24
|
+
return this.resources.fetch({ type: 'return_line_items' }, `line_items/${_lineItemId}/return_line_items`, params, options);
|
25
|
+
}
|
22
26
|
async stock_reservations(lineItemId, params, options) {
|
23
27
|
const _lineItemId = lineItemId.id || lineItemId;
|
24
28
|
return this.resources.fetch({ type: 'stock_reservations' }, `line_items/${_lineItemId}/stock_reservations`, params, options);
|
@@ -45,6 +49,9 @@ class LineItems extends resource_1.ApiResource {
|
|
45
49
|
async _reserve_stock(id, params, options) {
|
46
50
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: LineItems.TYPE, _reserve_stock: true }, params, options);
|
47
51
|
}
|
52
|
+
async _reset_circuit(id, params, options) {
|
53
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: LineItems.TYPE, _reset_circuit: true }, params, options);
|
54
|
+
}
|
48
55
|
isLineItem(resource) {
|
49
56
|
return resource.type && (resource.type === LineItems.TYPE);
|
50
57
|
}
|
@@ -40,9 +40,9 @@ interface Market extends Resource {
|
|
40
40
|
checkout_url?: string | null;
|
41
41
|
external_prices_url?: string | null;
|
42
42
|
external_order_validation_url?: string | null;
|
43
|
-
shared_secret: string;
|
44
43
|
private?: boolean | null;
|
45
44
|
disabled_at?: string | null;
|
45
|
+
shared_secret: string;
|
46
46
|
merchant?: Merchant | null;
|
47
47
|
price_list?: PriceList | null;
|
48
48
|
inventory_model?: InventoryModel | null;
|
@@ -33,6 +33,7 @@ interface OrderSubscription extends Resource {
|
|
33
33
|
customer_email?: string | null;
|
34
34
|
starts_at?: string | null;
|
35
35
|
expires_at?: string | null;
|
36
|
+
last_run_at?: string | null;
|
36
37
|
next_run_at?: string | null;
|
37
38
|
occurrencies?: number | null;
|
38
39
|
errors_count?: number | null;
|
@@ -45,10 +46,6 @@ interface OrderSubscription extends Resource {
|
|
45
46
|
customer_payment_source?: CustomerPaymentSource | null;
|
46
47
|
order_subscription_items?: OrderSubscriptionItem[] | null;
|
47
48
|
order_factories?: OrderFactory[] | null;
|
48
|
-
/**
|
49
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
50
|
-
*/
|
51
|
-
order_copies?: object[];
|
52
49
|
recurring_order_copies?: RecurringOrderCopy[] | null;
|
53
50
|
orders?: Order[] | null;
|
54
51
|
events?: Event[] | null;
|
@@ -35,6 +35,7 @@ import type { OrderFactory } from './order_factories';
|
|
35
35
|
import type { OrderCopy } from './order_copies';
|
36
36
|
import type { RecurringOrderCopy } from './recurring_order_copies';
|
37
37
|
import type { Attachment } from './attachments';
|
38
|
+
import type { ResourceError } from './resource_errors';
|
38
39
|
import type { Event } from './events';
|
39
40
|
import type { Tag, TagType } from './tags';
|
40
41
|
import type { Version } from './versions';
|
@@ -91,7 +92,8 @@ interface Order extends Resource {
|
|
91
92
|
readonly type: OrderType;
|
92
93
|
number?: string | null;
|
93
94
|
autorefresh?: boolean | null;
|
94
|
-
|
95
|
+
place_async?: boolean | null;
|
96
|
+
status: 'draft' | 'pending' | 'placing' | 'placed' | 'editing' | 'approved' | 'cancelled';
|
95
97
|
payment_status: 'unpaid' | 'authorized' | 'partially_authorized' | 'paid' | 'partially_paid' | 'voided' | 'partially_voided' | 'refunded' | 'partially_refunded' | 'free';
|
96
98
|
fulfillment_status: 'unfulfilled' | 'in_progress' | 'fulfilled' | 'not_required';
|
97
99
|
guest?: boolean | null;
|
@@ -178,6 +180,7 @@ interface Order extends Resource {
|
|
178
180
|
shipments_count?: number | null;
|
179
181
|
tax_calculations_count?: number | null;
|
180
182
|
validations_count?: number | null;
|
183
|
+
errors_count?: number | null;
|
181
184
|
payment_source_details?: Record<string, any> | null;
|
182
185
|
token?: string | null;
|
183
186
|
cart_url?: string | null;
|
@@ -194,6 +197,8 @@ interface Order extends Resource {
|
|
194
197
|
archived_at?: string | null;
|
195
198
|
expires_at?: string | null;
|
196
199
|
subscription_created_at?: string | null;
|
200
|
+
circuit_state?: string | null;
|
201
|
+
circuit_failure_count?: number | null;
|
197
202
|
market?: Market | null;
|
198
203
|
customer?: Customer | null;
|
199
204
|
shipping_address?: Address | null;
|
@@ -217,11 +222,13 @@ interface Order extends Resource {
|
|
217
222
|
voids?: Void[] | null;
|
218
223
|
refunds?: Refund[] | null;
|
219
224
|
returns?: Return[] | null;
|
225
|
+
order_subscription?: OrderSubscription | null;
|
220
226
|
order_subscriptions?: OrderSubscription[] | null;
|
221
227
|
order_factories?: OrderFactory[] | null;
|
222
228
|
order_copies?: OrderCopy[] | null;
|
223
229
|
recurring_order_copies?: RecurringOrderCopy[] | null;
|
224
230
|
attachments?: Attachment[] | null;
|
231
|
+
resource_errors?: ResourceError[] | null;
|
225
232
|
events?: Event[] | null;
|
226
233
|
tags?: Tag[] | null;
|
227
234
|
versions?: Version[] | null;
|
@@ -229,6 +236,7 @@ interface Order extends Resource {
|
|
229
236
|
interface OrderCreate extends ResourceCreate {
|
230
237
|
number?: string | null;
|
231
238
|
autorefresh?: boolean | null;
|
239
|
+
place_async?: boolean | null;
|
232
240
|
guest?: boolean | null;
|
233
241
|
customer_email?: string | null;
|
234
242
|
customer_password?: string | null;
|
@@ -255,6 +263,7 @@ interface OrderCreate extends ResourceCreate {
|
|
255
263
|
interface OrderUpdate extends ResourceUpdate {
|
256
264
|
number?: string | null;
|
257
265
|
autorefresh?: boolean | null;
|
266
|
+
place_async?: boolean | null;
|
258
267
|
guest?: boolean | null;
|
259
268
|
customer_email?: string | null;
|
260
269
|
customer_password?: string | null;
|
@@ -272,6 +281,7 @@ interface OrderUpdate extends ResourceUpdate {
|
|
272
281
|
privacy_url?: string | null;
|
273
282
|
_archive?: boolean | null;
|
274
283
|
_unarchive?: boolean | null;
|
284
|
+
_pending?: boolean | null;
|
275
285
|
_place?: boolean | null;
|
276
286
|
_cancel?: boolean | null;
|
277
287
|
_approve?: boolean | null;
|
@@ -297,6 +307,7 @@ interface OrderUpdate extends ResourceUpdate {
|
|
297
307
|
_create_subscriptions?: boolean | null;
|
298
308
|
_start_editing?: boolean | null;
|
299
309
|
_stop_editing?: boolean | null;
|
310
|
+
_reset_circuit?: boolean | null;
|
300
311
|
market?: MarketRel | null;
|
301
312
|
customer?: CustomerRel | null;
|
302
313
|
shipping_address?: AddressRel | null;
|
@@ -331,16 +342,19 @@ declare class Orders extends ApiResource<Order> {
|
|
331
342
|
voids(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
|
332
343
|
refunds(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
|
333
344
|
returns(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
|
345
|
+
order_subscription(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
334
346
|
order_subscriptions(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
|
335
347
|
order_factories(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderFactory>>;
|
336
348
|
order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
|
337
349
|
recurring_order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<RecurringOrderCopy>>;
|
338
350
|
attachments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
351
|
+
resource_errors(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ResourceError>>;
|
339
352
|
events(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
340
353
|
tags(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
341
354
|
versions(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
342
355
|
_archive(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
343
356
|
_unarchive(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
357
|
+
_pending(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
344
358
|
_place(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
345
359
|
_cancel(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
346
360
|
_approve(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
@@ -366,6 +380,7 @@ declare class Orders extends ApiResource<Order> {
|
|
366
380
|
_create_subscriptions(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
367
381
|
_start_editing(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
368
382
|
_stop_editing(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
383
|
+
_reset_circuit(id: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
369
384
|
isOrder(resource: any): resource is Order;
|
370
385
|
relationship(id: string | ResourceId | null): OrderRel;
|
371
386
|
type(): OrderType;
|
@@ -95,6 +95,10 @@ class Orders extends resource_1.ApiResource {
|
|
95
95
|
const _orderId = orderId.id || orderId;
|
96
96
|
return this.resources.fetch({ type: 'returns' }, `orders/${_orderId}/returns`, params, options);
|
97
97
|
}
|
98
|
+
async order_subscription(orderId, params, options) {
|
99
|
+
const _orderId = orderId.id || orderId;
|
100
|
+
return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscription`, params, options);
|
101
|
+
}
|
98
102
|
async order_subscriptions(orderId, params, options) {
|
99
103
|
const _orderId = orderId.id || orderId;
|
100
104
|
return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
|
@@ -115,6 +119,10 @@ class Orders extends resource_1.ApiResource {
|
|
115
119
|
const _orderId = orderId.id || orderId;
|
116
120
|
return this.resources.fetch({ type: 'attachments' }, `orders/${_orderId}/attachments`, params, options);
|
117
121
|
}
|
122
|
+
async resource_errors(orderId, params, options) {
|
123
|
+
const _orderId = orderId.id || orderId;
|
124
|
+
return this.resources.fetch({ type: 'resource_errors' }, `orders/${_orderId}/resource_errors`, params, options);
|
125
|
+
}
|
118
126
|
async events(orderId, params, options) {
|
119
127
|
const _orderId = orderId.id || orderId;
|
120
128
|
return this.resources.fetch({ type: 'events' }, `orders/${_orderId}/events`, params, options);
|
@@ -133,6 +141,9 @@ class Orders extends resource_1.ApiResource {
|
|
133
141
|
async _unarchive(id, params, options) {
|
134
142
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _unarchive: true }, params, options);
|
135
143
|
}
|
144
|
+
async _pending(id, params, options) {
|
145
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _pending: true }, params, options);
|
146
|
+
}
|
136
147
|
async _place(id, params, options) {
|
137
148
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _place: true }, params, options);
|
138
149
|
}
|
@@ -208,6 +219,9 @@ class Orders extends resource_1.ApiResource {
|
|
208
219
|
async _stop_editing(id, params, options) {
|
209
220
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _stop_editing: true }, params, options);
|
210
221
|
}
|
222
|
+
async _reset_circuit(id, params, options) {
|
223
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _reset_circuit: true }, params, options);
|
224
|
+
}
|
211
225
|
isOrder(resource) {
|
212
226
|
return resource.type && (resource.type === Orders.TYPE);
|
213
227
|
}
|
@@ -23,20 +23,12 @@ interface ParcelLineItem extends Resource {
|
|
23
23
|
image_url?: string | null;
|
24
24
|
parcel?: Parcel | null;
|
25
25
|
stock_line_item?: StockLineItem | null;
|
26
|
-
/**
|
27
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
28
|
-
*/
|
29
|
-
shipment_line_item?: object;
|
30
26
|
versions?: Version[] | null;
|
31
27
|
}
|
32
28
|
interface ParcelLineItemCreate extends ResourceCreate {
|
33
29
|
quantity: number;
|
34
30
|
parcel: ParcelRel;
|
35
31
|
stock_line_item: StockLineItemRel;
|
36
|
-
/**
|
37
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
38
|
-
*/
|
39
|
-
shipment_line_item?: object;
|
40
32
|
}
|
41
33
|
type ParcelLineItemUpdate = ResourceUpdate;
|
42
34
|
declare class ParcelLineItems extends ApiResource<ParcelLineItem> {
|
@@ -22,14 +22,15 @@ interface PaymentMethod extends Resource {
|
|
22
22
|
currency_code?: string | null;
|
23
23
|
moto?: boolean | null;
|
24
24
|
require_capture?: boolean | null;
|
25
|
+
auto_place?: boolean | null;
|
25
26
|
auto_capture?: boolean | null;
|
26
|
-
disabled_at?: string | null;
|
27
27
|
price_amount_cents: number;
|
28
28
|
price_amount_float?: number | null;
|
29
29
|
formatted_price_amount?: string | null;
|
30
30
|
auto_capture_max_amount_cents?: number | null;
|
31
31
|
auto_capture_max_amount_float?: number | null;
|
32
32
|
formatted_auto_capture_max_amount?: string | null;
|
33
|
+
disabled_at?: string | null;
|
33
34
|
market?: Market | null;
|
34
35
|
payment_gateway?: PaymentGateway | null;
|
35
36
|
attachments?: Attachment[] | null;
|
@@ -40,11 +41,12 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
40
41
|
currency_code?: string | null;
|
41
42
|
moto?: boolean | null;
|
42
43
|
require_capture?: boolean | null;
|
44
|
+
auto_place?: boolean | null;
|
43
45
|
auto_capture?: boolean | null;
|
44
|
-
_disable?: boolean | null;
|
45
|
-
_enable?: boolean | null;
|
46
46
|
price_amount_cents: number;
|
47
47
|
auto_capture_max_amount_cents?: number | null;
|
48
|
+
_disable?: boolean | null;
|
49
|
+
_enable?: boolean | null;
|
48
50
|
market?: MarketRel | null;
|
49
51
|
payment_gateway: PaymentGatewayRel;
|
50
52
|
}
|
@@ -53,11 +55,12 @@ interface PaymentMethodUpdate extends ResourceUpdate {
|
|
53
55
|
currency_code?: string | null;
|
54
56
|
moto?: boolean | null;
|
55
57
|
require_capture?: boolean | null;
|
58
|
+
auto_place?: boolean | null;
|
56
59
|
auto_capture?: boolean | null;
|
57
|
-
_disable?: boolean | null;
|
58
|
-
_enable?: boolean | null;
|
59
60
|
price_amount_cents?: number | null;
|
60
61
|
auto_capture_max_amount_cents?: number | null;
|
62
|
+
_disable?: boolean | null;
|
63
|
+
_enable?: boolean | null;
|
61
64
|
market?: MarketRel | null;
|
62
65
|
payment_gateway?: PaymentGatewayRel | null;
|
63
66
|
}
|
@@ -2,12 +2,13 @@ import { ApiResource } from '../resource';
|
|
2
2
|
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
3
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
4
|
import type { Market, MarketType } from './markets';
|
5
|
-
import type { PromotionRule
|
5
|
+
import type { PromotionRule } from './promotion_rules';
|
6
6
|
import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
|
7
7
|
import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
|
8
8
|
import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
9
|
-
import type {
|
9
|
+
import type { CustomPromotionRule, CustomPromotionRuleType } from './custom_promotion_rules';
|
10
10
|
import type { SkuList, SkuListType } from './sku_lists';
|
11
|
+
import type { Coupon } from './coupons';
|
11
12
|
import type { Attachment } from './attachments';
|
12
13
|
import type { Event } from './events';
|
13
14
|
import type { Tag, TagType } from './tags';
|
@@ -20,9 +21,6 @@ type PercentageDiscountPromotionRel = ResourceRel & {
|
|
20
21
|
type MarketRel = ResourceRel & {
|
21
22
|
type: MarketType;
|
22
23
|
};
|
23
|
-
type PromotionRuleRel = ResourceRel & {
|
24
|
-
type: PromotionRuleType;
|
25
|
-
};
|
26
24
|
type OrderAmountPromotionRuleRel = ResourceRel & {
|
27
25
|
type: OrderAmountPromotionRuleType;
|
28
26
|
};
|
@@ -32,8 +30,8 @@ type SkuListPromotionRuleRel = ResourceRel & {
|
|
32
30
|
type CouponCodesPromotionRuleRel = ResourceRel & {
|
33
31
|
type: CouponCodesPromotionRuleType;
|
34
32
|
};
|
35
|
-
type
|
36
|
-
type:
|
33
|
+
type CustomPromotionRuleRel = ResourceRel & {
|
34
|
+
type: CustomPromotionRuleType;
|
37
35
|
};
|
38
36
|
type SkuListRel = ResourceRel & {
|
39
37
|
type: SkuListType;
|
@@ -59,8 +57,9 @@ interface PercentageDiscountPromotion extends Resource {
|
|
59
57
|
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
60
58
|
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
61
59
|
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
62
|
-
|
60
|
+
custom_promotion_rule?: CustomPromotionRule | null;
|
63
61
|
sku_list?: SkuList | null;
|
62
|
+
coupons?: Coupon[] | null;
|
64
63
|
attachments?: Attachment[] | null;
|
65
64
|
events?: Event[] | null;
|
66
65
|
tags?: Tag[] | null;
|
@@ -79,11 +78,10 @@ interface PercentageDiscountPromotionCreate extends ResourceCreate {
|
|
79
78
|
_enable?: boolean | null;
|
80
79
|
percentage: number;
|
81
80
|
market?: MarketRel | null;
|
82
|
-
promotion_rules?: PromotionRuleRel[] | null;
|
83
81
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
84
82
|
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
85
83
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
86
|
-
|
84
|
+
custom_promotion_rule?: CustomPromotionRuleRel | null;
|
87
85
|
sku_list?: SkuListRel | null;
|
88
86
|
tags?: TagRel[] | null;
|
89
87
|
}
|
@@ -99,11 +97,10 @@ interface PercentageDiscountPromotionUpdate extends ResourceUpdate {
|
|
99
97
|
_enable?: boolean | null;
|
100
98
|
percentage?: number | null;
|
101
99
|
market?: MarketRel | null;
|
102
|
-
promotion_rules?: PromotionRuleRel[] | null;
|
103
100
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
104
101
|
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
105
102
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
106
|
-
|
103
|
+
custom_promotion_rule?: CustomPromotionRuleRel | null;
|
107
104
|
sku_list?: SkuListRel | null;
|
108
105
|
tags?: TagRel[] | null;
|
109
106
|
}
|
@@ -116,8 +113,9 @@ declare class PercentageDiscountPromotions extends ApiResource<PercentageDiscoun
|
|
116
113
|
order_amount_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
|
117
114
|
sku_list_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
118
115
|
coupon_codes_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
119
|
-
|
116
|
+
custom_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
|
120
117
|
sku_list(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
|
118
|
+
coupons(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
|
121
119
|
attachments(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
122
120
|
events(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
123
121
|
tags(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
@@ -27,14 +27,18 @@ class PercentageDiscountPromotions extends resource_1.ApiResource {
|
|
27
27
|
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
28
28
|
return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/coupon_codes_promotion_rule`, params, options);
|
29
29
|
}
|
30
|
-
async
|
30
|
+
async custom_promotion_rule(percentageDiscountPromotionId, params, options) {
|
31
31
|
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
32
|
-
return this.resources.fetch({ type: '
|
32
|
+
return this.resources.fetch({ type: 'custom_promotion_rules' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/custom_promotion_rule`, params, options);
|
33
33
|
}
|
34
34
|
async sku_list(percentageDiscountPromotionId, params, options) {
|
35
35
|
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
36
36
|
return this.resources.fetch({ type: 'sku_lists' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/sku_list`, params, options);
|
37
37
|
}
|
38
|
+
async coupons(percentageDiscountPromotionId, params, options) {
|
39
|
+
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
40
|
+
return this.resources.fetch({ type: 'coupons' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/coupons`, params, options);
|
41
|
+
}
|
38
42
|
async attachments(percentageDiscountPromotionId, params, options) {
|
39
43
|
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
40
44
|
return this.resources.fetch({ type: 'attachments' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/attachments`, params, options);
|
@@ -6,8 +6,9 @@ import type { PromotionRule } from './promotion_rules';
|
|
6
6
|
import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
|
7
7
|
import type { SkuListPromotionRule } from './sku_list_promotion_rules';
|
8
8
|
import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
|
9
|
-
import type {
|
9
|
+
import type { CustomPromotionRule } from './custom_promotion_rules';
|
10
10
|
import type { SkuList } from './sku_lists';
|
11
|
+
import type { Coupon } from './coupons';
|
11
12
|
import type { Attachment } from './attachments';
|
12
13
|
import type { Event } from './events';
|
13
14
|
import type { Tag } from './tags';
|
@@ -33,8 +34,9 @@ interface Promotion extends Resource {
|
|
33
34
|
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
34
35
|
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
35
36
|
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
36
|
-
|
37
|
+
custom_promotion_rule?: CustomPromotionRule | null;
|
37
38
|
sku_list?: SkuList | null;
|
39
|
+
coupons?: Coupon[] | null;
|
38
40
|
attachments?: Attachment[] | null;
|
39
41
|
events?: Event[] | null;
|
40
42
|
tags?: Tag[] | null;
|
@@ -46,8 +48,9 @@ declare class Promotions extends ApiResource<Promotion> {
|
|
46
48
|
order_amount_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
|
47
49
|
sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
48
50
|
coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
49
|
-
|
51
|
+
custom_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
|
50
52
|
sku_list(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
|
53
|
+
coupons(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
|
51
54
|
attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
52
55
|
events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
53
56
|
tags(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
@@ -18,14 +18,18 @@ class Promotions extends resource_1.ApiResource {
|
|
18
18
|
const _promotionId = promotionId.id || promotionId;
|
19
19
|
return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `promotions/${_promotionId}/coupon_codes_promotion_rule`, params, options);
|
20
20
|
}
|
21
|
-
async
|
21
|
+
async custom_promotion_rule(promotionId, params, options) {
|
22
22
|
const _promotionId = promotionId.id || promotionId;
|
23
|
-
return this.resources.fetch({ type: '
|
23
|
+
return this.resources.fetch({ type: 'custom_promotion_rules' }, `promotions/${_promotionId}/custom_promotion_rule`, params, options);
|
24
24
|
}
|
25
25
|
async sku_list(promotionId, params, options) {
|
26
26
|
const _promotionId = promotionId.id || promotionId;
|
27
27
|
return this.resources.fetch({ type: 'sku_lists' }, `promotions/${_promotionId}/sku_list`, params, options);
|
28
28
|
}
|
29
|
+
async coupons(promotionId, params, options) {
|
30
|
+
const _promotionId = promotionId.id || promotionId;
|
31
|
+
return this.resources.fetch({ type: 'coupons' }, `promotions/${_promotionId}/coupons`, params, options);
|
32
|
+
}
|
29
33
|
async attachments(promotionId, params, options) {
|
30
34
|
const _promotionId = promotionId.id || promotionId;
|
31
35
|
return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
|
@@ -0,0 +1,22 @@
|
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceId, ResourceRel } from '../resource';
|
3
|
+
import type { Order } from './orders';
|
4
|
+
type ResourceErrorType = 'resource_errors';
|
5
|
+
type ResourceErrorRel = ResourceRel & {
|
6
|
+
type: ResourceErrorType;
|
7
|
+
};
|
8
|
+
interface ResourceError extends Resource {
|
9
|
+
readonly type: ResourceErrorType;
|
10
|
+
name: string;
|
11
|
+
code: string;
|
12
|
+
message: string;
|
13
|
+
resource?: Order | null;
|
14
|
+
}
|
15
|
+
declare class ResourceErrors extends ApiResource<ResourceError> {
|
16
|
+
static readonly TYPE: ResourceErrorType;
|
17
|
+
isResourceError(resource: any): resource is ResourceError;
|
18
|
+
relationship(id: string | ResourceId | null): ResourceErrorRel;
|
19
|
+
type(): ResourceErrorType;
|
20
|
+
}
|
21
|
+
export default ResourceErrors;
|
22
|
+
export type { ResourceError, ResourceErrorType };
|
@@ -0,0 +1,16 @@
|
|
1
|
+
"use strict";
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
3
|
+
const resource_1 = require("../resource");
|
4
|
+
class ResourceErrors extends resource_1.ApiResource {
|
5
|
+
isResourceError(resource) {
|
6
|
+
return resource.type && (resource.type === ResourceErrors.TYPE);
|
7
|
+
}
|
8
|
+
relationship(id) {
|
9
|
+
return ((id === null) || (typeof id === 'string')) ? { id, type: ResourceErrors.TYPE } : { id: id.id, type: ResourceErrors.TYPE };
|
10
|
+
}
|
11
|
+
type() {
|
12
|
+
return ResourceErrors.TYPE;
|
13
|
+
}
|
14
|
+
}
|
15
|
+
ResourceErrors.TYPE = 'resource_errors';
|
16
|
+
exports.default = ResourceErrors;
|
@@ -70,10 +70,6 @@ interface Shipment extends Resource {
|
|
70
70
|
shipping_address?: Address | null;
|
71
71
|
shipping_method?: ShippingMethod | null;
|
72
72
|
delivery_lead_time?: DeliveryLeadTime | null;
|
73
|
-
/**
|
74
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
75
|
-
*/
|
76
|
-
shipment_line_items?: object[];
|
77
73
|
stock_line_items?: StockLineItem[] | null;
|
78
74
|
stock_transfers?: StockTransfer[] | null;
|
79
75
|
available_shipping_methods?: ShippingMethod[] | null;
|
@@ -35,7 +35,6 @@ interface ShippingMethod extends Resource {
|
|
35
35
|
scheme?: string | null;
|
36
36
|
currency_code?: string | null;
|
37
37
|
external_prices_url?: string | null;
|
38
|
-
disabled_at?: string | null;
|
39
38
|
price_amount_cents: number;
|
40
39
|
price_amount_float?: number | null;
|
41
40
|
formatted_price_amount?: string | null;
|
@@ -49,6 +48,9 @@ interface ShippingMethod extends Resource {
|
|
49
48
|
min_weight?: number | null;
|
50
49
|
max_weight?: number | null;
|
51
50
|
unit_of_weight?: string | null;
|
51
|
+
disabled_at?: string | null;
|
52
|
+
circuit_state?: string | null;
|
53
|
+
circuit_failure_count?: number | null;
|
52
54
|
market?: Market | null;
|
53
55
|
shipping_zone?: ShippingZone | null;
|
54
56
|
shipping_category?: ShippingCategory | null;
|
@@ -64,14 +66,14 @@ interface ShippingMethodCreate extends ResourceCreate {
|
|
64
66
|
scheme?: string | null;
|
65
67
|
currency_code?: string | null;
|
66
68
|
external_prices_url?: string | null;
|
67
|
-
_disable?: boolean | null;
|
68
|
-
_enable?: boolean | null;
|
69
69
|
price_amount_cents: number;
|
70
70
|
free_over_amount_cents?: number | null;
|
71
71
|
use_subtotal?: boolean | null;
|
72
72
|
min_weight?: number | null;
|
73
73
|
max_weight?: number | null;
|
74
74
|
unit_of_weight?: string | null;
|
75
|
+
_disable?: boolean | null;
|
76
|
+
_enable?: boolean | null;
|
75
77
|
market?: MarketRel | null;
|
76
78
|
shipping_zone?: ShippingZoneRel | null;
|
77
79
|
shipping_category?: ShippingCategoryRel | null;
|
@@ -83,14 +85,15 @@ interface ShippingMethodUpdate extends ResourceUpdate {
|
|
83
85
|
scheme?: string | null;
|
84
86
|
currency_code?: string | null;
|
85
87
|
external_prices_url?: string | null;
|
86
|
-
_disable?: boolean | null;
|
87
|
-
_enable?: boolean | null;
|
88
88
|
price_amount_cents?: number | null;
|
89
89
|
free_over_amount_cents?: number | null;
|
90
90
|
use_subtotal?: boolean | null;
|
91
91
|
min_weight?: number | null;
|
92
92
|
max_weight?: number | null;
|
93
93
|
unit_of_weight?: string | null;
|
94
|
+
_disable?: boolean | null;
|
95
|
+
_enable?: boolean | null;
|
96
|
+
_reset_circuit?: boolean | null;
|
94
97
|
market?: MarketRel | null;
|
95
98
|
shipping_zone?: ShippingZoneRel | null;
|
96
99
|
shipping_category?: ShippingCategoryRel | null;
|
@@ -113,6 +116,7 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
113
116
|
versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
114
117
|
_disable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
|
115
118
|
_enable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
|
119
|
+
_reset_circuit(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
|
116
120
|
isShippingMethod(resource: any): resource is ShippingMethod;
|
117
121
|
relationship(id: string | ResourceId | null): ShippingMethodRel;
|
118
122
|
type(): ShippingMethodType;
|
@@ -53,6 +53,9 @@ class ShippingMethods extends resource_1.ApiResource {
|
|
53
53
|
async _enable(id, params, options) {
|
54
54
|
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _enable: true }, params, options);
|
55
55
|
}
|
56
|
+
async _reset_circuit(id, params, options) {
|
57
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _reset_circuit: true }, params, options);
|
58
|
+
}
|
56
59
|
isShippingMethod(resource) {
|
57
60
|
return resource.type && (resource.type === ShippingMethods.TYPE);
|
58
61
|
}
|