@commercelayer/sdk 5.0.0-beta.9 → 5.1.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/LICENSE +2 -2
- package/README.md +18 -0
- package/lib/cjs/api.d.ts +23 -12
- package/lib/cjs/api.js +20 -2
- package/lib/cjs/client.d.ts +3 -5
- package/lib/cjs/commercelayer.d.ts +10 -4
- package/lib/cjs/commercelayer.js +9 -3
- package/lib/cjs/common.d.ts +1 -0
- package/lib/cjs/common.js +11 -0
- package/lib/cjs/index.d.ts +1 -2
- package/lib/cjs/index.js +0 -16
- package/lib/cjs/interceptor.d.ts +1 -1
- package/lib/cjs/model.d.ts +7 -1
- package/lib/cjs/query.d.ts +5 -13
- package/lib/cjs/resource.d.ts +8 -10
- package/lib/cjs/resources/addresses.d.ts +63 -51
- package/lib/cjs/resources/addresses.js +8 -0
- package/lib/cjs/resources/adjustments.d.ts +5 -4
- package/lib/cjs/resources/adyen_gateways.d.ts +21 -20
- package/lib/cjs/resources/adyen_payments.d.ts +16 -15
- package/lib/cjs/resources/application.d.ts +7 -6
- package/lib/cjs/resources/attachments.d.ts +11 -10
- package/lib/cjs/resources/authorizations.d.ts +28 -27
- package/lib/cjs/resources/avalara_accounts.d.ts +17 -16
- package/lib/cjs/resources/axerve_gateways.d.ts +9 -8
- package/lib/cjs/resources/axerve_payments.d.ts +12 -11
- package/lib/cjs/resources/billing_info_validation_rules.d.ts +5 -4
- package/lib/cjs/resources/bing_geocoders.d.ts +6 -5
- package/lib/cjs/resources/braintree_gateways.d.ts +21 -20
- package/lib/cjs/resources/braintree_payments.d.ts +17 -16
- package/lib/cjs/resources/bundles.d.ts +38 -26
- package/lib/cjs/resources/bundles.js +8 -0
- package/lib/cjs/resources/captures.d.ts +19 -18
- package/lib/cjs/resources/carrier_accounts.d.ts +7 -6
- package/lib/cjs/resources/checkout_com_gateways.d.ts +12 -11
- package/lib/cjs/resources/checkout_com_payments.d.ts +25 -24
- package/lib/cjs/resources/cleanups.d.ts +13 -12
- package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +7 -6
- package/lib/cjs/resources/coupon_recipients.d.ts +13 -12
- package/lib/cjs/resources/coupons.d.ts +27 -15
- package/lib/cjs/resources/coupons.js +8 -0
- package/lib/cjs/resources/customer_addresses.d.ts +8 -7
- package/lib/cjs/resources/customer_groups.d.ts +6 -5
- package/lib/cjs/resources/customer_password_resets.d.ts +8 -7
- package/lib/cjs/resources/customer_payment_sources.d.ts +9 -8
- package/lib/cjs/resources/customer_subscriptions.d.ts +4 -3
- package/lib/cjs/resources/customers.d.ts +27 -18
- package/lib/cjs/resources/customers.js +4 -0
- package/lib/cjs/resources/delivery_lead_times.d.ts +11 -10
- package/lib/cjs/resources/event_callbacks.d.ts +6 -5
- package/lib/cjs/resources/events.d.ts +4 -3
- package/lib/cjs/resources/exports.d.ts +17 -16
- package/lib/cjs/resources/external_gateways.d.ts +20 -19
- package/lib/cjs/resources/external_payments.d.ts +10 -9
- package/lib/cjs/resources/external_promotions.d.ts +37 -28
- package/lib/cjs/resources/external_promotions.js +4 -0
- package/lib/cjs/resources/external_tax_calculators.d.ts +6 -5
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +39 -30
- package/lib/cjs/resources/fixed_amount_promotions.js +4 -0
- package/lib/cjs/resources/fixed_price_promotions.d.ts +44 -35
- package/lib/cjs/resources/fixed_price_promotions.js +8 -4
- package/lib/cjs/resources/free_gift_promotions.d.ts +44 -35
- package/lib/cjs/resources/free_gift_promotions.js +8 -4
- package/lib/cjs/resources/free_shipping_promotions.d.ts +38 -26
- package/lib/cjs/resources/free_shipping_promotions.js +8 -0
- package/lib/cjs/resources/geocoders.d.ts +4 -3
- package/lib/cjs/resources/gift_card_recipients.d.ts +13 -12
- package/lib/cjs/resources/gift_cards.d.ts +50 -41
- package/lib/cjs/resources/gift_cards.js +4 -0
- package/lib/cjs/resources/google_geocoders.d.ts +6 -5
- package/lib/cjs/resources/imports.d.ts +22 -21
- package/lib/cjs/resources/in_stock_subscriptions.d.ts +20 -19
- package/lib/cjs/resources/inventory_models.d.ts +12 -11
- package/lib/cjs/resources/inventory_return_locations.d.ts +7 -6
- package/lib/cjs/resources/inventory_stock_locations.d.ts +10 -9
- package/lib/cjs/resources/klarna_gateways.d.ts +10 -9
- package/lib/cjs/resources/klarna_payments.d.ts +15 -14
- package/lib/cjs/resources/line_item_options.d.ts +32 -20
- package/lib/cjs/resources/line_item_options.js +8 -0
- package/lib/cjs/resources/line_items.d.ts +58 -43
- package/lib/cjs/resources/line_items.js +8 -0
- package/lib/cjs/resources/manual_gateways.d.ts +4 -3
- package/lib/cjs/resources/manual_tax_calculators.d.ts +8 -7
- package/lib/cjs/resources/markets.d.ts +41 -32
- package/lib/cjs/resources/markets.js +4 -0
- package/lib/cjs/resources/merchants.d.ts +6 -5
- package/lib/cjs/resources/order_amount_promotion_rules.d.ts +9 -8
- package/lib/cjs/resources/order_copies.d.ts +23 -20
- package/lib/cjs/resources/order_copies.js +7 -4
- package/lib/cjs/resources/order_factories.d.ts +34 -0
- package/lib/cjs/resources/order_factories.js +28 -0
- package/lib/cjs/resources/order_subscription_items.d.ts +61 -0
- package/lib/cjs/resources/order_subscription_items.js +29 -0
- package/lib/cjs/resources/order_subscriptions.d.ts +52 -29
- package/lib/cjs/resources/order_subscriptions.js +18 -2
- package/lib/cjs/resources/order_validation_rules.d.ts +4 -3
- package/lib/cjs/resources/orders.d.ts +200 -183
- package/lib/cjs/resources/orders.js +12 -0
- package/lib/cjs/resources/organization.d.ts +18 -17
- package/lib/cjs/resources/packages.d.ts +14 -13
- package/lib/cjs/resources/parcel_line_items.d.ts +7 -6
- package/lib/cjs/resources/parcels.d.ts +78 -74
- package/lib/cjs/resources/payment_gateways.d.ts +3 -2
- package/lib/cjs/resources/payment_methods.d.ts +33 -32
- package/lib/cjs/resources/paypal_gateways.d.ts +7 -6
- package/lib/cjs/resources/paypal_payments.d.ts +17 -16
- package/lib/cjs/resources/percentage_discount_promotions.d.ts +43 -34
- package/lib/cjs/resources/percentage_discount_promotions.js +8 -4
- package/lib/cjs/resources/price_frequency_tiers.d.ts +50 -0
- package/lib/cjs/resources/price_frequency_tiers.js +37 -0
- package/lib/cjs/resources/price_lists.d.ts +9 -8
- package/lib/cjs/resources/price_tiers.d.ts +7 -6
- package/lib/cjs/resources/price_volume_tiers.d.ts +15 -11
- package/lib/cjs/resources/price_volume_tiers.js +4 -0
- package/lib/cjs/resources/prices.d.ts +20 -16
- package/lib/cjs/resources/prices.js +4 -0
- package/lib/cjs/resources/promotion_rules.d.ts +3 -2
- package/lib/cjs/resources/promotions.d.ts +17 -10
- package/lib/cjs/resources/promotions.js +8 -0
- package/lib/cjs/resources/recurring_order_copies.d.ts +53 -0
- package/lib/cjs/resources/recurring_order_copies.js +41 -0
- package/lib/cjs/resources/refunds.d.ts +10 -9
- package/lib/cjs/resources/return_line_items.d.ts +13 -12
- package/lib/cjs/resources/returns.d.ts +39 -30
- package/lib/cjs/resources/returns.js +4 -0
- package/lib/cjs/resources/satispay_gateways.d.ts +11 -7
- package/lib/cjs/resources/satispay_payments.d.ts +10 -12
- package/lib/cjs/resources/shipments.d.ts +42 -41
- package/lib/cjs/resources/shipping_categories.d.ts +5 -4
- package/lib/cjs/resources/shipping_method_tiers.d.ts +7 -6
- package/lib/cjs/resources/shipping_methods.d.ts +50 -49
- package/lib/cjs/resources/shipping_weight_tiers.d.ts +12 -11
- package/lib/cjs/resources/shipping_zones.d.ts +22 -21
- package/lib/cjs/resources/sku_list_items.d.ts +13 -12
- package/lib/cjs/resources/sku_list_promotion_rules.d.ts +14 -13
- package/lib/cjs/resources/sku_lists.d.ts +22 -21
- package/lib/cjs/resources/sku_options.d.ts +36 -24
- package/lib/cjs/resources/sku_options.js +8 -0
- package/lib/cjs/resources/skus.d.ts +47 -35
- package/lib/cjs/resources/skus.js +8 -0
- package/lib/cjs/resources/stock_items.d.ts +12 -11
- package/lib/cjs/resources/stock_line_items.d.ts +7 -6
- package/lib/cjs/resources/stock_locations.d.ts +17 -16
- package/lib/cjs/resources/stock_transfers.d.ts +24 -23
- package/lib/cjs/resources/stripe_gateways.d.ts +12 -11
- package/lib/cjs/resources/stripe_payments.d.ts +15 -14
- package/lib/cjs/resources/subscription_models.d.ts +49 -0
- package/lib/cjs/resources/subscription_models.js +37 -0
- package/lib/cjs/resources/tags.d.ts +28 -0
- package/lib/cjs/resources/tags.js +25 -0
- package/lib/cjs/resources/tax_calculators.d.ts +4 -3
- package/lib/cjs/resources/tax_categories.d.ts +10 -9
- package/lib/cjs/resources/tax_rules.d.ts +39 -38
- package/lib/cjs/resources/taxjar_accounts.d.ts +9 -8
- package/lib/cjs/resources/transactions.d.ts +8 -7
- package/lib/cjs/resources/voids.d.ts +10 -9
- package/lib/cjs/resources/webhooks.d.ts +14 -13
- package/lib/cjs/resources/wire_transfers.d.ts +5 -4
- package/lib/cjs/util.d.ts +1 -3
- package/lib/esm/api.d.ts +23 -12
- package/lib/esm/api.js +12 -0
- package/lib/esm/client.d.ts +3 -5
- package/lib/esm/commercelayer.d.ts +10 -4
- package/lib/esm/commercelayer.js +9 -3
- package/lib/esm/common.d.ts +1 -0
- package/lib/esm/common.js +11 -0
- package/lib/esm/index.d.ts +1 -2
- package/lib/esm/index.js +0 -2
- package/lib/esm/interceptor.d.ts +1 -1
- package/lib/esm/model.d.ts +7 -1
- package/lib/esm/query.d.ts +5 -13
- package/lib/esm/resource.d.ts +8 -10
- package/lib/esm/resources/addresses.d.ts +63 -51
- package/lib/esm/resources/addresses.js +8 -0
- package/lib/esm/resources/adjustments.d.ts +5 -4
- package/lib/esm/resources/adyen_gateways.d.ts +21 -20
- package/lib/esm/resources/adyen_payments.d.ts +16 -15
- package/lib/esm/resources/application.d.ts +7 -6
- package/lib/esm/resources/attachments.d.ts +11 -10
- package/lib/esm/resources/authorizations.d.ts +28 -27
- package/lib/esm/resources/avalara_accounts.d.ts +17 -16
- package/lib/esm/resources/axerve_gateways.d.ts +9 -8
- package/lib/esm/resources/axerve_payments.d.ts +12 -11
- package/lib/esm/resources/billing_info_validation_rules.d.ts +5 -4
- package/lib/esm/resources/bing_geocoders.d.ts +6 -5
- package/lib/esm/resources/braintree_gateways.d.ts +21 -20
- package/lib/esm/resources/braintree_payments.d.ts +17 -16
- package/lib/esm/resources/bundles.d.ts +38 -26
- package/lib/esm/resources/bundles.js +8 -0
- package/lib/esm/resources/captures.d.ts +19 -18
- package/lib/esm/resources/carrier_accounts.d.ts +7 -6
- package/lib/esm/resources/checkout_com_gateways.d.ts +12 -11
- package/lib/esm/resources/checkout_com_payments.d.ts +25 -24
- package/lib/esm/resources/cleanups.d.ts +13 -12
- package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +7 -6
- package/lib/esm/resources/coupon_recipients.d.ts +13 -12
- package/lib/esm/resources/coupons.d.ts +27 -15
- package/lib/esm/resources/coupons.js +8 -0
- package/lib/esm/resources/customer_addresses.d.ts +8 -7
- package/lib/esm/resources/customer_groups.d.ts +6 -5
- package/lib/esm/resources/customer_password_resets.d.ts +8 -7
- package/lib/esm/resources/customer_payment_sources.d.ts +9 -8
- package/lib/esm/resources/customer_subscriptions.d.ts +4 -3
- package/lib/esm/resources/customers.d.ts +27 -18
- package/lib/esm/resources/customers.js +4 -0
- package/lib/esm/resources/delivery_lead_times.d.ts +11 -10
- package/lib/esm/resources/event_callbacks.d.ts +6 -5
- package/lib/esm/resources/events.d.ts +4 -3
- package/lib/esm/resources/exports.d.ts +17 -16
- package/lib/esm/resources/external_gateways.d.ts +20 -19
- package/lib/esm/resources/external_payments.d.ts +10 -9
- package/lib/esm/resources/external_promotions.d.ts +37 -28
- package/lib/esm/resources/external_promotions.js +4 -0
- package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
- package/lib/esm/resources/fixed_amount_promotions.d.ts +39 -30
- package/lib/esm/resources/fixed_amount_promotions.js +4 -0
- package/lib/esm/resources/fixed_price_promotions.d.ts +44 -35
- package/lib/esm/resources/fixed_price_promotions.js +8 -4
- package/lib/esm/resources/free_gift_promotions.d.ts +44 -35
- package/lib/esm/resources/free_gift_promotions.js +8 -4
- package/lib/esm/resources/free_shipping_promotions.d.ts +38 -26
- package/lib/esm/resources/free_shipping_promotions.js +8 -0
- package/lib/esm/resources/geocoders.d.ts +4 -3
- package/lib/esm/resources/gift_card_recipients.d.ts +13 -12
- package/lib/esm/resources/gift_cards.d.ts +50 -41
- package/lib/esm/resources/gift_cards.js +4 -0
- package/lib/esm/resources/google_geocoders.d.ts +6 -5
- package/lib/esm/resources/imports.d.ts +22 -21
- package/lib/esm/resources/in_stock_subscriptions.d.ts +20 -19
- package/lib/esm/resources/inventory_models.d.ts +12 -11
- package/lib/esm/resources/inventory_return_locations.d.ts +7 -6
- package/lib/esm/resources/inventory_stock_locations.d.ts +10 -9
- package/lib/esm/resources/klarna_gateways.d.ts +10 -9
- package/lib/esm/resources/klarna_payments.d.ts +15 -14
- package/lib/esm/resources/line_item_options.d.ts +32 -20
- package/lib/esm/resources/line_item_options.js +8 -0
- package/lib/esm/resources/line_items.d.ts +58 -43
- package/lib/esm/resources/line_items.js +8 -0
- package/lib/esm/resources/manual_gateways.d.ts +4 -3
- package/lib/esm/resources/manual_tax_calculators.d.ts +8 -7
- package/lib/esm/resources/markets.d.ts +41 -32
- package/lib/esm/resources/markets.js +4 -0
- package/lib/esm/resources/merchants.d.ts +6 -5
- package/lib/esm/resources/order_amount_promotion_rules.d.ts +9 -8
- package/lib/esm/resources/order_copies.d.ts +23 -20
- package/lib/esm/resources/order_copies.js +7 -4
- package/lib/esm/resources/order_factories.d.ts +34 -0
- package/lib/esm/resources/order_factories.js +26 -0
- package/lib/esm/resources/order_subscription_items.d.ts +61 -0
- package/lib/esm/resources/order_subscription_items.js +27 -0
- package/lib/esm/resources/order_subscriptions.d.ts +52 -29
- package/lib/esm/resources/order_subscriptions.js +18 -2
- package/lib/esm/resources/order_validation_rules.d.ts +4 -3
- package/lib/esm/resources/orders.d.ts +200 -183
- package/lib/esm/resources/orders.js +12 -0
- package/lib/esm/resources/organization.d.ts +18 -17
- package/lib/esm/resources/packages.d.ts +14 -13
- package/lib/esm/resources/parcel_line_items.d.ts +7 -6
- package/lib/esm/resources/parcels.d.ts +78 -74
- package/lib/esm/resources/payment_gateways.d.ts +3 -2
- package/lib/esm/resources/payment_methods.d.ts +33 -32
- package/lib/esm/resources/paypal_gateways.d.ts +7 -6
- package/lib/esm/resources/paypal_payments.d.ts +17 -16
- package/lib/esm/resources/percentage_discount_promotions.d.ts +43 -34
- package/lib/esm/resources/percentage_discount_promotions.js +8 -4
- package/lib/esm/resources/price_frequency_tiers.d.ts +50 -0
- package/lib/esm/resources/price_frequency_tiers.js +35 -0
- package/lib/esm/resources/price_lists.d.ts +9 -8
- package/lib/esm/resources/price_tiers.d.ts +7 -6
- package/lib/esm/resources/price_volume_tiers.d.ts +15 -11
- package/lib/esm/resources/price_volume_tiers.js +4 -0
- package/lib/esm/resources/prices.d.ts +20 -16
- package/lib/esm/resources/prices.js +4 -0
- package/lib/esm/resources/promotion_rules.d.ts +3 -2
- package/lib/esm/resources/promotions.d.ts +17 -10
- package/lib/esm/resources/promotions.js +8 -0
- package/lib/esm/resources/recurring_order_copies.d.ts +53 -0
- package/lib/esm/resources/recurring_order_copies.js +39 -0
- package/lib/esm/resources/refunds.d.ts +10 -9
- package/lib/esm/resources/return_line_items.d.ts +13 -12
- package/lib/esm/resources/returns.d.ts +39 -30
- package/lib/esm/resources/returns.js +4 -0
- package/lib/esm/resources/satispay_gateways.d.ts +11 -7
- package/lib/esm/resources/satispay_payments.d.ts +10 -12
- package/lib/esm/resources/shipments.d.ts +42 -41
- package/lib/esm/resources/shipping_categories.d.ts +5 -4
- package/lib/esm/resources/shipping_method_tiers.d.ts +7 -6
- package/lib/esm/resources/shipping_methods.d.ts +50 -49
- package/lib/esm/resources/shipping_weight_tiers.d.ts +12 -11
- package/lib/esm/resources/shipping_zones.d.ts +22 -21
- package/lib/esm/resources/sku_list_items.d.ts +13 -12
- package/lib/esm/resources/sku_list_promotion_rules.d.ts +14 -13
- package/lib/esm/resources/sku_lists.d.ts +22 -21
- package/lib/esm/resources/sku_options.d.ts +36 -24
- package/lib/esm/resources/sku_options.js +8 -0
- package/lib/esm/resources/skus.d.ts +47 -35
- package/lib/esm/resources/skus.js +8 -0
- package/lib/esm/resources/stock_items.d.ts +12 -11
- package/lib/esm/resources/stock_line_items.d.ts +7 -6
- package/lib/esm/resources/stock_locations.d.ts +17 -16
- package/lib/esm/resources/stock_transfers.d.ts +24 -23
- package/lib/esm/resources/stripe_gateways.d.ts +12 -11
- package/lib/esm/resources/stripe_payments.d.ts +15 -14
- package/lib/esm/resources/subscription_models.d.ts +49 -0
- package/lib/esm/resources/subscription_models.js +35 -0
- package/lib/esm/resources/tags.d.ts +28 -0
- package/lib/esm/resources/tags.js +23 -0
- package/lib/esm/resources/tax_calculators.d.ts +4 -3
- package/lib/esm/resources/tax_categories.d.ts +10 -9
- package/lib/esm/resources/tax_rules.d.ts +39 -38
- package/lib/esm/resources/taxjar_accounts.d.ts +9 -8
- package/lib/esm/resources/transactions.d.ts +8 -7
- package/lib/esm/resources/voids.d.ts +10 -9
- package/lib/esm/resources/webhooks.d.ts +14 -13
- package/lib/esm/resources/wire_transfers.d.ts +5 -4
- package/lib/esm/util.d.ts +1 -3
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +12 -12
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { PaymentMethod } from './payment_methods';
|
4
5
|
import type { ExternalPayment } from './external_payments';
|
@@ -10,29 +11,29 @@ interface ExternalGateway extends Resource {
|
|
10
11
|
readonly type: ExternalGatewayType;
|
11
12
|
name: string;
|
12
13
|
shared_secret: string;
|
13
|
-
authorize_url?: string;
|
14
|
-
capture_url?: string;
|
15
|
-
void_url?: string;
|
16
|
-
refund_url?: string;
|
17
|
-
token_url?: string;
|
18
|
-
payment_methods?: PaymentMethod[];
|
19
|
-
external_payments?: ExternalPayment[];
|
14
|
+
authorize_url?: string | null;
|
15
|
+
capture_url?: string | null;
|
16
|
+
void_url?: string | null;
|
17
|
+
refund_url?: string | null;
|
18
|
+
token_url?: string | null;
|
19
|
+
payment_methods?: PaymentMethod[] | null;
|
20
|
+
external_payments?: ExternalPayment[] | null;
|
20
21
|
}
|
21
22
|
interface ExternalGatewayCreate extends ResourceCreate {
|
22
23
|
name: string;
|
23
|
-
authorize_url?: string;
|
24
|
-
capture_url?: string;
|
25
|
-
void_url?: string;
|
26
|
-
refund_url?: string;
|
27
|
-
token_url?: string;
|
24
|
+
authorize_url?: string | null;
|
25
|
+
capture_url?: string | null;
|
26
|
+
void_url?: string | null;
|
27
|
+
refund_url?: string | null;
|
28
|
+
token_url?: string | null;
|
28
29
|
}
|
29
30
|
interface ExternalGatewayUpdate extends ResourceUpdate {
|
30
|
-
name
|
31
|
-
authorize_url?: string;
|
32
|
-
capture_url?: string;
|
33
|
-
void_url?: string;
|
34
|
-
refund_url?: string;
|
35
|
-
token_url?: string;
|
31
|
+
name?: string | null;
|
32
|
+
authorize_url?: string | null;
|
33
|
+
capture_url?: string | null;
|
34
|
+
void_url?: string | null;
|
35
|
+
refund_url?: string | null;
|
36
|
+
token_url?: string | null;
|
36
37
|
}
|
37
38
|
declare class ExternalGateways extends ApiResource<ExternalGateway> {
|
38
39
|
static readonly TYPE: ExternalGatewayType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve } from '../query';
|
3
4
|
import type { Order, OrderType } from './orders';
|
4
5
|
import type { PaymentGateway } from './payment_gateways';
|
@@ -13,20 +14,20 @@ type OrderRel = ResourceRel & {
|
|
13
14
|
interface ExternalPayment extends Resource {
|
14
15
|
readonly type: ExternalPaymentType;
|
15
16
|
payment_source_token: string;
|
16
|
-
options?:
|
17
|
-
payment_instrument?:
|
18
|
-
order?: Order;
|
19
|
-
payment_gateway?: PaymentGateway;
|
20
|
-
wallet?: CustomerPaymentSource;
|
17
|
+
options?: Record<string, any> | null;
|
18
|
+
payment_instrument?: Record<string, any> | null;
|
19
|
+
order?: Order | null;
|
20
|
+
payment_gateway?: PaymentGateway | null;
|
21
|
+
wallet?: CustomerPaymentSource | null;
|
21
22
|
}
|
22
23
|
interface ExternalPaymentCreate extends ResourceCreate {
|
23
24
|
payment_source_token: string;
|
24
|
-
options?:
|
25
|
+
options?: Record<string, any> | null;
|
25
26
|
order: OrderRel;
|
26
27
|
}
|
27
28
|
interface ExternalPaymentUpdate extends ResourceUpdate {
|
28
|
-
options?:
|
29
|
-
order?: OrderRel;
|
29
|
+
options?: Record<string, any> | null;
|
30
|
+
order?: OrderRel | null;
|
30
31
|
}
|
31
32
|
declare class ExternalPayments extends ApiResource<ExternalPayment> {
|
32
33
|
static readonly TYPE: ExternalPaymentType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Market, MarketType } from './markets';
|
4
5
|
import type { PromotionRule, PromotionRuleType } from './promotion_rules';
|
@@ -7,6 +8,7 @@ import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_
|
|
7
8
|
import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
8
9
|
import type { Attachment } from './attachments';
|
9
10
|
import type { Event } from './events';
|
11
|
+
import type { Tag, TagType } from './tags';
|
10
12
|
type ExternalPromotionType = 'external_promotions';
|
11
13
|
type ExternalPromotionRel = ResourceRel & {
|
12
14
|
type: ExternalPromotionType;
|
@@ -26,50 +28,56 @@ type SkuListPromotionRuleRel = ResourceRel & {
|
|
26
28
|
type CouponCodesPromotionRuleRel = ResourceRel & {
|
27
29
|
type: CouponCodesPromotionRuleType;
|
28
30
|
};
|
31
|
+
type TagRel = ResourceRel & {
|
32
|
+
type: TagType;
|
33
|
+
};
|
29
34
|
interface ExternalPromotion extends Resource {
|
30
35
|
readonly type: ExternalPromotionType;
|
31
36
|
name: string;
|
32
|
-
currency_code?: string;
|
37
|
+
currency_code?: string | null;
|
33
38
|
starts_at: string;
|
34
39
|
expires_at: string;
|
35
40
|
total_usage_limit: number;
|
36
|
-
total_usage_count?: number;
|
37
|
-
active?: boolean;
|
41
|
+
total_usage_count?: number | null;
|
42
|
+
active?: boolean | null;
|
38
43
|
promotion_url: string;
|
39
44
|
shared_secret: string;
|
40
|
-
market?: Market;
|
41
|
-
promotion_rules?: PromotionRule[];
|
42
|
-
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
43
|
-
sku_list_promotion_rule?: SkuListPromotionRule;
|
44
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRule;
|
45
|
-
attachments?: Attachment[];
|
46
|
-
events?: Event[];
|
45
|
+
market?: Market | null;
|
46
|
+
promotion_rules?: PromotionRule[] | null;
|
47
|
+
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
48
|
+
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
49
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
50
|
+
attachments?: Attachment[] | null;
|
51
|
+
events?: Event[] | null;
|
52
|
+
tags?: Tag[] | null;
|
47
53
|
}
|
48
54
|
interface ExternalPromotionCreate extends ResourceCreate {
|
49
55
|
name: string;
|
50
|
-
currency_code?: string;
|
56
|
+
currency_code?: string | null;
|
51
57
|
starts_at: string;
|
52
58
|
expires_at: string;
|
53
59
|
total_usage_limit: number;
|
54
60
|
promotion_url: string;
|
55
|
-
market?: MarketRel;
|
56
|
-
promotion_rules?: PromotionRuleRel[];
|
57
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
58
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
59
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
61
|
+
market?: MarketRel | null;
|
62
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
63
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
64
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
65
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
66
|
+
tags?: TagRel[] | null;
|
60
67
|
}
|
61
68
|
interface ExternalPromotionUpdate extends ResourceUpdate {
|
62
|
-
name
|
63
|
-
currency_code?: string;
|
64
|
-
starts_at
|
65
|
-
expires_at
|
66
|
-
total_usage_limit
|
67
|
-
promotion_url
|
68
|
-
market?: MarketRel;
|
69
|
-
promotion_rules?: PromotionRuleRel[];
|
70
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
71
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
72
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
69
|
+
name?: string | null;
|
70
|
+
currency_code?: string | null;
|
71
|
+
starts_at?: string | null;
|
72
|
+
expires_at?: string | null;
|
73
|
+
total_usage_limit?: number | null;
|
74
|
+
promotion_url?: string | null;
|
75
|
+
market?: MarketRel | null;
|
76
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
77
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
78
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
79
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
80
|
+
tags?: TagRel[] | null;
|
73
81
|
}
|
74
82
|
declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
|
75
83
|
static readonly TYPE: ExternalPromotionType;
|
@@ -82,6 +90,7 @@ declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
|
|
82
90
|
coupon_codes_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
83
91
|
attachments(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
84
92
|
events(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
93
|
+
tags(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
85
94
|
isExternalPromotion(resource: any): resource is ExternalPromotion;
|
86
95
|
relationship(id: string | ResourceId | null): ExternalPromotionRel;
|
87
96
|
type(): ExternalPromotionType;
|
@@ -33,6 +33,10 @@ class ExternalPromotions extends ApiResource {
|
|
33
33
|
const _externalPromotionId = externalPromotionId.id || externalPromotionId;
|
34
34
|
return this.resources.fetch({ type: 'events' }, `external_promotions/${_externalPromotionId}/events`, params, options);
|
35
35
|
}
|
36
|
+
async tags(externalPromotionId, params, options) {
|
37
|
+
const _externalPromotionId = externalPromotionId.id || externalPromotionId;
|
38
|
+
return this.resources.fetch({ type: 'tags' }, `external_promotions/${_externalPromotionId}/tags`, params, options);
|
39
|
+
}
|
36
40
|
isExternalPromotion(resource) {
|
37
41
|
return resource.type && (resource.type === ExternalPromotions.TYPE);
|
38
42
|
}
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Market } from './markets';
|
4
5
|
import type { Attachment } from './attachments';
|
@@ -11,16 +12,16 @@ interface ExternalTaxCalculator extends Resource {
|
|
11
12
|
name: string;
|
12
13
|
tax_calculator_url: string;
|
13
14
|
shared_secret: string;
|
14
|
-
markets?: Market[];
|
15
|
-
attachments?: Attachment[];
|
15
|
+
markets?: Market[] | null;
|
16
|
+
attachments?: Attachment[] | null;
|
16
17
|
}
|
17
18
|
interface ExternalTaxCalculatorCreate extends ResourceCreate {
|
18
19
|
name: string;
|
19
20
|
tax_calculator_url: string;
|
20
21
|
}
|
21
22
|
interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
|
22
|
-
name
|
23
|
-
tax_calculator_url
|
23
|
+
name?: string | null;
|
24
|
+
tax_calculator_url?: string | null;
|
24
25
|
}
|
25
26
|
declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
|
26
27
|
static readonly TYPE: ExternalTaxCalculatorType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Market, MarketType } from './markets';
|
4
5
|
import type { PromotionRule, PromotionRuleType } from './promotion_rules';
|
@@ -7,6 +8,7 @@ import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_
|
|
7
8
|
import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
8
9
|
import type { Attachment } from './attachments';
|
9
10
|
import type { Event } from './events';
|
11
|
+
import type { Tag, TagType } from './tags';
|
10
12
|
type FixedAmountPromotionType = 'fixed_amount_promotions';
|
11
13
|
type FixedAmountPromotionRel = ResourceRel & {
|
12
14
|
type: FixedAmountPromotionType;
|
@@ -26,51 +28,57 @@ type SkuListPromotionRuleRel = ResourceRel & {
|
|
26
28
|
type CouponCodesPromotionRuleRel = ResourceRel & {
|
27
29
|
type: CouponCodesPromotionRuleType;
|
28
30
|
};
|
31
|
+
type TagRel = ResourceRel & {
|
32
|
+
type: TagType;
|
33
|
+
};
|
29
34
|
interface FixedAmountPromotion extends Resource {
|
30
35
|
readonly type: FixedAmountPromotionType;
|
31
36
|
name: string;
|
32
|
-
currency_code?: string;
|
37
|
+
currency_code?: string | null;
|
33
38
|
starts_at: string;
|
34
39
|
expires_at: string;
|
35
40
|
total_usage_limit: number;
|
36
|
-
total_usage_count?: number;
|
37
|
-
active?: boolean;
|
41
|
+
total_usage_count?: number | null;
|
42
|
+
active?: boolean | null;
|
38
43
|
fixed_amount_cents: number;
|
39
|
-
fixed_amount_float?: number;
|
40
|
-
formatted_fixed_amount?: string;
|
41
|
-
market?: Market;
|
42
|
-
promotion_rules?: PromotionRule[];
|
43
|
-
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
44
|
-
sku_list_promotion_rule?: SkuListPromotionRule;
|
45
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRule;
|
46
|
-
attachments?: Attachment[];
|
47
|
-
events?: Event[];
|
44
|
+
fixed_amount_float?: number | null;
|
45
|
+
formatted_fixed_amount?: string | null;
|
46
|
+
market?: Market | null;
|
47
|
+
promotion_rules?: PromotionRule[] | null;
|
48
|
+
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
49
|
+
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
50
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
51
|
+
attachments?: Attachment[] | null;
|
52
|
+
events?: Event[] | null;
|
53
|
+
tags?: Tag[] | null;
|
48
54
|
}
|
49
55
|
interface FixedAmountPromotionCreate extends ResourceCreate {
|
50
56
|
name: string;
|
51
|
-
currency_code?: string;
|
57
|
+
currency_code?: string | null;
|
52
58
|
starts_at: string;
|
53
59
|
expires_at: string;
|
54
60
|
total_usage_limit: number;
|
55
61
|
fixed_amount_cents: number;
|
56
|
-
market?: MarketRel;
|
57
|
-
promotion_rules?: PromotionRuleRel[];
|
58
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
59
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
60
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
62
|
+
market?: MarketRel | null;
|
63
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
64
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
65
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
66
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
67
|
+
tags?: TagRel[] | null;
|
61
68
|
}
|
62
69
|
interface FixedAmountPromotionUpdate extends ResourceUpdate {
|
63
|
-
name
|
64
|
-
currency_code?: string;
|
65
|
-
starts_at
|
66
|
-
expires_at
|
67
|
-
total_usage_limit
|
68
|
-
fixed_amount_cents
|
69
|
-
market?: MarketRel;
|
70
|
-
promotion_rules?: PromotionRuleRel[];
|
71
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
72
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
73
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
70
|
+
name?: string | null;
|
71
|
+
currency_code?: string | null;
|
72
|
+
starts_at?: string | null;
|
73
|
+
expires_at?: string | null;
|
74
|
+
total_usage_limit?: number | null;
|
75
|
+
fixed_amount_cents?: number | null;
|
76
|
+
market?: MarketRel | null;
|
77
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
78
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
79
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
80
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
81
|
+
tags?: TagRel[] | null;
|
74
82
|
}
|
75
83
|
declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
|
76
84
|
static readonly TYPE: FixedAmountPromotionType;
|
@@ -83,6 +91,7 @@ declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
|
|
83
91
|
coupon_codes_promotion_rule(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
84
92
|
attachments(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
85
93
|
events(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
94
|
+
tags(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
86
95
|
isFixedAmountPromotion(resource: any): resource is FixedAmountPromotion;
|
87
96
|
relationship(id: string | ResourceId | null): FixedAmountPromotionRel;
|
88
97
|
type(): FixedAmountPromotionType;
|
@@ -33,6 +33,10 @@ class FixedAmountPromotions extends ApiResource {
|
|
33
33
|
const _fixedAmountPromotionId = fixedAmountPromotionId.id || fixedAmountPromotionId;
|
34
34
|
return this.resources.fetch({ type: 'events' }, `fixed_amount_promotions/${_fixedAmountPromotionId}/events`, params, options);
|
35
35
|
}
|
36
|
+
async tags(fixedAmountPromotionId, params, options) {
|
37
|
+
const _fixedAmountPromotionId = fixedAmountPromotionId.id || fixedAmountPromotionId;
|
38
|
+
return this.resources.fetch({ type: 'tags' }, `fixed_amount_promotions/${_fixedAmountPromotionId}/tags`, params, options);
|
39
|
+
}
|
36
40
|
isFixedAmountPromotion(resource) {
|
37
41
|
return resource.type && (resource.type === FixedAmountPromotions.TYPE);
|
38
42
|
}
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Market, MarketType } from './markets';
|
4
5
|
import type { PromotionRule, PromotionRuleType } from './promotion_rules';
|
@@ -6,9 +7,10 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
|
|
6
7
|
import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
|
7
8
|
import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
8
9
|
import type { Attachment } from './attachments';
|
10
|
+
import type { Event } from './events';
|
11
|
+
import type { Tag, TagType } from './tags';
|
9
12
|
import type { SkuList, SkuListType } from './sku_lists';
|
10
13
|
import type { Sku } from './skus';
|
11
|
-
import type { Event } from './events';
|
12
14
|
type FixedPricePromotionType = 'fixed_price_promotions';
|
13
15
|
type FixedPricePromotionRel = ResourceRel & {
|
14
16
|
type: FixedPricePromotionType;
|
@@ -28,58 +30,64 @@ type SkuListPromotionRuleRel = ResourceRel & {
|
|
28
30
|
type CouponCodesPromotionRuleRel = ResourceRel & {
|
29
31
|
type: CouponCodesPromotionRuleType;
|
30
32
|
};
|
33
|
+
type TagRel = ResourceRel & {
|
34
|
+
type: TagType;
|
35
|
+
};
|
31
36
|
type SkuListRel = ResourceRel & {
|
32
37
|
type: SkuListType;
|
33
38
|
};
|
34
39
|
interface FixedPricePromotion extends Resource {
|
35
40
|
readonly type: FixedPricePromotionType;
|
36
41
|
name: string;
|
37
|
-
currency_code?: string;
|
42
|
+
currency_code?: string | null;
|
38
43
|
starts_at: string;
|
39
44
|
expires_at: string;
|
40
45
|
total_usage_limit: number;
|
41
|
-
total_usage_count?: number;
|
42
|
-
active?: boolean;
|
46
|
+
total_usage_count?: number | null;
|
47
|
+
active?: boolean | null;
|
43
48
|
fixed_amount_cents: number;
|
44
|
-
fixed_amount_float?: number;
|
45
|
-
formatted_fixed_amount?: string;
|
46
|
-
market?: Market;
|
47
|
-
promotion_rules?: PromotionRule[];
|
48
|
-
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
49
|
-
sku_list_promotion_rule?: SkuListPromotionRule;
|
50
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRule;
|
51
|
-
attachments?: Attachment[];
|
52
|
-
|
53
|
-
|
54
|
-
|
49
|
+
fixed_amount_float?: number | null;
|
50
|
+
formatted_fixed_amount?: string | null;
|
51
|
+
market?: Market | null;
|
52
|
+
promotion_rules?: PromotionRule[] | null;
|
53
|
+
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
54
|
+
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
55
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
56
|
+
attachments?: Attachment[] | null;
|
57
|
+
events?: Event[] | null;
|
58
|
+
tags?: Tag[] | null;
|
59
|
+
sku_list?: SkuList | null;
|
60
|
+
skus?: Sku[] | null;
|
55
61
|
}
|
56
62
|
interface FixedPricePromotionCreate extends ResourceCreate {
|
57
63
|
name: string;
|
58
|
-
currency_code?: string;
|
64
|
+
currency_code?: string | null;
|
59
65
|
starts_at: string;
|
60
66
|
expires_at: string;
|
61
67
|
total_usage_limit: number;
|
62
68
|
fixed_amount_cents: number;
|
63
|
-
market?: MarketRel;
|
64
|
-
promotion_rules?: PromotionRuleRel[];
|
65
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
66
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
67
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
69
|
+
market?: MarketRel | null;
|
70
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
71
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
72
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
73
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
74
|
+
tags?: TagRel[] | null;
|
68
75
|
sku_list: SkuListRel;
|
69
76
|
}
|
70
77
|
interface FixedPricePromotionUpdate extends ResourceUpdate {
|
71
|
-
name
|
72
|
-
currency_code?: string;
|
73
|
-
starts_at
|
74
|
-
expires_at
|
75
|
-
total_usage_limit
|
76
|
-
fixed_amount_cents
|
77
|
-
market?: MarketRel;
|
78
|
-
promotion_rules?: PromotionRuleRel[];
|
79
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
80
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
81
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
82
|
-
|
78
|
+
name?: string | null;
|
79
|
+
currency_code?: string | null;
|
80
|
+
starts_at?: string | null;
|
81
|
+
expires_at?: string | null;
|
82
|
+
total_usage_limit?: number | null;
|
83
|
+
fixed_amount_cents?: number | null;
|
84
|
+
market?: MarketRel | null;
|
85
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
86
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
87
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
88
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
89
|
+
tags?: TagRel[] | null;
|
90
|
+
sku_list?: SkuListRel | null;
|
83
91
|
}
|
84
92
|
declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
|
85
93
|
static readonly TYPE: FixedPricePromotionType;
|
@@ -91,9 +99,10 @@ declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
|
|
91
99
|
sku_list_promotion_rule(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
92
100
|
coupon_codes_promotion_rule(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
93
101
|
attachments(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
102
|
+
events(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
103
|
+
tags(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
94
104
|
sku_list(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
|
95
105
|
skus(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
96
|
-
events(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
97
106
|
isFixedPricePromotion(resource: any): resource is FixedPricePromotion;
|
98
107
|
relationship(id: string | ResourceId | null): FixedPricePromotionRel;
|
99
108
|
type(): FixedPricePromotionType;
|
@@ -29,6 +29,14 @@ class FixedPricePromotions extends ApiResource {
|
|
29
29
|
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
30
30
|
return this.resources.fetch({ type: 'attachments' }, `fixed_price_promotions/${_fixedPricePromotionId}/attachments`, params, options);
|
31
31
|
}
|
32
|
+
async events(fixedPricePromotionId, params, options) {
|
33
|
+
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
34
|
+
return this.resources.fetch({ type: 'events' }, `fixed_price_promotions/${_fixedPricePromotionId}/events`, params, options);
|
35
|
+
}
|
36
|
+
async tags(fixedPricePromotionId, params, options) {
|
37
|
+
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
38
|
+
return this.resources.fetch({ type: 'tags' }, `fixed_price_promotions/${_fixedPricePromotionId}/tags`, params, options);
|
39
|
+
}
|
32
40
|
async sku_list(fixedPricePromotionId, params, options) {
|
33
41
|
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
34
42
|
return this.resources.fetch({ type: 'sku_lists' }, `fixed_price_promotions/${_fixedPricePromotionId}/sku_list`, params, options);
|
@@ -37,10 +45,6 @@ class FixedPricePromotions extends ApiResource {
|
|
37
45
|
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
38
46
|
return this.resources.fetch({ type: 'skus' }, `fixed_price_promotions/${_fixedPricePromotionId}/skus`, params, options);
|
39
47
|
}
|
40
|
-
async events(fixedPricePromotionId, params, options) {
|
41
|
-
const _fixedPricePromotionId = fixedPricePromotionId.id || fixedPricePromotionId;
|
42
|
-
return this.resources.fetch({ type: 'events' }, `fixed_price_promotions/${_fixedPricePromotionId}/events`, params, options);
|
43
|
-
}
|
44
48
|
isFixedPricePromotion(resource) {
|
45
49
|
return resource.type && (resource.type === FixedPricePromotions.TYPE);
|
46
50
|
}
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Market, MarketType } from './markets';
|
4
5
|
import type { PromotionRule, PromotionRuleType } from './promotion_rules';
|
@@ -6,9 +7,10 @@ import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './o
|
|
6
7
|
import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
|
7
8
|
import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
8
9
|
import type { Attachment } from './attachments';
|
10
|
+
import type { Event } from './events';
|
11
|
+
import type { Tag, TagType } from './tags';
|
9
12
|
import type { SkuList, SkuListType } from './sku_lists';
|
10
13
|
import type { Sku } from './skus';
|
11
|
-
import type { Event } from './events';
|
12
14
|
type FreeGiftPromotionType = 'free_gift_promotions';
|
13
15
|
type FreeGiftPromotionRel = ResourceRel & {
|
14
16
|
type: FreeGiftPromotionType;
|
@@ -28,56 +30,62 @@ type SkuListPromotionRuleRel = ResourceRel & {
|
|
28
30
|
type CouponCodesPromotionRuleRel = ResourceRel & {
|
29
31
|
type: CouponCodesPromotionRuleType;
|
30
32
|
};
|
33
|
+
type TagRel = ResourceRel & {
|
34
|
+
type: TagType;
|
35
|
+
};
|
31
36
|
type SkuListRel = ResourceRel & {
|
32
37
|
type: SkuListType;
|
33
38
|
};
|
34
39
|
interface FreeGiftPromotion extends Resource {
|
35
40
|
readonly type: FreeGiftPromotionType;
|
36
41
|
name: string;
|
37
|
-
currency_code?: string;
|
42
|
+
currency_code?: string | null;
|
38
43
|
starts_at: string;
|
39
44
|
expires_at: string;
|
40
45
|
total_usage_limit: number;
|
41
|
-
total_usage_count?: number;
|
42
|
-
active?: boolean;
|
43
|
-
max_quantity?: number;
|
44
|
-
market?: Market;
|
45
|
-
promotion_rules?: PromotionRule[];
|
46
|
-
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
47
|
-
sku_list_promotion_rule?: SkuListPromotionRule;
|
48
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRule;
|
49
|
-
attachments?: Attachment[];
|
50
|
-
|
51
|
-
|
52
|
-
|
46
|
+
total_usage_count?: number | null;
|
47
|
+
active?: boolean | null;
|
48
|
+
max_quantity?: number | null;
|
49
|
+
market?: Market | null;
|
50
|
+
promotion_rules?: PromotionRule[] | null;
|
51
|
+
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
52
|
+
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
53
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
54
|
+
attachments?: Attachment[] | null;
|
55
|
+
events?: Event[] | null;
|
56
|
+
tags?: Tag[] | null;
|
57
|
+
sku_list?: SkuList | null;
|
58
|
+
skus?: Sku[] | null;
|
53
59
|
}
|
54
60
|
interface FreeGiftPromotionCreate extends ResourceCreate {
|
55
61
|
name: string;
|
56
|
-
currency_code?: string;
|
62
|
+
currency_code?: string | null;
|
57
63
|
starts_at: string;
|
58
64
|
expires_at: string;
|
59
65
|
total_usage_limit: number;
|
60
|
-
max_quantity?: number;
|
61
|
-
market?: MarketRel;
|
62
|
-
promotion_rules?: PromotionRuleRel[];
|
63
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
64
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
65
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
66
|
+
max_quantity?: number | null;
|
67
|
+
market?: MarketRel | null;
|
68
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
69
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
70
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
71
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
72
|
+
tags?: TagRel[] | null;
|
66
73
|
sku_list: SkuListRel;
|
67
74
|
}
|
68
75
|
interface FreeGiftPromotionUpdate extends ResourceUpdate {
|
69
|
-
name
|
70
|
-
currency_code?: string;
|
71
|
-
starts_at
|
72
|
-
expires_at
|
73
|
-
total_usage_limit
|
74
|
-
max_quantity?: number;
|
75
|
-
market?: MarketRel;
|
76
|
-
promotion_rules?: PromotionRuleRel[];
|
77
|
-
order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
|
78
|
-
sku_list_promotion_rule?: SkuListPromotionRuleRel;
|
79
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
|
80
|
-
|
76
|
+
name?: string | null;
|
77
|
+
currency_code?: string | null;
|
78
|
+
starts_at?: string | null;
|
79
|
+
expires_at?: string | null;
|
80
|
+
total_usage_limit?: number | null;
|
81
|
+
max_quantity?: number | null;
|
82
|
+
market?: MarketRel | null;
|
83
|
+
promotion_rules?: PromotionRuleRel[] | null;
|
84
|
+
order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
|
85
|
+
sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
|
86
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
|
87
|
+
tags?: TagRel[] | null;
|
88
|
+
sku_list?: SkuListRel | null;
|
81
89
|
}
|
82
90
|
declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
|
83
91
|
static readonly TYPE: FreeGiftPromotionType;
|
@@ -89,9 +97,10 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
|
|
89
97
|
sku_list_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
90
98
|
coupon_codes_promotion_rule(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
91
99
|
attachments(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
100
|
+
events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
101
|
+
tags(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
92
102
|
sku_list(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
|
93
103
|
skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
94
|
-
events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
95
104
|
isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
|
96
105
|
relationship(id: string | ResourceId | null): FreeGiftPromotionRel;
|
97
106
|
type(): FreeGiftPromotionType;
|