@commercelayer/sdk 5.14.0 → 5.16.0
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 +10 -7
- package/lib/cjs/api.js +12 -3
- package/lib/cjs/commercelayer.d.ts +5 -2
- package/lib/cjs/commercelayer.js +4 -1
- package/lib/cjs/model.d.ts +3 -0
- package/lib/cjs/resources/buy_x_pay_y_promotions.d.ts +137 -0
- package/lib/cjs/resources/buy_x_pay_y_promotions.js +75 -0
- package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -3
- package/lib/cjs/resources/coupons.d.ts +3 -0
- package/lib/cjs/resources/custom_promotion_rules.d.ts +62 -0
- package/lib/cjs/resources/custom_promotion_rules.js +29 -0
- package/lib/cjs/resources/external_promotions.d.ts +20 -1
- package/lib/cjs/resources/external_promotions.js +10 -0
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +20 -1
- package/lib/cjs/resources/fixed_amount_promotions.js +10 -0
- package/lib/cjs/resources/fixed_price_promotions.d.ts +11 -0
- package/lib/cjs/resources/fixed_price_promotions.js +6 -0
- package/lib/cjs/resources/free_gift_promotions.d.ts +11 -0
- package/lib/cjs/resources/free_gift_promotions.js +6 -0
- package/lib/cjs/resources/free_shipping_promotions.d.ts +11 -0
- package/lib/cjs/resources/free_shipping_promotions.js +6 -0
- package/lib/cjs/resources/line_items.d.ts +1 -0
- package/lib/cjs/resources/order_amount_promotion_rules.d.ts +7 -3
- package/lib/cjs/resources/orders.d.ts +24 -0
- package/lib/cjs/resources/orders.js +20 -0
- package/lib/cjs/resources/payment_methods.d.ts +3 -3
- package/lib/cjs/resources/payment_options.d.ts +44 -0
- package/lib/cjs/resources/payment_options.js +33 -0
- package/lib/cjs/resources/percentage_discount_promotions.d.ts +11 -0
- package/lib/cjs/resources/percentage_discount_promotions.js +6 -0
- package/lib/cjs/resources/promotion_rules.d.ts +2 -1
- package/lib/cjs/resources/promotions.d.ts +3 -0
- package/lib/cjs/resources/sku_list_promotion_rules.d.ts +7 -3
- package/lib/esm/api.d.ts +10 -7
- package/lib/esm/api.js +6 -0
- package/lib/esm/commercelayer.d.ts +5 -2
- package/lib/esm/commercelayer.js +4 -1
- package/lib/esm/model.d.ts +3 -0
- package/lib/esm/resources/buy_x_pay_y_promotions.d.ts +137 -0
- package/lib/esm/resources/buy_x_pay_y_promotions.js +73 -0
- package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -3
- package/lib/esm/resources/coupons.d.ts +3 -0
- package/lib/esm/resources/custom_promotion_rules.d.ts +62 -0
- package/lib/esm/resources/custom_promotion_rules.js +27 -0
- package/lib/esm/resources/external_promotions.d.ts +20 -1
- package/lib/esm/resources/external_promotions.js +10 -0
- package/lib/esm/resources/fixed_amount_promotions.d.ts +20 -1
- package/lib/esm/resources/fixed_amount_promotions.js +10 -0
- package/lib/esm/resources/fixed_price_promotions.d.ts +11 -0
- package/lib/esm/resources/fixed_price_promotions.js +6 -0
- package/lib/esm/resources/free_gift_promotions.d.ts +11 -0
- package/lib/esm/resources/free_gift_promotions.js +6 -0
- package/lib/esm/resources/free_shipping_promotions.d.ts +11 -0
- package/lib/esm/resources/free_shipping_promotions.js +6 -0
- package/lib/esm/resources/line_items.d.ts +1 -0
- package/lib/esm/resources/order_amount_promotion_rules.d.ts +7 -3
- package/lib/esm/resources/orders.d.ts +24 -0
- package/lib/esm/resources/orders.js +20 -0
- package/lib/esm/resources/payment_methods.d.ts +3 -3
- package/lib/esm/resources/payment_options.d.ts +44 -0
- package/lib/esm/resources/payment_options.js +31 -0
- package/lib/esm/resources/percentage_discount_promotions.d.ts +11 -0
- package/lib/esm/resources/percentage_discount_promotions.js +6 -0
- package/lib/esm/resources/promotion_rules.d.ts +2 -1
- package/lib/esm/resources/promotions.d.ts +3 -0
- package/lib/esm/resources/sku_list_promotion_rules.d.ts +7 -3
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +11 -11
@@ -45,11 +45,14 @@ interface FreeGiftPromotion extends Resource {
|
|
45
45
|
readonly type: FreeGiftPromotionType;
|
46
46
|
name: string;
|
47
47
|
currency_code?: string | null;
|
48
|
+
exclusive?: boolean | null;
|
49
|
+
priority?: number | null;
|
48
50
|
starts_at: string;
|
49
51
|
expires_at: string;
|
50
52
|
total_usage_limit: number;
|
51
53
|
total_usage_count?: number | null;
|
52
54
|
active?: boolean | null;
|
55
|
+
disabled_at?: string | null;
|
53
56
|
max_quantity?: number | null;
|
54
57
|
market?: Market | null;
|
55
58
|
promotion_rules?: PromotionRule[] | null;
|
@@ -67,6 +70,8 @@ interface FreeGiftPromotion extends Resource {
|
|
67
70
|
interface FreeGiftPromotionCreate extends ResourceCreate {
|
68
71
|
name: string;
|
69
72
|
currency_code?: string | null;
|
73
|
+
exclusive?: boolean | null;
|
74
|
+
priority?: number | null;
|
70
75
|
starts_at: string;
|
71
76
|
expires_at: string;
|
72
77
|
total_usage_limit: number;
|
@@ -83,9 +88,13 @@ interface FreeGiftPromotionCreate extends ResourceCreate {
|
|
83
88
|
interface FreeGiftPromotionUpdate extends ResourceUpdate {
|
84
89
|
name?: string | null;
|
85
90
|
currency_code?: string | null;
|
91
|
+
exclusive?: boolean | null;
|
92
|
+
priority?: number | null;
|
86
93
|
starts_at?: string | null;
|
87
94
|
expires_at?: string | null;
|
88
95
|
total_usage_limit?: number | null;
|
96
|
+
_disable?: boolean | null;
|
97
|
+
_enable?: boolean | null;
|
89
98
|
max_quantity?: number | null;
|
90
99
|
market?: MarketRel | null;
|
91
100
|
promotion_rules?: PromotionRuleRel[] | null;
|
@@ -112,6 +121,8 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
|
|
112
121
|
tags(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
113
122
|
versions(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
114
123
|
skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
124
|
+
_disable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
125
|
+
_enable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
115
126
|
isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
|
116
127
|
relationship(id: string | ResourceId | null): FreeGiftPromotionRel;
|
117
128
|
type(): FreeGiftPromotionType;
|
@@ -53,6 +53,12 @@ class FreeGiftPromotions extends ApiResource {
|
|
53
53
|
const _freeGiftPromotionId = freeGiftPromotionId.id || freeGiftPromotionId;
|
54
54
|
return this.resources.fetch({ type: 'skus' }, `free_gift_promotions/${_freeGiftPromotionId}/skus`, params, options);
|
55
55
|
}
|
56
|
+
async _disable(id, params, options) {
|
57
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeGiftPromotions.TYPE, _disable: true }, params, options);
|
58
|
+
}
|
59
|
+
async _enable(id, params, options) {
|
60
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeGiftPromotions.TYPE, _enable: true }, params, options);
|
61
|
+
}
|
56
62
|
isFreeGiftPromotion(resource) {
|
57
63
|
return resource.type && (resource.type === FreeGiftPromotions.TYPE);
|
58
64
|
}
|
@@ -41,11 +41,14 @@ interface FreeShippingPromotion extends Resource {
|
|
41
41
|
readonly type: FreeShippingPromotionType;
|
42
42
|
name: string;
|
43
43
|
currency_code?: string | null;
|
44
|
+
exclusive?: boolean | null;
|
45
|
+
priority?: number | null;
|
44
46
|
starts_at: string;
|
45
47
|
expires_at: string;
|
46
48
|
total_usage_limit: number;
|
47
49
|
total_usage_count?: number | null;
|
48
50
|
active?: boolean | null;
|
51
|
+
disabled_at?: string | null;
|
49
52
|
market?: Market | null;
|
50
53
|
promotion_rules?: PromotionRule[] | null;
|
51
54
|
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
@@ -61,6 +64,8 @@ interface FreeShippingPromotion extends Resource {
|
|
61
64
|
interface FreeShippingPromotionCreate extends ResourceCreate {
|
62
65
|
name: string;
|
63
66
|
currency_code?: string | null;
|
67
|
+
exclusive?: boolean | null;
|
68
|
+
priority?: number | null;
|
64
69
|
starts_at: string;
|
65
70
|
expires_at: string;
|
66
71
|
total_usage_limit: number;
|
@@ -75,9 +80,13 @@ interface FreeShippingPromotionCreate extends ResourceCreate {
|
|
75
80
|
interface FreeShippingPromotionUpdate extends ResourceUpdate {
|
76
81
|
name?: string | null;
|
77
82
|
currency_code?: string | null;
|
83
|
+
exclusive?: boolean | null;
|
84
|
+
priority?: number | null;
|
78
85
|
starts_at?: string | null;
|
79
86
|
expires_at?: string | null;
|
80
87
|
total_usage_limit?: number | null;
|
88
|
+
_disable?: boolean | null;
|
89
|
+
_enable?: boolean | null;
|
81
90
|
market?: MarketRel | null;
|
82
91
|
promotion_rules?: PromotionRuleRel[] | null;
|
83
92
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
@@ -101,6 +110,8 @@ declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion>
|
|
101
110
|
events(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
102
111
|
tags(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
103
112
|
versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
113
|
+
_disable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
114
|
+
_enable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
104
115
|
isFreeShippingPromotion(resource: any): resource is FreeShippingPromotion;
|
105
116
|
relationship(id: string | ResourceId | null): FreeShippingPromotionRel;
|
106
117
|
type(): FreeShippingPromotionType;
|
@@ -49,6 +49,12 @@ class FreeShippingPromotions extends ApiResource {
|
|
49
49
|
const _freeShippingPromotionId = freeShippingPromotionId.id || freeShippingPromotionId;
|
50
50
|
return this.resources.fetch({ type: 'versions' }, `free_shipping_promotions/${_freeShippingPromotionId}/versions`, params, options);
|
51
51
|
}
|
52
|
+
async _disable(id, params, options) {
|
53
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _disable: true }, params, options);
|
54
|
+
}
|
55
|
+
async _enable(id, params, options) {
|
56
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: FreeShippingPromotions.TYPE, _enable: true }, params, options);
|
57
|
+
}
|
52
58
|
isFreeShippingPromotion(resource) {
|
53
59
|
return resource.type && (resource.type === FreeShippingPromotions.TYPE);
|
54
60
|
}
|
@@ -86,6 +86,7 @@ interface LineItem extends Resource {
|
|
86
86
|
tax_breakdown?: Record<string, any> | null;
|
87
87
|
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;
|
88
88
|
frequency?: string | null;
|
89
|
+
coupon_code?: string | null;
|
89
90
|
order?: Order | null;
|
90
91
|
item?: Adjustment | Bundle | ExternalPromotion | FixedAmountPromotion | FreeShippingPromotion | GiftCard | PaymentMethod | PercentageDiscountPromotion | Shipment | Sku | null;
|
91
92
|
sku?: Sku | null;
|
@@ -3,6 +3,7 @@ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesCon
|
|
3
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
4
|
import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
|
5
5
|
import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
|
6
|
+
import type { BuyXPayYPromotion, BuyXPayYPromotionType } from './buy_x_pay_y_promotions';
|
6
7
|
import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
|
7
8
|
import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
|
8
9
|
import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
|
@@ -18,6 +19,9 @@ type PercentageDiscountPromotionRel = ResourceRel & {
|
|
18
19
|
type FreeShippingPromotionRel = ResourceRel & {
|
19
20
|
type: FreeShippingPromotionType;
|
20
21
|
};
|
22
|
+
type BuyXPayYPromotionRel = ResourceRel & {
|
23
|
+
type: BuyXPayYPromotionType;
|
24
|
+
};
|
21
25
|
type FreeGiftPromotionRel = ResourceRel & {
|
22
26
|
type: FreeGiftPromotionType;
|
23
27
|
};
|
@@ -36,18 +40,18 @@ interface OrderAmountPromotionRule extends Resource {
|
|
36
40
|
order_amount_float?: number | null;
|
37
41
|
formatted_order_amount?: string | null;
|
38
42
|
use_subtotal?: boolean | null;
|
39
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
43
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
40
44
|
versions?: Version[] | null;
|
41
45
|
}
|
42
46
|
interface OrderAmountPromotionRuleCreate extends ResourceCreate {
|
43
47
|
order_amount_cents?: number | null;
|
44
48
|
use_subtotal?: boolean | null;
|
45
|
-
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
49
|
+
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
46
50
|
}
|
47
51
|
interface OrderAmountPromotionRuleUpdate extends ResourceUpdate {
|
48
52
|
order_amount_cents?: number | null;
|
49
53
|
use_subtotal?: boolean | null;
|
50
|
-
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
54
|
+
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
51
55
|
}
|
52
56
|
declare class OrderAmountPromotionRules extends ApiResource<OrderAmountPromotionRule> {
|
53
57
|
static readonly TYPE: OrderAmountPromotionRuleType;
|
@@ -19,7 +19,12 @@ import type { SatispayPayment, SatispayPaymentType } from './satispay_payments';
|
|
19
19
|
import type { StripePayment, StripePaymentType } from './stripe_payments';
|
20
20
|
import type { WireTransfer, WireTransferType } from './wire_transfers';
|
21
21
|
import type { LineItem } from './line_items';
|
22
|
+
import type { LineItemOption } from './line_item_options';
|
23
|
+
import type { StockReservation } from './stock_reservations';
|
24
|
+
import type { StockLineItem } from './stock_line_items';
|
25
|
+
import type { StockTransfer } from './stock_transfers';
|
22
26
|
import type { Shipment } from './shipments';
|
27
|
+
import type { PaymentOption } from './payment_options';
|
23
28
|
import type { Authorization } from './authorizations';
|
24
29
|
import type { Capture } from './captures';
|
25
30
|
import type { Void } from './voids';
|
@@ -97,6 +102,9 @@ interface Order extends Resource {
|
|
97
102
|
tax_included?: boolean | null;
|
98
103
|
tax_rate?: number | null;
|
99
104
|
freight_taxable?: boolean | null;
|
105
|
+
payment_method_taxable?: boolean | null;
|
106
|
+
adjustment_taxable?: boolean | null;
|
107
|
+
gift_card_taxable?: boolean | null;
|
100
108
|
requires_billing_info?: boolean | null;
|
101
109
|
country_code?: string | null;
|
102
110
|
shipping_country_code_lock?: string | null;
|
@@ -197,7 +205,12 @@ interface Order extends Resource {
|
|
197
205
|
payment_method?: PaymentMethod | null;
|
198
206
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
199
207
|
line_items?: LineItem[] | null;
|
208
|
+
line_item_options?: LineItemOption[] | null;
|
209
|
+
stock_reservations?: StockReservation[] | null;
|
210
|
+
stock_line_items?: StockLineItem[] | null;
|
211
|
+
stock_transfers?: StockTransfer[] | null;
|
200
212
|
shipments?: Shipment[] | null;
|
213
|
+
payment_options?: PaymentOption[] | null;
|
201
214
|
transactions?: Array<Authorization | Capture | Void | Refund> | null;
|
202
215
|
authorizations?: Authorization[] | null;
|
203
216
|
captures?: Capture[] | null;
|
@@ -220,6 +233,9 @@ interface OrderCreate extends ResourceCreate {
|
|
220
233
|
customer_password?: string | null;
|
221
234
|
language_code?: string | null;
|
222
235
|
freight_taxable?: boolean | null;
|
236
|
+
payment_method_taxable?: boolean | null;
|
237
|
+
adjustment_taxable?: boolean | null;
|
238
|
+
gift_card_taxable?: boolean | null;
|
223
239
|
shipping_country_code_lock?: string | null;
|
224
240
|
coupon_code?: string | null;
|
225
241
|
gift_card_code?: string | null;
|
@@ -242,6 +258,9 @@ interface OrderUpdate extends ResourceUpdate {
|
|
242
258
|
customer_password?: string | null;
|
243
259
|
language_code?: string | null;
|
244
260
|
freight_taxable?: boolean | null;
|
261
|
+
payment_method_taxable?: boolean | null;
|
262
|
+
adjustment_taxable?: boolean | null;
|
263
|
+
gift_card_taxable?: boolean | null;
|
245
264
|
shipping_country_code_lock?: string | null;
|
246
265
|
coupon_code?: string | null;
|
247
266
|
gift_card_code?: string | null;
|
@@ -299,7 +318,12 @@ declare class Orders extends ApiResource<Order> {
|
|
299
318
|
available_free_bundles(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
|
300
319
|
payment_method(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
|
301
320
|
line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
|
321
|
+
line_item_options(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItemOption>>;
|
322
|
+
stock_reservations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
323
|
+
stock_line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
|
324
|
+
stock_transfers(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
|
302
325
|
shipments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
|
326
|
+
payment_options(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentOption>>;
|
303
327
|
authorizations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Authorization>>;
|
304
328
|
captures(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
|
305
329
|
voids(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
|
@@ -49,10 +49,30 @@ class Orders extends ApiResource {
|
|
49
49
|
const _orderId = orderId.id || orderId;
|
50
50
|
return this.resources.fetch({ type: 'line_items' }, `orders/${_orderId}/line_items`, params, options);
|
51
51
|
}
|
52
|
+
async line_item_options(orderId, params, options) {
|
53
|
+
const _orderId = orderId.id || orderId;
|
54
|
+
return this.resources.fetch({ type: 'line_item_options' }, `orders/${_orderId}/line_item_options`, params, options);
|
55
|
+
}
|
56
|
+
async stock_reservations(orderId, params, options) {
|
57
|
+
const _orderId = orderId.id || orderId;
|
58
|
+
return this.resources.fetch({ type: 'stock_reservations' }, `orders/${_orderId}/stock_reservations`, params, options);
|
59
|
+
}
|
60
|
+
async stock_line_items(orderId, params, options) {
|
61
|
+
const _orderId = orderId.id || orderId;
|
62
|
+
return this.resources.fetch({ type: 'stock_line_items' }, `orders/${_orderId}/stock_line_items`, params, options);
|
63
|
+
}
|
64
|
+
async stock_transfers(orderId, params, options) {
|
65
|
+
const _orderId = orderId.id || orderId;
|
66
|
+
return this.resources.fetch({ type: 'stock_transfers' }, `orders/${_orderId}/stock_transfers`, params, options);
|
67
|
+
}
|
52
68
|
async shipments(orderId, params, options) {
|
53
69
|
const _orderId = orderId.id || orderId;
|
54
70
|
return this.resources.fetch({ type: 'shipments' }, `orders/${_orderId}/shipments`, params, options);
|
55
71
|
}
|
72
|
+
async payment_options(orderId, params, options) {
|
73
|
+
const _orderId = orderId.id || orderId;
|
74
|
+
return this.resources.fetch({ type: 'payment_options' }, `orders/${_orderId}/payment_options`, params, options);
|
75
|
+
}
|
56
76
|
async authorizations(orderId, params, options) {
|
57
77
|
const _orderId = orderId.id || orderId;
|
58
78
|
return this.resources.fetch({ type: 'authorizations' }, `orders/${_orderId}/authorizations`, params, options);
|
@@ -17,8 +17,8 @@ type PaymentGatewayRel = ResourceRel & {
|
|
17
17
|
};
|
18
18
|
interface PaymentMethod extends Resource {
|
19
19
|
readonly type: PaymentMethodType;
|
20
|
-
payment_source_type: string;
|
21
20
|
name?: string | null;
|
21
|
+
payment_source_type: 'AdyenPayment' | 'AxervePayment' | 'BraintreePayment' | 'CheckoutComPayment' | 'CreditCard' | 'ExternalPayment' | 'KlarnaPayment' | 'PaypalPayment' | 'SatispayPayment' | 'StripePayment' | 'WireTransfer';
|
22
22
|
currency_code?: string | null;
|
23
23
|
moto?: boolean | null;
|
24
24
|
require_capture?: boolean | null;
|
@@ -36,7 +36,7 @@ interface PaymentMethod extends Resource {
|
|
36
36
|
versions?: Version[] | null;
|
37
37
|
}
|
38
38
|
interface PaymentMethodCreate extends ResourceCreate {
|
39
|
-
payment_source_type:
|
39
|
+
payment_source_type: 'AdyenPayment' | 'AxervePayment' | 'BraintreePayment' | 'CheckoutComPayment' | 'CreditCard' | 'ExternalPayment' | 'KlarnaPayment' | 'PaypalPayment' | 'SatispayPayment' | 'StripePayment' | 'WireTransfer';
|
40
40
|
currency_code?: string | null;
|
41
41
|
moto?: boolean | null;
|
42
42
|
require_capture?: boolean | null;
|
@@ -47,7 +47,7 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
47
47
|
payment_gateway: PaymentGatewayRel;
|
48
48
|
}
|
49
49
|
interface PaymentMethodUpdate extends ResourceUpdate {
|
50
|
-
payment_source_type?:
|
50
|
+
payment_source_type?: 'AdyenPayment' | 'AxervePayment' | 'BraintreePayment' | 'CheckoutComPayment' | 'CreditCard' | 'ExternalPayment' | 'KlarnaPayment' | 'PaypalPayment' | 'SatispayPayment' | 'StripePayment' | 'WireTransfer' | null;
|
51
51
|
currency_code?: string | null;
|
52
52
|
moto?: boolean | null;
|
53
53
|
require_capture?: boolean | null;
|
@@ -0,0 +1,44 @@
|
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
3
|
+
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
|
+
import type { Order, OrderType } from './orders';
|
5
|
+
import type { Attachment } from './attachments';
|
6
|
+
type PaymentOptionType = 'payment_options';
|
7
|
+
type PaymentOptionRel = ResourceRel & {
|
8
|
+
type: PaymentOptionType;
|
9
|
+
};
|
10
|
+
type OrderRel = ResourceRel & {
|
11
|
+
type: OrderType;
|
12
|
+
};
|
13
|
+
interface PaymentOption extends Resource {
|
14
|
+
readonly type: PaymentOptionType;
|
15
|
+
name?: string | null;
|
16
|
+
payment_source_type: 'AdyenPayment' | 'AxervePayment' | 'BraintreePayment' | 'CheckoutComPayment' | 'CreditCard' | 'ExternalPayment' | 'KlarnaPayment' | 'PaypalPayment' | 'SatispayPayment' | 'StripePayment' | 'WireTransfer';
|
17
|
+
data: Record<string, any>;
|
18
|
+
order?: Order | null;
|
19
|
+
attachments?: Attachment[] | null;
|
20
|
+
}
|
21
|
+
interface PaymentOptionCreate extends ResourceCreate {
|
22
|
+
name?: string | null;
|
23
|
+
payment_source_type: 'AdyenPayment' | 'AxervePayment' | 'BraintreePayment' | 'CheckoutComPayment' | 'CreditCard' | 'ExternalPayment' | 'KlarnaPayment' | 'PaypalPayment' | 'SatispayPayment' | 'StripePayment' | 'WireTransfer';
|
24
|
+
data: Record<string, any>;
|
25
|
+
order: OrderRel;
|
26
|
+
}
|
27
|
+
interface PaymentOptionUpdate extends ResourceUpdate {
|
28
|
+
name?: string | null;
|
29
|
+
data?: Record<string, any> | null;
|
30
|
+
order?: OrderRel | null;
|
31
|
+
}
|
32
|
+
declare class PaymentOptions extends ApiResource<PaymentOption> {
|
33
|
+
static readonly TYPE: PaymentOptionType;
|
34
|
+
create(resource: PaymentOptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentOption>;
|
35
|
+
update(resource: PaymentOptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentOption>;
|
36
|
+
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
37
|
+
order(paymentOptionId: string | PaymentOption, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
38
|
+
attachments(paymentOptionId: string | PaymentOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
39
|
+
isPaymentOption(resource: any): resource is PaymentOption;
|
40
|
+
relationship(id: string | ResourceId | null): PaymentOptionRel;
|
41
|
+
type(): PaymentOptionType;
|
42
|
+
}
|
43
|
+
export default PaymentOptions;
|
44
|
+
export type { PaymentOption, PaymentOptionCreate, PaymentOptionUpdate, PaymentOptionType };
|
@@ -0,0 +1,31 @@
|
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
class PaymentOptions extends ApiResource {
|
3
|
+
async create(resource, params, options) {
|
4
|
+
return this.resources.create({ ...resource, type: PaymentOptions.TYPE }, params, options);
|
5
|
+
}
|
6
|
+
async update(resource, params, options) {
|
7
|
+
return this.resources.update({ ...resource, type: PaymentOptions.TYPE }, params, options);
|
8
|
+
}
|
9
|
+
async delete(id, options) {
|
10
|
+
await this.resources.delete((typeof id === 'string') ? { id, type: PaymentOptions.TYPE } : id, options);
|
11
|
+
}
|
12
|
+
async order(paymentOptionId, params, options) {
|
13
|
+
const _paymentOptionId = paymentOptionId.id || paymentOptionId;
|
14
|
+
return this.resources.fetch({ type: 'orders' }, `payment_options/${_paymentOptionId}/order`, params, options);
|
15
|
+
}
|
16
|
+
async attachments(paymentOptionId, params, options) {
|
17
|
+
const _paymentOptionId = paymentOptionId.id || paymentOptionId;
|
18
|
+
return this.resources.fetch({ type: 'attachments' }, `payment_options/${_paymentOptionId}/attachments`, params, options);
|
19
|
+
}
|
20
|
+
isPaymentOption(resource) {
|
21
|
+
return resource.type && (resource.type === PaymentOptions.TYPE);
|
22
|
+
}
|
23
|
+
relationship(id) {
|
24
|
+
return ((id === null) || (typeof id === 'string')) ? { id, type: PaymentOptions.TYPE } : { id: id.id, type: PaymentOptions.TYPE };
|
25
|
+
}
|
26
|
+
type() {
|
27
|
+
return PaymentOptions.TYPE;
|
28
|
+
}
|
29
|
+
}
|
30
|
+
PaymentOptions.TYPE = 'payment_options';
|
31
|
+
export default PaymentOptions;
|
@@ -45,11 +45,14 @@ interface PercentageDiscountPromotion extends Resource {
|
|
45
45
|
readonly type: PercentageDiscountPromotionType;
|
46
46
|
name: string;
|
47
47
|
currency_code?: string | null;
|
48
|
+
exclusive?: boolean | null;
|
49
|
+
priority?: number | null;
|
48
50
|
starts_at: string;
|
49
51
|
expires_at: string;
|
50
52
|
total_usage_limit: number;
|
51
53
|
total_usage_count?: number | null;
|
52
54
|
active?: boolean | null;
|
55
|
+
disabled_at?: string | null;
|
53
56
|
percentage: number;
|
54
57
|
market?: Market | null;
|
55
58
|
promotion_rules?: PromotionRule[] | null;
|
@@ -67,6 +70,8 @@ interface PercentageDiscountPromotion extends Resource {
|
|
67
70
|
interface PercentageDiscountPromotionCreate extends ResourceCreate {
|
68
71
|
name: string;
|
69
72
|
currency_code?: string | null;
|
73
|
+
exclusive?: boolean | null;
|
74
|
+
priority?: number | null;
|
70
75
|
starts_at: string;
|
71
76
|
expires_at: string;
|
72
77
|
total_usage_limit: number;
|
@@ -83,9 +88,13 @@ interface PercentageDiscountPromotionCreate extends ResourceCreate {
|
|
83
88
|
interface PercentageDiscountPromotionUpdate extends ResourceUpdate {
|
84
89
|
name?: string | null;
|
85
90
|
currency_code?: string | null;
|
91
|
+
exclusive?: boolean | null;
|
92
|
+
priority?: number | null;
|
86
93
|
starts_at?: string | null;
|
87
94
|
expires_at?: string | null;
|
88
95
|
total_usage_limit?: number | null;
|
96
|
+
_disable?: boolean | null;
|
97
|
+
_enable?: boolean | null;
|
89
98
|
percentage?: number | null;
|
90
99
|
market?: MarketRel | null;
|
91
100
|
promotion_rules?: PromotionRuleRel[] | null;
|
@@ -112,6 +121,8 @@ declare class PercentageDiscountPromotions extends ApiResource<PercentageDiscoun
|
|
112
121
|
tags(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
113
122
|
versions(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
114
123
|
skus(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
124
|
+
_disable(id: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
125
|
+
_enable(id: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
115
126
|
isPercentageDiscountPromotion(resource: any): resource is PercentageDiscountPromotion;
|
116
127
|
relationship(id: string | ResourceId | null): PercentageDiscountPromotionRel;
|
117
128
|
type(): PercentageDiscountPromotionType;
|
@@ -53,6 +53,12 @@ class PercentageDiscountPromotions extends ApiResource {
|
|
53
53
|
const _percentageDiscountPromotionId = percentageDiscountPromotionId.id || percentageDiscountPromotionId;
|
54
54
|
return this.resources.fetch({ type: 'skus' }, `percentage_discount_promotions/${_percentageDiscountPromotionId}/skus`, params, options);
|
55
55
|
}
|
56
|
+
async _disable(id, params, options) {
|
57
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: PercentageDiscountPromotions.TYPE, _disable: true }, params, options);
|
58
|
+
}
|
59
|
+
async _enable(id, params, options) {
|
60
|
+
return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: PercentageDiscountPromotions.TYPE, _enable: true }, params, options);
|
61
|
+
}
|
56
62
|
isPercentageDiscountPromotion(resource) {
|
57
63
|
return resource.type && (resource.type === PercentageDiscountPromotions.TYPE);
|
58
64
|
}
|
@@ -3,6 +3,7 @@ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse }
|
|
3
3
|
import type { QueryParamsList } from '../query';
|
4
4
|
import type { PercentageDiscountPromotion } from './percentage_discount_promotions';
|
5
5
|
import type { FreeShippingPromotion } from './free_shipping_promotions';
|
6
|
+
import type { BuyXPayYPromotion } from './buy_x_pay_y_promotions';
|
6
7
|
import type { FreeGiftPromotion } from './free_gift_promotions';
|
7
8
|
import type { FixedPricePromotion } from './fixed_price_promotions';
|
8
9
|
import type { ExternalPromotion } from './external_promotions';
|
@@ -14,7 +15,7 @@ type PromotionRuleRel = ResourceRel & {
|
|
14
15
|
};
|
15
16
|
interface PromotionRule extends Resource {
|
16
17
|
readonly type: PromotionRuleType;
|
17
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
18
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
18
19
|
versions?: Version[] | null;
|
19
20
|
}
|
20
21
|
declare class PromotionRules extends ApiResource<PromotionRule> {
|
@@ -20,11 +20,14 @@ interface Promotion extends Resource {
|
|
20
20
|
readonly type: PromotionType;
|
21
21
|
name: string;
|
22
22
|
currency_code?: string | null;
|
23
|
+
exclusive?: boolean | null;
|
24
|
+
priority?: number | null;
|
23
25
|
starts_at: string;
|
24
26
|
expires_at: string;
|
25
27
|
total_usage_limit: number;
|
26
28
|
total_usage_count?: number | null;
|
27
29
|
active?: boolean | null;
|
30
|
+
disabled_at?: string | null;
|
28
31
|
market?: Market | null;
|
29
32
|
promotion_rules?: PromotionRule[] | null;
|
30
33
|
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
@@ -3,6 +3,7 @@ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesCon
|
|
3
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
4
|
import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
|
5
5
|
import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
|
6
|
+
import type { BuyXPayYPromotion, BuyXPayYPromotionType } from './buy_x_pay_y_promotions';
|
6
7
|
import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
|
7
8
|
import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
|
8
9
|
import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
|
@@ -20,6 +21,9 @@ type PercentageDiscountPromotionRel = ResourceRel & {
|
|
20
21
|
type FreeShippingPromotionRel = ResourceRel & {
|
21
22
|
type: FreeShippingPromotionType;
|
22
23
|
};
|
24
|
+
type BuyXPayYPromotionRel = ResourceRel & {
|
25
|
+
type: BuyXPayYPromotionType;
|
26
|
+
};
|
23
27
|
type FreeGiftPromotionRel = ResourceRel & {
|
24
28
|
type: FreeGiftPromotionType;
|
25
29
|
};
|
@@ -39,7 +43,7 @@ interface SkuListPromotionRule extends Resource {
|
|
39
43
|
readonly type: SkuListPromotionRuleType;
|
40
44
|
all_skus?: boolean | null;
|
41
45
|
min_quantity?: number | null;
|
42
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
46
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
43
47
|
versions?: Version[] | null;
|
44
48
|
sku_list?: SkuList | null;
|
45
49
|
skus?: Sku[] | null;
|
@@ -47,13 +51,13 @@ interface SkuListPromotionRule extends Resource {
|
|
47
51
|
interface SkuListPromotionRuleCreate extends ResourceCreate {
|
48
52
|
all_skus?: boolean | null;
|
49
53
|
min_quantity?: number | null;
|
50
|
-
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
54
|
+
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
51
55
|
sku_list?: SkuListRel | null;
|
52
56
|
}
|
53
57
|
interface SkuListPromotionRuleUpdate extends ResourceUpdate {
|
54
58
|
all_skus?: boolean | null;
|
55
59
|
min_quantity?: number | null;
|
56
|
-
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
60
|
+
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
57
61
|
sku_list?: SkuListRel | null;
|
58
62
|
}
|
59
63
|
declare class SkuListPromotionRules extends ApiResource<SkuListPromotionRule> {
|