@commercelayer/sdk 5.0.0-beta.1 → 5.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/client.js +0 -1
- package/lib/cjs/common.js +0 -2
- package/lib/cjs/debug.js +0 -3
- package/lib/cjs/error.js +0 -1
- package/lib/cjs/query.d.ts +2 -1
- package/lib/cjs/query.js +2 -1
- package/lib/cjs/resource.d.ts +1 -1
- package/lib/cjs/resource.js +1 -1
- package/lib/cjs/resources/addresses.d.ts +10 -10
- package/lib/cjs/resources/adjustments.d.ts +8 -8
- package/lib/cjs/resources/adyen_gateways.d.ts +4 -4
- package/lib/cjs/resources/adyen_payments.d.ts +1 -1
- package/lib/cjs/resources/attachments.d.ts +2 -2
- package/lib/cjs/resources/authorizations.d.ts +6 -6
- package/lib/cjs/resources/avalara_accounts.d.ts +6 -6
- package/lib/cjs/resources/axerve_gateways.d.ts +4 -4
- package/lib/cjs/resources/axerve_payments.d.ts +3 -3
- package/lib/cjs/resources/bing_geocoders.d.ts +2 -2
- package/lib/cjs/resources/braintree_gateways.d.ts +2 -2
- package/lib/cjs/resources/braintree_payments.d.ts +1 -1
- package/lib/cjs/resources/bundles.d.ts +12 -12
- package/lib/cjs/resources/captures.d.ts +6 -6
- package/lib/cjs/resources/checkout_com_gateways.d.ts +2 -2
- package/lib/cjs/resources/checkout_com_payments.d.ts +4 -4
- package/lib/cjs/resources/cleanups.d.ts +1 -1
- package/lib/cjs/resources/coupon_recipients.d.ts +2 -2
- package/lib/cjs/resources/coupons.d.ts +4 -4
- package/lib/cjs/resources/customer_groups.d.ts +2 -2
- package/lib/cjs/resources/customer_password_resets.d.ts +1 -1
- package/lib/cjs/resources/customer_subscriptions.d.ts +1 -1
- package/lib/cjs/resources/customers.d.ts +2 -2
- package/lib/cjs/resources/delivery_lead_times.d.ts +4 -4
- package/lib/cjs/resources/event_callbacks.d.ts +1 -1
- package/lib/cjs/resources/events.d.ts +1 -1
- package/lib/cjs/resources/exports.d.ts +1 -1
- package/lib/cjs/resources/external_gateways.d.ts +3 -3
- package/lib/cjs/resources/external_payments.d.ts +1 -1
- package/lib/cjs/resources/external_promotions.d.ts +11 -11
- package/lib/cjs/resources/external_tax_calculators.d.ts +5 -5
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +10 -10
- package/lib/cjs/resources/fixed_price_promotions.d.ts +10 -10
- package/lib/cjs/resources/free_gift_promotions.d.ts +8 -8
- package/lib/cjs/resources/free_shipping_promotions.d.ts +8 -8
- package/lib/cjs/resources/geocoders.d.ts +1 -1
- package/lib/cjs/resources/gift_card_recipients.d.ts +2 -2
- package/lib/cjs/resources/gift_cards.d.ts +8 -8
- package/lib/cjs/resources/google_geocoders.d.ts +2 -2
- package/lib/cjs/resources/imports.d.ts +2 -2
- package/lib/cjs/resources/inventory_models.d.ts +2 -2
- package/lib/cjs/resources/inventory_return_locations.d.ts +2 -2
- package/lib/cjs/resources/inventory_stock_locations.d.ts +2 -2
- package/lib/cjs/resources/klarna_gateways.d.ts +2 -2
- package/lib/cjs/resources/klarna_payments.d.ts +2 -2
- package/lib/cjs/resources/line_item_options.d.ts +5 -5
- package/lib/cjs/resources/line_items.d.ts +4 -4
- package/lib/cjs/resources/manual_gateways.d.ts +2 -2
- package/lib/cjs/resources/manual_tax_calculators.d.ts +2 -2
- package/lib/cjs/resources/markets.d.ts +3 -3
- package/lib/cjs/resources/merchants.d.ts +2 -2
- package/lib/cjs/resources/order_subscriptions.d.ts +1 -1
- package/lib/cjs/resources/packages.d.ts +10 -10
- package/lib/cjs/resources/parcel_line_items.d.ts +2 -2
- package/lib/cjs/resources/parcels.d.ts +4 -4
- package/lib/cjs/resources/payment_gateways.d.ts +1 -1
- package/lib/cjs/resources/payment_methods.d.ts +4 -4
- package/lib/cjs/resources/paypal_gateways.d.ts +2 -2
- package/lib/cjs/resources/paypal_payments.d.ts +3 -3
- package/lib/cjs/resources/percentage_discount_promotions.d.ts +10 -10
- package/lib/cjs/resources/price_lists.d.ts +4 -4
- package/lib/cjs/resources/price_tiers.d.ts +2 -2
- package/lib/cjs/resources/price_volume_tiers.d.ts +4 -4
- package/lib/cjs/resources/prices.d.ts +8 -8
- package/lib/cjs/resources/promotions.d.ts +4 -4
- package/lib/cjs/resources/refunds.d.ts +6 -6
- package/lib/cjs/resources/return_line_items.d.ts +2 -2
- package/lib/cjs/resources/satispay_gateways.d.ts +2 -2
- package/lib/cjs/resources/satispay_payments.d.ts +1 -1
- package/lib/cjs/resources/shipping_categories.d.ts +2 -2
- package/lib/cjs/resources/shipping_method_tiers.d.ts +2 -2
- package/lib/cjs/resources/shipping_methods.d.ts +4 -4
- package/lib/cjs/resources/shipping_weight_tiers.d.ts +4 -4
- package/lib/cjs/resources/shipping_zones.d.ts +2 -2
- package/lib/cjs/resources/sku_lists.d.ts +3 -3
- package/lib/cjs/resources/sku_options.d.ts +2 -2
- package/lib/cjs/resources/skus.d.ts +4 -4
- package/lib/cjs/resources/stock_items.d.ts +2 -2
- package/lib/cjs/resources/stock_line_items.d.ts +1 -1
- package/lib/cjs/resources/stock_locations.d.ts +2 -2
- package/lib/cjs/resources/stock_transfers.d.ts +1 -1
- package/lib/cjs/resources/stripe_gateways.d.ts +2 -2
- package/lib/cjs/resources/stripe_payments.d.ts +2 -2
- package/lib/cjs/resources/tax_calculators.d.ts +1 -1
- package/lib/cjs/resources/tax_categories.d.ts +2 -2
- package/lib/cjs/resources/tax_rules.d.ts +2 -2
- package/lib/cjs/resources/taxjar_accounts.d.ts +2 -2
- package/lib/cjs/resources/transactions.d.ts +6 -6
- package/lib/cjs/resources/voids.d.ts +6 -6
- package/lib/cjs/resources/webhooks.d.ts +5 -5
- package/lib/esm/client.js +0 -1
- package/lib/esm/common.js +0 -2
- package/lib/esm/debug.js +0 -3
- package/lib/esm/error.js +0 -1
- package/lib/esm/query.d.ts +2 -1
- package/lib/esm/query.js +1 -1
- package/lib/esm/resource.d.ts +1 -1
- package/lib/esm/resource.js +2 -2
- package/lib/esm/resources/addresses.d.ts +10 -10
- package/lib/esm/resources/adjustments.d.ts +8 -8
- package/lib/esm/resources/adyen_gateways.d.ts +4 -4
- package/lib/esm/resources/adyen_payments.d.ts +1 -1
- package/lib/esm/resources/attachments.d.ts +2 -2
- package/lib/esm/resources/authorizations.d.ts +6 -6
- package/lib/esm/resources/avalara_accounts.d.ts +6 -6
- package/lib/esm/resources/axerve_gateways.d.ts +4 -4
- package/lib/esm/resources/axerve_payments.d.ts +3 -3
- package/lib/esm/resources/bing_geocoders.d.ts +2 -2
- package/lib/esm/resources/braintree_gateways.d.ts +2 -2
- package/lib/esm/resources/braintree_payments.d.ts +1 -1
- package/lib/esm/resources/bundles.d.ts +12 -12
- package/lib/esm/resources/captures.d.ts +6 -6
- package/lib/esm/resources/checkout_com_gateways.d.ts +2 -2
- package/lib/esm/resources/checkout_com_payments.d.ts +4 -4
- package/lib/esm/resources/cleanups.d.ts +1 -1
- package/lib/esm/resources/coupon_recipients.d.ts +2 -2
- package/lib/esm/resources/coupons.d.ts +4 -4
- package/lib/esm/resources/customer_groups.d.ts +2 -2
- package/lib/esm/resources/customer_password_resets.d.ts +1 -1
- package/lib/esm/resources/customer_subscriptions.d.ts +1 -1
- package/lib/esm/resources/customers.d.ts +2 -2
- package/lib/esm/resources/delivery_lead_times.d.ts +4 -4
- package/lib/esm/resources/event_callbacks.d.ts +1 -1
- package/lib/esm/resources/events.d.ts +1 -1
- package/lib/esm/resources/exports.d.ts +1 -1
- package/lib/esm/resources/external_gateways.d.ts +3 -3
- package/lib/esm/resources/external_payments.d.ts +1 -1
- package/lib/esm/resources/external_promotions.d.ts +11 -11
- package/lib/esm/resources/external_tax_calculators.d.ts +5 -5
- package/lib/esm/resources/fixed_amount_promotions.d.ts +10 -10
- package/lib/esm/resources/fixed_price_promotions.d.ts +10 -10
- package/lib/esm/resources/free_gift_promotions.d.ts +8 -8
- package/lib/esm/resources/free_shipping_promotions.d.ts +8 -8
- package/lib/esm/resources/geocoders.d.ts +1 -1
- package/lib/esm/resources/gift_card_recipients.d.ts +2 -2
- package/lib/esm/resources/gift_cards.d.ts +8 -8
- package/lib/esm/resources/google_geocoders.d.ts +2 -2
- package/lib/esm/resources/imports.d.ts +2 -2
- package/lib/esm/resources/inventory_models.d.ts +2 -2
- package/lib/esm/resources/inventory_return_locations.d.ts +2 -2
- package/lib/esm/resources/inventory_stock_locations.d.ts +2 -2
- package/lib/esm/resources/klarna_gateways.d.ts +2 -2
- package/lib/esm/resources/klarna_payments.d.ts +2 -2
- package/lib/esm/resources/line_item_options.d.ts +5 -5
- package/lib/esm/resources/line_items.d.ts +4 -4
- package/lib/esm/resources/manual_gateways.d.ts +2 -2
- package/lib/esm/resources/manual_tax_calculators.d.ts +2 -2
- package/lib/esm/resources/markets.d.ts +3 -3
- package/lib/esm/resources/merchants.d.ts +2 -2
- package/lib/esm/resources/order_subscriptions.d.ts +1 -1
- package/lib/esm/resources/packages.d.ts +10 -10
- package/lib/esm/resources/parcel_line_items.d.ts +2 -2
- package/lib/esm/resources/parcels.d.ts +4 -4
- package/lib/esm/resources/payment_gateways.d.ts +1 -1
- package/lib/esm/resources/payment_methods.d.ts +4 -4
- package/lib/esm/resources/paypal_gateways.d.ts +2 -2
- package/lib/esm/resources/paypal_payments.d.ts +3 -3
- package/lib/esm/resources/percentage_discount_promotions.d.ts +10 -10
- package/lib/esm/resources/price_lists.d.ts +4 -4
- package/lib/esm/resources/price_tiers.d.ts +2 -2
- package/lib/esm/resources/price_volume_tiers.d.ts +4 -4
- package/lib/esm/resources/prices.d.ts +8 -8
- package/lib/esm/resources/promotions.d.ts +4 -4
- package/lib/esm/resources/refunds.d.ts +6 -6
- package/lib/esm/resources/return_line_items.d.ts +2 -2
- package/lib/esm/resources/satispay_gateways.d.ts +2 -2
- package/lib/esm/resources/satispay_payments.d.ts +1 -1
- package/lib/esm/resources/shipping_categories.d.ts +2 -2
- package/lib/esm/resources/shipping_method_tiers.d.ts +2 -2
- package/lib/esm/resources/shipping_methods.d.ts +4 -4
- package/lib/esm/resources/shipping_weight_tiers.d.ts +4 -4
- package/lib/esm/resources/shipping_zones.d.ts +2 -2
- package/lib/esm/resources/sku_lists.d.ts +3 -3
- package/lib/esm/resources/sku_options.d.ts +2 -2
- package/lib/esm/resources/skus.d.ts +4 -4
- package/lib/esm/resources/stock_items.d.ts +2 -2
- package/lib/esm/resources/stock_line_items.d.ts +1 -1
- package/lib/esm/resources/stock_locations.d.ts +2 -2
- package/lib/esm/resources/stock_transfers.d.ts +1 -1
- package/lib/esm/resources/stripe_gateways.d.ts +2 -2
- package/lib/esm/resources/stripe_payments.d.ts +2 -2
- package/lib/esm/resources/tax_calculators.d.ts +1 -1
- package/lib/esm/resources/tax_categories.d.ts +2 -2
- package/lib/esm/resources/tax_rules.d.ts +2 -2
- package/lib/esm/resources/taxjar_accounts.d.ts +2 -2
- package/lib/esm/resources/transactions.d.ts +6 -6
- package/lib/esm/resources/voids.d.ts +6 -6
- package/lib/esm/resources/webhooks.d.ts +5 -5
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +4 -4
@@ -28,15 +28,15 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
|
|
28
28
|
};
|
29
29
|
interface ExternalPromotion extends Resource {
|
30
30
|
readonly type: ExternalPromotionType;
|
31
|
-
name
|
31
|
+
name: string;
|
32
32
|
currency_code?: string;
|
33
|
-
starts_at
|
34
|
-
expires_at
|
35
|
-
total_usage_limit
|
33
|
+
starts_at: string;
|
34
|
+
expires_at: string;
|
35
|
+
total_usage_limit: number;
|
36
36
|
total_usage_count?: number;
|
37
37
|
active?: boolean;
|
38
|
-
promotion_url
|
39
|
-
shared_secret
|
38
|
+
promotion_url: string;
|
39
|
+
shared_secret: string;
|
40
40
|
market?: Market;
|
41
41
|
promotion_rules?: PromotionRule[];
|
42
42
|
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
@@ -59,12 +59,12 @@ interface ExternalPromotionCreate extends ResourceCreate {
|
|
59
59
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
60
60
|
}
|
61
61
|
interface ExternalPromotionUpdate extends ResourceUpdate {
|
62
|
-
name
|
62
|
+
name: string;
|
63
63
|
currency_code?: string;
|
64
|
-
starts_at
|
65
|
-
expires_at
|
66
|
-
total_usage_limit
|
67
|
-
promotion_url
|
64
|
+
starts_at: string;
|
65
|
+
expires_at: string;
|
66
|
+
total_usage_limit: number;
|
67
|
+
promotion_url: string;
|
68
68
|
market?: MarketRel;
|
69
69
|
promotion_rules?: PromotionRuleRel[];
|
70
70
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
@@ -8,9 +8,9 @@ type ExternalTaxCalculatorRel = ResourceRel & {
|
|
8
8
|
};
|
9
9
|
interface ExternalTaxCalculator extends Resource {
|
10
10
|
readonly type: ExternalTaxCalculatorType;
|
11
|
-
name
|
12
|
-
tax_calculator_url
|
13
|
-
shared_secret
|
11
|
+
name: string;
|
12
|
+
tax_calculator_url: string;
|
13
|
+
shared_secret: string;
|
14
14
|
markets?: Market[];
|
15
15
|
attachments?: Attachment[];
|
16
16
|
}
|
@@ -19,8 +19,8 @@ interface ExternalTaxCalculatorCreate extends ResourceCreate {
|
|
19
19
|
tax_calculator_url: string;
|
20
20
|
}
|
21
21
|
interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
|
22
|
-
name
|
23
|
-
tax_calculator_url
|
22
|
+
name: string;
|
23
|
+
tax_calculator_url: string;
|
24
24
|
}
|
25
25
|
declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
|
26
26
|
static readonly TYPE: ExternalTaxCalculatorType;
|
@@ -28,14 +28,14 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
|
|
28
28
|
};
|
29
29
|
interface FixedAmountPromotion extends Resource {
|
30
30
|
readonly type: FixedAmountPromotionType;
|
31
|
-
name
|
31
|
+
name: string;
|
32
32
|
currency_code?: string;
|
33
|
-
starts_at
|
34
|
-
expires_at
|
35
|
-
total_usage_limit
|
33
|
+
starts_at: string;
|
34
|
+
expires_at: string;
|
35
|
+
total_usage_limit: number;
|
36
36
|
total_usage_count?: number;
|
37
37
|
active?: boolean;
|
38
|
-
fixed_amount_cents
|
38
|
+
fixed_amount_cents: number;
|
39
39
|
fixed_amount_float?: number;
|
40
40
|
formatted_fixed_amount?: string;
|
41
41
|
market?: Market;
|
@@ -60,12 +60,12 @@ interface FixedAmountPromotionCreate extends ResourceCreate {
|
|
60
60
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
61
61
|
}
|
62
62
|
interface FixedAmountPromotionUpdate extends ResourceUpdate {
|
63
|
-
name
|
63
|
+
name: string;
|
64
64
|
currency_code?: string;
|
65
|
-
starts_at
|
66
|
-
expires_at
|
67
|
-
total_usage_limit
|
68
|
-
fixed_amount_cents
|
65
|
+
starts_at: string;
|
66
|
+
expires_at: string;
|
67
|
+
total_usage_limit: number;
|
68
|
+
fixed_amount_cents: number;
|
69
69
|
market?: MarketRel;
|
70
70
|
promotion_rules?: PromotionRuleRel[];
|
71
71
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
@@ -33,14 +33,14 @@ type SkuListRel = ResourceRel & {
|
|
33
33
|
};
|
34
34
|
interface FixedPricePromotion extends Resource {
|
35
35
|
readonly type: FixedPricePromotionType;
|
36
|
-
name
|
36
|
+
name: string;
|
37
37
|
currency_code?: string;
|
38
|
-
starts_at
|
39
|
-
expires_at
|
40
|
-
total_usage_limit
|
38
|
+
starts_at: string;
|
39
|
+
expires_at: string;
|
40
|
+
total_usage_limit: number;
|
41
41
|
total_usage_count?: number;
|
42
42
|
active?: boolean;
|
43
|
-
fixed_amount_cents
|
43
|
+
fixed_amount_cents: number;
|
44
44
|
fixed_amount_float?: number;
|
45
45
|
formatted_fixed_amount?: string;
|
46
46
|
market?: Market;
|
@@ -68,12 +68,12 @@ interface FixedPricePromotionCreate extends ResourceCreate {
|
|
68
68
|
sku_list: SkuListRel;
|
69
69
|
}
|
70
70
|
interface FixedPricePromotionUpdate extends ResourceUpdate {
|
71
|
-
name
|
71
|
+
name: string;
|
72
72
|
currency_code?: string;
|
73
|
-
starts_at
|
74
|
-
expires_at
|
75
|
-
total_usage_limit
|
76
|
-
fixed_amount_cents
|
73
|
+
starts_at: string;
|
74
|
+
expires_at: string;
|
75
|
+
total_usage_limit: number;
|
76
|
+
fixed_amount_cents: number;
|
77
77
|
market?: MarketRel;
|
78
78
|
promotion_rules?: PromotionRuleRel[];
|
79
79
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
@@ -33,11 +33,11 @@ type SkuListRel = ResourceRel & {
|
|
33
33
|
};
|
34
34
|
interface FreeGiftPromotion extends Resource {
|
35
35
|
readonly type: FreeGiftPromotionType;
|
36
|
-
name
|
36
|
+
name: string;
|
37
37
|
currency_code?: string;
|
38
|
-
starts_at
|
39
|
-
expires_at
|
40
|
-
total_usage_limit
|
38
|
+
starts_at: string;
|
39
|
+
expires_at: string;
|
40
|
+
total_usage_limit: number;
|
41
41
|
total_usage_count?: number;
|
42
42
|
active?: boolean;
|
43
43
|
max_quantity?: number;
|
@@ -66,11 +66,11 @@ interface FreeGiftPromotionCreate extends ResourceCreate {
|
|
66
66
|
sku_list: SkuListRel;
|
67
67
|
}
|
68
68
|
interface FreeGiftPromotionUpdate extends ResourceUpdate {
|
69
|
-
name
|
69
|
+
name: string;
|
70
70
|
currency_code?: string;
|
71
|
-
starts_at
|
72
|
-
expires_at
|
73
|
-
total_usage_limit
|
71
|
+
starts_at: string;
|
72
|
+
expires_at: string;
|
73
|
+
total_usage_limit: number;
|
74
74
|
max_quantity?: number;
|
75
75
|
market?: MarketRel;
|
76
76
|
promotion_rules?: PromotionRuleRel[];
|
@@ -27,11 +27,11 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
|
|
27
27
|
};
|
28
28
|
interface FreeShippingPromotion extends Resource {
|
29
29
|
readonly type: FreeShippingPromotionType;
|
30
|
-
name
|
30
|
+
name: string;
|
31
31
|
currency_code?: string;
|
32
|
-
starts_at
|
33
|
-
expires_at
|
34
|
-
total_usage_limit
|
32
|
+
starts_at: string;
|
33
|
+
expires_at: string;
|
34
|
+
total_usage_limit: number;
|
35
35
|
total_usage_count?: number;
|
36
36
|
active?: boolean;
|
37
37
|
market?: Market;
|
@@ -54,11 +54,11 @@ interface FreeShippingPromotionCreate extends ResourceCreate {
|
|
54
54
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
55
55
|
}
|
56
56
|
interface FreeShippingPromotionUpdate extends ResourceUpdate {
|
57
|
-
name
|
57
|
+
name: string;
|
58
58
|
currency_code?: string;
|
59
|
-
starts_at
|
60
|
-
expires_at
|
61
|
-
total_usage_limit
|
59
|
+
starts_at: string;
|
60
|
+
expires_at: string;
|
61
|
+
total_usage_limit: number;
|
62
62
|
market?: MarketRel;
|
63
63
|
promotion_rules?: PromotionRuleRel[];
|
64
64
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
@@ -11,7 +11,7 @@ type CustomerRel = ResourceRel & {
|
|
11
11
|
};
|
12
12
|
interface GiftCardRecipient extends Resource {
|
13
13
|
readonly type: GiftCardRecipientType;
|
14
|
-
email
|
14
|
+
email: string;
|
15
15
|
first_name?: string;
|
16
16
|
last_name?: string;
|
17
17
|
customer?: Customer;
|
@@ -24,7 +24,7 @@ interface GiftCardRecipientCreate extends ResourceCreate {
|
|
24
24
|
customer?: CustomerRel;
|
25
25
|
}
|
26
26
|
interface GiftCardRecipientUpdate extends ResourceUpdate {
|
27
|
-
email
|
27
|
+
email: string;
|
28
28
|
first_name?: string;
|
29
29
|
last_name?: string;
|
30
30
|
customer?: CustomerRel;
|
@@ -19,16 +19,16 @@ interface GiftCard extends Resource {
|
|
19
19
|
status?: 'draft' | 'inactive' | 'active' | 'redeemed';
|
20
20
|
code?: string;
|
21
21
|
currency_code?: string;
|
22
|
-
initial_balance_cents
|
23
|
-
initial_balance_float
|
24
|
-
formatted_initial_balance
|
25
|
-
balance_cents
|
26
|
-
balance_float
|
27
|
-
formatted_balance
|
22
|
+
initial_balance_cents: number;
|
23
|
+
initial_balance_float: number;
|
24
|
+
formatted_initial_balance: string;
|
25
|
+
balance_cents: number;
|
26
|
+
balance_float: number;
|
27
|
+
formatted_balance: string;
|
28
28
|
balance_max_cents?: string;
|
29
29
|
balance_max_float?: number;
|
30
30
|
formatted_balance_max?: string;
|
31
|
-
balance_log
|
31
|
+
balance_log: object[];
|
32
32
|
single_use?: boolean;
|
33
33
|
rechargeable?: boolean;
|
34
34
|
image_url?: string;
|
@@ -54,7 +54,7 @@ interface GiftCardCreate extends ResourceCreate {
|
|
54
54
|
}
|
55
55
|
interface GiftCardUpdate extends ResourceUpdate {
|
56
56
|
currency_code?: string;
|
57
|
-
balance_cents
|
57
|
+
balance_cents: number;
|
58
58
|
balance_max_cents?: string;
|
59
59
|
single_use?: boolean;
|
60
60
|
rechargeable?: boolean;
|
@@ -8,7 +8,7 @@ type GoogleGeocoderRel = ResourceRel & {
|
|
8
8
|
};
|
9
9
|
interface GoogleGeocoder extends Resource {
|
10
10
|
readonly type: GoogleGeocoderType;
|
11
|
-
name
|
11
|
+
name: string;
|
12
12
|
addresses?: Address[];
|
13
13
|
attachments?: Attachment[];
|
14
14
|
}
|
@@ -17,7 +17,7 @@ interface GoogleGeocoderCreate extends ResourceCreate {
|
|
17
17
|
api_key: string;
|
18
18
|
}
|
19
19
|
interface GoogleGeocoderUpdate extends ResourceUpdate {
|
20
|
-
name
|
20
|
+
name: string;
|
21
21
|
api_key?: string;
|
22
22
|
}
|
23
23
|
declare class GoogleGeocoders extends ApiResource<GoogleGeocoder> {
|
@@ -7,13 +7,13 @@ type ImportRel = ResourceRel & {
|
|
7
7
|
};
|
8
8
|
interface Import extends Resource {
|
9
9
|
readonly type: ImportType;
|
10
|
-
resource_type
|
10
|
+
resource_type: string;
|
11
11
|
parent_resource_id?: string;
|
12
12
|
status?: 'pending' | 'in_progress' | 'interrupted' | 'completed';
|
13
13
|
started_at?: string;
|
14
14
|
completed_at?: string;
|
15
15
|
interrupted_at?: string;
|
16
|
-
inputs
|
16
|
+
inputs: object[];
|
17
17
|
inputs_size?: number;
|
18
18
|
errors_count?: number;
|
19
19
|
warnings_count?: number;
|
@@ -9,7 +9,7 @@ type InventoryModelRel = ResourceRel & {
|
|
9
9
|
};
|
10
10
|
interface InventoryModel extends Resource {
|
11
11
|
readonly type: InventoryModelType;
|
12
|
-
name
|
12
|
+
name: string;
|
13
13
|
strategy?: string;
|
14
14
|
stock_locations_cutoff?: number;
|
15
15
|
inventory_stock_locations?: InventoryStockLocation[];
|
@@ -22,7 +22,7 @@ interface InventoryModelCreate extends ResourceCreate {
|
|
22
22
|
stock_locations_cutoff?: number;
|
23
23
|
}
|
24
24
|
interface InventoryModelUpdate extends ResourceUpdate {
|
25
|
-
name
|
25
|
+
name: string;
|
26
26
|
strategy?: string;
|
27
27
|
stock_locations_cutoff?: number;
|
28
28
|
}
|
@@ -14,7 +14,7 @@ type InventoryModelRel = ResourceRel & {
|
|
14
14
|
};
|
15
15
|
interface InventoryReturnLocation extends Resource {
|
16
16
|
readonly type: InventoryReturnLocationType;
|
17
|
-
priority
|
17
|
+
priority: number;
|
18
18
|
stock_location?: StockLocation;
|
19
19
|
inventory_model?: InventoryModel;
|
20
20
|
}
|
@@ -24,7 +24,7 @@ interface InventoryReturnLocationCreate extends ResourceCreate {
|
|
24
24
|
inventory_model: InventoryModelRel;
|
25
25
|
}
|
26
26
|
interface InventoryReturnLocationUpdate extends ResourceUpdate {
|
27
|
-
priority
|
27
|
+
priority: number;
|
28
28
|
stock_location?: StockLocationRel;
|
29
29
|
inventory_model?: InventoryModelRel;
|
30
30
|
}
|
@@ -14,7 +14,7 @@ type InventoryModelRel = ResourceRel & {
|
|
14
14
|
};
|
15
15
|
interface InventoryStockLocation extends Resource {
|
16
16
|
readonly type: InventoryStockLocationType;
|
17
|
-
priority
|
17
|
+
priority: number;
|
18
18
|
on_hold?: boolean;
|
19
19
|
stock_location?: StockLocation;
|
20
20
|
inventory_model?: InventoryModel;
|
@@ -26,7 +26,7 @@ interface InventoryStockLocationCreate extends ResourceCreate {
|
|
26
26
|
inventory_model: InventoryModelRel;
|
27
27
|
}
|
28
28
|
interface InventoryStockLocationUpdate extends ResourceUpdate {
|
29
|
-
priority
|
29
|
+
priority: number;
|
30
30
|
on_hold?: boolean;
|
31
31
|
stock_location?: StockLocationRel;
|
32
32
|
inventory_model?: InventoryModelRel;
|
@@ -11,7 +11,7 @@ type KlarnaPaymentRel = ResourceRel & {
|
|
11
11
|
};
|
12
12
|
interface KlarnaGateway extends Resource {
|
13
13
|
readonly type: KlarnaGatewayType;
|
14
|
-
name
|
14
|
+
name: string;
|
15
15
|
payment_methods?: PaymentMethod[];
|
16
16
|
klarna_payments?: KlarnaPayment[];
|
17
17
|
}
|
@@ -23,7 +23,7 @@ interface KlarnaGatewayCreate extends ResourceCreate {
|
|
23
23
|
klarna_payments?: KlarnaPaymentRel[];
|
24
24
|
}
|
25
25
|
interface KlarnaGatewayUpdate extends ResourceUpdate {
|
26
|
-
name
|
26
|
+
name: string;
|
27
27
|
country_code?: string;
|
28
28
|
api_key?: string;
|
29
29
|
api_secret?: string;
|
@@ -13,10 +13,10 @@ interface KlarnaPayment extends Resource {
|
|
13
13
|
readonly type: KlarnaPaymentType;
|
14
14
|
session_id?: string;
|
15
15
|
client_token?: string;
|
16
|
-
payment_methods
|
16
|
+
payment_methods: object[];
|
17
17
|
auth_token?: string;
|
18
18
|
mismatched_amounts?: boolean;
|
19
|
-
intent_amount_cents
|
19
|
+
intent_amount_cents: number;
|
20
20
|
intent_amount_float?: number;
|
21
21
|
formatted_intent_amount?: string;
|
22
22
|
payment_instrument?: object;
|
@@ -15,17 +15,17 @@ type SkuOptionRel = ResourceRel & {
|
|
15
15
|
interface LineItemOption extends Resource {
|
16
16
|
readonly type: LineItemOptionType;
|
17
17
|
name?: string;
|
18
|
-
quantity
|
18
|
+
quantity: number;
|
19
19
|
currency_code?: string;
|
20
20
|
unit_amount_cents?: number;
|
21
21
|
unit_amount_float?: number;
|
22
22
|
formatted_unit_amount?: string;
|
23
23
|
total_amount_cents?: number;
|
24
|
-
total_amount_float
|
24
|
+
total_amount_float: number;
|
25
25
|
formatted_total_amount?: string;
|
26
26
|
delay_hours?: number;
|
27
27
|
delay_days?: number;
|
28
|
-
options
|
28
|
+
options: object;
|
29
29
|
line_item?: LineItem;
|
30
30
|
sku_option?: SkuOption;
|
31
31
|
}
|
@@ -38,8 +38,8 @@ interface LineItemOptionCreate extends ResourceCreate {
|
|
38
38
|
}
|
39
39
|
interface LineItemOptionUpdate extends ResourceUpdate {
|
40
40
|
name?: string;
|
41
|
-
quantity
|
42
|
-
options
|
41
|
+
quantity: number;
|
42
|
+
options: object;
|
43
43
|
sku_option?: SkuOptionRel;
|
44
44
|
}
|
45
45
|
declare class LineItemOptions extends ApiResource<LineItemOption> {
|
@@ -55,7 +55,7 @@ interface LineItem extends Resource {
|
|
55
55
|
readonly type: LineItemType;
|
56
56
|
sku_code?: string;
|
57
57
|
bundle_code?: string;
|
58
|
-
quantity
|
58
|
+
quantity: number;
|
59
59
|
currency_code?: string;
|
60
60
|
unit_amount_cents?: number;
|
61
61
|
unit_amount_float?: number;
|
@@ -67,10 +67,10 @@ interface LineItem extends Resource {
|
|
67
67
|
discount_float?: number;
|
68
68
|
formatted_discount?: string;
|
69
69
|
total_amount_cents?: number;
|
70
|
-
total_amount_float
|
70
|
+
total_amount_float: number;
|
71
71
|
formatted_total_amount?: string;
|
72
72
|
tax_amount_cents?: number;
|
73
|
-
tax_amount_float
|
73
|
+
tax_amount_float: number;
|
74
74
|
formatted_tax_amount?: string;
|
75
75
|
name?: string;
|
76
76
|
image_url?: string;
|
@@ -104,7 +104,7 @@ interface LineItemCreate extends ResourceCreate {
|
|
104
104
|
interface LineItemUpdate extends ResourceUpdate {
|
105
105
|
sku_code?: string;
|
106
106
|
bundle_code?: string;
|
107
|
-
quantity
|
107
|
+
quantity: number;
|
108
108
|
_external_price?: boolean;
|
109
109
|
name?: string;
|
110
110
|
image_url?: string;
|
@@ -7,14 +7,14 @@ type ManualGatewayRel = ResourceRel & {
|
|
7
7
|
};
|
8
8
|
interface ManualGateway extends Resource {
|
9
9
|
readonly type: ManualGatewayType;
|
10
|
-
name
|
10
|
+
name: string;
|
11
11
|
payment_methods?: PaymentMethod[];
|
12
12
|
}
|
13
13
|
interface ManualGatewayCreate extends ResourceCreate {
|
14
14
|
name: string;
|
15
15
|
}
|
16
16
|
interface ManualGatewayUpdate extends ResourceUpdate {
|
17
|
-
name
|
17
|
+
name: string;
|
18
18
|
}
|
19
19
|
declare class ManualGateways extends ApiResource<ManualGateway> {
|
20
20
|
static readonly TYPE: ManualGatewayType;
|
@@ -12,7 +12,7 @@ type TaxRuleRel = ResourceRel & {
|
|
12
12
|
};
|
13
13
|
interface ManualTaxCalculator extends Resource {
|
14
14
|
readonly type: ManualTaxCalculatorType;
|
15
|
-
name
|
15
|
+
name: string;
|
16
16
|
markets?: Market[];
|
17
17
|
attachments?: Attachment[];
|
18
18
|
tax_rules?: TaxRule[];
|
@@ -22,7 +22,7 @@ interface ManualTaxCalculatorCreate extends ResourceCreate {
|
|
22
22
|
tax_rules?: TaxRuleRel[];
|
23
23
|
}
|
24
24
|
interface ManualTaxCalculatorUpdate extends ResourceUpdate {
|
25
|
-
name
|
25
|
+
name: string;
|
26
26
|
tax_rules?: TaxRuleRel[];
|
27
27
|
}
|
28
28
|
declare class ManualTaxCalculators extends ApiResource<ManualTaxCalculator> {
|
@@ -28,12 +28,12 @@ type CustomerGroupRel = ResourceRel & {
|
|
28
28
|
interface Market extends Resource {
|
29
29
|
readonly type: MarketType;
|
30
30
|
number?: number;
|
31
|
-
name
|
31
|
+
name: string;
|
32
32
|
facebook_pixel_id?: string;
|
33
33
|
checkout_url?: string;
|
34
34
|
external_prices_url?: string;
|
35
35
|
external_order_validation_url?: string;
|
36
|
-
shared_secret
|
36
|
+
shared_secret: string;
|
37
37
|
private?: boolean;
|
38
38
|
disabled_at?: string;
|
39
39
|
merchant?: Merchant;
|
@@ -56,7 +56,7 @@ interface MarketCreate extends ResourceCreate {
|
|
56
56
|
customer_group?: CustomerGroupRel;
|
57
57
|
}
|
58
58
|
interface MarketUpdate extends ResourceUpdate {
|
59
|
-
name
|
59
|
+
name: string;
|
60
60
|
facebook_pixel_id?: string;
|
61
61
|
checkout_url?: string;
|
62
62
|
external_prices_url?: string;
|
@@ -11,7 +11,7 @@ type AddressRel = ResourceRel & {
|
|
11
11
|
};
|
12
12
|
interface Merchant extends Resource {
|
13
13
|
readonly type: MerchantType;
|
14
|
-
name
|
14
|
+
name: string;
|
15
15
|
address?: Address;
|
16
16
|
attachments?: Attachment[];
|
17
17
|
}
|
@@ -20,7 +20,7 @@ interface MerchantCreate extends ResourceCreate {
|
|
20
20
|
address: AddressRel;
|
21
21
|
}
|
22
22
|
interface MerchantUpdate extends ResourceUpdate {
|
23
|
-
name
|
23
|
+
name: string;
|
24
24
|
address?: AddressRel;
|
25
25
|
}
|
26
26
|
declare class Merchants extends ApiResource<Merchant> {
|
@@ -19,7 +19,7 @@ interface OrderSubscription extends Resource {
|
|
19
19
|
readonly type: OrderSubscriptionType;
|
20
20
|
number?: string;
|
21
21
|
status?: 'draft' | 'inactive' | 'active' | 'cancelled';
|
22
|
-
frequency
|
22
|
+
frequency: string;
|
23
23
|
activate_by_source_order?: boolean;
|
24
24
|
customer_email?: string;
|
25
25
|
starts_at?: string;
|
@@ -12,12 +12,12 @@ type StockLocationRel = ResourceRel & {
|
|
12
12
|
};
|
13
13
|
interface Package extends Resource {
|
14
14
|
readonly type: PackageType;
|
15
|
-
name
|
15
|
+
name: string;
|
16
16
|
code?: string;
|
17
|
-
length
|
18
|
-
width
|
19
|
-
height
|
20
|
-
unit_of_length
|
17
|
+
length: number;
|
18
|
+
width: number;
|
19
|
+
height: number;
|
20
|
+
unit_of_length: string;
|
21
21
|
stock_location?: StockLocation;
|
22
22
|
parcels?: Parcel[];
|
23
23
|
attachments?: Attachment[];
|
@@ -32,12 +32,12 @@ interface PackageCreate extends ResourceCreate {
|
|
32
32
|
stock_location: StockLocationRel;
|
33
33
|
}
|
34
34
|
interface PackageUpdate extends ResourceUpdate {
|
35
|
-
name
|
35
|
+
name: string;
|
36
36
|
code?: string;
|
37
|
-
length
|
38
|
-
width
|
39
|
-
height
|
40
|
-
unit_of_length
|
37
|
+
length: number;
|
38
|
+
width: number;
|
39
|
+
height: number;
|
40
|
+
unit_of_length: string;
|
41
41
|
stock_location?: StockLocationRel;
|
42
42
|
}
|
43
43
|
declare class Packages extends ApiResource<Package> {
|
@@ -15,8 +15,8 @@ type StockLineItemRel = ResourceRel & {
|
|
15
15
|
interface ParcelLineItem extends Resource {
|
16
16
|
readonly type: ParcelLineItemType;
|
17
17
|
sku_code?: string;
|
18
|
-
quantity
|
19
|
-
name
|
18
|
+
quantity: number;
|
19
|
+
name: string;
|
20
20
|
image_url?: string;
|
21
21
|
parcel?: Parcel;
|
22
22
|
stock_line_item?: StockLineItem;
|
@@ -18,8 +18,8 @@ type PackageRel = ResourceRel & {
|
|
18
18
|
interface Parcel extends Resource {
|
19
19
|
readonly type: ParcelType;
|
20
20
|
number?: string;
|
21
|
-
weight
|
22
|
-
unit_of_weight
|
21
|
+
weight: number;
|
22
|
+
unit_of_weight: string;
|
23
23
|
eel_pfc?: string;
|
24
24
|
contents_type?: string;
|
25
25
|
contents_explanation?: string;
|
@@ -75,8 +75,8 @@ interface ParcelCreate extends ResourceCreate {
|
|
75
75
|
package: PackageRel;
|
76
76
|
}
|
77
77
|
interface ParcelUpdate extends ResourceUpdate {
|
78
|
-
weight
|
79
|
-
unit_of_weight
|
78
|
+
weight: number;
|
79
|
+
unit_of_weight: string;
|
80
80
|
eel_pfc?: string;
|
81
81
|
contents_type?: string;
|
82
82
|
contents_explanation?: string;
|
@@ -7,7 +7,7 @@ type PaymentGatewayRel = ResourceRel & {
|
|
7
7
|
};
|
8
8
|
interface PaymentGateway extends Resource {
|
9
9
|
readonly type: PaymentGatewayType;
|
10
|
-
name
|
10
|
+
name: string;
|
11
11
|
payment_methods?: PaymentMethod[];
|
12
12
|
}
|
13
13
|
declare class PaymentGateways extends ApiResource<PaymentGateway> {
|
@@ -15,14 +15,14 @@ type PaymentGatewayRel = ResourceRel & {
|
|
15
15
|
};
|
16
16
|
interface PaymentMethod extends Resource {
|
17
17
|
readonly type: PaymentMethodType;
|
18
|
-
payment_source_type
|
18
|
+
payment_source_type: string;
|
19
19
|
name?: string;
|
20
20
|
currency_code?: string;
|
21
21
|
moto?: boolean;
|
22
22
|
require_capture?: boolean;
|
23
23
|
auto_capture?: boolean;
|
24
24
|
disabled_at?: string;
|
25
|
-
price_amount_cents
|
25
|
+
price_amount_cents: number;
|
26
26
|
price_amount_float?: number;
|
27
27
|
formatted_price_amount?: string;
|
28
28
|
auto_capture_max_amount_cents?: number;
|
@@ -44,14 +44,14 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
44
44
|
payment_gateway: PaymentGatewayRel;
|
45
45
|
}
|
46
46
|
interface PaymentMethodUpdate extends ResourceUpdate {
|
47
|
-
payment_source_type
|
47
|
+
payment_source_type: string;
|
48
48
|
currency_code?: string;
|
49
49
|
moto?: boolean;
|
50
50
|
require_capture?: boolean;
|
51
51
|
auto_capture?: boolean;
|
52
52
|
_disable?: boolean;
|
53
53
|
_enable?: boolean;
|
54
|
-
price_amount_cents
|
54
|
+
price_amount_cents: number;
|
55
55
|
auto_capture_max_amount_cents?: number;
|
56
56
|
market?: MarketRel;
|
57
57
|
payment_gateway?: PaymentGatewayRel;
|