@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, 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 { KlarnaPayment, KlarnaPaymentType } from './klarna_payments';
|
@@ -12,22 +13,22 @@ type KlarnaPaymentRel = ResourceRel & {
|
|
12
13
|
interface KlarnaGateway extends Resource {
|
13
14
|
readonly type: KlarnaGatewayType;
|
14
15
|
name: string;
|
15
|
-
payment_methods?: PaymentMethod[];
|
16
|
-
klarna_payments?: KlarnaPayment[];
|
16
|
+
payment_methods?: PaymentMethod[] | null;
|
17
|
+
klarna_payments?: KlarnaPayment[] | null;
|
17
18
|
}
|
18
19
|
interface KlarnaGatewayCreate extends ResourceCreate {
|
19
20
|
name: string;
|
20
21
|
country_code: string;
|
21
22
|
api_key: string;
|
22
23
|
api_secret: string;
|
23
|
-
klarna_payments?: KlarnaPaymentRel[];
|
24
|
+
klarna_payments?: KlarnaPaymentRel[] | null;
|
24
25
|
}
|
25
26
|
interface KlarnaGatewayUpdate extends ResourceUpdate {
|
26
|
-
name
|
27
|
-
country_code?: string;
|
28
|
-
api_key?: string;
|
29
|
-
api_secret?: string;
|
30
|
-
klarna_payments?: KlarnaPaymentRel[];
|
27
|
+
name?: string | null;
|
28
|
+
country_code?: string | null;
|
29
|
+
api_key?: string | null;
|
30
|
+
api_secret?: string | null;
|
31
|
+
klarna_payments?: KlarnaPaymentRel[] | null;
|
31
32
|
}
|
32
33
|
declare class KlarnaGateways extends ApiResource<KlarnaGateway> {
|
33
34
|
static readonly TYPE: KlarnaGatewayType;
|
@@ -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,25 +12,25 @@ type OrderRel = ResourceRel & {
|
|
11
12
|
};
|
12
13
|
interface KlarnaPayment extends Resource {
|
13
14
|
readonly type: KlarnaPaymentType;
|
14
|
-
session_id?: string;
|
15
|
-
client_token?: string;
|
15
|
+
session_id?: string | null;
|
16
|
+
client_token?: string | null;
|
16
17
|
payment_methods: object[];
|
17
|
-
auth_token?: string;
|
18
|
-
mismatched_amounts?: boolean;
|
18
|
+
auth_token?: string | null;
|
19
|
+
mismatched_amounts?: boolean | null;
|
19
20
|
intent_amount_cents: number;
|
20
|
-
intent_amount_float?: number;
|
21
|
-
formatted_intent_amount?: string;
|
22
|
-
payment_instrument?: object;
|
23
|
-
order?: Order;
|
24
|
-
payment_gateway?: PaymentGateway;
|
21
|
+
intent_amount_float?: number | null;
|
22
|
+
formatted_intent_amount?: string | null;
|
23
|
+
payment_instrument?: object | null;
|
24
|
+
order?: Order | null;
|
25
|
+
payment_gateway?: PaymentGateway | null;
|
25
26
|
}
|
26
27
|
interface KlarnaPaymentCreate extends ResourceCreate {
|
27
28
|
order: OrderRel;
|
28
29
|
}
|
29
30
|
interface KlarnaPaymentUpdate extends ResourceUpdate {
|
30
|
-
auth_token?: string;
|
31
|
-
_update?: boolean;
|
32
|
-
order?: OrderRel;
|
31
|
+
auth_token?: string | null;
|
32
|
+
_update?: boolean | null;
|
33
|
+
order?: OrderRel | null;
|
33
34
|
}
|
34
35
|
declare class KlarnaPayments extends ApiResource<KlarnaPayment> {
|
35
36
|
static readonly TYPE: KlarnaPaymentType;
|
@@ -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 { LineItem, LineItemType } from './line_items';
|
4
5
|
import type { SkuOption, SkuOptionType } from './sku_options';
|
@@ -14,33 +15,33 @@ type SkuOptionRel = ResourceRel & {
|
|
14
15
|
};
|
15
16
|
interface LineItemOption extends Resource {
|
16
17
|
readonly type: LineItemOptionType;
|
17
|
-
name?: string;
|
18
|
+
name?: string | null;
|
18
19
|
quantity: number;
|
19
|
-
currency_code?: string;
|
20
|
-
unit_amount_cents?: number;
|
21
|
-
unit_amount_float?: number;
|
22
|
-
formatted_unit_amount?: string;
|
23
|
-
total_amount_cents?: number;
|
20
|
+
currency_code?: string | null;
|
21
|
+
unit_amount_cents?: number | null;
|
22
|
+
unit_amount_float?: number | null;
|
23
|
+
formatted_unit_amount?: string | null;
|
24
|
+
total_amount_cents?: number | null;
|
24
25
|
total_amount_float: number;
|
25
|
-
formatted_total_amount?: string;
|
26
|
-
delay_hours?: number;
|
27
|
-
delay_days?: number;
|
26
|
+
formatted_total_amount?: string | null;
|
27
|
+
delay_hours?: number | null;
|
28
|
+
delay_days?: number | null;
|
28
29
|
options: object;
|
29
|
-
line_item?: LineItem;
|
30
|
-
sku_option?: SkuOption;
|
30
|
+
line_item?: LineItem | null;
|
31
|
+
sku_option?: SkuOption | null;
|
31
32
|
}
|
32
33
|
interface LineItemOptionCreate extends ResourceCreate {
|
33
|
-
name?: string;
|
34
|
+
name?: string | null;
|
34
35
|
quantity: number;
|
35
36
|
options: object;
|
36
37
|
line_item: LineItemRel;
|
37
38
|
sku_option: SkuOptionRel;
|
38
39
|
}
|
39
40
|
interface LineItemOptionUpdate extends ResourceUpdate {
|
40
|
-
name?: string;
|
41
|
-
quantity
|
42
|
-
options
|
43
|
-
sku_option?: SkuOptionRel;
|
41
|
+
name?: string | null;
|
42
|
+
quantity?: number | null;
|
43
|
+
options?: object | null;
|
44
|
+
sku_option?: SkuOptionRel | null;
|
44
45
|
}
|
45
46
|
declare class LineItemOptions extends ApiResource<LineItemOption> {
|
46
47
|
static readonly TYPE: LineItemOptionType;
|
@@ -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 { Order, OrderType } from './orders';
|
4
5
|
import type { Adjustment, AdjustmentType } from './adjustments';
|
@@ -53,61 +54,64 @@ type SkuRel = ResourceRel & {
|
|
53
54
|
};
|
54
55
|
interface LineItem extends Resource {
|
55
56
|
readonly type: LineItemType;
|
56
|
-
sku_code?: string;
|
57
|
-
bundle_code?: string;
|
57
|
+
sku_code?: string | null;
|
58
|
+
bundle_code?: string | null;
|
58
59
|
quantity: number;
|
59
|
-
currency_code?: string;
|
60
|
-
unit_amount_cents?: number;
|
61
|
-
unit_amount_float?: number;
|
62
|
-
formatted_unit_amount?: string;
|
63
|
-
options_amount_cents?: number;
|
64
|
-
options_amount_float?: number;
|
65
|
-
formatted_options_amount?: string;
|
66
|
-
discount_cents?: number;
|
67
|
-
discount_float?: number;
|
68
|
-
formatted_discount?: string;
|
69
|
-
total_amount_cents?: number;
|
60
|
+
currency_code?: string | null;
|
61
|
+
unit_amount_cents?: number | null;
|
62
|
+
unit_amount_float?: number | null;
|
63
|
+
formatted_unit_amount?: string | null;
|
64
|
+
options_amount_cents?: number | null;
|
65
|
+
options_amount_float?: number | null;
|
66
|
+
formatted_options_amount?: string | null;
|
67
|
+
discount_cents?: number | null;
|
68
|
+
discount_float?: number | null;
|
69
|
+
formatted_discount?: string | null;
|
70
|
+
total_amount_cents?: number | null;
|
70
71
|
total_amount_float: number;
|
71
|
-
formatted_total_amount?: string;
|
72
|
-
tax_amount_cents?: number;
|
72
|
+
formatted_total_amount?: string | null;
|
73
|
+
tax_amount_cents?: number | null;
|
73
74
|
tax_amount_float: number;
|
74
|
-
formatted_tax_amount?: string;
|
75
|
-
name?: string;
|
76
|
-
image_url?: string;
|
77
|
-
discount_breakdown?: object;
|
78
|
-
tax_rate?: number;
|
79
|
-
tax_breakdown?: object;
|
80
|
-
item_type?: '
|
81
|
-
|
82
|
-
|
83
|
-
|
75
|
+
formatted_tax_amount?: string | null;
|
76
|
+
name?: string | null;
|
77
|
+
image_url?: string | null;
|
78
|
+
discount_breakdown?: object | null;
|
79
|
+
tax_rate?: number | null;
|
80
|
+
tax_breakdown?: object | null;
|
81
|
+
item_type?: 'skus' | 'bundles' | 'shipments' | 'payment_methods' | 'adjustments' | 'gift_cards' | 'percentage_discount_promotions' | 'free_shipping_promotions' | 'free_gift_promotions' | 'fixed_price_promotions' | 'external_promotions' | 'fixed_amount_promotions' | null;
|
82
|
+
frequency?: string | null;
|
83
|
+
order?: Order | null;
|
84
|
+
item?: Adjustment | Bundle | ExternalPromotion | FixedAmountPromotion | FreeShippingPromotion | GiftCard | PaymentMethod | PercentageDiscountPromotion | Shipment | Sku | null;
|
85
|
+
line_item_options?: LineItemOption[] | null;
|
84
86
|
/**
|
85
87
|
* @deprecated This field should not be used as it may be removed in the future without notice
|
86
88
|
*/
|
87
89
|
shipment_line_items?: object[];
|
88
|
-
stock_line_items?: StockLineItem[];
|
89
|
-
stock_transfers?: StockTransfer[];
|
90
|
+
stock_line_items?: StockLineItem[] | null;
|
91
|
+
stock_transfers?: StockTransfer[] | null;
|
90
92
|
}
|
91
93
|
interface LineItemCreate extends ResourceCreate {
|
92
|
-
sku_code?: string;
|
93
|
-
bundle_code?: string;
|
94
|
+
sku_code?: string | null;
|
95
|
+
bundle_code?: string | null;
|
94
96
|
quantity: number;
|
95
|
-
_external_price?: boolean;
|
96
|
-
_update_quantity?: boolean;
|
97
|
-
unit_amount_cents?: number;
|
98
|
-
name?: string;
|
99
|
-
image_url?: string;
|
100
|
-
item_type?: '
|
97
|
+
_external_price?: boolean | null;
|
98
|
+
_update_quantity?: boolean | null;
|
99
|
+
unit_amount_cents?: number | null;
|
100
|
+
name?: string | null;
|
101
|
+
image_url?: string | null;
|
102
|
+
item_type?: 'skus' | 'bundles' | 'shipments' | 'payment_methods' | 'adjustments' | 'gift_cards' | 'percentage_discount_promotions' | 'free_shipping_promotions' | 'free_gift_promotions' | 'fixed_price_promotions' | 'external_promotions' | 'fixed_amount_promotions' | null;
|
103
|
+
frequency?: string | null;
|
101
104
|
order: OrderRel;
|
102
|
-
item?: AdjustmentRel | BundleRel | ExternalPromotionRel | FixedAmountPromotionRel | FreeShippingPromotionRel | GiftCardRel | PaymentMethodRel | PercentageDiscountPromotionRel | ShipmentRel | SkuRel;
|
105
|
+
item?: AdjustmentRel | BundleRel | ExternalPromotionRel | FixedAmountPromotionRel | FreeShippingPromotionRel | GiftCardRel | PaymentMethodRel | PercentageDiscountPromotionRel | ShipmentRel | SkuRel | null;
|
103
106
|
}
|
104
107
|
interface LineItemUpdate extends ResourceUpdate {
|
105
|
-
sku_code?: string;
|
106
|
-
bundle_code?: string;
|
107
|
-
quantity
|
108
|
-
_external_price?: boolean;
|
109
|
-
name?: string;
|
110
|
-
image_url?: string;
|
108
|
+
sku_code?: string | null;
|
109
|
+
bundle_code?: string | null;
|
110
|
+
quantity?: number | null;
|
111
|
+
_external_price?: boolean | null;
|
112
|
+
name?: string | null;
|
113
|
+
image_url?: string | null;
|
114
|
+
frequency?: string | null;
|
111
115
|
}
|
112
116
|
declare class LineItems extends ApiResource<LineItem> {
|
113
117
|
static readonly TYPE: LineItemType;
|
@@ -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
|
type ManualGatewayType = 'manual_gateways';
|
@@ -8,13 +9,13 @@ type ManualGatewayRel = ResourceRel & {
|
|
8
9
|
interface ManualGateway extends Resource {
|
9
10
|
readonly type: ManualGatewayType;
|
10
11
|
name: string;
|
11
|
-
payment_methods?: PaymentMethod[];
|
12
|
+
payment_methods?: PaymentMethod[] | null;
|
12
13
|
}
|
13
14
|
interface ManualGatewayCreate extends ResourceCreate {
|
14
15
|
name: string;
|
15
16
|
}
|
16
17
|
interface ManualGatewayUpdate extends ResourceUpdate {
|
17
|
-
name
|
18
|
+
name?: string | null;
|
18
19
|
}
|
19
20
|
declare class ManualGateways extends ApiResource<ManualGateway> {
|
20
21
|
static readonly TYPE: ManualGatewayType;
|
@@ -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';
|
@@ -13,17 +14,17 @@ type TaxRuleRel = ResourceRel & {
|
|
13
14
|
interface ManualTaxCalculator extends Resource {
|
14
15
|
readonly type: ManualTaxCalculatorType;
|
15
16
|
name: string;
|
16
|
-
markets?: Market[];
|
17
|
-
attachments?: Attachment[];
|
18
|
-
tax_rules?: TaxRule[];
|
17
|
+
markets?: Market[] | null;
|
18
|
+
attachments?: Attachment[] | null;
|
19
|
+
tax_rules?: TaxRule[] | null;
|
19
20
|
}
|
20
21
|
interface ManualTaxCalculatorCreate extends ResourceCreate {
|
21
22
|
name: string;
|
22
|
-
tax_rules?: TaxRuleRel[];
|
23
|
+
tax_rules?: TaxRuleRel[] | null;
|
23
24
|
}
|
24
25
|
interface ManualTaxCalculatorUpdate extends ResourceUpdate {
|
25
|
-
name
|
26
|
-
tax_rules?: TaxRuleRel[];
|
26
|
+
name?: string | null;
|
27
|
+
tax_rules?: TaxRuleRel[] | null;
|
27
28
|
}
|
28
29
|
declare class ManualTaxCalculators extends ApiResource<ManualTaxCalculator> {
|
29
30
|
static readonly TYPE: ManualTaxCalculatorType;
|
@@ -1,8 +1,10 @@
|
|
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 { Merchant, MerchantType } from './merchants';
|
4
5
|
import type { PriceList, PriceListType } from './price_lists';
|
5
6
|
import type { InventoryModel, InventoryModelType } from './inventory_models';
|
7
|
+
import type { SubscriptionModel, SubscriptionModelType } from './subscription_models';
|
6
8
|
import type { TaxCalculator, TaxCalculatorType } from './tax_calculators';
|
7
9
|
import type { CustomerGroup, CustomerGroupType } from './customer_groups';
|
8
10
|
import type { Attachment } from './attachments';
|
@@ -19,6 +21,9 @@ type PriceListRel = ResourceRel & {
|
|
19
21
|
type InventoryModelRel = ResourceRel & {
|
20
22
|
type: InventoryModelType;
|
21
23
|
};
|
24
|
+
type SubscriptionModelRel = ResourceRel & {
|
25
|
+
type: SubscriptionModelType;
|
26
|
+
};
|
22
27
|
type TaxCalculatorRel = ResourceRel & {
|
23
28
|
type: TaxCalculatorType;
|
24
29
|
};
|
@@ -27,47 +32,50 @@ type CustomerGroupRel = ResourceRel & {
|
|
27
32
|
};
|
28
33
|
interface Market extends Resource {
|
29
34
|
readonly type: MarketType;
|
30
|
-
number?: number;
|
35
|
+
number?: number | null;
|
31
36
|
name: string;
|
32
|
-
facebook_pixel_id?: string;
|
33
|
-
checkout_url?: string;
|
34
|
-
external_prices_url?: string;
|
35
|
-
external_order_validation_url?: string;
|
37
|
+
facebook_pixel_id?: string | null;
|
38
|
+
checkout_url?: string | null;
|
39
|
+
external_prices_url?: string | null;
|
40
|
+
external_order_validation_url?: string | null;
|
36
41
|
shared_secret: string;
|
37
|
-
private?: boolean;
|
38
|
-
disabled_at?: string;
|
39
|
-
merchant?: Merchant;
|
40
|
-
price_list?: PriceList;
|
41
|
-
inventory_model?: InventoryModel;
|
42
|
-
|
43
|
-
|
44
|
-
|
42
|
+
private?: boolean | null;
|
43
|
+
disabled_at?: string | null;
|
44
|
+
merchant?: Merchant | null;
|
45
|
+
price_list?: PriceList | null;
|
46
|
+
inventory_model?: InventoryModel | null;
|
47
|
+
subscription_model?: SubscriptionModel | null;
|
48
|
+
tax_calculator?: TaxCalculator | null;
|
49
|
+
customer_group?: CustomerGroup | null;
|
50
|
+
attachments?: Attachment[] | null;
|
45
51
|
}
|
46
52
|
interface MarketCreate extends ResourceCreate {
|
47
53
|
name: string;
|
48
|
-
facebook_pixel_id?: string;
|
49
|
-
checkout_url?: string;
|
50
|
-
external_prices_url?: string;
|
51
|
-
external_order_validation_url?: string;
|
54
|
+
facebook_pixel_id?: string | null;
|
55
|
+
checkout_url?: string | null;
|
56
|
+
external_prices_url?: string | null;
|
57
|
+
external_order_validation_url?: string | null;
|
52
58
|
merchant: MerchantRel;
|
53
59
|
price_list: PriceListRel;
|
54
60
|
inventory_model: InventoryModelRel;
|
55
|
-
|
56
|
-
|
61
|
+
subscription_model?: SubscriptionModelRel | null;
|
62
|
+
tax_calculator?: TaxCalculatorRel | null;
|
63
|
+
customer_group?: CustomerGroupRel | null;
|
57
64
|
}
|
58
65
|
interface MarketUpdate extends ResourceUpdate {
|
59
|
-
name
|
60
|
-
facebook_pixel_id?: string;
|
61
|
-
checkout_url?: string;
|
62
|
-
external_prices_url?: string;
|
63
|
-
external_order_validation_url?: string;
|
64
|
-
_disable?: boolean;
|
65
|
-
_enable?: boolean;
|
66
|
-
merchant?: MerchantRel;
|
67
|
-
price_list?: PriceListRel;
|
68
|
-
inventory_model?: InventoryModelRel;
|
69
|
-
|
70
|
-
|
66
|
+
name?: string | null;
|
67
|
+
facebook_pixel_id?: string | null;
|
68
|
+
checkout_url?: string | null;
|
69
|
+
external_prices_url?: string | null;
|
70
|
+
external_order_validation_url?: string | null;
|
71
|
+
_disable?: boolean | null;
|
72
|
+
_enable?: boolean | null;
|
73
|
+
merchant?: MerchantRel | null;
|
74
|
+
price_list?: PriceListRel | null;
|
75
|
+
inventory_model?: InventoryModelRel | null;
|
76
|
+
subscription_model?: SubscriptionModelRel | null;
|
77
|
+
tax_calculator?: TaxCalculatorRel | null;
|
78
|
+
customer_group?: CustomerGroupRel | null;
|
71
79
|
}
|
72
80
|
declare class Markets extends ApiResource<Market> {
|
73
81
|
static readonly TYPE: MarketType;
|
@@ -77,6 +85,7 @@ declare class Markets extends ApiResource<Market> {
|
|
77
85
|
merchant(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Merchant>;
|
78
86
|
price_list(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceList>;
|
79
87
|
inventory_model(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<InventoryModel>;
|
88
|
+
subscription_model(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SubscriptionModel>;
|
80
89
|
tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<TaxCalculator>;
|
81
90
|
customer_group(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerGroup>;
|
82
91
|
attachments(marketId: string | Market, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
@@ -23,6 +23,10 @@ class Markets extends resource_1.ApiResource {
|
|
23
23
|
const _marketId = marketId.id || marketId;
|
24
24
|
return this.resources.fetch({ type: 'inventory_models' }, `markets/${_marketId}/inventory_model`, params, options);
|
25
25
|
}
|
26
|
+
async subscription_model(marketId, params, options) {
|
27
|
+
const _marketId = marketId.id || marketId;
|
28
|
+
return this.resources.fetch({ type: 'subscription_models' }, `markets/${_marketId}/subscription_model`, params, options);
|
29
|
+
}
|
26
30
|
async tax_calculator(marketId, params, options) {
|
27
31
|
const _marketId = marketId.id || marketId;
|
28
32
|
return this.resources.fetch({ type: 'tax_calculators' }, `markets/${_marketId}/tax_calculator`, params, options);
|
@@ -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 { Address, AddressType } from './addresses';
|
4
5
|
import type { Attachment } from './attachments';
|
@@ -12,16 +13,16 @@ type AddressRel = ResourceRel & {
|
|
12
13
|
interface Merchant extends Resource {
|
13
14
|
readonly type: MerchantType;
|
14
15
|
name: string;
|
15
|
-
address?: Address;
|
16
|
-
attachments?: Attachment[];
|
16
|
+
address?: Address | null;
|
17
|
+
attachments?: Attachment[] | null;
|
17
18
|
}
|
18
19
|
interface MerchantCreate extends ResourceCreate {
|
19
20
|
name: string;
|
20
21
|
address: AddressRel;
|
21
22
|
}
|
22
23
|
interface MerchantUpdate extends ResourceUpdate {
|
23
|
-
name
|
24
|
-
address?: AddressRel;
|
24
|
+
name?: string | null;
|
25
|
+
address?: AddressRel | null;
|
25
26
|
}
|
26
27
|
declare class Merchants extends ApiResource<Merchant> {
|
27
28
|
static readonly TYPE: MerchantType;
|
@@ -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 { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
|
4
5
|
import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
|
@@ -30,18 +31,18 @@ type FixedAmountPromotionRel = ResourceRel & {
|
|
30
31
|
};
|
31
32
|
interface OrderAmountPromotionRule extends Resource {
|
32
33
|
readonly type: OrderAmountPromotionRuleType;
|
33
|
-
order_amount_cents?: number;
|
34
|
-
order_amount_float?: number;
|
35
|
-
formatted_order_amount?: string;
|
36
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
|
34
|
+
order_amount_cents?: number | null;
|
35
|
+
order_amount_float?: number | null;
|
36
|
+
formatted_order_amount?: string | null;
|
37
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
37
38
|
}
|
38
39
|
interface OrderAmountPromotionRuleCreate extends ResourceCreate {
|
39
|
-
order_amount_cents?: number;
|
40
|
+
order_amount_cents?: number | null;
|
40
41
|
promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
41
42
|
}
|
42
43
|
interface OrderAmountPromotionRuleUpdate extends ResourceUpdate {
|
43
|
-
order_amount_cents?: number;
|
44
|
-
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
|
44
|
+
order_amount_cents?: number | null;
|
45
|
+
promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | null;
|
45
46
|
}
|
46
47
|
declare class OrderAmountPromotionRules extends ApiResource<OrderAmountPromotionRule> {
|
47
48
|
static readonly TYPE: OrderAmountPromotionRuleType;
|
@@ -1,8 +1,9 @@
|
|
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 { Order, OrderType } from './orders';
|
4
|
-
import type { OrderSubscription } from './order_subscriptions';
|
5
5
|
import type { Event } from './events';
|
6
|
+
import type { OrderSubscription } from './order_subscriptions';
|
6
7
|
type OrderCopyType = 'order_copies';
|
7
8
|
type OrderCopyRel = ResourceRel & {
|
8
9
|
type: OrderCopyType;
|
@@ -12,37 +13,39 @@ type OrderRel = ResourceRel & {
|
|
12
13
|
};
|
13
14
|
interface OrderCopy extends Resource {
|
14
15
|
readonly type: OrderCopyType;
|
15
|
-
status
|
16
|
-
started_at?: string;
|
17
|
-
completed_at?: string;
|
18
|
-
failed_at?: string;
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
source_order?: Order;
|
25
|
-
target_order?: Order;
|
26
|
-
|
27
|
-
|
16
|
+
status: 'pending' | 'in_progress' | 'failed' | 'completed';
|
17
|
+
started_at?: string | null;
|
18
|
+
completed_at?: string | null;
|
19
|
+
failed_at?: string | null;
|
20
|
+
errors_log?: object | null;
|
21
|
+
errors_count?: number | null;
|
22
|
+
place_target_order?: boolean | null;
|
23
|
+
reuse_wallet?: boolean | null;
|
24
|
+
cancel_source_order?: boolean | null;
|
25
|
+
source_order?: Order | null;
|
26
|
+
target_order?: Order | null;
|
27
|
+
events?: Event[] | null;
|
28
|
+
order_subscription?: OrderSubscription | null;
|
28
29
|
}
|
29
30
|
interface OrderCopyCreate extends ResourceCreate {
|
30
|
-
place_target_order?: boolean;
|
31
|
-
|
32
|
-
|
31
|
+
place_target_order?: boolean | null;
|
32
|
+
reuse_wallet?: boolean | null;
|
33
|
+
cancel_source_order?: boolean | null;
|
33
34
|
source_order: OrderRel;
|
34
35
|
}
|
36
|
+
type OrderCopyUpdate = ResourceUpdate;
|
35
37
|
declare class OrderCopies extends ApiResource<OrderCopy> {
|
36
38
|
static readonly TYPE: OrderCopyType;
|
37
39
|
create(resource: OrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderCopy>;
|
40
|
+
update(resource: OrderCopyUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderCopy>;
|
38
41
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
39
42
|
source_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
40
43
|
target_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
41
|
-
order_subscription(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
42
44
|
events(orderCopyId: string | OrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
45
|
+
order_subscription(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
43
46
|
isOrderCopy(resource: any): resource is OrderCopy;
|
44
47
|
relationship(id: string | ResourceId | null): OrderCopyRel;
|
45
48
|
type(): OrderCopyType;
|
46
49
|
}
|
47
50
|
export default OrderCopies;
|
48
|
-
export type { OrderCopy, OrderCopyCreate, OrderCopyType };
|
51
|
+
export type { OrderCopy, OrderCopyCreate, OrderCopyUpdate, OrderCopyType };
|
@@ -5,6 +5,9 @@ class OrderCopies extends resource_1.ApiResource {
|
|
5
5
|
async create(resource, params, options) {
|
6
6
|
return this.resources.create({ ...resource, type: OrderCopies.TYPE }, params, options);
|
7
7
|
}
|
8
|
+
async update(resource, params, options) {
|
9
|
+
return this.resources.update({ ...resource, type: OrderCopies.TYPE }, params, options);
|
10
|
+
}
|
8
11
|
async delete(id, options) {
|
9
12
|
await this.resources.delete((typeof id === 'string') ? { id, type: OrderCopies.TYPE } : id, options);
|
10
13
|
}
|
@@ -16,14 +19,14 @@ class OrderCopies extends resource_1.ApiResource {
|
|
16
19
|
const _orderCopyId = orderCopyId.id || orderCopyId;
|
17
20
|
return this.resources.fetch({ type: 'orders' }, `order_copies/${_orderCopyId}/target_order`, params, options);
|
18
21
|
}
|
19
|
-
async order_subscription(orderCopyId, params, options) {
|
20
|
-
const _orderCopyId = orderCopyId.id || orderCopyId;
|
21
|
-
return this.resources.fetch({ type: 'order_subscriptions' }, `order_copies/${_orderCopyId}/order_subscription`, params, options);
|
22
|
-
}
|
23
22
|
async events(orderCopyId, params, options) {
|
24
23
|
const _orderCopyId = orderCopyId.id || orderCopyId;
|
25
24
|
return this.resources.fetch({ type: 'events' }, `order_copies/${_orderCopyId}/events`, params, options);
|
26
25
|
}
|
26
|
+
async order_subscription(orderCopyId, params, options) {
|
27
|
+
const _orderCopyId = orderCopyId.id || orderCopyId;
|
28
|
+
return this.resources.fetch({ type: 'order_subscriptions' }, `order_copies/${_orderCopyId}/order_subscription`, params, options);
|
29
|
+
}
|
27
30
|
isOrderCopy(resource) {
|
28
31
|
return resource.type && (resource.type === OrderCopies.TYPE);
|
29
32
|
}
|
@@ -0,0 +1,34 @@
|
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
3
|
+
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
|
+
import type { Order } from './orders';
|
5
|
+
import type { Event } from './events';
|
6
|
+
type OrderFactoryType = 'order_factories';
|
7
|
+
type OrderFactoryRel = ResourceRel & {
|
8
|
+
type: OrderFactoryType;
|
9
|
+
};
|
10
|
+
interface OrderFactory extends Resource {
|
11
|
+
readonly type: OrderFactoryType;
|
12
|
+
status: 'pending' | 'in_progress' | 'failed' | 'completed';
|
13
|
+
started_at?: string | null;
|
14
|
+
completed_at?: string | null;
|
15
|
+
failed_at?: string | null;
|
16
|
+
errors_log?: object | null;
|
17
|
+
errors_count?: number | null;
|
18
|
+
place_target_order?: boolean | null;
|
19
|
+
reuse_wallet?: boolean | null;
|
20
|
+
source_order?: Order | null;
|
21
|
+
target_order?: Order | null;
|
22
|
+
events?: Event[] | null;
|
23
|
+
}
|
24
|
+
declare class OrderFactories extends ApiResource<OrderFactory> {
|
25
|
+
static readonly TYPE: OrderFactoryType;
|
26
|
+
source_order(orderFactoryId: string | OrderFactory, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
27
|
+
target_order(orderFactoryId: string | OrderFactory, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
28
|
+
events(orderFactoryId: string | OrderFactory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
29
|
+
isOrderFactory(resource: any): resource is OrderFactory;
|
30
|
+
relationship(id: string | ResourceId | null): OrderFactoryRel;
|
31
|
+
type(): OrderFactoryType;
|
32
|
+
}
|
33
|
+
export default OrderFactories;
|
34
|
+
export type { OrderFactory, OrderFactoryType };
|