@commercelayer/sdk 5.0.0-beta.8 → 5.0.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 +27 -2
- package/lib/cjs/api.js +17 -15
- package/lib/cjs/client.d.ts +3 -5
- package/lib/cjs/commercelayer.d.ts +10 -5
- package/lib/cjs/commercelayer.js +8 -3
- package/lib/cjs/common.d.ts +1 -0
- package/lib/cjs/common.js +11 -0
- package/lib/cjs/index.d.ts +1 -1
- package/lib/cjs/index.js +0 -16
- package/lib/cjs/interceptor.d.ts +1 -1
- package/lib/cjs/model.d.ts +6 -1
- package/lib/cjs/query.d.ts +6 -14
- package/lib/cjs/resource.d.ts +14 -20
- package/lib/cjs/resources/addresses.d.ts +51 -50
- 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 +15 -14
- 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 +27 -26
- 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 +13 -12
- 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 +19 -18
- 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 +29 -28
- package/lib/cjs/resources/external_tax_calculators.d.ts +6 -5
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +31 -30
- package/lib/cjs/resources/fixed_price_promotions.d.ts +36 -35
- package/lib/cjs/resources/fixed_price_promotions.js +4 -4
- package/lib/cjs/resources/free_gift_promotions.d.ts +36 -35
- package/lib/cjs/resources/free_gift_promotions.js +4 -4
- package/lib/cjs/resources/free_shipping_promotions.d.ts +30 -26
- package/lib/cjs/resources/free_shipping_promotions.js +4 -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 +41 -40
- package/lib/cjs/resources/google_geocoders.d.ts +6 -5
- package/lib/cjs/resources/imports.d.ts +20 -19
- 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 +14 -13
- package/lib/cjs/resources/line_item_options.d.ts +18 -17
- package/lib/cjs/resources/line_items.d.ts +47 -43
- 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 +192 -183
- package/lib/cjs/resources/orders.js +8 -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 +75 -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 +35 -34
- package/lib/cjs/resources/percentage_discount_promotions.js +4 -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 +14 -10
- package/lib/cjs/resources/promotions.js +4 -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 +31 -30
- package/lib/cjs/resources/satispay_gateways.d.ts +8 -7
- package/lib/cjs/resources/satispay_payments.d.ts +12 -11
- 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 +25 -24
- package/lib/cjs/resources/skus.d.ts +36 -35
- 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/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/static.d.ts +1 -1
- package/lib/cjs/util.d.ts +1 -3
- package/lib/esm/api.d.ts +27 -2
- package/lib/esm/api.js +10 -13
- package/lib/esm/client.d.ts +3 -5
- package/lib/esm/commercelayer.d.ts +10 -5
- package/lib/esm/commercelayer.js +8 -3
- package/lib/esm/common.d.ts +1 -0
- package/lib/esm/common.js +11 -0
- package/lib/esm/index.d.ts +1 -1
- package/lib/esm/index.js +0 -2
- package/lib/esm/interceptor.d.ts +1 -1
- package/lib/esm/model.d.ts +6 -1
- package/lib/esm/query.d.ts +6 -14
- package/lib/esm/resource.d.ts +14 -20
- package/lib/esm/resources/addresses.d.ts +51 -50
- 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 +15 -14
- 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 +27 -26
- 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 +13 -12
- 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 +19 -18
- 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 +29 -28
- package/lib/esm/resources/external_tax_calculators.d.ts +6 -5
- package/lib/esm/resources/fixed_amount_promotions.d.ts +31 -30
- package/lib/esm/resources/fixed_price_promotions.d.ts +36 -35
- package/lib/esm/resources/fixed_price_promotions.js +4 -4
- package/lib/esm/resources/free_gift_promotions.d.ts +36 -35
- package/lib/esm/resources/free_gift_promotions.js +4 -4
- package/lib/esm/resources/free_shipping_promotions.d.ts +30 -26
- package/lib/esm/resources/free_shipping_promotions.js +4 -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 +41 -40
- package/lib/esm/resources/google_geocoders.d.ts +6 -5
- package/lib/esm/resources/imports.d.ts +20 -19
- 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 +14 -13
- package/lib/esm/resources/line_item_options.d.ts +18 -17
- package/lib/esm/resources/line_items.d.ts +47 -43
- 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 +192 -183
- package/lib/esm/resources/orders.js +8 -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 +75 -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 +35 -34
- package/lib/esm/resources/percentage_discount_promotions.js +4 -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 +14 -10
- package/lib/esm/resources/promotions.js +4 -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 +31 -30
- package/lib/esm/resources/satispay_gateways.d.ts +8 -7
- package/lib/esm/resources/satispay_payments.d.ts +12 -11
- 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 +25 -24
- package/lib/esm/resources/skus.d.ts +36 -35
- 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/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/static.d.ts +1 -1
- package/lib/esm/util.d.ts +1 -3
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +10 -10
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Order } from './orders';
|
4
5
|
import type { Authorization } from './authorizations';
|
@@ -16,25 +17,25 @@ interface Capture extends Resource {
|
|
16
17
|
amount_float: number;
|
17
18
|
formatted_amount: string;
|
18
19
|
succeeded: boolean;
|
19
|
-
message?: string;
|
20
|
-
error_code?: string;
|
21
|
-
error_detail?: string;
|
22
|
-
token?: string;
|
23
|
-
gateway_transaction_id?: string;
|
24
|
-
refund_amount_cents?: number;
|
25
|
-
refund_amount_float?: number;
|
26
|
-
formatted_refund_amount?: string;
|
27
|
-
refund_balance_cents?: number;
|
28
|
-
refund_balance_float?: number;
|
29
|
-
formatted_refund_balance?: string;
|
30
|
-
order?: Order;
|
31
|
-
reference_authorization?: Authorization;
|
32
|
-
refunds?: Refund[];
|
33
|
-
events?: Event[];
|
20
|
+
message?: string | null;
|
21
|
+
error_code?: string | null;
|
22
|
+
error_detail?: string | null;
|
23
|
+
token?: string | null;
|
24
|
+
gateway_transaction_id?: string | null;
|
25
|
+
refund_amount_cents?: number | null;
|
26
|
+
refund_amount_float?: number | null;
|
27
|
+
formatted_refund_amount?: string | null;
|
28
|
+
refund_balance_cents?: number | null;
|
29
|
+
refund_balance_float?: number | null;
|
30
|
+
formatted_refund_balance?: string | null;
|
31
|
+
order?: Order | null;
|
32
|
+
reference_authorization?: Authorization | null;
|
33
|
+
refunds?: Refund[] | null;
|
34
|
+
events?: Event[] | null;
|
34
35
|
}
|
35
36
|
interface CaptureUpdate extends ResourceUpdate {
|
36
|
-
_refund?: boolean;
|
37
|
-
_refund_amount_cents?: number;
|
37
|
+
_refund?: boolean | null;
|
38
|
+
_refund_amount_cents?: number | null;
|
38
39
|
}
|
39
40
|
declare class Captures extends ApiResource<Capture> {
|
40
41
|
static readonly TYPE: CaptureType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, 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';
|
@@ -8,11 +9,11 @@ type CarrierAccountRel = ResourceRel & {
|
|
8
9
|
};
|
9
10
|
interface CarrierAccount extends Resource {
|
10
11
|
readonly type: CarrierAccountType;
|
11
|
-
name?: string;
|
12
|
-
easypost_type?: string;
|
13
|
-
easypost_id?: string;
|
14
|
-
market?: Market;
|
15
|
-
attachments?: Attachment[];
|
12
|
+
name?: string | null;
|
13
|
+
easypost_type?: string | null;
|
14
|
+
easypost_id?: string | null;
|
15
|
+
market?: Market | null;
|
16
|
+
attachments?: Attachment[] | null;
|
16
17
|
}
|
17
18
|
declare class CarrierAccounts extends ApiResource<CarrierAccount> {
|
18
19
|
static readonly TYPE: CarrierAccountType;
|
@@ -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 { CheckoutComPayment, CheckoutComPaymentType } from './checkout_com_payments';
|
@@ -12,23 +13,23 @@ type CheckoutComPaymentRel = ResourceRel & {
|
|
12
13
|
interface CheckoutComGateway extends Resource {
|
13
14
|
readonly type: CheckoutComGatewayType;
|
14
15
|
name: string;
|
15
|
-
webhook_endpoint_id?: string;
|
16
|
-
webhook_endpoint_secret?: string;
|
17
|
-
webhook_endpoint_url?: string;
|
18
|
-
payment_methods?: PaymentMethod[];
|
19
|
-
checkout_com_payments?: CheckoutComPayment[];
|
16
|
+
webhook_endpoint_id?: string | null;
|
17
|
+
webhook_endpoint_secret?: string | null;
|
18
|
+
webhook_endpoint_url?: string | null;
|
19
|
+
payment_methods?: PaymentMethod[] | null;
|
20
|
+
checkout_com_payments?: CheckoutComPayment[] | null;
|
20
21
|
}
|
21
22
|
interface CheckoutComGatewayCreate extends ResourceCreate {
|
22
23
|
name: string;
|
23
24
|
secret_key: string;
|
24
25
|
public_key: string;
|
25
|
-
checkout_com_payments?: CheckoutComPaymentRel[];
|
26
|
+
checkout_com_payments?: CheckoutComPaymentRel[] | null;
|
26
27
|
}
|
27
28
|
interface CheckoutComGatewayUpdate extends ResourceUpdate {
|
28
|
-
name
|
29
|
-
secret_key?: string;
|
30
|
-
public_key?: string;
|
31
|
-
checkout_com_payments?: CheckoutComPaymentRel[];
|
29
|
+
name?: string | null;
|
30
|
+
secret_key?: string | null;
|
31
|
+
public_key?: string | null;
|
32
|
+
checkout_com_payments?: CheckoutComPaymentRel[] | null;
|
32
33
|
}
|
33
34
|
declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
|
34
35
|
static readonly TYPE: CheckoutComGatewayType;
|
@@ -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';
|
@@ -11,38 +12,38 @@ type OrderRel = ResourceRel & {
|
|
11
12
|
};
|
12
13
|
interface CheckoutComPayment extends Resource {
|
13
14
|
readonly type: CheckoutComPaymentType;
|
14
|
-
public_key?: string;
|
15
|
+
public_key?: string | null;
|
15
16
|
payment_type: string;
|
16
17
|
token: string;
|
17
|
-
session_id?: string;
|
18
|
-
success_url?: string;
|
19
|
-
failure_url?: string;
|
20
|
-
source_id?: string;
|
21
|
-
customer_token?: string;
|
22
|
-
redirect_uri?: string;
|
23
|
-
payment_response?: object;
|
24
|
-
mismatched_amounts?: boolean;
|
25
|
-
payment_instrument?: object;
|
26
|
-
order?: Order;
|
27
|
-
payment_gateway?: PaymentGateway;
|
18
|
+
session_id?: string | null;
|
19
|
+
success_url?: string | null;
|
20
|
+
failure_url?: string | null;
|
21
|
+
source_id?: string | null;
|
22
|
+
customer_token?: string | null;
|
23
|
+
redirect_uri?: string | null;
|
24
|
+
payment_response?: object | null;
|
25
|
+
mismatched_amounts?: boolean | null;
|
26
|
+
payment_instrument?: object | null;
|
27
|
+
order?: Order | null;
|
28
|
+
payment_gateway?: PaymentGateway | null;
|
28
29
|
}
|
29
30
|
interface CheckoutComPaymentCreate extends ResourceCreate {
|
30
31
|
payment_type: string;
|
31
32
|
token: string;
|
32
|
-
session_id?: string;
|
33
|
-
success_url?: string;
|
34
|
-
failure_url?: string;
|
33
|
+
session_id?: string | null;
|
34
|
+
success_url?: string | null;
|
35
|
+
failure_url?: string | null;
|
35
36
|
order: OrderRel;
|
36
37
|
}
|
37
38
|
interface CheckoutComPaymentUpdate extends ResourceUpdate {
|
38
|
-
payment_type
|
39
|
-
token
|
40
|
-
session_id?: string;
|
41
|
-
success_url?: string;
|
42
|
-
failure_url?: string;
|
43
|
-
_details?: boolean;
|
44
|
-
_refresh?: boolean;
|
45
|
-
order?: OrderRel;
|
39
|
+
payment_type?: string | null;
|
40
|
+
token?: string | null;
|
41
|
+
session_id?: string | null;
|
42
|
+
success_url?: string | null;
|
43
|
+
failure_url?: string | null;
|
44
|
+
_details?: boolean | null;
|
45
|
+
_refresh?: boolean | null;
|
46
|
+
order?: OrderRel | null;
|
46
47
|
}
|
47
48
|
declare class CheckoutComPayments extends ApiResource<CheckoutComPayment> {
|
48
49
|
static readonly TYPE: CheckoutComPaymentType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
3
4
|
import type { Event } from './events';
|
4
5
|
type CleanupType = 'cleanups';
|
@@ -8,20 +9,20 @@ type CleanupRel = ResourceRel & {
|
|
8
9
|
interface Cleanup extends Resource {
|
9
10
|
readonly type: CleanupType;
|
10
11
|
resource_type: string;
|
11
|
-
status
|
12
|
-
started_at?: string;
|
13
|
-
completed_at?: string;
|
14
|
-
interrupted_at?: string;
|
15
|
-
filters?: object;
|
16
|
-
records_count?: number;
|
17
|
-
errors_count?: number;
|
18
|
-
processed_count?: number;
|
19
|
-
errors_log?: object;
|
20
|
-
events?: Event[];
|
12
|
+
status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
|
13
|
+
started_at?: string | null;
|
14
|
+
completed_at?: string | null;
|
15
|
+
interrupted_at?: string | null;
|
16
|
+
filters?: object | null;
|
17
|
+
records_count?: number | null;
|
18
|
+
errors_count?: number | null;
|
19
|
+
processed_count?: number | null;
|
20
|
+
errors_log?: object | null;
|
21
|
+
events?: Event[] | null;
|
21
22
|
}
|
22
23
|
interface CleanupCreate extends ResourceCreate {
|
23
24
|
resource_type: string;
|
24
|
-
filters?: object;
|
25
|
+
filters?: object | null;
|
25
26
|
}
|
26
27
|
declare class Cleanups extends ApiResource<Cleanup> {
|
27
28
|
static readonly TYPE: CleanupType;
|
@@ -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 { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
|
4
5
|
import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
|
@@ -34,16 +35,16 @@ type CouponRel = ResourceRel & {
|
|
34
35
|
};
|
35
36
|
interface CouponCodesPromotionRule extends Resource {
|
36
37
|
readonly type: CouponCodesPromotionRuleType;
|
37
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
|
38
|
-
coupons?: Coupon[];
|
38
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
39
|
+
coupons?: Coupon[] | null;
|
39
40
|
}
|
40
41
|
interface CouponCodesPromotionRuleCreate extends ResourceCreate {
|
41
42
|
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
42
|
-
coupons?: CouponRel[];
|
43
|
+
coupons?: CouponRel[] | null;
|
43
44
|
}
|
44
45
|
interface CouponCodesPromotionRuleUpdate extends ResourceUpdate {
|
45
|
-
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
46
|
-
coupons?: CouponRel[];
|
46
|
+
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
47
|
+
coupons?: CouponRel[] | null;
|
47
48
|
}
|
48
49
|
declare class CouponCodesPromotionRules extends ApiResource<CouponCodesPromotionRule> {
|
49
50
|
static readonly TYPE: CouponCodesPromotionRuleType;
|
@@ -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 { Customer, CustomerType } from './customers';
|
4
5
|
import type { Attachment } from './attachments';
|
@@ -12,22 +13,22 @@ type CustomerRel = ResourceRel & {
|
|
12
13
|
interface CouponRecipient extends Resource {
|
13
14
|
readonly type: CouponRecipientType;
|
14
15
|
email: string;
|
15
|
-
first_name?: string;
|
16
|
-
last_name?: string;
|
17
|
-
customer?: Customer;
|
18
|
-
attachments?: Attachment[];
|
16
|
+
first_name?: string | null;
|
17
|
+
last_name?: string | null;
|
18
|
+
customer?: Customer | null;
|
19
|
+
attachments?: Attachment[] | null;
|
19
20
|
}
|
20
21
|
interface CouponRecipientCreate extends ResourceCreate {
|
21
22
|
email: string;
|
22
|
-
first_name?: string;
|
23
|
-
last_name?: string;
|
24
|
-
customer?: CustomerRel;
|
23
|
+
first_name?: string | null;
|
24
|
+
last_name?: string | null;
|
25
|
+
customer?: CustomerRel | null;
|
25
26
|
}
|
26
27
|
interface CouponRecipientUpdate extends ResourceUpdate {
|
27
|
-
email
|
28
|
-
first_name?: string;
|
29
|
-
last_name?: string;
|
30
|
-
customer?: CustomerRel;
|
28
|
+
email?: string | null;
|
29
|
+
first_name?: string | null;
|
30
|
+
last_name?: string | null;
|
31
|
+
customer?: CustomerRel | null;
|
31
32
|
}
|
32
33
|
declare class CouponRecipients extends ApiResource<CouponRecipient> {
|
33
34
|
static readonly TYPE: CouponRecipientType;
|
@@ -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 { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
|
4
5
|
type CouponType = 'coupons';
|
@@ -11,25 +12,25 @@ type CouponCodesPromotionRuleRel = ResourceRel & {
|
|
11
12
|
interface Coupon extends Resource {
|
12
13
|
readonly type: CouponType;
|
13
14
|
code: string;
|
14
|
-
customer_single_use?: boolean;
|
15
|
+
customer_single_use?: boolean | null;
|
15
16
|
usage_limit: number;
|
16
|
-
usage_count?: number;
|
17
|
-
recipient_email?: string;
|
18
|
-
promotion_rule?: CouponCodesPromotionRule;
|
17
|
+
usage_count?: number | null;
|
18
|
+
recipient_email?: string | null;
|
19
|
+
promotion_rule?: CouponCodesPromotionRule | null;
|
19
20
|
}
|
20
21
|
interface CouponCreate extends ResourceCreate {
|
21
22
|
code: string;
|
22
|
-
customer_single_use?: boolean;
|
23
|
+
customer_single_use?: boolean | null;
|
23
24
|
usage_limit: number;
|
24
|
-
recipient_email?: string;
|
25
|
+
recipient_email?: string | null;
|
25
26
|
promotion_rule: CouponCodesPromotionRuleRel;
|
26
27
|
}
|
27
28
|
interface CouponUpdate extends ResourceUpdate {
|
28
|
-
code
|
29
|
-
customer_single_use?: boolean;
|
30
|
-
usage_limit
|
31
|
-
recipient_email?: string;
|
32
|
-
promotion_rule?: CouponCodesPromotionRuleRel;
|
29
|
+
code?: string | null;
|
30
|
+
customer_single_use?: boolean | null;
|
31
|
+
usage_limit?: number | null;
|
32
|
+
recipient_email?: string | null;
|
33
|
+
promotion_rule?: CouponCodesPromotionRuleRel | null;
|
33
34
|
}
|
34
35
|
declare class Coupons extends ApiResource<Coupon> {
|
35
36
|
static readonly TYPE: CouponType;
|
@@ -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 { Customer, CustomerType } from './customers';
|
4
5
|
import type { Address, AddressType } from './addresses';
|
@@ -15,18 +16,18 @@ type AddressRel = ResourceRel & {
|
|
15
16
|
};
|
16
17
|
interface CustomerAddress extends Resource {
|
17
18
|
readonly type: CustomerAddressType;
|
18
|
-
name?: string;
|
19
|
-
customer?: Customer;
|
20
|
-
address?: Address;
|
21
|
-
events?: Event[];
|
19
|
+
name?: string | null;
|
20
|
+
customer?: Customer | null;
|
21
|
+
address?: Address | null;
|
22
|
+
events?: Event[] | null;
|
22
23
|
}
|
23
24
|
interface CustomerAddressCreate extends ResourceCreate {
|
24
25
|
customer: CustomerRel;
|
25
26
|
address: AddressRel;
|
26
27
|
}
|
27
28
|
interface CustomerAddressUpdate extends ResourceUpdate {
|
28
|
-
customer?: CustomerRel;
|
29
|
-
address?: AddressRel;
|
29
|
+
customer?: CustomerRel | null;
|
30
|
+
address?: AddressRel | null;
|
30
31
|
}
|
31
32
|
declare class CustomerAddresses extends ApiResource<CustomerAddress> {
|
32
33
|
static readonly TYPE: CustomerAddressType;
|
@@ -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 { Customer } from './customers';
|
4
5
|
import type { Market } from './markets';
|
@@ -10,15 +11,15 @@ type CustomerGroupRel = ResourceRel & {
|
|
10
11
|
interface CustomerGroup extends Resource {
|
11
12
|
readonly type: CustomerGroupType;
|
12
13
|
name: string;
|
13
|
-
customers?: Customer[];
|
14
|
-
markets?: Market[];
|
15
|
-
attachments?: Attachment[];
|
14
|
+
customers?: Customer[] | null;
|
15
|
+
markets?: Market[] | null;
|
16
|
+
attachments?: Attachment[] | null;
|
16
17
|
}
|
17
18
|
interface CustomerGroupCreate extends ResourceCreate {
|
18
19
|
name: string;
|
19
20
|
}
|
20
21
|
interface CustomerGroupUpdate extends ResourceUpdate {
|
21
|
-
name
|
22
|
+
name?: string | null;
|
22
23
|
}
|
23
24
|
declare class CustomerGroups extends ApiResource<CustomerGroup> {
|
24
25
|
static readonly TYPE: CustomerGroupType;
|
@@ -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 { Customer } from './customers';
|
4
5
|
import type { Event } from './events';
|
@@ -9,17 +10,17 @@ type CustomerPasswordResetRel = ResourceRel & {
|
|
9
10
|
interface CustomerPasswordReset extends Resource {
|
10
11
|
readonly type: CustomerPasswordResetType;
|
11
12
|
customer_email: string;
|
12
|
-
reset_password_token?: string;
|
13
|
-
reset_password_at?: string;
|
14
|
-
customer?: Customer;
|
15
|
-
events?: Event[];
|
13
|
+
reset_password_token?: string | null;
|
14
|
+
reset_password_at?: string | null;
|
15
|
+
customer?: Customer | null;
|
16
|
+
events?: Event[] | null;
|
16
17
|
}
|
17
18
|
interface CustomerPasswordResetCreate extends ResourceCreate {
|
18
19
|
customer_email: string;
|
19
20
|
}
|
20
21
|
interface CustomerPasswordResetUpdate extends ResourceUpdate {
|
21
|
-
customer_password?: string;
|
22
|
-
_reset_password_token?: string;
|
22
|
+
customer_password?: string | null;
|
23
|
+
_reset_password_token?: string | null;
|
23
24
|
}
|
24
25
|
declare class CustomerPasswordResets extends ApiResource<CustomerPasswordReset> {
|
25
26
|
static readonly TYPE: CustomerPasswordResetType;
|
@@ -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 { Customer, CustomerType } from './customers';
|
4
5
|
import type { AdyenPayment, AdyenPaymentType } from './adyen_payments';
|
@@ -50,19 +51,19 @@ type WireTransferRel = ResourceRel & {
|
|
50
51
|
};
|
51
52
|
interface CustomerPaymentSource extends Resource {
|
52
53
|
readonly type: CustomerPaymentSourceType;
|
53
|
-
name?: string;
|
54
|
-
customer_token?: string;
|
55
|
-
payment_source_token?: string;
|
56
|
-
customer?: Customer;
|
57
|
-
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer;
|
54
|
+
name?: string | null;
|
55
|
+
customer_token?: string | null;
|
56
|
+
payment_source_token?: string | null;
|
57
|
+
customer?: Customer | null;
|
58
|
+
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
58
59
|
}
|
59
60
|
interface CustomerPaymentSourceCreate extends ResourceCreate {
|
60
61
|
customer: CustomerRel;
|
61
62
|
payment_source: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
|
62
63
|
}
|
63
64
|
interface CustomerPaymentSourceUpdate extends ResourceUpdate {
|
64
|
-
customer?: CustomerRel;
|
65
|
-
payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
|
65
|
+
customer?: CustomerRel | null;
|
66
|
+
payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel | null;
|
66
67
|
}
|
67
68
|
declare class CustomerPaymentSources extends ApiResource<CustomerPaymentSource> {
|
68
69
|
static readonly TYPE: CustomerPaymentSourceType;
|
@@ -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 { Customer } from './customers';
|
4
5
|
import type { Event } from './events';
|
@@ -9,8 +10,8 @@ type CustomerSubscriptionRel = ResourceRel & {
|
|
9
10
|
interface CustomerSubscription extends Resource {
|
10
11
|
readonly type: CustomerSubscriptionType;
|
11
12
|
customer_email: string;
|
12
|
-
customer?: Customer;
|
13
|
-
events?: Event[];
|
13
|
+
customer?: Customer | null;
|
14
|
+
events?: Event[] | null;
|
14
15
|
}
|
15
16
|
interface CustomerSubscriptionCreate extends ResourceCreate {
|
16
17
|
customer_email: string;
|
@@ -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 { CustomerGroup, CustomerGroupType } from './customer_groups';
|
4
5
|
import type { CustomerAddress } from './customer_addresses';
|
@@ -20,28 +21,28 @@ type CustomerGroupRel = ResourceRel & {
|
|
20
21
|
interface Customer extends Resource {
|
21
22
|
readonly type: CustomerType;
|
22
23
|
email: string;
|
23
|
-
status
|
24
|
-
has_password?: boolean;
|
25
|
-
customer_group?: CustomerGroup;
|
26
|
-
customer_addresses?: CustomerAddress[];
|
27
|
-
customer_payment_sources?: CustomerPaymentSource[];
|
28
|
-
customer_subscriptions?: CustomerSubscription[];
|
29
|
-
orders?: Order[];
|
30
|
-
order_subscriptions?: OrderSubscription[];
|
31
|
-
returns?: Return[];
|
32
|
-
sku_lists?: SkuList[];
|
33
|
-
attachments?: Attachment[];
|
34
|
-
events?: Event[];
|
24
|
+
status: 'prospect' | 'acquired' | 'repeat';
|
25
|
+
has_password?: boolean | null;
|
26
|
+
customer_group?: CustomerGroup | null;
|
27
|
+
customer_addresses?: CustomerAddress[] | null;
|
28
|
+
customer_payment_sources?: CustomerPaymentSource[] | null;
|
29
|
+
customer_subscriptions?: CustomerSubscription[] | null;
|
30
|
+
orders?: Order[] | null;
|
31
|
+
order_subscriptions?: OrderSubscription[] | null;
|
32
|
+
returns?: Return[] | null;
|
33
|
+
sku_lists?: SkuList[] | null;
|
34
|
+
attachments?: Attachment[] | null;
|
35
|
+
events?: Event[] | null;
|
35
36
|
}
|
36
37
|
interface CustomerCreate extends ResourceCreate {
|
37
38
|
email: string;
|
38
|
-
password?: string;
|
39
|
-
customer_group?: CustomerGroupRel;
|
39
|
+
password?: string | null;
|
40
|
+
customer_group?: CustomerGroupRel | null;
|
40
41
|
}
|
41
42
|
interface CustomerUpdate extends ResourceUpdate {
|
42
|
-
email
|
43
|
-
password?: string;
|
44
|
-
customer_group?: CustomerGroupRel;
|
43
|
+
email?: string | null;
|
44
|
+
password?: string | null;
|
45
|
+
customer_group?: CustomerGroupRel | null;
|
45
46
|
}
|
46
47
|
declare class Customers extends ApiResource<Customer> {
|
47
48
|
static readonly TYPE: CustomerType;
|
@@ -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 { StockLocation, StockLocationType } from './stock_locations';
|
4
5
|
import type { ShippingMethod, ShippingMethodType } from './shipping_methods';
|
@@ -17,11 +18,11 @@ interface DeliveryLeadTime extends Resource {
|
|
17
18
|
readonly type: DeliveryLeadTimeType;
|
18
19
|
min_hours: number;
|
19
20
|
max_hours: number;
|
20
|
-
min_days?: number;
|
21
|
-
max_days?: number;
|
22
|
-
stock_location?: StockLocation;
|
23
|
-
shipping_method?: ShippingMethod;
|
24
|
-
attachments?: Attachment[];
|
21
|
+
min_days?: number | null;
|
22
|
+
max_days?: number | null;
|
23
|
+
stock_location?: StockLocation | null;
|
24
|
+
shipping_method?: ShippingMethod | null;
|
25
|
+
attachments?: Attachment[] | null;
|
25
26
|
}
|
26
27
|
interface DeliveryLeadTimeCreate extends ResourceCreate {
|
27
28
|
min_hours: number;
|
@@ -30,10 +31,10 @@ interface DeliveryLeadTimeCreate extends ResourceCreate {
|
|
30
31
|
shipping_method: ShippingMethodRel;
|
31
32
|
}
|
32
33
|
interface DeliveryLeadTimeUpdate extends ResourceUpdate {
|
33
|
-
min_hours
|
34
|
-
max_hours
|
35
|
-
stock_location?: StockLocationRel;
|
36
|
-
shipping_method?: ShippingMethodRel;
|
34
|
+
min_hours?: number | null;
|
35
|
+
max_hours?: number | null;
|
36
|
+
stock_location?: StockLocationRel | null;
|
37
|
+
shipping_method?: ShippingMethodRel | null;
|
37
38
|
}
|
38
39
|
declare class DeliveryLeadTimes extends ApiResource<DeliveryLeadTime> {
|
39
40
|
static readonly TYPE: DeliveryLeadTimeType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
|
2
3
|
import type { QueryParamsRetrieve } from '../query';
|
3
4
|
import type { Webhook } from './webhooks';
|
4
5
|
type EventCallbackType = 'event_callbacks';
|
@@ -8,10 +9,10 @@ type EventCallbackRel = ResourceRel & {
|
|
8
9
|
interface EventCallback extends Resource {
|
9
10
|
readonly type: EventCallbackType;
|
10
11
|
callback_url: string;
|
11
|
-
payload?: object;
|
12
|
-
response_code?: string;
|
13
|
-
response_message?: string;
|
14
|
-
webhook?: Webhook;
|
12
|
+
payload?: object | null;
|
13
|
+
response_code?: string | null;
|
14
|
+
response_message?: string | null;
|
15
|
+
webhook?: Webhook | null;
|
15
16
|
}
|
16
17
|
declare class EventCallbacks extends ApiResource<EventCallback> {
|
17
18
|
static readonly TYPE: EventCallbackType;
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
2
3
|
import type { QueryParamsList } from '../query';
|
3
4
|
import type { EventCallback } from './event_callbacks';
|
4
5
|
import type { Webhook } from './webhooks';
|
@@ -9,8 +10,8 @@ type EventRel = ResourceRel & {
|
|
9
10
|
interface Event extends Resource {
|
10
11
|
readonly type: EventType;
|
11
12
|
name: string;
|
12
|
-
last_event_callbacks?: EventCallback[];
|
13
|
-
webhooks?: Webhook[];
|
13
|
+
last_event_callbacks?: EventCallback[] | null;
|
14
|
+
webhooks?: Webhook[] | null;
|
14
15
|
}
|
15
16
|
declare class Events extends ApiResource<Event> {
|
16
17
|
static readonly TYPE: EventType;
|