@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,7 +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 { Price, PriceType } from './prices';
|
4
5
|
import type { Attachment } from './attachments';
|
6
|
+
import type { Event } from './events';
|
5
7
|
type PriceVolumeTierType = 'price_volume_tiers';
|
6
8
|
type PriceVolumeTierRel = ResourceRel & {
|
7
9
|
type: PriceVolumeTierType;
|
@@ -12,24 +14,25 @@ type PriceRel = ResourceRel & {
|
|
12
14
|
interface PriceVolumeTier extends Resource {
|
13
15
|
readonly type: PriceVolumeTierType;
|
14
16
|
name: string;
|
15
|
-
up_to?: number;
|
17
|
+
up_to?: number | null;
|
16
18
|
price_amount_cents: number;
|
17
|
-
price_amount_float?: number;
|
18
|
-
formatted_price_amount?: string;
|
19
|
-
price?: Price;
|
20
|
-
attachments?: Attachment[];
|
19
|
+
price_amount_float?: number | null;
|
20
|
+
formatted_price_amount?: string | null;
|
21
|
+
price?: Price | null;
|
22
|
+
attachments?: Attachment[] | null;
|
23
|
+
events?: Event[] | null;
|
21
24
|
}
|
22
25
|
interface PriceVolumeTierCreate extends ResourceCreate {
|
23
26
|
name: string;
|
24
|
-
up_to?: number;
|
27
|
+
up_to?: number | null;
|
25
28
|
price_amount_cents: number;
|
26
29
|
price: PriceRel;
|
27
30
|
}
|
28
31
|
interface PriceVolumeTierUpdate extends ResourceUpdate {
|
29
|
-
name
|
30
|
-
up_to?: number;
|
31
|
-
price_amount_cents
|
32
|
-
price?: PriceRel;
|
32
|
+
name?: string | null;
|
33
|
+
up_to?: number | null;
|
34
|
+
price_amount_cents?: number | null;
|
35
|
+
price?: PriceRel | null;
|
33
36
|
}
|
34
37
|
declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
|
35
38
|
static readonly TYPE: PriceVolumeTierType;
|
@@ -38,6 +41,7 @@ declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
|
|
38
41
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
39
42
|
price(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
|
40
43
|
attachments(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
44
|
+
events(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
41
45
|
isPriceVolumeTier(resource: any): resource is PriceVolumeTier;
|
42
46
|
relationship(id: string | ResourceId | null): PriceVolumeTierRel;
|
43
47
|
type(): PriceVolumeTierType;
|
@@ -19,6 +19,10 @@ class PriceVolumeTiers extends resource_1.ApiResource {
|
|
19
19
|
const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
|
20
20
|
return this.resources.fetch({ type: 'attachments' }, `price_volume_tiers/${_priceVolumeTierId}/attachments`, params, options);
|
21
21
|
}
|
22
|
+
async events(priceVolumeTierId, params, options) {
|
23
|
+
const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
|
24
|
+
return this.resources.fetch({ type: 'events' }, `price_volume_tiers/${_priceVolumeTierId}/events`, params, options);
|
25
|
+
}
|
22
26
|
isPriceVolumeTier(resource) {
|
23
27
|
return resource.type && (resource.type === PriceVolumeTiers.TYPE);
|
24
28
|
}
|
@@ -1,9 +1,11 @@
|
|
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 { PriceList, PriceListType } from './price_lists';
|
4
5
|
import type { Sku, SkuType } from './skus';
|
5
6
|
import type { PriceTier, PriceTierType } from './price_tiers';
|
6
7
|
import type { PriceVolumeTier } from './price_volume_tiers';
|
8
|
+
import type { PriceFrequencyTier } from './price_frequency_tiers';
|
7
9
|
import type { Attachment } from './attachments';
|
8
10
|
type PriceType = 'prices';
|
9
11
|
type PriceRel = ResourceRel & {
|
@@ -20,35 +22,36 @@ type PriceTierRel = ResourceRel & {
|
|
20
22
|
};
|
21
23
|
interface Price extends Resource {
|
22
24
|
readonly type: PriceType;
|
23
|
-
currency_code?: string;
|
24
|
-
sku_code?: string;
|
25
|
+
currency_code?: string | null;
|
26
|
+
sku_code?: string | null;
|
25
27
|
amount_cents: number;
|
26
28
|
amount_float: number;
|
27
29
|
formatted_amount: string;
|
28
30
|
compare_at_amount_cents: number;
|
29
31
|
compare_at_amount_float: number;
|
30
32
|
formatted_compare_at_amount: string;
|
31
|
-
price_list?: PriceList;
|
32
|
-
sku?: Sku;
|
33
|
-
price_tiers?: PriceTier[];
|
34
|
-
price_volume_tiers?: PriceVolumeTier[];
|
35
|
-
|
33
|
+
price_list?: PriceList | null;
|
34
|
+
sku?: Sku | null;
|
35
|
+
price_tiers?: PriceTier[] | null;
|
36
|
+
price_volume_tiers?: PriceVolumeTier[] | null;
|
37
|
+
price_frequency_tiers?: PriceFrequencyTier[] | null;
|
38
|
+
attachments?: Attachment[] | null;
|
36
39
|
}
|
37
40
|
interface PriceCreate extends ResourceCreate {
|
38
|
-
sku_code?: string;
|
41
|
+
sku_code?: string | null;
|
39
42
|
amount_cents: number;
|
40
43
|
compare_at_amount_cents: number;
|
41
44
|
price_list: PriceListRel;
|
42
45
|
sku: SkuRel;
|
43
|
-
price_tiers?: PriceTierRel[];
|
46
|
+
price_tiers?: PriceTierRel[] | null;
|
44
47
|
}
|
45
48
|
interface PriceUpdate extends ResourceUpdate {
|
46
|
-
sku_code?: string;
|
47
|
-
amount_cents
|
48
|
-
compare_at_amount_cents
|
49
|
-
price_list?: PriceListRel;
|
50
|
-
sku?: SkuRel;
|
51
|
-
price_tiers?: PriceTierRel[];
|
49
|
+
sku_code?: string | null;
|
50
|
+
amount_cents?: number | null;
|
51
|
+
compare_at_amount_cents?: number | null;
|
52
|
+
price_list?: PriceListRel | null;
|
53
|
+
sku?: SkuRel | null;
|
54
|
+
price_tiers?: PriceTierRel[] | null;
|
52
55
|
}
|
53
56
|
declare class Prices extends ApiResource<Price> {
|
54
57
|
static readonly TYPE: PriceType;
|
@@ -59,6 +62,7 @@ declare class Prices extends ApiResource<Price> {
|
|
59
62
|
sku(priceId: string | Price, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
|
60
63
|
price_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceTier>>;
|
61
64
|
price_volume_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceVolumeTier>>;
|
65
|
+
price_frequency_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceFrequencyTier>>;
|
62
66
|
attachments(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
63
67
|
isPrice(resource: any): resource is Price;
|
64
68
|
relationship(id: string | ResourceId | null): PriceRel;
|
@@ -27,6 +27,10 @@ class Prices extends resource_1.ApiResource {
|
|
27
27
|
const _priceId = priceId.id || priceId;
|
28
28
|
return this.resources.fetch({ type: 'price_volume_tiers' }, `prices/${_priceId}/price_volume_tiers`, params, options);
|
29
29
|
}
|
30
|
+
async price_frequency_tiers(priceId, params, options) {
|
31
|
+
const _priceId = priceId.id || priceId;
|
32
|
+
return this.resources.fetch({ type: 'price_frequency_tiers' }, `prices/${_priceId}/price_frequency_tiers`, params, options);
|
33
|
+
}
|
30
34
|
async attachments(priceId, params, options) {
|
31
35
|
const _priceId = priceId.id || priceId;
|
32
36
|
return this.resources.fetch({ type: 'attachments' }, `prices/${_priceId}/attachments`, params, options);
|
@@ -1,4 +1,5 @@
|
|
1
|
-
import { ApiResource
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceId, ResourceRel } from '../resource';
|
2
3
|
import type { PercentageDiscountPromotion } from './percentage_discount_promotions';
|
3
4
|
import type { FreeShippingPromotion } from './free_shipping_promotions';
|
4
5
|
import type { FreeGiftPromotion } from './free_gift_promotions';
|
@@ -11,7 +12,7 @@ type PromotionRuleRel = ResourceRel & {
|
|
11
12
|
};
|
12
13
|
interface PromotionRule extends Resource {
|
13
14
|
readonly type: PromotionRuleType;
|
14
|
-
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
|
15
|
+
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
|
15
16
|
}
|
16
17
|
declare class PromotionRules extends ApiResource<PromotionRule> {
|
17
18
|
static readonly TYPE: PromotionRuleType;
|
@@ -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 { PromotionRule } from './promotion_rules';
|
@@ -6,6 +7,7 @@ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
|
|
6
7
|
import type { SkuListPromotionRule } from './sku_list_promotion_rules';
|
7
8
|
import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
|
8
9
|
import type { Attachment } from './attachments';
|
10
|
+
import type { Event } from './events';
|
9
11
|
type PromotionType = 'promotions';
|
10
12
|
type PromotionRel = ResourceRel & {
|
11
13
|
type: PromotionType;
|
@@ -13,18 +15,19 @@ type PromotionRel = ResourceRel & {
|
|
13
15
|
interface Promotion extends Resource {
|
14
16
|
readonly type: PromotionType;
|
15
17
|
name: string;
|
16
|
-
currency_code?: string;
|
18
|
+
currency_code?: string | null;
|
17
19
|
starts_at: string;
|
18
20
|
expires_at: string;
|
19
21
|
total_usage_limit: number;
|
20
|
-
total_usage_count?: number;
|
21
|
-
active?: boolean;
|
22
|
-
market?: Market;
|
23
|
-
promotion_rules?: PromotionRule[];
|
24
|
-
order_amount_promotion_rule?: OrderAmountPromotionRule;
|
25
|
-
sku_list_promotion_rule?: SkuListPromotionRule;
|
26
|
-
coupon_codes_promotion_rule?: CouponCodesPromotionRule;
|
27
|
-
attachments?: Attachment[];
|
22
|
+
total_usage_count?: number | null;
|
23
|
+
active?: boolean | null;
|
24
|
+
market?: Market | null;
|
25
|
+
promotion_rules?: PromotionRule[] | null;
|
26
|
+
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
27
|
+
sku_list_promotion_rule?: SkuListPromotionRule | null;
|
28
|
+
coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
|
29
|
+
attachments?: Attachment[] | null;
|
30
|
+
events?: Event[] | null;
|
28
31
|
}
|
29
32
|
declare class Promotions extends ApiResource<Promotion> {
|
30
33
|
static readonly TYPE: PromotionType;
|
@@ -33,6 +36,7 @@ declare class Promotions extends ApiResource<Promotion> {
|
|
33
36
|
sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
34
37
|
coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
35
38
|
attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
39
|
+
events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
36
40
|
isPromotion(resource: any): resource is Promotion;
|
37
41
|
relationship(id: string | ResourceId | null): PromotionRel;
|
38
42
|
type(): PromotionType;
|
@@ -22,6 +22,10 @@ class Promotions extends resource_1.ApiResource {
|
|
22
22
|
const _promotionId = promotionId.id || promotionId;
|
23
23
|
return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
|
24
24
|
}
|
25
|
+
async events(promotionId, params, options) {
|
26
|
+
const _promotionId = promotionId.id || promotionId;
|
27
|
+
return this.resources.fetch({ type: 'events' }, `promotions/${_promotionId}/events`, params, options);
|
28
|
+
}
|
25
29
|
isPromotion(resource) {
|
26
30
|
return resource.type && (resource.type === Promotions.TYPE);
|
27
31
|
}
|
@@ -0,0 +1,53 @@
|
|
1
|
+
import { ApiResource } from '../resource';
|
2
|
+
import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
|
3
|
+
import type { QueryParamsRetrieve, QueryParamsList } from '../query';
|
4
|
+
import type { Order, OrderType } from './orders';
|
5
|
+
import type { Event } from './events';
|
6
|
+
import type { OrderSubscription, OrderSubscriptionType } from './order_subscriptions';
|
7
|
+
type RecurringOrderCopyType = 'recurring_order_copies';
|
8
|
+
type RecurringOrderCopyRel = ResourceRel & {
|
9
|
+
type: RecurringOrderCopyType;
|
10
|
+
};
|
11
|
+
type OrderRel = ResourceRel & {
|
12
|
+
type: OrderType;
|
13
|
+
};
|
14
|
+
type OrderSubscriptionRel = ResourceRel & {
|
15
|
+
type: OrderSubscriptionType;
|
16
|
+
};
|
17
|
+
interface RecurringOrderCopy extends Resource {
|
18
|
+
readonly type: RecurringOrderCopyType;
|
19
|
+
status: 'pending' | 'in_progress' | 'failed' | 'completed';
|
20
|
+
started_at?: string | null;
|
21
|
+
completed_at?: string | null;
|
22
|
+
failed_at?: string | null;
|
23
|
+
errors_log?: object | null;
|
24
|
+
errors_count?: number | null;
|
25
|
+
place_target_order?: boolean | null;
|
26
|
+
reuse_wallet?: boolean | null;
|
27
|
+
source_order?: Order | null;
|
28
|
+
target_order?: Order | null;
|
29
|
+
events?: Event[] | null;
|
30
|
+
order_subscription?: OrderSubscription | null;
|
31
|
+
}
|
32
|
+
interface RecurringOrderCopyCreate extends ResourceCreate {
|
33
|
+
place_target_order?: boolean | null;
|
34
|
+
reuse_wallet?: boolean | null;
|
35
|
+
source_order: OrderRel;
|
36
|
+
order_subscription: OrderSubscriptionRel;
|
37
|
+
}
|
38
|
+
type RecurringOrderCopyUpdate = ResourceUpdate;
|
39
|
+
declare class RecurringOrderCopies extends ApiResource<RecurringOrderCopy> {
|
40
|
+
static readonly TYPE: RecurringOrderCopyType;
|
41
|
+
create(resource: RecurringOrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
|
42
|
+
update(resource: RecurringOrderCopyUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
|
43
|
+
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
44
|
+
source_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
45
|
+
target_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
46
|
+
events(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
47
|
+
order_subscription(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
48
|
+
isRecurringOrderCopy(resource: any): resource is RecurringOrderCopy;
|
49
|
+
relationship(id: string | ResourceId | null): RecurringOrderCopyRel;
|
50
|
+
type(): RecurringOrderCopyType;
|
51
|
+
}
|
52
|
+
export default RecurringOrderCopies;
|
53
|
+
export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate, RecurringOrderCopyType };
|
@@ -0,0 +1,41 @@
|
|
1
|
+
"use strict";
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
3
|
+
const resource_1 = require("../resource");
|
4
|
+
class RecurringOrderCopies extends resource_1.ApiResource {
|
5
|
+
async create(resource, params, options) {
|
6
|
+
return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
|
7
|
+
}
|
8
|
+
async update(resource, params, options) {
|
9
|
+
return this.resources.update({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
|
10
|
+
}
|
11
|
+
async delete(id, options) {
|
12
|
+
await this.resources.delete((typeof id === 'string') ? { id, type: RecurringOrderCopies.TYPE } : id, options);
|
13
|
+
}
|
14
|
+
async source_order(recurringOrderCopyId, params, options) {
|
15
|
+
const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
|
16
|
+
return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/source_order`, params, options);
|
17
|
+
}
|
18
|
+
async target_order(recurringOrderCopyId, params, options) {
|
19
|
+
const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
|
20
|
+
return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/target_order`, params, options);
|
21
|
+
}
|
22
|
+
async events(recurringOrderCopyId, params, options) {
|
23
|
+
const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
|
24
|
+
return this.resources.fetch({ type: 'events' }, `recurring_order_copies/${_recurringOrderCopyId}/events`, params, options);
|
25
|
+
}
|
26
|
+
async order_subscription(recurringOrderCopyId, params, options) {
|
27
|
+
const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
|
28
|
+
return this.resources.fetch({ type: 'order_subscriptions' }, `recurring_order_copies/${_recurringOrderCopyId}/order_subscription`, params, options);
|
29
|
+
}
|
30
|
+
isRecurringOrderCopy(resource) {
|
31
|
+
return resource.type && (resource.type === RecurringOrderCopies.TYPE);
|
32
|
+
}
|
33
|
+
relationship(id) {
|
34
|
+
return ((id === null) || (typeof id === 'string')) ? { id, type: RecurringOrderCopies.TYPE } : { id: id.id, type: RecurringOrderCopies.TYPE };
|
35
|
+
}
|
36
|
+
type() {
|
37
|
+
return RecurringOrderCopies.TYPE;
|
38
|
+
}
|
39
|
+
}
|
40
|
+
RecurringOrderCopies.TYPE = 'recurring_order_copies';
|
41
|
+
exports.default = RecurringOrderCopies;
|
@@ -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 { Order } from './orders';
|
4
5
|
import type { Capture } from './captures';
|
@@ -15,14 +16,14 @@ interface Refund extends Resource {
|
|
15
16
|
amount_float: number;
|
16
17
|
formatted_amount: string;
|
17
18
|
succeeded: boolean;
|
18
|
-
message?: string;
|
19
|
-
error_code?: string;
|
20
|
-
error_detail?: string;
|
21
|
-
token?: string;
|
22
|
-
gateway_transaction_id?: string;
|
23
|
-
order?: Order;
|
24
|
-
reference_capture?: Capture;
|
25
|
-
events?: Event[];
|
19
|
+
message?: string | null;
|
20
|
+
error_code?: string | null;
|
21
|
+
error_detail?: string | null;
|
22
|
+
token?: string | null;
|
23
|
+
gateway_transaction_id?: string | null;
|
24
|
+
order?: Order | null;
|
25
|
+
reference_capture?: Capture | null;
|
26
|
+
events?: Event[] | null;
|
26
27
|
}
|
27
28
|
declare class Refunds extends ApiResource<Refund> {
|
28
29
|
static readonly TYPE: RefundType;
|
@@ -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 { Return, ReturnType } from './returns';
|
4
5
|
import type { LineItem, LineItemType } from './line_items';
|
@@ -14,25 +15,25 @@ type LineItemRel = ResourceRel & {
|
|
14
15
|
};
|
15
16
|
interface ReturnLineItem extends Resource {
|
16
17
|
readonly type: ReturnLineItemType;
|
17
|
-
sku_code?: string;
|
18
|
-
bundle_code?: string;
|
19
|
-
name?: string;
|
18
|
+
sku_code?: string | null;
|
19
|
+
bundle_code?: string | null;
|
20
|
+
name?: string | null;
|
20
21
|
quantity: number;
|
21
|
-
return_reason?: object;
|
22
|
-
restocked_at?: string;
|
23
|
-
return?: Return;
|
24
|
-
line_item?: LineItem;
|
22
|
+
return_reason?: object | null;
|
23
|
+
restocked_at?: string | null;
|
24
|
+
return?: Return | null;
|
25
|
+
line_item?: LineItem | null;
|
25
26
|
}
|
26
27
|
interface ReturnLineItemCreate extends ResourceCreate {
|
27
28
|
quantity: number;
|
28
|
-
return_reason?: object;
|
29
|
+
return_reason?: object | null;
|
29
30
|
return: ReturnRel;
|
30
31
|
line_item: LineItemRel;
|
31
32
|
}
|
32
33
|
interface ReturnLineItemUpdate extends ResourceUpdate {
|
33
|
-
quantity
|
34
|
-
_restock?: boolean;
|
35
|
-
return_reason?: object;
|
34
|
+
quantity?: number | null;
|
35
|
+
_restock?: boolean | null;
|
36
|
+
return_reason?: object | null;
|
36
37
|
}
|
37
38
|
declare class ReturnLineItems extends ApiResource<ReturnLineItem> {
|
38
39
|
static readonly TYPE: ReturnLineItemType;
|
@@ -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 { Customer } from './customers';
|
@@ -19,40 +20,40 @@ type StockLocationRel = ResourceRel & {
|
|
19
20
|
};
|
20
21
|
interface Return extends Resource {
|
21
22
|
readonly type: ReturnType;
|
22
|
-
number?: string;
|
23
|
-
status
|
24
|
-
customer_email?: string;
|
25
|
-
skus_count?: number;
|
26
|
-
approved_at?: string;
|
27
|
-
cancelled_at?: string;
|
28
|
-
shipped_at?: string;
|
29
|
-
rejected_at?: string;
|
30
|
-
received_at?: string;
|
31
|
-
archived_at?: string;
|
32
|
-
order?: Order;
|
33
|
-
customer?: Customer;
|
34
|
-
stock_location?: StockLocation;
|
35
|
-
origin_address?: Address;
|
36
|
-
destination_address?: Address;
|
37
|
-
return_line_items?: ReturnLineItem[];
|
38
|
-
attachments?: Attachment[];
|
39
|
-
events?: Event[];
|
23
|
+
number?: string | null;
|
24
|
+
status: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
|
25
|
+
customer_email?: string | null;
|
26
|
+
skus_count?: number | null;
|
27
|
+
approved_at?: string | null;
|
28
|
+
cancelled_at?: string | null;
|
29
|
+
shipped_at?: string | null;
|
30
|
+
rejected_at?: string | null;
|
31
|
+
received_at?: string | null;
|
32
|
+
archived_at?: string | null;
|
33
|
+
order?: Order | null;
|
34
|
+
customer?: Customer | null;
|
35
|
+
stock_location?: StockLocation | null;
|
36
|
+
origin_address?: Address | null;
|
37
|
+
destination_address?: Address | null;
|
38
|
+
return_line_items?: ReturnLineItem[] | null;
|
39
|
+
attachments?: Attachment[] | null;
|
40
|
+
events?: Event[] | null;
|
40
41
|
}
|
41
42
|
interface ReturnCreate extends ResourceCreate {
|
42
43
|
order: OrderRel;
|
43
|
-
stock_location?: StockLocationRel;
|
44
|
+
stock_location?: StockLocationRel | null;
|
44
45
|
}
|
45
46
|
interface ReturnUpdate extends ResourceUpdate {
|
46
|
-
_request?: boolean;
|
47
|
-
_approve?: boolean;
|
48
|
-
_cancel?: boolean;
|
49
|
-
_ship?: boolean;
|
50
|
-
_reject?: boolean;
|
51
|
-
_receive?: boolean;
|
52
|
-
_restock?: boolean;
|
53
|
-
_archive?: boolean;
|
54
|
-
_unarchive?: boolean;
|
55
|
-
stock_location?: StockLocationRel;
|
47
|
+
_request?: boolean | null;
|
48
|
+
_approve?: boolean | null;
|
49
|
+
_cancel?: boolean | null;
|
50
|
+
_ship?: boolean | null;
|
51
|
+
_reject?: boolean | null;
|
52
|
+
_receive?: boolean | null;
|
53
|
+
_restock?: boolean | null;
|
54
|
+
_archive?: boolean | null;
|
55
|
+
_unarchive?: boolean | null;
|
56
|
+
stock_location?: StockLocationRel | null;
|
56
57
|
}
|
57
58
|
declare class Returns extends ApiResource<Return> {
|
58
59
|
static readonly TYPE: ReturnType;
|
@@ -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 { SatispayPayment, SatispayPaymentType } from './satispay_payments';
|
@@ -12,17 +13,17 @@ type SatispayPaymentRel = ResourceRel & {
|
|
12
13
|
interface SatispayGateway extends Resource {
|
13
14
|
readonly type: SatispayGatewayType;
|
14
15
|
name: string;
|
15
|
-
webhook_endpoint_url?: string;
|
16
|
-
payment_methods?: PaymentMethod[];
|
17
|
-
satispay_payments?: SatispayPayment[];
|
16
|
+
webhook_endpoint_url?: string | null;
|
17
|
+
payment_methods?: PaymentMethod[] | null;
|
18
|
+
satispay_payments?: SatispayPayment[] | null;
|
18
19
|
}
|
19
20
|
interface SatispayGatewayCreate extends ResourceCreate {
|
20
21
|
name: string;
|
21
|
-
satispay_payments?: SatispayPaymentRel[];
|
22
|
+
satispay_payments?: SatispayPaymentRel[] | null;
|
22
23
|
}
|
23
24
|
interface SatispayGatewayUpdate extends ResourceUpdate {
|
24
|
-
name
|
25
|
-
satispay_payments?: SatispayPaymentRel[];
|
25
|
+
name?: string | null;
|
26
|
+
satispay_payments?: SatispayPaymentRel[] | null;
|
26
27
|
}
|
27
28
|
declare class SatispayGateways extends ApiResource<SatispayGateway> {
|
28
29
|
static readonly TYPE: SatispayGatewayType;
|
@@ -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,22 +12,22 @@ type OrderRel = ResourceRel & {
|
|
11
12
|
};
|
12
13
|
interface SatispayPayment extends Resource {
|
13
14
|
readonly type: SatispayPaymentType;
|
14
|
-
token?: string;
|
15
|
+
token?: string | null;
|
15
16
|
key_id: string;
|
16
|
-
payment_id?: string;
|
17
|
-
redirect_url?: string;
|
18
|
-
order?: Order;
|
19
|
-
payment_gateway?: PaymentGateway;
|
17
|
+
payment_id?: string | null;
|
18
|
+
redirect_url?: string | null;
|
19
|
+
order?: Order | null;
|
20
|
+
payment_gateway?: PaymentGateway | null;
|
20
21
|
}
|
21
22
|
interface SatispayPaymentCreate extends ResourceCreate {
|
22
|
-
token?: string;
|
23
|
-
redirect_url?: string;
|
23
|
+
token?: string | null;
|
24
|
+
redirect_url?: string | null;
|
24
25
|
order: OrderRel;
|
25
26
|
}
|
26
27
|
interface SatispayPaymentUpdate extends ResourceUpdate {
|
27
|
-
redirect_url?: string;
|
28
|
-
_refresh?: boolean;
|
29
|
-
order?: OrderRel;
|
28
|
+
redirect_url?: string | null;
|
29
|
+
_refresh?: boolean | null;
|
30
|
+
order?: OrderRel | null;
|
30
31
|
}
|
31
32
|
declare class SatispayPayments extends ApiResource<SatispayPayment> {
|
32
33
|
static readonly TYPE: SatispayPaymentType;
|
@@ -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 { ShippingCategory } from './shipping_categories';
|
@@ -21,52 +22,52 @@ type ShippingMethodRel = ResourceRel & {
|
|
21
22
|
};
|
22
23
|
interface Shipment extends Resource {
|
23
24
|
readonly type: ShipmentType;
|
24
|
-
number?: string;
|
25
|
-
status
|
26
|
-
currency_code?: string;
|
27
|
-
cost_amount_cents?: number;
|
28
|
-
cost_amount_float?: number;
|
29
|
-
formatted_cost_amount?: string;
|
30
|
-
skus_count?: number;
|
31
|
-
selected_rate_id?: string;
|
32
|
-
rates?: object[];
|
33
|
-
purchase_error_code?: string;
|
34
|
-
purchase_error_message?: string;
|
35
|
-
get_rates_errors?: object[];
|
36
|
-
get_rates_started_at?: string;
|
37
|
-
get_rates_completed_at?: string;
|
38
|
-
purchase_started_at?: string;
|
39
|
-
purchase_completed_at?: string;
|
40
|
-
purchase_failed_at?: string;
|
41
|
-
order?: Order;
|
42
|
-
shipping_category?: ShippingCategory;
|
43
|
-
stock_location?: StockLocation;
|
44
|
-
origin_address?: Address;
|
45
|
-
shipping_address?: Address;
|
46
|
-
shipping_method?: ShippingMethod;
|
47
|
-
delivery_lead_time?: DeliveryLeadTime;
|
25
|
+
number?: string | null;
|
26
|
+
status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
|
27
|
+
currency_code?: string | null;
|
28
|
+
cost_amount_cents?: number | null;
|
29
|
+
cost_amount_float?: number | null;
|
30
|
+
formatted_cost_amount?: string | null;
|
31
|
+
skus_count?: number | null;
|
32
|
+
selected_rate_id?: string | null;
|
33
|
+
rates?: object[] | null;
|
34
|
+
purchase_error_code?: string | null;
|
35
|
+
purchase_error_message?: string | null;
|
36
|
+
get_rates_errors?: object[] | null;
|
37
|
+
get_rates_started_at?: string | null;
|
38
|
+
get_rates_completed_at?: string | null;
|
39
|
+
purchase_started_at?: string | null;
|
40
|
+
purchase_completed_at?: string | null;
|
41
|
+
purchase_failed_at?: string | null;
|
42
|
+
order?: Order | null;
|
43
|
+
shipping_category?: ShippingCategory | null;
|
44
|
+
stock_location?: StockLocation | null;
|
45
|
+
origin_address?: Address | null;
|
46
|
+
shipping_address?: Address | null;
|
47
|
+
shipping_method?: ShippingMethod | null;
|
48
|
+
delivery_lead_time?: DeliveryLeadTime | null;
|
48
49
|
/**
|
49
50
|
* @deprecated This field should not be used as it may be removed in the future without notice
|
50
51
|
*/
|
51
52
|
shipment_line_items?: object[];
|
52
|
-
stock_line_items?: StockLineItem[];
|
53
|
-
stock_transfers?: StockTransfer[];
|
54
|
-
available_shipping_methods?: ShippingMethod[];
|
55
|
-
carrier_accounts?: CarrierAccount[];
|
56
|
-
parcels?: Parcel[];
|
57
|
-
attachments?: Attachment[];
|
58
|
-
events?: Event[];
|
53
|
+
stock_line_items?: StockLineItem[] | null;
|
54
|
+
stock_transfers?: StockTransfer[] | null;
|
55
|
+
available_shipping_methods?: ShippingMethod[] | null;
|
56
|
+
carrier_accounts?: CarrierAccount[] | null;
|
57
|
+
parcels?: Parcel[] | null;
|
58
|
+
attachments?: Attachment[] | null;
|
59
|
+
events?: Event[] | null;
|
59
60
|
}
|
60
61
|
interface ShipmentUpdate extends ResourceUpdate {
|
61
|
-
_on_hold?: boolean;
|
62
|
-
_picking?: boolean;
|
63
|
-
_packing?: boolean;
|
64
|
-
_ready_to_ship?: boolean;
|
65
|
-
_ship?: boolean;
|
66
|
-
_get_rates?: boolean;
|
67
|
-
selected_rate_id?: string;
|
68
|
-
_purchase?: boolean;
|
69
|
-
shipping_method?: ShippingMethodRel;
|
62
|
+
_on_hold?: boolean | null;
|
63
|
+
_picking?: boolean | null;
|
64
|
+
_packing?: boolean | null;
|
65
|
+
_ready_to_ship?: boolean | null;
|
66
|
+
_ship?: boolean | null;
|
67
|
+
_get_rates?: boolean | null;
|
68
|
+
selected_rate_id?: string | null;
|
69
|
+
_purchase?: boolean | null;
|
70
|
+
shipping_method?: ShippingMethodRel | null;
|
70
71
|
}
|
71
72
|
declare class Shipments extends ApiResource<Shipment> {
|
72
73
|
static readonly TYPE: ShipmentType;
|