@commercelayer/sdk 4.7.5 → 4.7.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/api.d.ts +1 -103
- package/lib/cjs/client.d.ts +1 -31
- package/lib/cjs/commercelayer.d.ts +1 -122
- package/lib/cjs/common.d.ts +1 -4
- package/lib/cjs/config.d.ts +1 -11
- package/lib/cjs/debug.d.ts +1 -3
- package/lib/cjs/error.d.ts +1 -26
- package/lib/cjs/index.d.ts +1 -7
- package/lib/cjs/interceptor.d.ts +1 -19
- package/lib/cjs/jsonapi.d.ts +1 -5
- package/lib/cjs/model.d.ts +1 -101
- package/lib/cjs/query.d.ts +1 -23
- package/lib/cjs/resource.d.ts +1 -76
- package/lib/cjs/resources/addresses.d.ts +1 -88
- package/lib/cjs/resources/adjustments.d.ts +1 -35
- package/lib/cjs/resources/adyen_gateways.d.ts +1 -47
- package/lib/cjs/resources/adyen_payments.d.ts +1 -44
- package/lib/cjs/resources/application.d.ts +1 -21
- package/lib/cjs/resources/attachments.d.ts +1 -156
- package/lib/cjs/resources/authorizations.d.ts +1 -57
- package/lib/cjs/resources/avalara_accounts.d.ts +1 -52
- package/lib/cjs/resources/billing_info_validation_rules.d.ts +1 -32
- package/lib/cjs/resources/bing_geocoders.d.ts +1 -35
- package/lib/cjs/resources/braintree_gateways.d.ts +1 -56
- package/lib/cjs/resources/braintree_payments.d.ts +1 -47
- package/lib/cjs/resources/bundles.d.ts +1 -74
- package/lib/cjs/resources/captures.d.ts +1 -48
- package/lib/cjs/resources/carrier_accounts.d.ts +1 -26
- package/lib/cjs/resources/checkout_com_gateways.d.ts +1 -45
- package/lib/cjs/resources/checkout_com_payments.d.ts +1 -51
- package/lib/cjs/resources/coupon_codes_promotion_rules.d.ts +1 -59
- package/lib/cjs/resources/coupon_recipients.d.ts +1 -44
- package/lib/cjs/resources/coupons.d.ts +1 -45
- package/lib/cjs/resources/customer_addresses.d.ts +1 -41
- package/lib/cjs/resources/customer_groups.d.ts +1 -36
- package/lib/cjs/resources/customer_password_resets.d.ts +1 -33
- package/lib/cjs/resources/customer_payment_sources.d.ts +1 -70
- package/lib/cjs/resources/customer_subscriptions.d.ts +1 -28
- package/lib/cjs/resources/customers.d.ts +1 -60
- package/lib/cjs/resources/delivery_lead_times.d.ts +1 -51
- package/lib/cjs/resources/event_callbacks.d.ts +1 -24
- package/lib/cjs/resources/external_gateways.d.ts +1 -49
- package/lib/cjs/resources/external_payments.d.ts +1 -43
- package/lib/cjs/resources/external_promotions.d.ts +1 -86
- package/lib/cjs/resources/external_tax_calculators.d.ts +1 -44
- package/lib/cjs/resources/fixed_amount_promotions.d.ts +1 -88
- package/lib/cjs/resources/fixed_price_promotions.d.ts +1 -99
- package/lib/cjs/resources/free_gift_promotions.d.ts +1 -97
- package/lib/cjs/resources/free_shipping_promotions.d.ts +1 -83
- package/lib/cjs/resources/geocoders.d.ts +1 -24
- package/lib/cjs/resources/gift_card_recipients.d.ts +1 -44
- package/lib/cjs/resources/gift_cards.d.ts +1 -82
- package/lib/cjs/resources/google_geocoders.d.ts +1 -35
- package/lib/cjs/resources/imports.d.ts +1 -40
- package/lib/cjs/resources/in_stock_subscriptions.d.ts +1 -59
- package/lib/cjs/resources/inventory_models.d.ts +1 -42
- package/lib/cjs/resources/inventory_return_locations.d.ts +1 -43
- package/lib/cjs/resources/inventory_stock_locations.d.ts +1 -46
- package/lib/cjs/resources/klarna_gateways.d.ts +1 -44
- package/lib/cjs/resources/klarna_payments.d.ts +1 -41
- package/lib/cjs/resources/line_item_options.d.ts +1 -57
- package/lib/cjs/resources/line_items.d.ts +1 -125
- package/lib/cjs/resources/manual_gateways.d.ts +1 -33
- package/lib/cjs/resources/manual_tax_calculators.d.ts +1 -49
- package/lib/cjs/resources/markets.d.ts +1 -81
- package/lib/cjs/resources/merchants.d.ts +1 -38
- package/lib/cjs/resources/order_amount_promotion_rules.d.ts +1 -56
- package/lib/cjs/resources/order_copies.d.ts +1 -45
- package/lib/cjs/resources/order_subscriptions.d.ts +1 -67
- package/lib/cjs/resources/order_validation_rules.d.ts +1 -20
- package/lib/cjs/resources/orders.d.ts +1 -271
- package/lib/cjs/resources/organization.d.ts +1 -32
- package/lib/cjs/resources/packages.d.ts +1 -56
- package/lib/cjs/resources/parcel_line_items.d.ts +1 -49
- package/lib/cjs/resources/parcels.d.ts +1 -108
- package/lib/cjs/resources/payment_gateways.d.ts +1 -21
- package/lib/cjs/resources/payment_methods.d.ts +1 -59
- package/lib/cjs/resources/paypal_gateways.d.ts +1 -39
- package/lib/cjs/resources/paypal_payments.d.ts +1 -49
- package/lib/cjs/resources/percentage_discount_promotions.d.ts +1 -97
- package/lib/cjs/resources/price_lists.d.ts +1 -39
- package/lib/cjs/resources/prices.d.ts +1 -57
- package/lib/cjs/resources/promotion_rules.d.ts +1 -24
- package/lib/cjs/resources/promotions.d.ts +1 -41
- package/lib/cjs/resources/refunds.d.ts +1 -34
- package/lib/cjs/resources/return_line_items.d.ts +1 -49
- package/lib/cjs/resources/returns.d.ts +1 -72
- package/lib/cjs/resources/shipments.d.ts +1 -89
- package/lib/cjs/resources/shipping_categories.d.ts +1 -33
- package/lib/cjs/resources/shipping_methods.d.ts +1 -74
- package/lib/cjs/resources/shipping_zones.d.ts +1 -48
- package/lib/cjs/resources/sku_list_items.d.ts +1 -47
- package/lib/cjs/resources/sku_list_promotion_rules.d.ts +1 -68
- package/lib/cjs/resources/sku_lists.d.ts +1 -49
- package/lib/cjs/resources/sku_options.d.ts +1 -56
- package/lib/cjs/resources/skus.d.ts +1 -78
- package/lib/cjs/resources/stock_items.d.ts +1 -49
- package/lib/cjs/resources/stock_line_items.d.ts +1 -29
- package/lib/cjs/resources/stock_locations.d.ts +1 -57
- package/lib/cjs/resources/stock_transfers.d.ts +1 -71
- package/lib/cjs/resources/stripe_gateways.d.ts +1 -38
- package/lib/cjs/resources/stripe_payments.d.ts +1 -42
- package/lib/cjs/resources/tax_calculators.d.ts +1 -27
- package/lib/cjs/resources/tax_categories.d.ts +1 -59
- package/lib/cjs/resources/tax_rules.d.ts +1 -69
- package/lib/cjs/resources/taxjar_accounts.d.ts +1 -43
- package/lib/cjs/resources/transactions.d.ts +1 -31
- package/lib/cjs/resources/voids.d.ts +1 -34
- package/lib/cjs/resources/webhooks.d.ts +1 -42
- package/lib/cjs/resources/wire_transfers.d.ts +1 -32
- package/lib/cjs/static.d.ts +1 -6
- package/lib/cjs/util.d.ts +1 -2
- package/lib/esm/api.d.ts +1 -103
- package/lib/esm/client.d.ts +1 -31
- package/lib/esm/commercelayer.d.ts +1 -122
- package/lib/esm/common.d.ts +1 -4
- package/lib/esm/config.d.ts +1 -11
- package/lib/esm/debug.d.ts +1 -3
- package/lib/esm/error.d.ts +1 -26
- package/lib/esm/index.d.ts +1 -7
- package/lib/esm/interceptor.d.ts +1 -19
- package/lib/esm/jsonapi.d.ts +1 -5
- package/lib/esm/model.d.ts +1 -101
- package/lib/esm/query.d.ts +1 -23
- package/lib/esm/resource.d.ts +1 -76
- package/lib/esm/resources/addresses.d.ts +1 -88
- package/lib/esm/resources/adjustments.d.ts +1 -35
- package/lib/esm/resources/adyen_gateways.d.ts +1 -47
- package/lib/esm/resources/adyen_payments.d.ts +1 -44
- package/lib/esm/resources/application.d.ts +1 -21
- package/lib/esm/resources/attachments.d.ts +1 -156
- package/lib/esm/resources/authorizations.d.ts +1 -57
- package/lib/esm/resources/avalara_accounts.d.ts +1 -52
- package/lib/esm/resources/billing_info_validation_rules.d.ts +1 -32
- package/lib/esm/resources/bing_geocoders.d.ts +1 -35
- package/lib/esm/resources/braintree_gateways.d.ts +1 -56
- package/lib/esm/resources/braintree_payments.d.ts +1 -47
- package/lib/esm/resources/bundles.d.ts +1 -74
- package/lib/esm/resources/captures.d.ts +1 -48
- package/lib/esm/resources/carrier_accounts.d.ts +1 -26
- package/lib/esm/resources/checkout_com_gateways.d.ts +1 -45
- package/lib/esm/resources/checkout_com_payments.d.ts +1 -51
- package/lib/esm/resources/coupon_codes_promotion_rules.d.ts +1 -59
- package/lib/esm/resources/coupon_recipients.d.ts +1 -44
- package/lib/esm/resources/coupons.d.ts +1 -45
- package/lib/esm/resources/customer_addresses.d.ts +1 -41
- package/lib/esm/resources/customer_groups.d.ts +1 -36
- package/lib/esm/resources/customer_password_resets.d.ts +1 -33
- package/lib/esm/resources/customer_payment_sources.d.ts +1 -70
- package/lib/esm/resources/customer_subscriptions.d.ts +1 -28
- package/lib/esm/resources/customers.d.ts +1 -60
- package/lib/esm/resources/delivery_lead_times.d.ts +1 -51
- package/lib/esm/resources/event_callbacks.d.ts +1 -24
- package/lib/esm/resources/external_gateways.d.ts +1 -49
- package/lib/esm/resources/external_payments.d.ts +1 -43
- package/lib/esm/resources/external_promotions.d.ts +1 -86
- package/lib/esm/resources/external_tax_calculators.d.ts +1 -44
- package/lib/esm/resources/fixed_amount_promotions.d.ts +1 -88
- package/lib/esm/resources/fixed_price_promotions.d.ts +1 -99
- package/lib/esm/resources/free_gift_promotions.d.ts +1 -97
- package/lib/esm/resources/free_shipping_promotions.d.ts +1 -83
- package/lib/esm/resources/geocoders.d.ts +1 -24
- package/lib/esm/resources/gift_card_recipients.d.ts +1 -44
- package/lib/esm/resources/gift_cards.d.ts +1 -82
- package/lib/esm/resources/google_geocoders.d.ts +1 -35
- package/lib/esm/resources/imports.d.ts +1 -40
- package/lib/esm/resources/in_stock_subscriptions.d.ts +1 -59
- package/lib/esm/resources/inventory_models.d.ts +1 -42
- package/lib/esm/resources/inventory_return_locations.d.ts +1 -43
- package/lib/esm/resources/inventory_stock_locations.d.ts +1 -46
- package/lib/esm/resources/klarna_gateways.d.ts +1 -44
- package/lib/esm/resources/klarna_payments.d.ts +1 -41
- package/lib/esm/resources/line_item_options.d.ts +1 -57
- package/lib/esm/resources/line_items.d.ts +1 -125
- package/lib/esm/resources/manual_gateways.d.ts +1 -33
- package/lib/esm/resources/manual_tax_calculators.d.ts +1 -49
- package/lib/esm/resources/markets.d.ts +1 -81
- package/lib/esm/resources/merchants.d.ts +1 -38
- package/lib/esm/resources/order_amount_promotion_rules.d.ts +1 -56
- package/lib/esm/resources/order_copies.d.ts +1 -45
- package/lib/esm/resources/order_subscriptions.d.ts +1 -67
- package/lib/esm/resources/order_validation_rules.d.ts +1 -20
- package/lib/esm/resources/orders.d.ts +1 -271
- package/lib/esm/resources/organization.d.ts +1 -32
- package/lib/esm/resources/packages.d.ts +1 -56
- package/lib/esm/resources/parcel_line_items.d.ts +1 -49
- package/lib/esm/resources/parcels.d.ts +1 -108
- package/lib/esm/resources/payment_gateways.d.ts +1 -21
- package/lib/esm/resources/payment_methods.d.ts +1 -59
- package/lib/esm/resources/paypal_gateways.d.ts +1 -39
- package/lib/esm/resources/paypal_payments.d.ts +1 -49
- package/lib/esm/resources/percentage_discount_promotions.d.ts +1 -97
- package/lib/esm/resources/price_lists.d.ts +1 -39
- package/lib/esm/resources/prices.d.ts +1 -57
- package/lib/esm/resources/promotion_rules.d.ts +1 -24
- package/lib/esm/resources/promotions.d.ts +1 -41
- package/lib/esm/resources/refunds.d.ts +1 -34
- package/lib/esm/resources/return_line_items.d.ts +1 -49
- package/lib/esm/resources/returns.d.ts +1 -72
- package/lib/esm/resources/shipments.d.ts +1 -89
- package/lib/esm/resources/shipping_categories.d.ts +1 -33
- package/lib/esm/resources/shipping_methods.d.ts +1 -74
- package/lib/esm/resources/shipping_zones.d.ts +1 -48
- package/lib/esm/resources/sku_list_items.d.ts +1 -47
- package/lib/esm/resources/sku_list_promotion_rules.d.ts +1 -68
- package/lib/esm/resources/sku_lists.d.ts +1 -49
- package/lib/esm/resources/sku_options.d.ts +1 -56
- package/lib/esm/resources/skus.d.ts +1 -78
- package/lib/esm/resources/stock_items.d.ts +1 -49
- package/lib/esm/resources/stock_line_items.d.ts +1 -29
- package/lib/esm/resources/stock_locations.d.ts +1 -57
- package/lib/esm/resources/stock_transfers.d.ts +1 -71
- package/lib/esm/resources/stripe_gateways.d.ts +1 -38
- package/lib/esm/resources/stripe_payments.d.ts +1 -42
- package/lib/esm/resources/tax_calculators.d.ts +1 -27
- package/lib/esm/resources/tax_categories.d.ts +1 -59
- package/lib/esm/resources/tax_rules.d.ts +1 -69
- package/lib/esm/resources/taxjar_accounts.d.ts +1 -43
- package/lib/esm/resources/transactions.d.ts +1 -31
- package/lib/esm/resources/voids.d.ts +1 -34
- package/lib/esm/resources/webhooks.d.ts +1 -42
- package/lib/esm/resources/wire_transfers.d.ts +1 -32
- package/lib/esm/static.d.ts +1 -6
- package/lib/esm/util.d.ts +1 -2
- package/package.json +3 -3
@@ -1,45 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { Order } from './orders';
|
4
|
-
import type { OrderSubscription } from './order_subscriptions';
|
5
|
-
declare type OrderCopyRel = ResourceRel & {
|
6
|
-
type: typeof OrderCopies.TYPE;
|
7
|
-
};
|
8
|
-
declare type OrderRel = ResourceRel & {
|
9
|
-
type: 'orders';
|
10
|
-
};
|
11
|
-
interface OrderCopy extends Resource {
|
12
|
-
status?: string;
|
13
|
-
started_at?: string;
|
14
|
-
completed_at?: string;
|
15
|
-
failed_at?: string;
|
16
|
-
place_target_order?: boolean;
|
17
|
-
cancel_source_order?: boolean;
|
18
|
-
reuse_wallet?: boolean;
|
19
|
-
errors_log?: object;
|
20
|
-
errors_count?: number;
|
21
|
-
source_order?: Order;
|
22
|
-
target_order?: Order;
|
23
|
-
order_subscription?: OrderSubscription;
|
24
|
-
}
|
25
|
-
interface OrderCopyCreate extends ResourceCreate {
|
26
|
-
place_target_order?: boolean;
|
27
|
-
cancel_source_order?: boolean;
|
28
|
-
reuse_wallet?: boolean;
|
29
|
-
source_order: OrderRel;
|
30
|
-
}
|
31
|
-
declare class OrderCopies extends ApiResource {
|
32
|
-
static readonly TYPE: 'order_copies';
|
33
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
|
34
|
-
create(resource: OrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderCopy>;
|
35
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderCopy>;
|
36
|
-
delete(id: string, options?: ResourcesConfig): Promise<void>;
|
37
|
-
source_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
38
|
-
target_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
39
|
-
order_subscription(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
40
|
-
isOrderCopy(resource: any): resource is OrderCopy;
|
41
|
-
relationship(id: string | ResourceId | null): OrderCopyRel;
|
42
|
-
type(): string;
|
43
|
-
}
|
44
|
-
export default OrderCopies;
|
45
|
-
export { OrderCopy, OrderCopyCreate };
|
1
|
+
import{ApiResource,Resource,ResourceCreate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Order}from'./orders';import type{OrderSubscription}from'./order_subscriptions';declare type OrderCopyRel=ResourceRel&{type:typeof OrderCopies.TYPE;};declare type OrderRel=ResourceRel&{type:'orders';};interface OrderCopy extends Resource{status?:string;started_at?:string;completed_at?:string;failed_at?:string;place_target_order?:boolean;cancel_source_order?:boolean;reuse_wallet?:boolean;errors_log?:object;errors_count?:number;source_order?:Order;target_order?:Order;order_subscription?:OrderSubscription;}interface OrderCopyCreate extends ResourceCreate{place_target_order?:boolean;cancel_source_order?:boolean;reuse_wallet?:boolean;source_order:OrderRel;}declare class OrderCopies extends ApiResource{static readonly TYPE:'order_copies';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderCopy>>;create(resource:OrderCopyCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderCopy>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderCopy>;delete(id:string,options?:ResourcesConfig):Promise<void>;source_order(orderCopyId:string|OrderCopy,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;target_order(orderCopyId:string|OrderCopy,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;order_subscription(orderCopyId:string|OrderCopy,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderSubscription>;isOrderCopy(resource:any):resource is OrderCopy;relationship(id:string|ResourceId|null):OrderCopyRel;type():string;}export default OrderCopies;export{OrderCopy,OrderCopyCreate};
|
@@ -1,67 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { Market } from './markets';
|
4
|
-
import type { Order } from './orders';
|
5
|
-
import type { Customer } from './customers';
|
6
|
-
import type { OrderCopy } from './order_copies';
|
7
|
-
declare type OrderSubscriptionRel = ResourceRel & {
|
8
|
-
type: typeof OrderSubscriptions.TYPE;
|
9
|
-
};
|
10
|
-
declare type MarketRel = ResourceRel & {
|
11
|
-
type: 'markets';
|
12
|
-
};
|
13
|
-
declare type OrderRel = ResourceRel & {
|
14
|
-
type: 'orders';
|
15
|
-
};
|
16
|
-
interface OrderSubscription extends Resource {
|
17
|
-
number?: string;
|
18
|
-
status?: string;
|
19
|
-
frequency?: string;
|
20
|
-
activate_by_source_order?: boolean;
|
21
|
-
customer_email?: string;
|
22
|
-
starts_at?: string;
|
23
|
-
expires_at?: string;
|
24
|
-
next_run_at?: string;
|
25
|
-
occurrencies?: number;
|
26
|
-
errors_count?: number;
|
27
|
-
succeeded_on_last_run?: boolean;
|
28
|
-
options?: object;
|
29
|
-
market?: Market;
|
30
|
-
source_order?: Order;
|
31
|
-
customer?: Customer;
|
32
|
-
order_copies?: OrderCopy[];
|
33
|
-
orders?: Order[];
|
34
|
-
}
|
35
|
-
interface OrderSubscriptionCreate extends ResourceCreate {
|
36
|
-
frequency: string;
|
37
|
-
activate_by_source_order?: boolean;
|
38
|
-
starts_at?: string;
|
39
|
-
expires_at?: string;
|
40
|
-
options?: object;
|
41
|
-
market?: MarketRel;
|
42
|
-
source_order: OrderRel;
|
43
|
-
}
|
44
|
-
interface OrderSubscriptionUpdate extends ResourceUpdate {
|
45
|
-
expires_at?: string;
|
46
|
-
_activate?: boolean;
|
47
|
-
_deactivate?: boolean;
|
48
|
-
_cancel?: boolean;
|
49
|
-
}
|
50
|
-
declare class OrderSubscriptions extends ApiResource {
|
51
|
-
static readonly TYPE: 'order_subscriptions';
|
52
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
|
53
|
-
create(resource: OrderSubscriptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
54
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
55
|
-
update(resource: OrderSubscriptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
|
56
|
-
delete(id: string, options?: ResourcesConfig): Promise<void>;
|
57
|
-
market(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
|
58
|
-
source_order(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
59
|
-
customer(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
|
60
|
-
order_copies(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
|
61
|
-
orders(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
62
|
-
isOrderSubscription(resource: any): resource is OrderSubscription;
|
63
|
-
relationship(id: string | ResourceId | null): OrderSubscriptionRel;
|
64
|
-
type(): string;
|
65
|
-
}
|
66
|
-
export default OrderSubscriptions;
|
67
|
-
export { OrderSubscription, OrderSubscriptionCreate, OrderSubscriptionUpdate };
|
1
|
+
import{ApiResource,Resource,ResourceCreate,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Market}from'./markets';import type{Order}from'./orders';import type{Customer}from'./customers';import type{OrderCopy}from'./order_copies';declare type OrderSubscriptionRel=ResourceRel&{type:typeof OrderSubscriptions.TYPE;};declare type MarketRel=ResourceRel&{type:'markets';};declare type OrderRel=ResourceRel&{type:'orders';};interface OrderSubscription extends Resource{number?:string;status?:string;frequency?:string;activate_by_source_order?:boolean;customer_email?:string;starts_at?:string;expires_at?:string;next_run_at?:string;occurrencies?:number;errors_count?:number;succeeded_on_last_run?:boolean;options?:object;market?:Market;source_order?:Order;customer?:Customer;order_copies?:OrderCopy[];orders?:Order[];}interface OrderSubscriptionCreate extends ResourceCreate{frequency:string;activate_by_source_order?:boolean;starts_at?:string;expires_at?:string;options?:object;market?:MarketRel;source_order:OrderRel;}interface OrderSubscriptionUpdate extends ResourceUpdate{expires_at?:string;_activate?:boolean;_deactivate?:boolean;_cancel?:boolean;}declare class OrderSubscriptions extends ApiResource{static readonly TYPE:'order_subscriptions';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderSubscription>>;create(resource:OrderSubscriptionCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderSubscription>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderSubscription>;update(resource:OrderSubscriptionUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderSubscription>;delete(id:string,options?:ResourcesConfig):Promise<void>;market(orderSubscriptionId:string|OrderSubscription,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Market>;source_order(orderSubscriptionId:string|OrderSubscription,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;customer(orderSubscriptionId:string|OrderSubscription,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Customer>;order_copies(orderSubscriptionId:string|OrderSubscription,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderCopy>>;orders(orderSubscriptionId:string|OrderSubscription,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Order>>;isOrderSubscription(resource:any):resource is OrderSubscription;relationship(id:string|ResourceId|null):OrderSubscriptionRel;type():string;}export default OrderSubscriptions;export{OrderSubscription,OrderSubscriptionCreate,OrderSubscriptionUpdate};
|
@@ -1,20 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { Market } from './markets';
|
4
|
-
declare type OrderValidationRuleRel = ResourceRel & {
|
5
|
-
type: typeof OrderValidationRules.TYPE;
|
6
|
-
};
|
7
|
-
interface OrderValidationRule extends Resource {
|
8
|
-
market?: Market;
|
9
|
-
}
|
10
|
-
declare class OrderValidationRules extends ApiResource {
|
11
|
-
static readonly TYPE: 'order_validation_rules';
|
12
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderValidationRule>>;
|
13
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderValidationRule>;
|
14
|
-
market(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
|
15
|
-
isOrderValidationRule(resource: any): resource is OrderValidationRule;
|
16
|
-
relationship(id: string | ResourceId | null): OrderValidationRuleRel;
|
17
|
-
type(): string;
|
18
|
-
}
|
19
|
-
export default OrderValidationRules;
|
20
|
-
export { OrderValidationRule };
|
1
|
+
import{ApiResource,Resource,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Market}from'./markets';declare type OrderValidationRuleRel=ResourceRel&{type:typeof OrderValidationRules.TYPE;};interface OrderValidationRule extends Resource{market?:Market;}declare class OrderValidationRules extends ApiResource{static readonly TYPE:'order_validation_rules';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderValidationRule>>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<OrderValidationRule>;market(orderValidationRuleId:string|OrderValidationRule,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Market>;isOrderValidationRule(resource:any):resource is OrderValidationRule;relationship(id:string|ResourceId|null):OrderValidationRuleRel;type():string;}export default OrderValidationRules;export{OrderValidationRule};
|
@@ -1,271 +1 @@
|
|
1
|
-
import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { Market } from './markets';
|
4
|
-
import type { Customer } from './customers';
|
5
|
-
import type { Address } from './addresses';
|
6
|
-
import type { PaymentMethod } from './payment_methods';
|
7
|
-
import type { CustomerPaymentSource } from './customer_payment_sources';
|
8
|
-
import type { AdyenPayment } from './adyen_payments';
|
9
|
-
import type { BraintreePayment } from './braintree_payments';
|
10
|
-
import type { CheckoutComPayment } from './checkout_com_payments';
|
11
|
-
import type { ExternalPayment } from './external_payments';
|
12
|
-
import type { KlarnaPayment } from './klarna_payments';
|
13
|
-
import type { PaypalPayment } from './paypal_payments';
|
14
|
-
import type { StripePayment } from './stripe_payments';
|
15
|
-
import type { WireTransfer } from './wire_transfers';
|
16
|
-
import type { LineItem } from './line_items';
|
17
|
-
import type { Shipment } from './shipments';
|
18
|
-
import type { Authorization } from './authorizations';
|
19
|
-
import type { Void } from './voids';
|
20
|
-
import type { Capture } from './captures';
|
21
|
-
import type { Refund } from './refunds';
|
22
|
-
import type { OrderSubscription } from './order_subscriptions';
|
23
|
-
import type { OrderCopy } from './order_copies';
|
24
|
-
import type { Attachment } from './attachments';
|
25
|
-
declare type OrderRel = ResourceRel & {
|
26
|
-
type: typeof Orders.TYPE;
|
27
|
-
};
|
28
|
-
declare type MarketRel = ResourceRel & {
|
29
|
-
type: 'markets';
|
30
|
-
};
|
31
|
-
declare type CustomerRel = ResourceRel & {
|
32
|
-
type: 'customers';
|
33
|
-
};
|
34
|
-
declare type AddressRel = ResourceRel & {
|
35
|
-
type: 'addresses';
|
36
|
-
};
|
37
|
-
declare type PaymentMethodRel = ResourceRel & {
|
38
|
-
type: 'payment_methods';
|
39
|
-
};
|
40
|
-
declare type AdyenPaymentRel = ResourceRel & {
|
41
|
-
type: 'adyen_payments';
|
42
|
-
};
|
43
|
-
declare type BraintreePaymentRel = ResourceRel & {
|
44
|
-
type: 'braintree_payments';
|
45
|
-
};
|
46
|
-
declare type CheckoutComPaymentRel = ResourceRel & {
|
47
|
-
type: 'checkout_com_payments';
|
48
|
-
};
|
49
|
-
declare type ExternalPaymentRel = ResourceRel & {
|
50
|
-
type: 'external_payments';
|
51
|
-
};
|
52
|
-
declare type KlarnaPaymentRel = ResourceRel & {
|
53
|
-
type: 'klarna_payments';
|
54
|
-
};
|
55
|
-
declare type PaypalPaymentRel = ResourceRel & {
|
56
|
-
type: 'paypal_payments';
|
57
|
-
};
|
58
|
-
declare type StripePaymentRel = ResourceRel & {
|
59
|
-
type: 'stripe_payments';
|
60
|
-
};
|
61
|
-
declare type WireTransferRel = ResourceRel & {
|
62
|
-
type: 'wire_transfers';
|
63
|
-
};
|
64
|
-
interface Order extends Resource {
|
65
|
-
number?: number;
|
66
|
-
autorefresh?: boolean;
|
67
|
-
status?: string;
|
68
|
-
payment_status?: string;
|
69
|
-
fulfillment_status?: string;
|
70
|
-
guest?: boolean;
|
71
|
-
editable?: boolean;
|
72
|
-
customer_email?: string;
|
73
|
-
language_code?: string;
|
74
|
-
currency_code?: string;
|
75
|
-
tax_included?: boolean;
|
76
|
-
tax_rate?: number;
|
77
|
-
freight_taxable?: boolean;
|
78
|
-
requires_billing_info?: boolean;
|
79
|
-
country_code?: string;
|
80
|
-
shipping_country_code_lock?: string;
|
81
|
-
coupon_code?: string;
|
82
|
-
gift_card_code?: string;
|
83
|
-
gift_card_or_coupon_code?: string;
|
84
|
-
subtotal_amount_cents?: number;
|
85
|
-
subtotal_amount_float?: number;
|
86
|
-
formatted_subtotal_amount?: string;
|
87
|
-
shipping_amount_cents?: number;
|
88
|
-
shipping_amount_float?: number;
|
89
|
-
formatted_shipping_amount?: string;
|
90
|
-
payment_method_amount_cents?: number;
|
91
|
-
payment_method_amount_float?: number;
|
92
|
-
formatted_payment_method_amount?: string;
|
93
|
-
discount_amount_cents?: number;
|
94
|
-
discount_amount_float?: number;
|
95
|
-
formatted_discount_amount?: string;
|
96
|
-
adjustment_amount_cents?: number;
|
97
|
-
adjustment_amount_float?: number;
|
98
|
-
formatted_adjustment_amount?: string;
|
99
|
-
gift_card_amount_cents?: number;
|
100
|
-
gift_card_amount_float?: number;
|
101
|
-
formatted_gift_card_amount?: string;
|
102
|
-
total_tax_amount_cents?: number;
|
103
|
-
total_tax_amount_float?: number;
|
104
|
-
formatted_total_tax_amount?: string;
|
105
|
-
subtotal_tax_amount_cents?: number;
|
106
|
-
subtotal_tax_amount_float?: number;
|
107
|
-
formatted_subtotal_tax_amount?: string;
|
108
|
-
shipping_tax_amount_cents?: number;
|
109
|
-
shipping_tax_amount_float?: number;
|
110
|
-
formatted_shipping_tax_amount?: string;
|
111
|
-
payment_method_tax_amount_cents?: number;
|
112
|
-
payment_method_tax_amount_float?: number;
|
113
|
-
formatted_payment_method_tax_amount?: string;
|
114
|
-
adjustment_tax_amount_cents?: number;
|
115
|
-
adjustment_tax_amount_float?: number;
|
116
|
-
formatted_adjustment_tax_amount?: string;
|
117
|
-
total_amount_cents?: number;
|
118
|
-
total_amount_float?: number;
|
119
|
-
formatted_total_amount?: string;
|
120
|
-
total_taxable_amount_cents?: number;
|
121
|
-
total_taxable_amount_float?: number;
|
122
|
-
formatted_total_taxable_amount?: string;
|
123
|
-
subtotal_taxable_amount_cents?: number;
|
124
|
-
subtotal_taxable_amount_float?: number;
|
125
|
-
formatted_subtotal_taxable_amount?: string;
|
126
|
-
shipping_taxable_amount_cents?: number;
|
127
|
-
shipping_taxable_amount_float?: number;
|
128
|
-
formatted_shipping_taxable_amount?: string;
|
129
|
-
payment_method_taxable_amount_cents?: number;
|
130
|
-
payment_method_taxable_amount_float?: number;
|
131
|
-
formatted_payment_method_taxable_amount?: string;
|
132
|
-
adjustment_taxable_amount_cents?: number;
|
133
|
-
adjustment_taxable_amount_float?: number;
|
134
|
-
formatted_adjustment_taxable_amount?: string;
|
135
|
-
total_amount_with_taxes_cents?: number;
|
136
|
-
total_amount_with_taxes_float?: number;
|
137
|
-
formatted_total_amount_with_taxes?: string;
|
138
|
-
fees_amount_cents?: number;
|
139
|
-
fees_amount_float?: number;
|
140
|
-
formatted_fees_amount?: string;
|
141
|
-
duty_amount_cents?: number;
|
142
|
-
duty_amount_float?: number;
|
143
|
-
formatted_duty_amount?: string;
|
144
|
-
skus_count?: number;
|
145
|
-
line_item_options_count?: number;
|
146
|
-
shipments_count?: number;
|
147
|
-
payment_source_details?: object;
|
148
|
-
token?: string;
|
149
|
-
cart_url?: string;
|
150
|
-
return_url?: string;
|
151
|
-
terms_url?: string;
|
152
|
-
privacy_url?: string;
|
153
|
-
checkout_url?: string;
|
154
|
-
placed_at?: string;
|
155
|
-
approved_at?: string;
|
156
|
-
cancelled_at?: string;
|
157
|
-
payment_updated_at?: string;
|
158
|
-
fulfillment_updated_at?: string;
|
159
|
-
refreshed_at?: string;
|
160
|
-
archived_at?: string;
|
161
|
-
expires_at?: string;
|
162
|
-
market?: Market;
|
163
|
-
customer?: Customer;
|
164
|
-
shipping_address?: Address;
|
165
|
-
billing_address?: Address;
|
166
|
-
available_payment_methods?: PaymentMethod[];
|
167
|
-
available_customer_payment_sources?: CustomerPaymentSource[];
|
168
|
-
payment_method?: PaymentMethod;
|
169
|
-
payment_source?: AdyenPayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | StripePayment | WireTransfer;
|
170
|
-
line_items?: LineItem[];
|
171
|
-
shipments?: Shipment[];
|
172
|
-
transactions?: (Authorization | Void | Capture | Refund)[];
|
173
|
-
authorizations?: Authorization[];
|
174
|
-
captures?: Capture[];
|
175
|
-
voids?: Void[];
|
176
|
-
refunds?: Refund[];
|
177
|
-
order_subscriptions?: OrderSubscription[];
|
178
|
-
order_copies?: OrderCopy[];
|
179
|
-
attachments?: Attachment[];
|
180
|
-
}
|
181
|
-
interface OrderCreate extends ResourceCreate {
|
182
|
-
autorefresh?: boolean;
|
183
|
-
guest?: boolean;
|
184
|
-
customer_email?: string;
|
185
|
-
customer_password?: string;
|
186
|
-
language_code?: string;
|
187
|
-
shipping_country_code_lock?: string;
|
188
|
-
coupon_code?: string;
|
189
|
-
gift_card_code?: string;
|
190
|
-
gift_card_or_coupon_code?: string;
|
191
|
-
cart_url?: string;
|
192
|
-
return_url?: string;
|
193
|
-
terms_url?: string;
|
194
|
-
privacy_url?: string;
|
195
|
-
market?: MarketRel;
|
196
|
-
customer?: CustomerRel;
|
197
|
-
shipping_address?: AddressRel;
|
198
|
-
billing_address?: AddressRel;
|
199
|
-
payment_method?: PaymentMethodRel;
|
200
|
-
payment_source?: AdyenPaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | StripePaymentRel | WireTransferRel;
|
201
|
-
}
|
202
|
-
interface OrderUpdate extends ResourceUpdate {
|
203
|
-
autorefresh?: boolean;
|
204
|
-
guest?: boolean;
|
205
|
-
customer_email?: string;
|
206
|
-
customer_password?: string;
|
207
|
-
language_code?: string;
|
208
|
-
shipping_country_code_lock?: string;
|
209
|
-
coupon_code?: string;
|
210
|
-
gift_card_code?: string;
|
211
|
-
gift_card_or_coupon_code?: string;
|
212
|
-
cart_url?: string;
|
213
|
-
return_url?: string;
|
214
|
-
terms_url?: string;
|
215
|
-
privacy_url?: string;
|
216
|
-
_archive?: boolean;
|
217
|
-
_unarchive?: boolean;
|
218
|
-
_place?: boolean;
|
219
|
-
_cancel?: boolean;
|
220
|
-
_approve?: boolean;
|
221
|
-
_approve_and_capture?: boolean;
|
222
|
-
_authorize?: boolean;
|
223
|
-
_authorization_amount_cents?: number;
|
224
|
-
_capture?: boolean;
|
225
|
-
_refund?: boolean;
|
226
|
-
_update_taxes?: boolean;
|
227
|
-
_billing_address_clone_id?: string;
|
228
|
-
_shipping_address_clone_id?: string;
|
229
|
-
_customer_payment_source_id?: string;
|
230
|
-
_shipping_address_same_as_billing?: boolean;
|
231
|
-
_billing_address_same_as_shipping?: boolean;
|
232
|
-
_save_payment_source_to_customer_wallet?: boolean;
|
233
|
-
_save_shipping_address_to_customer_address_book?: boolean;
|
234
|
-
_save_billing_address_to_customer_address_book?: boolean;
|
235
|
-
_refresh?: boolean;
|
236
|
-
market?: MarketRel;
|
237
|
-
customer?: CustomerRel;
|
238
|
-
shipping_address?: AddressRel;
|
239
|
-
billing_address?: AddressRel;
|
240
|
-
payment_method?: PaymentMethodRel;
|
241
|
-
payment_source?: AdyenPaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | StripePaymentRel | WireTransferRel;
|
242
|
-
}
|
243
|
-
declare class Orders extends ApiResource {
|
244
|
-
static readonly TYPE: 'orders';
|
245
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
246
|
-
create(resource: OrderCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
247
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
248
|
-
update(resource: OrderUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
|
249
|
-
delete(id: string, options?: ResourcesConfig): Promise<void>;
|
250
|
-
market(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
|
251
|
-
customer(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
|
252
|
-
shipping_address(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
|
253
|
-
billing_address(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
|
254
|
-
available_payment_methods(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
255
|
-
available_customer_payment_sources(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CustomerPaymentSource>>;
|
256
|
-
payment_method(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
|
257
|
-
line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
|
258
|
-
shipments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
|
259
|
-
authorizations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Authorization>>;
|
260
|
-
captures(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
|
261
|
-
voids(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
|
262
|
-
refunds(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
|
263
|
-
order_subscriptions(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
|
264
|
-
order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
|
265
|
-
attachments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
266
|
-
isOrder(resource: any): resource is Order;
|
267
|
-
relationship(id: string | ResourceId | null): OrderRel;
|
268
|
-
type(): string;
|
269
|
-
}
|
270
|
-
export default Orders;
|
271
|
-
export { Order, OrderCreate, OrderUpdate };
|
1
|
+
import{ApiResource,Resource,ResourceCreate,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Market}from'./markets';import type{Customer}from'./customers';import type{Address}from'./addresses';import type{PaymentMethod}from'./payment_methods';import type{CustomerPaymentSource}from'./customer_payment_sources';import type{AdyenPayment}from'./adyen_payments';import type{BraintreePayment}from'./braintree_payments';import type{CheckoutComPayment}from'./checkout_com_payments';import type{ExternalPayment}from'./external_payments';import type{KlarnaPayment}from'./klarna_payments';import type{PaypalPayment}from'./paypal_payments';import type{StripePayment}from'./stripe_payments';import type{WireTransfer}from'./wire_transfers';import type{LineItem}from'./line_items';import type{Shipment}from'./shipments';import type{Authorization}from'./authorizations';import type{Void}from'./voids';import type{Capture}from'./captures';import type{Refund}from'./refunds';import type{OrderSubscription}from'./order_subscriptions';import type{OrderCopy}from'./order_copies';import type{Attachment}from'./attachments';declare type OrderRel=ResourceRel&{type:typeof Orders.TYPE;};declare type MarketRel=ResourceRel&{type:'markets';};declare type CustomerRel=ResourceRel&{type:'customers';};declare type AddressRel=ResourceRel&{type:'addresses';};declare type PaymentMethodRel=ResourceRel&{type:'payment_methods';};declare type AdyenPaymentRel=ResourceRel&{type:'adyen_payments';};declare type BraintreePaymentRel=ResourceRel&{type:'braintree_payments';};declare type CheckoutComPaymentRel=ResourceRel&{type:'checkout_com_payments';};declare type ExternalPaymentRel=ResourceRel&{type:'external_payments';};declare type KlarnaPaymentRel=ResourceRel&{type:'klarna_payments';};declare type PaypalPaymentRel=ResourceRel&{type:'paypal_payments';};declare type StripePaymentRel=ResourceRel&{type:'stripe_payments';};declare type WireTransferRel=ResourceRel&{type:'wire_transfers';};interface Order extends Resource{number?:number;autorefresh?:boolean;status?:string;payment_status?:string;fulfillment_status?:string;guest?:boolean;editable?:boolean;customer_email?:string;language_code?:string;currency_code?:string;tax_included?:boolean;tax_rate?:number;freight_taxable?:boolean;requires_billing_info?:boolean;country_code?:string;shipping_country_code_lock?:string;coupon_code?:string;gift_card_code?:string;gift_card_or_coupon_code?:string;subtotal_amount_cents?:number;subtotal_amount_float?:number;formatted_subtotal_amount?:string;shipping_amount_cents?:number;shipping_amount_float?:number;formatted_shipping_amount?:string;payment_method_amount_cents?:number;payment_method_amount_float?:number;formatted_payment_method_amount?:string;discount_amount_cents?:number;discount_amount_float?:number;formatted_discount_amount?:string;adjustment_amount_cents?:number;adjustment_amount_float?:number;formatted_adjustment_amount?:string;gift_card_amount_cents?:number;gift_card_amount_float?:number;formatted_gift_card_amount?:string;total_tax_amount_cents?:number;total_tax_amount_float?:number;formatted_total_tax_amount?:string;subtotal_tax_amount_cents?:number;subtotal_tax_amount_float?:number;formatted_subtotal_tax_amount?:string;shipping_tax_amount_cents?:number;shipping_tax_amount_float?:number;formatted_shipping_tax_amount?:string;payment_method_tax_amount_cents?:number;payment_method_tax_amount_float?:number;formatted_payment_method_tax_amount?:string;adjustment_tax_amount_cents?:number;adjustment_tax_amount_float?:number;formatted_adjustment_tax_amount?:string;total_amount_cents?:number;total_amount_float?:number;formatted_total_amount?:string;total_taxable_amount_cents?:number;total_taxable_amount_float?:number;formatted_total_taxable_amount?:string;subtotal_taxable_amount_cents?:number;subtotal_taxable_amount_float?:number;formatted_subtotal_taxable_amount?:string;shipping_taxable_amount_cents?:number;shipping_taxable_amount_float?:number;formatted_shipping_taxable_amount?:string;payment_method_taxable_amount_cents?:number;payment_method_taxable_amount_float?:number;formatted_payment_method_taxable_amount?:string;adjustment_taxable_amount_cents?:number;adjustment_taxable_amount_float?:number;formatted_adjustment_taxable_amount?:string;total_amount_with_taxes_cents?:number;total_amount_with_taxes_float?:number;formatted_total_amount_with_taxes?:string;fees_amount_cents?:number;fees_amount_float?:number;formatted_fees_amount?:string;duty_amount_cents?:number;duty_amount_float?:number;formatted_duty_amount?:string;skus_count?:number;line_item_options_count?:number;shipments_count?:number;payment_source_details?:object;token?:string;cart_url?:string;return_url?:string;terms_url?:string;privacy_url?:string;checkout_url?:string;placed_at?:string;approved_at?:string;cancelled_at?:string;payment_updated_at?:string;fulfillment_updated_at?:string;refreshed_at?:string;archived_at?:string;expires_at?:string;market?:Market;customer?:Customer;shipping_address?:Address;billing_address?:Address;available_payment_methods?:PaymentMethod[];available_customer_payment_sources?:CustomerPaymentSource[];payment_method?:PaymentMethod;payment_source?:AdyenPayment|BraintreePayment|CheckoutComPayment|ExternalPayment|KlarnaPayment|PaypalPayment|StripePayment|WireTransfer;line_items?:LineItem[];shipments?:Shipment[];transactions?:(Authorization|Void|Capture|Refund)[];authorizations?:Authorization[];captures?:Capture[];voids?:Void[];refunds?:Refund[];order_subscriptions?:OrderSubscription[];order_copies?:OrderCopy[];attachments?:Attachment[];}interface OrderCreate extends ResourceCreate{autorefresh?:boolean;guest?:boolean;customer_email?:string;customer_password?:string;language_code?:string;shipping_country_code_lock?:string;coupon_code?:string;gift_card_code?:string;gift_card_or_coupon_code?:string;cart_url?:string;return_url?:string;terms_url?:string;privacy_url?:string;market?:MarketRel;customer?:CustomerRel;shipping_address?:AddressRel;billing_address?:AddressRel;payment_method?:PaymentMethodRel;payment_source?:AdyenPaymentRel|BraintreePaymentRel|CheckoutComPaymentRel|ExternalPaymentRel|KlarnaPaymentRel|PaypalPaymentRel|StripePaymentRel|WireTransferRel;}interface OrderUpdate extends ResourceUpdate{autorefresh?:boolean;guest?:boolean;customer_email?:string;customer_password?:string;language_code?:string;shipping_country_code_lock?:string;coupon_code?:string;gift_card_code?:string;gift_card_or_coupon_code?:string;cart_url?:string;return_url?:string;terms_url?:string;privacy_url?:string;_archive?:boolean;_unarchive?:boolean;_place?:boolean;_cancel?:boolean;_approve?:boolean;_approve_and_capture?:boolean;_authorize?:boolean;_authorization_amount_cents?:number;_capture?:boolean;_refund?:boolean;_update_taxes?:boolean;_billing_address_clone_id?:string;_shipping_address_clone_id?:string;_customer_payment_source_id?:string;_shipping_address_same_as_billing?:boolean;_billing_address_same_as_shipping?:boolean;_save_payment_source_to_customer_wallet?:boolean;_save_shipping_address_to_customer_address_book?:boolean;_save_billing_address_to_customer_address_book?:boolean;_refresh?:boolean;market?:MarketRel;customer?:CustomerRel;shipping_address?:AddressRel;billing_address?:AddressRel;payment_method?:PaymentMethodRel;payment_source?:AdyenPaymentRel|BraintreePaymentRel|CheckoutComPaymentRel|ExternalPaymentRel|KlarnaPaymentRel|PaypalPaymentRel|StripePaymentRel|WireTransferRel;}declare class Orders extends ApiResource{static readonly TYPE:'orders';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Order>>;create(resource:OrderCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;update(resource:OrderUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;delete(id:string,options?:ResourcesConfig):Promise<void>;market(orderId:string|Order,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Market>;customer(orderId:string|Order,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Customer>;shipping_address(orderId:string|Order,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;billing_address(orderId:string|Order,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;available_payment_methods(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<PaymentMethod>>;available_customer_payment_sources(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<CustomerPaymentSource>>;payment_method(orderId:string|Order,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<PaymentMethod>;line_items(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<LineItem>>;shipments(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Shipment>>;authorizations(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Authorization>>;captures(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Capture>>;voids(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Void>>;refunds(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Refund>>;order_subscriptions(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderSubscription>>;order_copies(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<OrderCopy>>;attachments(orderId:string|Order,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;isOrder(resource:any):resource is Order;relationship(id:string|ResourceId|null):OrderRel;type():string;}export default Orders;export{Order,OrderCreate,OrderUpdate};
|
@@ -1,32 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsRetrieve } from '../query';
|
3
|
-
declare type OrganizationRel = ResourceRel & {
|
4
|
-
type: typeof Organizations.TYPE;
|
5
|
-
};
|
6
|
-
interface Organization extends Resource {
|
7
|
-
name?: string;
|
8
|
-
slug?: string;
|
9
|
-
domain?: string;
|
10
|
-
support_phone?: string;
|
11
|
-
support_email?: string;
|
12
|
-
logo_url?: string;
|
13
|
-
favicon_url?: string;
|
14
|
-
primary_color?: string;
|
15
|
-
contrast_color?: string;
|
16
|
-
gtm_id?: string;
|
17
|
-
gtm_id_test?: string;
|
18
|
-
discount_disabled?: boolean;
|
19
|
-
account_disabled?: boolean;
|
20
|
-
acceptance_disabled?: boolean;
|
21
|
-
max_concurrent_promotions?: number;
|
22
|
-
max_concurrent_imports?: number;
|
23
|
-
}
|
24
|
-
declare class Organizations extends ApiResource {
|
25
|
-
static readonly TYPE: 'organization';
|
26
|
-
retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
27
|
-
isOrganization(resource: any): resource is Organization;
|
28
|
-
relationship(id: string | ResourceId | null): OrganizationRel;
|
29
|
-
type(): string;
|
30
|
-
}
|
31
|
-
export default Organizations;
|
32
|
-
export { Organization };
|
1
|
+
import{ApiResource,Resource,ResourcesConfig,ResourceId,ResourceRel}from'../resource';import type{QueryParamsRetrieve}from'../query';declare type OrganizationRel=ResourceRel&{type:typeof Organizations.TYPE;};interface Organization extends Resource{name?:string;slug?:string;domain?:string;support_phone?:string;support_email?:string;logo_url?:string;favicon_url?:string;primary_color?:string;contrast_color?:string;gtm_id?:string;gtm_id_test?:string;discount_disabled?:boolean;account_disabled?:boolean;acceptance_disabled?:boolean;max_concurrent_promotions?:number;max_concurrent_imports?:number;}declare class Organizations extends ApiResource{static readonly TYPE:'organization';retrieve(params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Organization>;isOrganization(resource:any):resource is Organization;relationship(id:string|ResourceId|null):OrganizationRel;type():string;}export default Organizations;export{Organization};
|
@@ -1,56 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { StockLocation } from './stock_locations';
|
4
|
-
import type { Parcel } from './parcels';
|
5
|
-
import type { Attachment } from './attachments';
|
6
|
-
declare type PackageRel = ResourceRel & {
|
7
|
-
type: typeof Packages.TYPE;
|
8
|
-
};
|
9
|
-
declare type StockLocationRel = ResourceRel & {
|
10
|
-
type: 'stock_locations';
|
11
|
-
};
|
12
|
-
interface Package extends Resource {
|
13
|
-
name?: string;
|
14
|
-
code?: string;
|
15
|
-
length?: number;
|
16
|
-
width?: number;
|
17
|
-
height?: number;
|
18
|
-
unit_of_length?: string;
|
19
|
-
stock_location?: StockLocation;
|
20
|
-
parcels?: Parcel[];
|
21
|
-
attachments?: Attachment[];
|
22
|
-
}
|
23
|
-
interface PackageCreate extends ResourceCreate {
|
24
|
-
name: string;
|
25
|
-
code?: string;
|
26
|
-
length: number;
|
27
|
-
width: number;
|
28
|
-
height: number;
|
29
|
-
unit_of_length: string;
|
30
|
-
stock_location: StockLocationRel;
|
31
|
-
}
|
32
|
-
interface PackageUpdate extends ResourceUpdate {
|
33
|
-
name?: string;
|
34
|
-
code?: string;
|
35
|
-
length?: number;
|
36
|
-
width?: number;
|
37
|
-
height?: number;
|
38
|
-
unit_of_length?: string;
|
39
|
-
stock_location?: StockLocationRel;
|
40
|
-
}
|
41
|
-
declare class Packages extends ApiResource {
|
42
|
-
static readonly TYPE: 'packages';
|
43
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Package>>;
|
44
|
-
create(resource: PackageCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
|
45
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
|
46
|
-
update(resource: PackageUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
|
47
|
-
delete(id: string, options?: ResourcesConfig): Promise<void>;
|
48
|
-
stock_location(packageId: string | Package, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
|
49
|
-
parcels(packageId: string | Package, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
|
50
|
-
attachments(packageId: string | Package, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
51
|
-
isPackage(resource: any): resource is Package;
|
52
|
-
relationship(id: string | ResourceId | null): PackageRel;
|
53
|
-
type(): string;
|
54
|
-
}
|
55
|
-
export default Packages;
|
56
|
-
export { Package, PackageCreate, PackageUpdate };
|
1
|
+
import{ApiResource,Resource,ResourceCreate,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{StockLocation}from'./stock_locations';import type{Parcel}from'./parcels';import type{Attachment}from'./attachments';declare type PackageRel=ResourceRel&{type:typeof Packages.TYPE;};declare type StockLocationRel=ResourceRel&{type:'stock_locations';};interface Package extends Resource{name?:string;code?:string;length?:number;width?:number;height?:number;unit_of_length?:string;stock_location?:StockLocation;parcels?:Parcel[];attachments?:Attachment[];}interface PackageCreate extends ResourceCreate{name:string;code?:string;length:number;width:number;height:number;unit_of_length:string;stock_location:StockLocationRel;}interface PackageUpdate extends ResourceUpdate{name?:string;code?:string;length?:number;width?:number;height?:number;unit_of_length?:string;stock_location?:StockLocationRel;}declare class Packages extends ApiResource{static readonly TYPE:'packages';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Package>>;create(resource:PackageCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Package>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Package>;update(resource:PackageUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Package>;delete(id:string,options?:ResourcesConfig):Promise<void>;stock_location(packageId:string|Package,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<StockLocation>;parcels(packageId:string|Package,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Parcel>>;attachments(packageId:string|Package,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;isPackage(resource:any):resource is Package;relationship(id:string|ResourceId|null):PackageRel;type():string;}export default Packages;export{Package,PackageCreate,PackageUpdate};
|
@@ -1,49 +1 @@
|
|
1
|
-
import
|
2
|
-
import type { QueryParamsList, QueryParamsRetrieve } from '../query';
|
3
|
-
import type { Parcel } from './parcels';
|
4
|
-
import type { StockLineItem } from './stock_line_items';
|
5
|
-
declare type ParcelLineItemRel = ResourceRel & {
|
6
|
-
type: typeof ParcelLineItems.TYPE;
|
7
|
-
};
|
8
|
-
declare type ParcelRel = ResourceRel & {
|
9
|
-
type: 'parcels';
|
10
|
-
};
|
11
|
-
declare type StockLineItemRel = ResourceRel & {
|
12
|
-
type: 'stock_line_items';
|
13
|
-
};
|
14
|
-
interface ParcelLineItem extends Resource {
|
15
|
-
sku_code?: string;
|
16
|
-
quantity?: number;
|
17
|
-
parcel?: Parcel;
|
18
|
-
stock_line_item?: StockLineItem;
|
19
|
-
/**
|
20
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
21
|
-
*/
|
22
|
-
shipment_line_item?: object;
|
23
|
-
}
|
24
|
-
interface ParcelLineItemCreate extends ResourceCreate {
|
25
|
-
sku_code?: string;
|
26
|
-
quantity: number;
|
27
|
-
parcel: ParcelRel;
|
28
|
-
stock_line_item: StockLineItemRel;
|
29
|
-
/**
|
30
|
-
* @deprecated This field should not be used as it may be removed in the future without notice
|
31
|
-
*/
|
32
|
-
shipment_line_item?: object;
|
33
|
-
}
|
34
|
-
declare type ParcelLineItemUpdate = ResourceUpdate;
|
35
|
-
declare class ParcelLineItems extends ApiResource {
|
36
|
-
static readonly TYPE: 'parcel_line_items';
|
37
|
-
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
|
38
|
-
create(resource: ParcelLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
|
39
|
-
retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
|
40
|
-
update(resource: ParcelLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
|
41
|
-
delete(id: string, options?: ResourcesConfig): Promise<void>;
|
42
|
-
parcel(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
|
43
|
-
stock_line_item(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
|
44
|
-
isParcelLineItem(resource: any): resource is ParcelLineItem;
|
45
|
-
relationship(id: string | ResourceId | null): ParcelLineItemRel;
|
46
|
-
type(): string;
|
47
|
-
}
|
48
|
-
export default ParcelLineItems;
|
49
|
-
export { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate };
|
1
|
+
import{ApiResource,Resource,ResourceCreate,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Parcel}from'./parcels';import type{StockLineItem}from'./stock_line_items';declare type ParcelLineItemRel=ResourceRel&{type:typeof ParcelLineItems.TYPE;};declare type ParcelRel=ResourceRel&{type:'parcels';};declare type StockLineItemRel=ResourceRel&{type:'stock_line_items';};interface ParcelLineItem extends Resource{sku_code?:string;quantity?:number;parcel?:Parcel;stock_line_item?:StockLineItem;shipment_line_item?:object;}interface ParcelLineItemCreate extends ResourceCreate{sku_code?:string;quantity:number;parcel:ParcelRel;stock_line_item:StockLineItemRel;shipment_line_item?:object;}declare type ParcelLineItemUpdate=ResourceUpdate;declare class ParcelLineItems extends ApiResource{static readonly TYPE:'parcel_line_items';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<ParcelLineItem>>;create(resource:ParcelLineItemCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<ParcelLineItem>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<ParcelLineItem>;update(resource:ParcelLineItemUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<ParcelLineItem>;delete(id:string,options?:ResourcesConfig):Promise<void>;parcel(parcelLineItemId:string|ParcelLineItem,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Parcel>;stock_line_item(parcelLineItemId:string|ParcelLineItem,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<StockLineItem>;isParcelLineItem(resource:any):resource is ParcelLineItem;relationship(id:string|ResourceId|null):ParcelLineItemRel;type():string;}export default ParcelLineItems;export{ParcelLineItem,ParcelLineItemCreate,ParcelLineItemUpdate};
|