@commercelayer/sdk 6.57.0 → 6.58.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/lib/index.d.mts +224 -352
- package/lib/index.d.ts +224 -352
- package/lib/index.js +2 -2
- package/lib/index.mjs +2 -2
- package/package.json +5 -5
package/lib/index.d.ts
CHANGED
|
@@ -209,10 +209,10 @@ type EventStoreSort = Pick<EventStore, 'id'> & ResourceSort;
|
|
|
209
209
|
interface EventStore extends Resource {
|
|
210
210
|
readonly type: EventStoreType;
|
|
211
211
|
/**
|
|
212
|
-
* The type of the affected resource.
|
|
212
|
+
* The type of the affected resource. One of 'applications', 'event_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price_lists', 'payment_gateways', 'payment_methods', 'markets', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'adyen_payments', 'orders', 'transactions', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'payment_options', 'resource_errors', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.
|
|
213
213
|
* @example ```"orders"```
|
|
214
214
|
*/
|
|
215
|
-
resource_type?:
|
|
215
|
+
resource_type?: 'applications' | 'event_stores' | 'organizations' | 'addresses' | 'geocoders' | 'events' | 'tags' | 'adjustments' | 'price_lists' | 'payment_gateways' | 'payment_methods' | 'markets' | 'customer_groups' | 'line_items' | 'discount_engine_items' | 'promotions' | 'adyen_payments' | 'orders' | 'transactions' | 'order_factories' | 'attachments' | 'tax_calculators' | 'tax_categories' | 'skus' | 'shipping_categories' | 'axerve_payments' | 'order_validation_rules' | 'braintree_payments' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'promotion_rules' | 'coupons' | 'returns' | 'carrier_accounts' | 'checkout_com_payments' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'order_subscriptions' | 'customer_password_resets' | 'delivery_lead_times' | 'shipping_methods' | 'shipments' | 'discount_engines' | 'pickups' | 'parcels' | 'webhooks' | 'event_callbacks' | 'external_payments' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_stock_locations' | 'inventory_return_locations' | 'klarna_payments' | 'line_item_options' | 'return_line_items' | 'stock_line_items' | 'stock_reservations' | 'stock_transfers' | 'notifications' | 'sku_options' | 'links' | 'tax_rules' | 'merchants' | 'subscription_models' | 'stores' | 'price_list_schedulers' | 'order_subscription_items' | 'payment_options' | 'resource_errors' | 'paypal_payments' | 'packages' | 'parcel_line_items' | 'prices' | 'price_tiers' | 'reserved_stocks' | 'satispay_payments' | 'shipping_method_tiers' | 'shipping_zones' | 'stripe_payments' | 'wire_transfers' | null;
|
|
216
216
|
/**
|
|
217
217
|
* The ID of the affected resource.
|
|
218
218
|
* @example ```"PzdJhdLdYV"```
|
|
@@ -282,49 +282,6 @@ declare class Tags extends ApiResource<Tag> {
|
|
|
282
282
|
type(): TagType;
|
|
283
283
|
}
|
|
284
284
|
|
|
285
|
-
type VersionType = 'versions';
|
|
286
|
-
type VersionRel = ResourceRel & {
|
|
287
|
-
type: VersionType;
|
|
288
|
-
};
|
|
289
|
-
type VersionSort = Pick<Version, 'id'> & ResourceSort;
|
|
290
|
-
interface Version extends Resource {
|
|
291
|
-
readonly type: VersionType;
|
|
292
|
-
/**
|
|
293
|
-
* The type of the versioned resource.
|
|
294
|
-
* @example ```"orders"```
|
|
295
|
-
*/
|
|
296
|
-
resource_type?: string | null;
|
|
297
|
-
/**
|
|
298
|
-
* The versioned resource id.
|
|
299
|
-
* @example ```"PzdJhdLdYV"```
|
|
300
|
-
*/
|
|
301
|
-
resource_id?: string | null;
|
|
302
|
-
/**
|
|
303
|
-
* The event which generates the version.
|
|
304
|
-
* @example ```"update"```
|
|
305
|
-
*/
|
|
306
|
-
event?: string | null;
|
|
307
|
-
/**
|
|
308
|
-
* The object changes payload.
|
|
309
|
-
* @example ```{"status":["draft","placed"]}```
|
|
310
|
-
*/
|
|
311
|
-
changes?: Record<string, any> | null;
|
|
312
|
-
/**
|
|
313
|
-
* Information about who triggered the change.
|
|
314
|
-
* @example ```{"application":{"id":"DNOPYiZYpn","kind":"sales_channel","public":true},"owner":{"id":"yQQrBhLBmQ","type":"Customer"}}```
|
|
315
|
-
*/
|
|
316
|
-
who?: Record<string, any> | null;
|
|
317
|
-
event_stores?: EventStore[] | null;
|
|
318
|
-
}
|
|
319
|
-
declare class Versions extends ApiResource<Version> {
|
|
320
|
-
static readonly TYPE: VersionType;
|
|
321
|
-
event_stores(versionId: string | Version, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
322
|
-
isVersion(resource: any): resource is Version;
|
|
323
|
-
relationship(id: string | ResourceId | null): VersionRel;
|
|
324
|
-
relationshipToMany(...ids: string[]): VersionRel[];
|
|
325
|
-
type(): VersionType;
|
|
326
|
-
}
|
|
327
|
-
|
|
328
285
|
type ShippingCategoryType = 'shipping_categories';
|
|
329
286
|
type ShippingCategoryRel$4 = ResourceRel & {
|
|
330
287
|
type: ShippingCategoryType;
|
|
@@ -344,7 +301,6 @@ interface ShippingCategory extends Resource {
|
|
|
344
301
|
code?: string | null;
|
|
345
302
|
skus?: Sku[] | null;
|
|
346
303
|
attachments?: Attachment[] | null;
|
|
347
|
-
versions?: Version[] | null;
|
|
348
304
|
event_stores?: EventStore[] | null;
|
|
349
305
|
}
|
|
350
306
|
interface ShippingCategoryCreate extends ResourceCreate {
|
|
@@ -378,7 +334,6 @@ declare class ShippingCategories extends ApiResource<ShippingCategory> {
|
|
|
378
334
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
379
335
|
skus(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
380
336
|
attachments(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
381
|
-
versions(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
382
337
|
event_stores(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
383
338
|
isShippingCategory(resource: any): resource is ShippingCategory;
|
|
384
339
|
relationship(id: string | ResourceId | null): ShippingCategoryRel$4;
|
|
@@ -406,7 +361,6 @@ interface InventoryReturnLocation extends Resource {
|
|
|
406
361
|
priority: number;
|
|
407
362
|
stock_location?: StockLocation | null;
|
|
408
363
|
inventory_model?: InventoryModel | null;
|
|
409
|
-
versions?: Version[] | null;
|
|
410
364
|
event_stores?: EventStore[] | null;
|
|
411
365
|
}
|
|
412
366
|
interface InventoryReturnLocationCreate extends ResourceCreate {
|
|
@@ -434,7 +388,6 @@ declare class InventoryReturnLocations extends ApiResource<InventoryReturnLocati
|
|
|
434
388
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
435
389
|
stock_location(inventoryReturnLocationId: string | InventoryReturnLocation, params?: QueryParamsRetrieve<StockLocation>, options?: ResourcesConfig): Promise<StockLocation>;
|
|
436
390
|
inventory_model(inventoryReturnLocationId: string | InventoryReturnLocation, params?: QueryParamsRetrieve<InventoryModel>, options?: ResourcesConfig): Promise<InventoryModel>;
|
|
437
|
-
versions(inventoryReturnLocationId: string | InventoryReturnLocation, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
438
391
|
event_stores(inventoryReturnLocationId: string | InventoryReturnLocation, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
439
392
|
isInventoryReturnLocation(resource: any): resource is InventoryReturnLocation;
|
|
440
393
|
relationship(id: string | ResourceId | null): InventoryReturnLocationRel;
|
|
@@ -482,7 +435,6 @@ interface InventoryModel extends Resource {
|
|
|
482
435
|
inventory_stock_locations?: InventoryStockLocation[] | null;
|
|
483
436
|
inventory_return_locations?: InventoryReturnLocation[] | null;
|
|
484
437
|
attachments?: Attachment[] | null;
|
|
485
|
-
versions?: Version[] | null;
|
|
486
438
|
event_stores?: EventStore[] | null;
|
|
487
439
|
}
|
|
488
440
|
interface InventoryModelCreate extends ResourceCreate {
|
|
@@ -557,7 +509,6 @@ declare class InventoryModels extends ApiResource<InventoryModel> {
|
|
|
557
509
|
inventory_stock_locations(inventoryModelId: string | InventoryModel, params?: QueryParamsList<InventoryStockLocation>, options?: ResourcesConfig): Promise<ListResponse<InventoryStockLocation>>;
|
|
558
510
|
inventory_return_locations(inventoryModelId: string | InventoryModel, params?: QueryParamsList<InventoryReturnLocation>, options?: ResourcesConfig): Promise<ListResponse<InventoryReturnLocation>>;
|
|
559
511
|
attachments(inventoryModelId: string | InventoryModel, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
560
|
-
versions(inventoryModelId: string | InventoryModel, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
561
512
|
event_stores(inventoryModelId: string | InventoryModel, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
562
513
|
isInventoryModel(resource: any): resource is InventoryModel;
|
|
563
514
|
relationship(id: string | ResourceId | null): InventoryModelRel$3;
|
|
@@ -589,7 +540,6 @@ interface InventoryStockLocation extends Resource {
|
|
|
589
540
|
on_hold?: boolean | null;
|
|
590
541
|
stock_location?: StockLocation | null;
|
|
591
542
|
inventory_model?: InventoryModel | null;
|
|
592
|
-
versions?: Version[] | null;
|
|
593
543
|
event_stores?: EventStore[] | null;
|
|
594
544
|
}
|
|
595
545
|
interface InventoryStockLocationCreate extends ResourceCreate {
|
|
@@ -625,7 +575,6 @@ declare class InventoryStockLocations extends ApiResource<InventoryStockLocation
|
|
|
625
575
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
626
576
|
stock_location(inventoryStockLocationId: string | InventoryStockLocation, params?: QueryParamsRetrieve<StockLocation>, options?: ResourcesConfig): Promise<StockLocation>;
|
|
627
577
|
inventory_model(inventoryStockLocationId: string | InventoryStockLocation, params?: QueryParamsRetrieve<InventoryModel>, options?: ResourcesConfig): Promise<InventoryModel>;
|
|
628
|
-
versions(inventoryStockLocationId: string | InventoryStockLocation, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
629
578
|
event_stores(inventoryStockLocationId: string | InventoryStockLocation, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
630
579
|
isInventoryStockLocation(resource: any): resource is InventoryStockLocation;
|
|
631
580
|
relationship(id: string | ResourceId | null): InventoryStockLocationRel$1;
|
|
@@ -653,7 +602,6 @@ interface CustomerGroup extends Resource {
|
|
|
653
602
|
customers?: Customer[] | null;
|
|
654
603
|
markets?: Market[] | null;
|
|
655
604
|
attachments?: Attachment[] | null;
|
|
656
|
-
versions?: Version[] | null;
|
|
657
605
|
event_stores?: EventStore[] | null;
|
|
658
606
|
}
|
|
659
607
|
interface CustomerGroupCreate extends ResourceCreate {
|
|
@@ -688,7 +636,6 @@ declare class CustomerGroups extends ApiResource<CustomerGroup> {
|
|
|
688
636
|
customers(customerGroupId: string | CustomerGroup, params?: QueryParamsList<Customer>, options?: ResourcesConfig): Promise<ListResponse<Customer>>;
|
|
689
637
|
markets(customerGroupId: string | CustomerGroup, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
690
638
|
attachments(customerGroupId: string | CustomerGroup, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
691
|
-
versions(customerGroupId: string | CustomerGroup, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
692
639
|
event_stores(customerGroupId: string | CustomerGroup, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
693
640
|
isCustomerGroup(resource: any): resource is CustomerGroup;
|
|
694
641
|
relationship(id: string | ResourceId | null): CustomerGroupRel$3;
|
|
@@ -784,7 +731,6 @@ interface Webhook extends Resource {
|
|
|
784
731
|
*/
|
|
785
732
|
shared_secret: string;
|
|
786
733
|
last_event_callbacks?: EventCallback[] | null;
|
|
787
|
-
versions?: Version[] | null;
|
|
788
734
|
event_stores?: EventStore[] | null;
|
|
789
735
|
}
|
|
790
736
|
interface WebhookCreate extends ResourceCreate {
|
|
@@ -862,7 +808,6 @@ declare class Webhooks extends ApiResource<Webhook> {
|
|
|
862
808
|
update(resource: WebhookUpdate, params?: QueryParamsRetrieve<Webhook>, options?: ResourcesConfig): Promise<Webhook>;
|
|
863
809
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
864
810
|
last_event_callbacks(webhookId: string | Webhook, params?: QueryParamsList<EventCallback>, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
|
|
865
|
-
versions(webhookId: string | Webhook, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
866
811
|
event_stores(webhookId: string | Webhook, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
867
812
|
_disable(id: string | Webhook, params?: QueryParamsRetrieve<Webhook>, options?: ResourcesConfig): Promise<Webhook>;
|
|
868
813
|
_enable(id: string | Webhook, params?: QueryParamsRetrieve<Webhook>, options?: ResourcesConfig): Promise<Webhook>;
|
|
@@ -935,7 +880,6 @@ interface CustomerAddress extends Resource {
|
|
|
935
880
|
customer?: Customer | null;
|
|
936
881
|
address?: Address | null;
|
|
937
882
|
events?: Event[] | null;
|
|
938
|
-
versions?: Version[] | null;
|
|
939
883
|
event_stores?: EventStore[] | null;
|
|
940
884
|
}
|
|
941
885
|
interface CustomerAddressCreate extends ResourceCreate {
|
|
@@ -959,7 +903,6 @@ declare class CustomerAddresses extends ApiResource<CustomerAddress> {
|
|
|
959
903
|
customer(customerAddressId: string | CustomerAddress, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
960
904
|
address(customerAddressId: string | CustomerAddress, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
|
961
905
|
events(customerAddressId: string | CustomerAddress, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
962
|
-
versions(customerAddressId: string | CustomerAddress, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
963
906
|
event_stores(customerAddressId: string | CustomerAddress, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
964
907
|
isCustomerAddress(resource: any): resource is CustomerAddress;
|
|
965
908
|
relationship(id: string | ResourceId | null): CustomerAddressRel;
|
|
@@ -984,19 +927,22 @@ interface PaymentGateway extends Resource {
|
|
|
984
927
|
* @example ```true```
|
|
985
928
|
*/
|
|
986
929
|
force_payments?: boolean | null;
|
|
930
|
+
/**
|
|
931
|
+
* The payment gateway's API credential keys last digits.
|
|
932
|
+
* @example ```{"api_key":"********BW989"}```
|
|
933
|
+
*/
|
|
934
|
+
credential_keys?: Record<string, any> | null;
|
|
987
935
|
/**
|
|
988
936
|
* Time at which this resource was disabled.
|
|
989
937
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
990
938
|
*/
|
|
991
939
|
disabled_at?: string | null;
|
|
992
940
|
payment_methods?: PaymentMethod[] | null;
|
|
993
|
-
versions?: Version[] | null;
|
|
994
941
|
event_stores?: EventStore[] | null;
|
|
995
942
|
}
|
|
996
943
|
declare class PaymentGateways extends ApiResource<PaymentGateway> {
|
|
997
944
|
static readonly TYPE: PaymentGatewayType;
|
|
998
945
|
payment_methods(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
999
|
-
versions(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1000
946
|
event_stores(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1001
947
|
isPaymentGateway(resource: any): resource is PaymentGateway;
|
|
1002
948
|
relationship(id: string | ResourceId | null): PaymentGatewayRel$1;
|
|
@@ -1036,7 +982,6 @@ interface Store extends Resource {
|
|
|
1036
982
|
orders?: Order[] | null;
|
|
1037
983
|
payment_methods?: PaymentMethod[] | null;
|
|
1038
984
|
events?: Event[] | null;
|
|
1039
|
-
versions?: Version[] | null;
|
|
1040
985
|
event_stores?: EventStore[] | null;
|
|
1041
986
|
}
|
|
1042
987
|
interface StoreCreate extends ResourceCreate {
|
|
@@ -1080,7 +1025,6 @@ declare class Stores extends ApiResource<Store> {
|
|
|
1080
1025
|
orders(storeId: string | Store, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
|
1081
1026
|
payment_methods(storeId: string | Store, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
1082
1027
|
events(storeId: string | Store, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
1083
|
-
versions(storeId: string | Store, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1084
1028
|
event_stores(storeId: string | Store, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1085
1029
|
isStore(resource: any): resource is Store;
|
|
1086
1030
|
relationship(id: string | ResourceId | null): StoreRel$2;
|
|
@@ -1172,7 +1116,6 @@ interface PaymentMethod extends Resource {
|
|
|
1172
1116
|
payment_gateway?: PaymentGateway | null;
|
|
1173
1117
|
store?: Store | null;
|
|
1174
1118
|
attachments?: Attachment[] | null;
|
|
1175
|
-
versions?: Version[] | null;
|
|
1176
1119
|
event_stores?: EventStore[] | null;
|
|
1177
1120
|
}
|
|
1178
1121
|
interface PaymentMethodCreate extends ResourceCreate {
|
|
@@ -1296,7 +1239,6 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
|
|
|
1296
1239
|
payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1297
1240
|
store(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
|
|
1298
1241
|
attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
1299
|
-
versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1300
1242
|
event_stores(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1301
1243
|
_disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
|
1302
1244
|
_enable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
|
@@ -1355,6 +1297,11 @@ interface AdyenPayment extends Resource {
|
|
|
1355
1297
|
* @example ```"2018-01-02T12:00:00.000Z"```
|
|
1356
1298
|
*/
|
|
1357
1299
|
expires_at?: string | null;
|
|
1300
|
+
/**
|
|
1301
|
+
* The date/time when the Adyen order was closed, meaning all partial payments have been completed (valid for partial payments only).
|
|
1302
|
+
* @example ```"2018-01-02T12:00:00.000Z"```
|
|
1303
|
+
*/
|
|
1304
|
+
closed_at?: string | null;
|
|
1358
1305
|
/**
|
|
1359
1306
|
* Information about the payment instrument used in the transaction.
|
|
1360
1307
|
* @example ```{"issuer":"cl bank","card_type":"visa"}```
|
|
@@ -1362,7 +1309,6 @@ interface AdyenPayment extends Resource {
|
|
|
1362
1309
|
payment_instrument?: Record<string, any> | null;
|
|
1363
1310
|
order?: Order | null;
|
|
1364
1311
|
payment_gateway?: PaymentGateway | null;
|
|
1365
|
-
versions?: Version[] | null;
|
|
1366
1312
|
event_stores?: EventStore[] | null;
|
|
1367
1313
|
}
|
|
1368
1314
|
interface AdyenPaymentCreate extends ResourceCreate {
|
|
@@ -1403,7 +1349,6 @@ declare class AdyenPayments extends ApiResource<AdyenPayment> {
|
|
|
1403
1349
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1404
1350
|
order(adyenPaymentId: string | AdyenPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1405
1351
|
payment_gateway(adyenPaymentId: string | AdyenPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1406
|
-
versions(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1407
1352
|
event_stores(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1408
1353
|
_authorize(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
|
1409
1354
|
_details(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
|
@@ -1465,7 +1410,6 @@ interface AxervePayment extends Resource {
|
|
|
1465
1410
|
payment_instrument?: Record<string, any> | null;
|
|
1466
1411
|
order?: Order | null;
|
|
1467
1412
|
payment_gateway?: PaymentGateway | null;
|
|
1468
|
-
versions?: Version[] | null;
|
|
1469
1413
|
event_stores?: EventStore[] | null;
|
|
1470
1414
|
}
|
|
1471
1415
|
interface AxervePaymentCreate extends ResourceCreate {
|
|
@@ -1511,7 +1455,6 @@ declare class AxervePayments extends ApiResource<AxervePayment> {
|
|
|
1511
1455
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1512
1456
|
order(axervePaymentId: string | AxervePayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1513
1457
|
payment_gateway(axervePaymentId: string | AxervePayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1514
|
-
versions(axervePaymentId: string | AxervePayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1515
1458
|
event_stores(axervePaymentId: string | AxervePayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1516
1459
|
_update(id: string | AxervePayment, params?: QueryParamsRetrieve<AxervePayment>, options?: ResourcesConfig): Promise<AxervePayment>;
|
|
1517
1460
|
isAxervePayment(resource: any): resource is AxervePayment;
|
|
@@ -1562,7 +1505,6 @@ interface BraintreePayment extends Resource {
|
|
|
1562
1505
|
payment_instrument?: Record<string, any> | null;
|
|
1563
1506
|
order?: Order | null;
|
|
1564
1507
|
payment_gateway?: PaymentGateway | null;
|
|
1565
|
-
versions?: Version[] | null;
|
|
1566
1508
|
event_stores?: EventStore[] | null;
|
|
1567
1509
|
}
|
|
1568
1510
|
interface BraintreePaymentCreate extends ResourceCreate {
|
|
@@ -1613,7 +1555,6 @@ declare class BraintreePayments extends ApiResource<BraintreePayment> {
|
|
|
1613
1555
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1614
1556
|
order(braintreePaymentId: string | BraintreePayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1615
1557
|
payment_gateway(braintreePaymentId: string | BraintreePayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1616
|
-
versions(braintreePaymentId: string | BraintreePayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1617
1558
|
event_stores(braintreePaymentId: string | BraintreePayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1618
1559
|
isBraintreePayment(resource: any): resource is BraintreePayment;
|
|
1619
1560
|
relationship(id: string | ResourceId | null): BraintreePaymentRel$3;
|
|
@@ -1687,7 +1628,6 @@ interface CheckoutComPayment extends Resource {
|
|
|
1687
1628
|
payment_instrument?: Record<string, any> | null;
|
|
1688
1629
|
order?: Order | null;
|
|
1689
1630
|
payment_gateway?: PaymentGateway | null;
|
|
1690
|
-
versions?: Version[] | null;
|
|
1691
1631
|
event_stores?: EventStore[] | null;
|
|
1692
1632
|
}
|
|
1693
1633
|
interface CheckoutComPaymentCreate extends ResourceCreate {
|
|
@@ -1733,7 +1673,6 @@ declare class CheckoutComPayments extends ApiResource<CheckoutComPayment> {
|
|
|
1733
1673
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1734
1674
|
order(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1735
1675
|
payment_gateway(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1736
|
-
versions(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1737
1676
|
event_stores(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1738
1677
|
_details(id: string | CheckoutComPayment, params?: QueryParamsRetrieve<CheckoutComPayment>, options?: ResourcesConfig): Promise<CheckoutComPayment>;
|
|
1739
1678
|
_refresh(id: string | CheckoutComPayment, params?: QueryParamsRetrieve<CheckoutComPayment>, options?: ResourcesConfig): Promise<CheckoutComPayment>;
|
|
@@ -1771,7 +1710,6 @@ interface ExternalPayment extends Resource {
|
|
|
1771
1710
|
order?: Order | null;
|
|
1772
1711
|
payment_gateway?: PaymentGateway | null;
|
|
1773
1712
|
wallet?: CustomerPaymentSource | null;
|
|
1774
|
-
versions?: Version[] | null;
|
|
1775
1713
|
event_stores?: EventStore[] | null;
|
|
1776
1714
|
}
|
|
1777
1715
|
interface ExternalPaymentCreate extends ResourceCreate {
|
|
@@ -1803,7 +1741,6 @@ declare class ExternalPayments extends ApiResource<ExternalPayment> {
|
|
|
1803
1741
|
order(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1804
1742
|
payment_gateway(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1805
1743
|
wallet(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve<CustomerPaymentSource>, options?: ResourcesConfig): Promise<CustomerPaymentSource>;
|
|
1806
|
-
versions(externalPaymentId: string | ExternalPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1807
1744
|
event_stores(externalPaymentId: string | ExternalPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1808
1745
|
isExternalPayment(resource: any): resource is ExternalPayment;
|
|
1809
1746
|
relationship(id: string | ResourceId | null): ExternalPaymentRel$2;
|
|
@@ -1852,7 +1789,6 @@ interface KlarnaPayment extends Resource {
|
|
|
1852
1789
|
payment_instrument?: Record<string, any> | null;
|
|
1853
1790
|
order?: Order | null;
|
|
1854
1791
|
payment_gateway?: PaymentGateway | null;
|
|
1855
|
-
versions?: Version[] | null;
|
|
1856
1792
|
event_stores?: EventStore[] | null;
|
|
1857
1793
|
}
|
|
1858
1794
|
interface KlarnaPaymentCreate extends ResourceCreate {
|
|
@@ -1878,7 +1814,6 @@ declare class KlarnaPayments extends ApiResource<KlarnaPayment> {
|
|
|
1878
1814
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1879
1815
|
order(klarnaPaymentId: string | KlarnaPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1880
1816
|
payment_gateway(klarnaPaymentId: string | KlarnaPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1881
|
-
versions(klarnaPaymentId: string | KlarnaPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1882
1817
|
event_stores(klarnaPaymentId: string | KlarnaPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1883
1818
|
_update(id: string | KlarnaPayment, params?: QueryParamsRetrieve<KlarnaPayment>, options?: ResourcesConfig): Promise<KlarnaPayment>;
|
|
1884
1819
|
isKlarnaPayment(resource: any): resource is KlarnaPayment;
|
|
@@ -1948,7 +1883,6 @@ interface PaypalPayment extends Resource {
|
|
|
1948
1883
|
payment_instrument?: Record<string, any> | null;
|
|
1949
1884
|
order?: Order | null;
|
|
1950
1885
|
payment_gateway?: PaymentGateway | null;
|
|
1951
|
-
versions?: Version[] | null;
|
|
1952
1886
|
event_stores?: EventStore[] | null;
|
|
1953
1887
|
}
|
|
1954
1888
|
interface PaypalPaymentCreate extends ResourceCreate {
|
|
@@ -1984,7 +1918,6 @@ declare class PaypalPayments extends ApiResource<PaypalPayment> {
|
|
|
1984
1918
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
1985
1919
|
order(paypalPaymentId: string | PaypalPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
1986
1920
|
payment_gateway(paypalPaymentId: string | PaypalPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
1987
|
-
versions(paypalPaymentId: string | PaypalPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
1988
1921
|
event_stores(paypalPaymentId: string | PaypalPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
1989
1922
|
isPaypalPayment(resource: any): resource is PaypalPayment;
|
|
1990
1923
|
relationship(id: string | ResourceId | null): PaypalPaymentRel$2;
|
|
@@ -2039,7 +1972,6 @@ interface SatispayPayment extends Resource {
|
|
|
2039
1972
|
payment_instrument?: Record<string, any> | null;
|
|
2040
1973
|
order?: Order | null;
|
|
2041
1974
|
payment_gateway?: PaymentGateway | null;
|
|
2042
|
-
versions?: Version[] | null;
|
|
2043
1975
|
event_stores?: EventStore[] | null;
|
|
2044
1976
|
}
|
|
2045
1977
|
interface SatispayPaymentCreate extends ResourceCreate {
|
|
@@ -2075,7 +2007,6 @@ declare class SatispayPayments extends ApiResource<SatispayPayment> {
|
|
|
2075
2007
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
2076
2008
|
order(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
2077
2009
|
payment_gateway(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
2078
|
-
versions(satispayPaymentId: string | SatispayPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2079
2010
|
event_stores(satispayPaymentId: string | SatispayPayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2080
2011
|
_refresh(id: string | SatispayPayment, params?: QueryParamsRetrieve<SatispayPayment>, options?: ResourcesConfig): Promise<SatispayPayment>;
|
|
2081
2012
|
isSatispayPayment(resource: any): resource is SatispayPayment;
|
|
@@ -2160,7 +2091,6 @@ interface StripePayment extends Resource {
|
|
|
2160
2091
|
payment_instrument?: Record<string, any> | null;
|
|
2161
2092
|
order?: Order | null;
|
|
2162
2093
|
payment_gateway?: PaymentGateway | null;
|
|
2163
|
-
versions?: Version[] | null;
|
|
2164
2094
|
event_stores?: EventStore[] | null;
|
|
2165
2095
|
}
|
|
2166
2096
|
interface StripePaymentCreate extends ResourceCreate {
|
|
@@ -2221,7 +2151,6 @@ declare class StripePayments extends ApiResource<StripePayment> {
|
|
|
2221
2151
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
2222
2152
|
order(stripePaymentId: string | StripePayment, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
2223
2153
|
payment_gateway(stripePaymentId: string | StripePayment, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
|
2224
|
-
versions(stripePaymentId: string | StripePayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2225
2154
|
event_stores(stripePaymentId: string | StripePayment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2226
2155
|
_update(id: string | StripePayment, params?: QueryParamsRetrieve<StripePayment>, options?: ResourcesConfig): Promise<StripePayment>;
|
|
2227
2156
|
_refresh(id: string | StripePayment, params?: QueryParamsRetrieve<StripePayment>, options?: ResourcesConfig): Promise<StripePayment>;
|
|
@@ -2247,7 +2176,6 @@ interface WireTransfer extends Resource {
|
|
|
2247
2176
|
*/
|
|
2248
2177
|
payment_instrument?: Record<string, any> | null;
|
|
2249
2178
|
order?: Order | null;
|
|
2250
|
-
versions?: Version[] | null;
|
|
2251
2179
|
event_stores?: EventStore[] | null;
|
|
2252
2180
|
}
|
|
2253
2181
|
interface WireTransferCreate extends ResourceCreate {
|
|
@@ -2262,7 +2190,6 @@ declare class WireTransfers extends ApiResource<WireTransfer> {
|
|
|
2262
2190
|
update(resource: WireTransferUpdate, params?: QueryParamsRetrieve<WireTransfer>, options?: ResourcesConfig): Promise<WireTransfer>;
|
|
2263
2191
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
2264
2192
|
order(wireTransferId: string | WireTransfer, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
2265
|
-
versions(wireTransferId: string | WireTransfer, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2266
2193
|
event_stores(wireTransferId: string | WireTransfer, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2267
2194
|
isWireTransfer(resource: any): resource is WireTransfer;
|
|
2268
2195
|
relationship(id: string | ResourceId | null): WireTransferRel$2;
|
|
@@ -2331,7 +2258,6 @@ interface CustomerPaymentSource extends Resource {
|
|
|
2331
2258
|
customer?: Customer | null;
|
|
2332
2259
|
payment_method?: PaymentMethod | null;
|
|
2333
2260
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
2334
|
-
versions?: Version[] | null;
|
|
2335
2261
|
event_stores?: EventStore[] | null;
|
|
2336
2262
|
}
|
|
2337
2263
|
interface CustomerPaymentSourceCreate extends ResourceCreate {
|
|
@@ -2371,7 +2297,6 @@ declare class CustomerPaymentSources extends ApiResource<CustomerPaymentSource>
|
|
|
2371
2297
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
2372
2298
|
customer(customerPaymentSourceId: string | CustomerPaymentSource, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
2373
2299
|
payment_method(customerPaymentSourceId: string | CustomerPaymentSource, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
|
2374
|
-
versions(customerPaymentSourceId: string | CustomerPaymentSource, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2375
2300
|
event_stores(customerPaymentSourceId: string | CustomerPaymentSource, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2376
2301
|
isCustomerPaymentSource(resource: any): resource is CustomerPaymentSource;
|
|
2377
2302
|
relationship(id: string | ResourceId | null): CustomerPaymentSourceRel$1;
|
|
@@ -2393,7 +2318,6 @@ interface CustomerSubscription extends Resource {
|
|
|
2393
2318
|
customer_email: string;
|
|
2394
2319
|
customer?: Customer | null;
|
|
2395
2320
|
events?: Event[] | null;
|
|
2396
|
-
versions?: Version[] | null;
|
|
2397
2321
|
event_stores?: EventStore[] | null;
|
|
2398
2322
|
}
|
|
2399
2323
|
interface CustomerSubscriptionCreate extends ResourceCreate {
|
|
@@ -2411,7 +2335,6 @@ declare class CustomerSubscriptions extends ApiResource<CustomerSubscription> {
|
|
|
2411
2335
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
2412
2336
|
customer(customerSubscriptionId: string | CustomerSubscription, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
2413
2337
|
events(customerSubscriptionId: string | CustomerSubscription, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
2414
|
-
versions(customerSubscriptionId: string | CustomerSubscription, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2415
2338
|
event_stores(customerSubscriptionId: string | CustomerSubscription, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2416
2339
|
isCustomerSubscription(resource: any): resource is CustomerSubscription;
|
|
2417
2340
|
relationship(id: string | ResourceId | null): CustomerSubscriptionRel;
|
|
@@ -2584,7 +2507,6 @@ interface SkuOption extends Resource {
|
|
|
2584
2507
|
attachments?: Attachment[] | null;
|
|
2585
2508
|
events?: Event[] | null;
|
|
2586
2509
|
tags?: Tag[] | null;
|
|
2587
|
-
versions?: Version[] | null;
|
|
2588
2510
|
event_stores?: EventStore[] | null;
|
|
2589
2511
|
}
|
|
2590
2512
|
interface SkuOptionCreate extends ResourceCreate {
|
|
@@ -2672,7 +2594,6 @@ declare class SkuOptions extends ApiResource<SkuOption> {
|
|
|
2672
2594
|
attachments(skuOptionId: string | SkuOption, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
2673
2595
|
events(skuOptionId: string | SkuOption, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
2674
2596
|
tags(skuOptionId: string | SkuOption, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
2675
|
-
versions(skuOptionId: string | SkuOption, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2676
2597
|
event_stores(skuOptionId: string | SkuOption, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2677
2598
|
_add_tags(id: string | SkuOption, triggerValue: string, params?: QueryParamsRetrieve<SkuOption>, options?: ResourcesConfig): Promise<SkuOption>;
|
|
2678
2599
|
_remove_tags(id: string | SkuOption, triggerValue: string, params?: QueryParamsRetrieve<SkuOption>, options?: ResourcesConfig): Promise<SkuOption>;
|
|
@@ -2909,7 +2830,6 @@ interface Void extends Resource {
|
|
|
2909
2830
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
2910
2831
|
attachments?: Attachment[] | null;
|
|
2911
2832
|
events?: Event[] | null;
|
|
2912
|
-
versions?: Version[] | null;
|
|
2913
2833
|
event_stores?: EventStore[] | null;
|
|
2914
2834
|
reference_authorization?: Authorization | null;
|
|
2915
2835
|
}
|
|
@@ -2930,7 +2850,6 @@ declare class Voids extends ApiResource<Void> {
|
|
|
2930
2850
|
order(voidId: string | Void, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
2931
2851
|
attachments(voidId: string | Void, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
2932
2852
|
events(voidId: string | Void, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
2933
|
-
versions(voidId: string | Void, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
2934
2853
|
event_stores(voidId: string | Void, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
2935
2854
|
reference_authorization(voidId: string | Void, params?: QueryParamsRetrieve<Authorization>, options?: ResourcesConfig): Promise<Authorization>;
|
|
2936
2855
|
_forward(id: string | Void, params?: QueryParamsRetrieve<Void>, options?: ResourcesConfig): Promise<Void>;
|
|
@@ -3080,7 +2999,6 @@ interface Authorization extends Resource {
|
|
|
3080
2999
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
3081
3000
|
attachments?: Attachment[] | null;
|
|
3082
3001
|
events?: Event[] | null;
|
|
3083
|
-
versions?: Version[] | null;
|
|
3084
3002
|
event_stores?: EventStore[] | null;
|
|
3085
3003
|
captures?: Capture[] | null;
|
|
3086
3004
|
voids?: Void[] | null;
|
|
@@ -3122,7 +3040,6 @@ declare class Authorizations extends ApiResource<Authorization> {
|
|
|
3122
3040
|
order(authorizationId: string | Authorization, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
3123
3041
|
attachments(authorizationId: string | Authorization, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
3124
3042
|
events(authorizationId: string | Authorization, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
3125
|
-
versions(authorizationId: string | Authorization, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3126
3043
|
event_stores(authorizationId: string | Authorization, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3127
3044
|
captures(authorizationId: string | Authorization, params?: QueryParamsList<Capture>, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
|
|
3128
3045
|
voids(authorizationId: string | Authorization, params?: QueryParamsList<Void>, options?: ResourcesConfig): Promise<ListResponse<Void>>;
|
|
@@ -3207,7 +3124,6 @@ interface Refund extends Resource {
|
|
|
3207
3124
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
3208
3125
|
attachments?: Attachment[] | null;
|
|
3209
3126
|
events?: Event[] | null;
|
|
3210
|
-
versions?: Version[] | null;
|
|
3211
3127
|
event_stores?: EventStore[] | null;
|
|
3212
3128
|
reference_capture?: Capture | null;
|
|
3213
3129
|
return?: Return | null;
|
|
@@ -3229,7 +3145,6 @@ declare class Refunds extends ApiResource<Refund> {
|
|
|
3229
3145
|
order(refundId: string | Refund, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
3230
3146
|
attachments(refundId: string | Refund, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
3231
3147
|
events(refundId: string | Refund, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
3232
|
-
versions(refundId: string | Refund, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3233
3148
|
event_stores(refundId: string | Refund, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3234
3149
|
reference_capture(refundId: string | Refund, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture>;
|
|
3235
3150
|
return(refundId: string | Refund, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
|
@@ -3340,7 +3255,6 @@ interface Capture extends Resource {
|
|
|
3340
3255
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
3341
3256
|
attachments?: Attachment[] | null;
|
|
3342
3257
|
events?: Event[] | null;
|
|
3343
|
-
versions?: Version[] | null;
|
|
3344
3258
|
event_stores?: EventStore[] | null;
|
|
3345
3259
|
reference_authorization?: Authorization | null;
|
|
3346
3260
|
refunds?: Refund[] | null;
|
|
@@ -3378,7 +3292,6 @@ declare class Captures extends ApiResource<Capture> {
|
|
|
3378
3292
|
order(captureId: string | Capture, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
3379
3293
|
attachments(captureId: string | Capture, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
3380
3294
|
events(captureId: string | Capture, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
3381
|
-
versions(captureId: string | Capture, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3382
3295
|
event_stores(captureId: string | Capture, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3383
3296
|
reference_authorization(captureId: string | Capture, params?: QueryParamsRetrieve<Authorization>, options?: ResourcesConfig): Promise<Authorization>;
|
|
3384
3297
|
refunds(captureId: string | Capture, params?: QueryParamsList<Refund>, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
|
|
@@ -3528,7 +3441,6 @@ interface Return extends Resource {
|
|
|
3528
3441
|
resource_errors?: ResourceError[] | null;
|
|
3529
3442
|
events?: Event[] | null;
|
|
3530
3443
|
tags?: Tag[] | null;
|
|
3531
|
-
versions?: Version[] | null;
|
|
3532
3444
|
event_stores?: EventStore[] | null;
|
|
3533
3445
|
}
|
|
3534
3446
|
interface ReturnCreate extends ResourceCreate {
|
|
@@ -3622,7 +3534,6 @@ declare class Returns extends ApiResource<Return> {
|
|
|
3622
3534
|
resource_errors(returnId: string | Return, params?: QueryParamsList<ResourceError>, options?: ResourcesConfig): Promise<ListResponse<ResourceError>>;
|
|
3623
3535
|
events(returnId: string | Return, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
3624
3536
|
tags(returnId: string | Return, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
3625
|
-
versions(returnId: string | Return, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3626
3537
|
event_stores(returnId: string | Return, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3627
3538
|
_request(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
|
3628
3539
|
_approve(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
|
@@ -3805,7 +3716,6 @@ interface StockLineItem extends Resource {
|
|
|
3805
3716
|
stock_item?: StockItem | null;
|
|
3806
3717
|
sku?: Sku | null;
|
|
3807
3718
|
stock_reservation?: StockReservation | null;
|
|
3808
|
-
versions?: Version[] | null;
|
|
3809
3719
|
event_stores?: EventStore[] | null;
|
|
3810
3720
|
}
|
|
3811
3721
|
interface StockLineItemCreate extends ResourceCreate {
|
|
@@ -3865,7 +3775,6 @@ declare class StockLineItems extends ApiResource<StockLineItem> {
|
|
|
3865
3775
|
stock_item(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve<StockItem>, options?: ResourcesConfig): Promise<StockItem>;
|
|
3866
3776
|
sku(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
|
3867
3777
|
stock_reservation(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve<StockReservation>, options?: ResourcesConfig): Promise<StockReservation>;
|
|
3868
|
-
versions(stockLineItemId: string | StockLineItem, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3869
3778
|
event_stores(stockLineItemId: string | StockLineItem, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3870
3779
|
_reserve_stock(id: string | StockLineItem, params?: QueryParamsRetrieve<StockLineItem>, options?: ResourcesConfig): Promise<StockLineItem>;
|
|
3871
3780
|
_release_stock(id: string | StockLineItem, params?: QueryParamsRetrieve<StockLineItem>, options?: ResourcesConfig): Promise<StockLineItem>;
|
|
@@ -3891,7 +3800,6 @@ interface ReservedStock extends Resource {
|
|
|
3891
3800
|
stock_item?: StockItem | null;
|
|
3892
3801
|
sku?: Sku | null;
|
|
3893
3802
|
stock_reservations?: StockReservation[] | null;
|
|
3894
|
-
versions?: Version[] | null;
|
|
3895
3803
|
event_stores?: EventStore[] | null;
|
|
3896
3804
|
}
|
|
3897
3805
|
declare class ReservedStocks extends ApiResource<ReservedStock> {
|
|
@@ -3899,7 +3807,6 @@ declare class ReservedStocks extends ApiResource<ReservedStock> {
|
|
|
3899
3807
|
stock_item(reservedStockId: string | ReservedStock, params?: QueryParamsRetrieve<StockItem>, options?: ResourcesConfig): Promise<StockItem>;
|
|
3900
3808
|
sku(reservedStockId: string | ReservedStock, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
|
3901
3809
|
stock_reservations(reservedStockId: string | ReservedStock, params?: QueryParamsList<StockReservation>, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
|
3902
|
-
versions(reservedStockId: string | ReservedStock, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
3903
3810
|
event_stores(reservedStockId: string | ReservedStock, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
3904
3811
|
isReservedStock(resource: any): resource is ReservedStock;
|
|
3905
3812
|
relationship(id: string | ResourceId | null): ReservedStockRel;
|
|
@@ -4024,7 +3931,6 @@ interface ShippingZone extends Resource {
|
|
|
4024
3931
|
*/
|
|
4025
3932
|
not_zip_code_regex?: string | null;
|
|
4026
3933
|
attachments?: Attachment[] | null;
|
|
4027
|
-
versions?: Version[] | null;
|
|
4028
3934
|
event_stores?: EventStore[] | null;
|
|
4029
3935
|
}
|
|
4030
3936
|
interface ShippingZoneCreate extends ResourceCreate {
|
|
@@ -4107,7 +4013,6 @@ declare class ShippingZones extends ApiResource<ShippingZone> {
|
|
|
4107
4013
|
update(resource: ShippingZoneUpdate, params?: QueryParamsRetrieve<ShippingZone>, options?: ResourcesConfig): Promise<ShippingZone>;
|
|
4108
4014
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
4109
4015
|
attachments(shippingZoneId: string | ShippingZone, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4110
|
-
versions(shippingZoneId: string | ShippingZone, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4111
4016
|
event_stores(shippingZoneId: string | ShippingZone, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4112
4017
|
isShippingZone(resource: any): resource is ShippingZone;
|
|
4113
4018
|
relationship(id: string | ResourceId | null): ShippingZoneRel$2;
|
|
@@ -4151,7 +4056,6 @@ interface DeliveryLeadTime extends Resource {
|
|
|
4151
4056
|
stock_location?: StockLocation | null;
|
|
4152
4057
|
shipping_method?: ShippingMethod | null;
|
|
4153
4058
|
attachments?: Attachment[] | null;
|
|
4154
|
-
versions?: Version[] | null;
|
|
4155
4059
|
event_stores?: EventStore[] | null;
|
|
4156
4060
|
}
|
|
4157
4061
|
interface DeliveryLeadTimeCreate extends ResourceCreate {
|
|
@@ -4190,7 +4094,6 @@ declare class DeliveryLeadTimes extends ApiResource<DeliveryLeadTime> {
|
|
|
4190
4094
|
stock_location(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsRetrieve<StockLocation>, options?: ResourcesConfig): Promise<StockLocation>;
|
|
4191
4095
|
shipping_method(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4192
4096
|
attachments(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4193
|
-
versions(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4194
4097
|
event_stores(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4195
4098
|
isDeliveryLeadTime(resource: any): resource is DeliveryLeadTime;
|
|
4196
4099
|
relationship(id: string | ResourceId | null): DeliveryLeadTimeRel$1;
|
|
@@ -4232,14 +4135,12 @@ interface ShippingMethodTier extends Resource {
|
|
|
4232
4135
|
formatted_price_amount?: string | null;
|
|
4233
4136
|
shipping_method?: ShippingMethod | null;
|
|
4234
4137
|
attachments?: Attachment[] | null;
|
|
4235
|
-
versions?: Version[] | null;
|
|
4236
4138
|
event_stores?: EventStore[] | null;
|
|
4237
4139
|
}
|
|
4238
4140
|
declare class ShippingMethodTiers extends ApiResource<ShippingMethodTier> {
|
|
4239
4141
|
static readonly TYPE: ShippingMethodTierType;
|
|
4240
4142
|
shipping_method(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4241
4143
|
attachments(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4242
|
-
versions(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4243
4144
|
event_stores(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4244
4145
|
isShippingMethodTier(resource: any): resource is ShippingMethodTier;
|
|
4245
4146
|
relationship(id: string | ResourceId | null): ShippingMethodTierRel$2;
|
|
@@ -4284,8 +4185,8 @@ interface ShippingWeightTier extends Resource {
|
|
|
4284
4185
|
formatted_price_amount?: string | null;
|
|
4285
4186
|
shipping_method?: ShippingMethod | null;
|
|
4286
4187
|
attachments?: Attachment[] | null;
|
|
4287
|
-
versions?: Version[] | null;
|
|
4288
4188
|
event_stores?: EventStore[] | null;
|
|
4189
|
+
events?: Event[] | null;
|
|
4289
4190
|
}
|
|
4290
4191
|
interface ShippingWeightTierCreate extends ResourceCreate {
|
|
4291
4192
|
/**
|
|
@@ -4330,8 +4231,8 @@ declare class ShippingWeightTiers extends ApiResource<ShippingWeightTier> {
|
|
|
4330
4231
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
4331
4232
|
shipping_method(shippingWeightTierId: string | ShippingWeightTier, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4332
4233
|
attachments(shippingWeightTierId: string | ShippingWeightTier, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4333
|
-
versions(shippingWeightTierId: string | ShippingWeightTier, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4334
4234
|
event_stores(shippingWeightTierId: string | ShippingWeightTier, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4235
|
+
events(shippingWeightTierId: string | ShippingWeightTier, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
4335
4236
|
isShippingWeightTier(resource: any): resource is ShippingWeightTier;
|
|
4336
4237
|
relationship(id: string | ResourceId | null): ShippingWeightTierRel;
|
|
4337
4238
|
relationshipToMany(...ids: string[]): ShippingWeightTierRel[];
|
|
@@ -4487,7 +4388,6 @@ interface ShippingMethod extends Resource {
|
|
|
4487
4388
|
notifications?: Notification[] | null;
|
|
4488
4389
|
events?: Event[] | null;
|
|
4489
4390
|
tags?: Tag[] | null;
|
|
4490
|
-
versions?: Version[] | null;
|
|
4491
4391
|
event_stores?: EventStore[] | null;
|
|
4492
4392
|
}
|
|
4493
4393
|
interface ShippingMethodCreate extends ResourceCreate {
|
|
@@ -4675,7 +4575,6 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
|
4675
4575
|
notifications(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Notification>, options?: ResourcesConfig): Promise<ListResponse<Notification>>;
|
|
4676
4576
|
events(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
4677
4577
|
tags(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
4678
|
-
versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4679
4578
|
event_stores(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4680
4579
|
_disable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4681
4580
|
_enable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
@@ -4797,7 +4696,6 @@ interface SkuListItem extends Resource {
|
|
|
4797
4696
|
quantity?: number | null;
|
|
4798
4697
|
sku_list?: SkuList | null;
|
|
4799
4698
|
sku?: Sku | null;
|
|
4800
|
-
versions?: Version[] | null;
|
|
4801
4699
|
event_stores?: EventStore[] | null;
|
|
4802
4700
|
}
|
|
4803
4701
|
interface SkuListItemCreate extends ResourceCreate {
|
|
@@ -4843,7 +4741,6 @@ declare class SkuListItems extends ApiResource<SkuListItem> {
|
|
|
4843
4741
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
4844
4742
|
sku_list(skuListItemId: string | SkuListItem, params?: QueryParamsRetrieve<SkuList>, options?: ResourcesConfig): Promise<SkuList>;
|
|
4845
4743
|
sku(skuListItemId: string | SkuListItem, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
|
4846
|
-
versions(skuListItemId: string | SkuListItem, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4847
4744
|
event_stores(skuListItemId: string | SkuListItem, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4848
4745
|
isSkuListItem(resource: any): resource is SkuListItem;
|
|
4849
4746
|
relationship(id: string | ResourceId | null): SkuListItemRel;
|
|
@@ -5092,7 +4989,6 @@ interface SkuList extends Resource {
|
|
|
5092
4989
|
bundles?: Bundle[] | null;
|
|
5093
4990
|
attachments?: Attachment[] | null;
|
|
5094
4991
|
links?: Link[] | null;
|
|
5095
|
-
versions?: Version[] | null;
|
|
5096
4992
|
event_stores?: EventStore[] | null;
|
|
5097
4993
|
}
|
|
5098
4994
|
interface SkuListCreate extends ResourceCreate {
|
|
@@ -5160,7 +5056,6 @@ declare class SkuLists extends ApiResource<SkuList> {
|
|
|
5160
5056
|
bundles(skuListId: string | SkuList, params?: QueryParamsList<Bundle>, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
|
|
5161
5057
|
attachments(skuListId: string | SkuList, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5162
5058
|
links(skuListId: string | SkuList, params?: QueryParamsList<Link>, options?: ResourcesConfig): Promise<ListResponse<Link>>;
|
|
5163
|
-
versions(skuListId: string | SkuList, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5164
5059
|
event_stores(skuListId: string | SkuList, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5165
5060
|
isSkuList(resource: any): resource is SkuList;
|
|
5166
5061
|
relationship(id: string | ResourceId | null): SkuListRel$a;
|
|
@@ -5258,7 +5153,6 @@ interface Bundle extends Resource {
|
|
|
5258
5153
|
attachments?: Attachment[] | null;
|
|
5259
5154
|
events?: Event[] | null;
|
|
5260
5155
|
tags?: Tag[] | null;
|
|
5261
|
-
versions?: Version[] | null;
|
|
5262
5156
|
event_stores?: EventStore[] | null;
|
|
5263
5157
|
}
|
|
5264
5158
|
interface BundleCreate extends ResourceCreate {
|
|
@@ -5378,7 +5272,6 @@ declare class Bundles extends ApiResource<Bundle> {
|
|
|
5378
5272
|
attachments(bundleId: string | Bundle, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5379
5273
|
events(bundleId: string | Bundle, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
5380
5274
|
tags(bundleId: string | Bundle, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
5381
|
-
versions(bundleId: string | Bundle, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5382
5275
|
event_stores(bundleId: string | Bundle, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5383
5276
|
_compute_price_amount(id: string | Bundle, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
|
5384
5277
|
_compute_compare_at_amount(id: string | Bundle, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
|
@@ -5418,7 +5311,6 @@ interface GiftCardRecipient extends Resource {
|
|
|
5418
5311
|
customer?: Customer | null;
|
|
5419
5312
|
event_stores?: EventStore[] | null;
|
|
5420
5313
|
attachments?: Attachment[] | null;
|
|
5421
|
-
versions?: Version[] | null;
|
|
5422
5314
|
}
|
|
5423
5315
|
interface GiftCardRecipientCreate extends ResourceCreate {
|
|
5424
5316
|
/**
|
|
@@ -5464,7 +5356,6 @@ declare class GiftCardRecipients extends ApiResource<GiftCardRecipient> {
|
|
|
5464
5356
|
customer(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
5465
5357
|
event_stores(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5466
5358
|
attachments(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5467
|
-
versions(giftCardRecipientId: string | GiftCardRecipient, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5468
5359
|
isGiftCardRecipient(resource: any): resource is GiftCardRecipient;
|
|
5469
5360
|
relationship(id: string | ResourceId | null): GiftCardRecipientRel$2;
|
|
5470
5361
|
relationshipToMany(...ids: string[]): GiftCardRecipientRel$2[];
|
|
@@ -5591,7 +5482,6 @@ interface GiftCard extends Resource {
|
|
|
5591
5482
|
attachments?: Attachment[] | null;
|
|
5592
5483
|
events?: Event[] | null;
|
|
5593
5484
|
tags?: Tag[] | null;
|
|
5594
|
-
versions?: Version[] | null;
|
|
5595
5485
|
event_stores?: EventStore[] | null;
|
|
5596
5486
|
}
|
|
5597
5487
|
interface GiftCardCreate extends ResourceCreate {
|
|
@@ -5735,7 +5625,6 @@ declare class GiftCards extends ApiResource<GiftCard> {
|
|
|
5735
5625
|
attachments(giftCardId: string | GiftCard, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5736
5626
|
events(giftCardId: string | GiftCard, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
5737
5627
|
tags(giftCardId: string | GiftCard, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
5738
|
-
versions(giftCardId: string | GiftCard, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5739
5628
|
event_stores(giftCardId: string | GiftCard, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5740
5629
|
_purchase(id: string | GiftCard, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
|
5741
5630
|
_activate(id: string | GiftCard, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
|
@@ -5786,7 +5675,6 @@ interface Adjustment extends Resource {
|
|
|
5786
5675
|
* @example ```true```
|
|
5787
5676
|
*/
|
|
5788
5677
|
distribute_discount?: boolean | null;
|
|
5789
|
-
versions?: Version[] | null;
|
|
5790
5678
|
event_stores?: EventStore[] | null;
|
|
5791
5679
|
}
|
|
5792
5680
|
interface AdjustmentCreate extends ResourceCreate {
|
|
@@ -5838,7 +5726,6 @@ declare class Adjustments extends ApiResource<Adjustment> {
|
|
|
5838
5726
|
create(resource: AdjustmentCreate, params?: QueryParamsRetrieve<Adjustment>, options?: ResourcesConfig): Promise<Adjustment>;
|
|
5839
5727
|
update(resource: AdjustmentUpdate, params?: QueryParamsRetrieve<Adjustment>, options?: ResourcesConfig): Promise<Adjustment>;
|
|
5840
5728
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
5841
|
-
versions(adjustmentId: string | Adjustment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5842
5729
|
event_stores(adjustmentId: string | Adjustment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5843
5730
|
isAdjustment(resource: any): resource is Adjustment;
|
|
5844
5731
|
relationship(id: string | ResourceId | null): AdjustmentRel$2;
|
|
@@ -5865,7 +5752,6 @@ interface DiscountEngine extends Resource {
|
|
|
5865
5752
|
markets?: Market[] | null;
|
|
5866
5753
|
discount_engine_items?: DiscountEngineItem[] | null;
|
|
5867
5754
|
attachments?: Attachment[] | null;
|
|
5868
|
-
versions?: Version[] | null;
|
|
5869
5755
|
event_stores?: EventStore[] | null;
|
|
5870
5756
|
}
|
|
5871
5757
|
declare class DiscountEngines extends ApiResource<DiscountEngine> {
|
|
@@ -5873,7 +5759,6 @@ declare class DiscountEngines extends ApiResource<DiscountEngine> {
|
|
|
5873
5759
|
markets(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
5874
5760
|
discount_engine_items(discountEngineId: string | DiscountEngine, params?: QueryParamsList<DiscountEngineItem>, options?: ResourcesConfig): Promise<ListResponse<DiscountEngineItem>>;
|
|
5875
5761
|
attachments(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5876
|
-
versions(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5877
5762
|
event_stores(discountEngineId: string | DiscountEngine, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5878
5763
|
isDiscountEngine(resource: any): resource is DiscountEngine;
|
|
5879
5764
|
relationship(id: string | ResourceId | null): DiscountEngineRel$2;
|
|
@@ -5936,7 +5821,6 @@ interface CouponRecipient extends Resource {
|
|
|
5936
5821
|
customer?: Customer | null;
|
|
5937
5822
|
event_stores?: EventStore[] | null;
|
|
5938
5823
|
attachments?: Attachment[] | null;
|
|
5939
|
-
versions?: Version[] | null;
|
|
5940
5824
|
}
|
|
5941
5825
|
interface CouponRecipientCreate extends ResourceCreate {
|
|
5942
5826
|
/**
|
|
@@ -5982,7 +5866,6 @@ declare class CouponRecipients extends ApiResource<CouponRecipient> {
|
|
|
5982
5866
|
customer(couponRecipientId: string | CouponRecipient, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
5983
5867
|
event_stores(couponRecipientId: string | CouponRecipient, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
5984
5868
|
attachments(couponRecipientId: string | CouponRecipient, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
5985
|
-
versions(couponRecipientId: string | CouponRecipient, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
5986
5869
|
isCouponRecipient(resource: any): resource is CouponRecipient;
|
|
5987
5870
|
relationship(id: string | ResourceId | null): CouponRecipientRel$2;
|
|
5988
5871
|
relationshipToMany(...ids: string[]): CouponRecipientRel$2[];
|
|
@@ -6038,7 +5921,6 @@ interface Coupon extends Resource {
|
|
|
6038
5921
|
coupon_recipient?: CouponRecipient | null;
|
|
6039
5922
|
events?: Event[] | null;
|
|
6040
5923
|
tags?: Tag[] | null;
|
|
6041
|
-
versions?: Version[] | null;
|
|
6042
5924
|
event_stores?: EventStore[] | null;
|
|
6043
5925
|
}
|
|
6044
5926
|
interface CouponCreate extends ResourceCreate {
|
|
@@ -6116,7 +5998,6 @@ declare class Coupons extends ApiResource<Coupon> {
|
|
|
6116
5998
|
coupon_recipient(couponId: string | Coupon, params?: QueryParamsRetrieve<CouponRecipient>, options?: ResourcesConfig): Promise<CouponRecipient>;
|
|
6117
5999
|
events(couponId: string | Coupon, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
6118
6000
|
tags(couponId: string | Coupon, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
6119
|
-
versions(couponId: string | Coupon, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
6120
6001
|
event_stores(couponId: string | Coupon, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
6121
6002
|
_add_tags(id: string | Coupon, triggerValue: string, params?: QueryParamsRetrieve<Coupon>, options?: ResourcesConfig): Promise<Coupon>;
|
|
6122
6003
|
_remove_tags(id: string | Coupon, triggerValue: string, params?: QueryParamsRetrieve<Coupon>, options?: ResourcesConfig): Promise<Coupon>;
|
|
@@ -6223,11 +6104,6 @@ interface ExternalPromotion extends Resource {
|
|
|
6223
6104
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
6224
6105
|
*/
|
|
6225
6106
|
disabled_at?: string | null;
|
|
6226
|
-
/**
|
|
6227
|
-
* The URL to the service that will compute the discount.
|
|
6228
|
-
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6229
|
-
*/
|
|
6230
|
-
promotion_url: string;
|
|
6231
6107
|
/**
|
|
6232
6108
|
* The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
|
|
6233
6109
|
* @example ```"closed"```
|
|
@@ -6248,6 +6124,11 @@ interface ExternalPromotion extends Resource {
|
|
|
6248
6124
|
* @example ```["order.line_item_options"]```
|
|
6249
6125
|
*/
|
|
6250
6126
|
external_includes?: string[] | null;
|
|
6127
|
+
/**
|
|
6128
|
+
* The URL to the service that will compute the discount.
|
|
6129
|
+
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6130
|
+
*/
|
|
6131
|
+
promotion_url: string;
|
|
6251
6132
|
market?: Market | null;
|
|
6252
6133
|
promotion_rules?: PromotionRule[] | null;
|
|
6253
6134
|
order_amount_promotion_rule?: OrderAmountPromotionRule | null;
|
|
@@ -6259,7 +6140,6 @@ interface ExternalPromotion extends Resource {
|
|
|
6259
6140
|
attachments?: Attachment[] | null;
|
|
6260
6141
|
events?: Event[] | null;
|
|
6261
6142
|
tags?: Tag[] | null;
|
|
6262
|
-
versions?: Version[] | null;
|
|
6263
6143
|
event_stores?: EventStore[] | null;
|
|
6264
6144
|
skus?: Sku[] | null;
|
|
6265
6145
|
}
|
|
@@ -6309,16 +6189,16 @@ interface ExternalPromotionCreate extends ResourceCreate {
|
|
|
6309
6189
|
* @example ```true```
|
|
6310
6190
|
*/
|
|
6311
6191
|
_enable?: boolean | null;
|
|
6312
|
-
/**
|
|
6313
|
-
* The URL to the service that will compute the discount.
|
|
6314
|
-
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6315
|
-
*/
|
|
6316
|
-
promotion_url: string;
|
|
6317
6192
|
/**
|
|
6318
6193
|
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
6319
6194
|
* @example ```["order.line_item_options"]```
|
|
6320
6195
|
*/
|
|
6321
6196
|
external_includes?: string[] | null;
|
|
6197
|
+
/**
|
|
6198
|
+
* The URL to the service that will compute the discount.
|
|
6199
|
+
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6200
|
+
*/
|
|
6201
|
+
promotion_url: string;
|
|
6322
6202
|
market?: MarketRel$d | null;
|
|
6323
6203
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
|
|
6324
6204
|
sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
|
|
@@ -6381,11 +6261,6 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
|
|
|
6381
6261
|
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
|
6382
6262
|
*/
|
|
6383
6263
|
_remove_tags?: string | null;
|
|
6384
|
-
/**
|
|
6385
|
-
* The URL to the service that will compute the discount.
|
|
6386
|
-
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6387
|
-
*/
|
|
6388
|
-
promotion_url?: string | null;
|
|
6389
6264
|
/**
|
|
6390
6265
|
* Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
|
|
6391
6266
|
* @example ```true```
|
|
@@ -6396,6 +6271,11 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
|
|
|
6396
6271
|
* @example ```["order.line_item_options"]```
|
|
6397
6272
|
*/
|
|
6398
6273
|
external_includes?: string[] | null;
|
|
6274
|
+
/**
|
|
6275
|
+
* The URL to the service that will compute the discount.
|
|
6276
|
+
* @example ```"https://external_promotion.yourbrand.com"```
|
|
6277
|
+
*/
|
|
6278
|
+
promotion_url?: string | null;
|
|
6399
6279
|
market?: MarketRel$d | null;
|
|
6400
6280
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
|
|
6401
6281
|
sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
|
|
@@ -6419,7 +6299,6 @@ declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
|
|
|
6419
6299
|
attachments(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
6420
6300
|
events(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
6421
6301
|
tags(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
6422
|
-
versions(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
6423
6302
|
event_stores(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
6424
6303
|
skus(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
6425
6304
|
_disable(id: string | ExternalPromotion, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
|
@@ -6556,7 +6435,6 @@ interface FixedAmountPromotion extends Resource {
|
|
|
6556
6435
|
attachments?: Attachment[] | null;
|
|
6557
6436
|
events?: Event[] | null;
|
|
6558
6437
|
tags?: Tag[] | null;
|
|
6559
|
-
versions?: Version[] | null;
|
|
6560
6438
|
event_stores?: EventStore[] | null;
|
|
6561
6439
|
skus?: Sku[] | null;
|
|
6562
6440
|
}
|
|
@@ -6701,7 +6579,6 @@ declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
|
|
|
6701
6579
|
attachments(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
6702
6580
|
events(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
6703
6581
|
tags(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
6704
|
-
versions(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
6705
6582
|
event_stores(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
6706
6583
|
skus(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
6707
6584
|
_disable(id: string | FixedAmountPromotion, params?: QueryParamsRetrieve<FixedAmountPromotion>, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
|
|
@@ -6797,7 +6674,6 @@ interface FlexPromotion extends Resource {
|
|
|
6797
6674
|
attachments?: Attachment[] | null;
|
|
6798
6675
|
events?: Event[] | null;
|
|
6799
6676
|
tags?: Tag[] | null;
|
|
6800
|
-
versions?: Version[] | null;
|
|
6801
6677
|
event_stores?: EventStore[] | null;
|
|
6802
6678
|
}
|
|
6803
6679
|
interface FlexPromotionCreate extends ResourceCreate {
|
|
@@ -6916,7 +6792,6 @@ declare class FlexPromotions extends ApiResource<FlexPromotion> {
|
|
|
6916
6792
|
attachments(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
6917
6793
|
events(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
6918
6794
|
tags(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
6919
|
-
versions(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
6920
6795
|
event_stores(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
6921
6796
|
_disable(id: string | FlexPromotion, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
|
6922
6797
|
_enable(id: string | FlexPromotion, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
|
@@ -6936,12 +6811,10 @@ type PromotionRuleSort = Pick<PromotionRule, 'id'> & ResourceSort;
|
|
|
6936
6811
|
interface PromotionRule extends Resource {
|
|
6937
6812
|
readonly type: PromotionRuleType;
|
|
6938
6813
|
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | FlexPromotion | null;
|
|
6939
|
-
versions?: Version[] | null;
|
|
6940
6814
|
event_stores?: EventStore[] | null;
|
|
6941
6815
|
}
|
|
6942
6816
|
declare class PromotionRules extends ApiResource<PromotionRule> {
|
|
6943
6817
|
static readonly TYPE: PromotionRuleType;
|
|
6944
|
-
versions(promotionRuleId: string | PromotionRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
6945
6818
|
event_stores(promotionRuleId: string | PromotionRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
6946
6819
|
isPromotionRule(resource: any): resource is PromotionRule;
|
|
6947
6820
|
relationship(id: string | ResourceId | null): PromotionRuleRel;
|
|
@@ -7072,7 +6945,6 @@ interface FixedPricePromotion extends Resource {
|
|
|
7072
6945
|
attachments?: Attachment[] | null;
|
|
7073
6946
|
events?: Event[] | null;
|
|
7074
6947
|
tags?: Tag[] | null;
|
|
7075
|
-
versions?: Version[] | null;
|
|
7076
6948
|
event_stores?: EventStore[] | null;
|
|
7077
6949
|
skus?: Sku[] | null;
|
|
7078
6950
|
}
|
|
@@ -7217,7 +7089,6 @@ declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
|
|
|
7217
7089
|
attachments(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
7218
7090
|
events(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
7219
7091
|
tags(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
7220
|
-
versions(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
7221
7092
|
event_stores(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
7222
7093
|
skus(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
7223
7094
|
_disable(id: string | FixedPricePromotion, params?: QueryParamsRetrieve<FixedPricePromotion>, options?: ResourcesConfig): Promise<FixedPricePromotion>;
|
|
@@ -7267,7 +7138,6 @@ interface CustomPromotionRule extends Resource {
|
|
|
7267
7138
|
*/
|
|
7268
7139
|
filters?: Record<string, any> | null;
|
|
7269
7140
|
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | FlexPromotion | null;
|
|
7270
|
-
versions?: Version[] | null;
|
|
7271
7141
|
event_stores?: EventStore[] | null;
|
|
7272
7142
|
}
|
|
7273
7143
|
interface CustomPromotionRuleCreate extends ResourceCreate {
|
|
@@ -7291,7 +7161,6 @@ declare class CustomPromotionRules extends ApiResource<CustomPromotionRule> {
|
|
|
7291
7161
|
create(resource: CustomPromotionRuleCreate, params?: QueryParamsRetrieve<CustomPromotionRule>, options?: ResourcesConfig): Promise<CustomPromotionRule>;
|
|
7292
7162
|
update(resource: CustomPromotionRuleUpdate, params?: QueryParamsRetrieve<CustomPromotionRule>, options?: ResourcesConfig): Promise<CustomPromotionRule>;
|
|
7293
7163
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
7294
|
-
versions(customPromotionRuleId: string | CustomPromotionRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
7295
7164
|
event_stores(customPromotionRuleId: string | CustomPromotionRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
7296
7165
|
isCustomPromotionRule(resource: any): resource is CustomPromotionRule;
|
|
7297
7166
|
relationship(id: string | ResourceId | null): CustomPromotionRuleRel$4;
|
|
@@ -7412,7 +7281,6 @@ interface FreeGiftPromotion extends Resource {
|
|
|
7412
7281
|
attachments?: Attachment[] | null;
|
|
7413
7282
|
events?: Event[] | null;
|
|
7414
7283
|
tags?: Tag[] | null;
|
|
7415
|
-
versions?: Version[] | null;
|
|
7416
7284
|
event_stores?: EventStore[] | null;
|
|
7417
7285
|
skus?: Sku[] | null;
|
|
7418
7286
|
}
|
|
@@ -7557,7 +7425,6 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
|
|
|
7557
7425
|
attachments(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
7558
7426
|
events(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
7559
7427
|
tags(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
7560
|
-
versions(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
7561
7428
|
event_stores(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
7562
7429
|
skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
7563
7430
|
_disable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve<FreeGiftPromotion>, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
|
@@ -7605,7 +7472,6 @@ type CouponCodesPromotionRuleSort = Pick<CouponCodesPromotionRule, 'id'> & Resou
|
|
|
7605
7472
|
interface CouponCodesPromotionRule extends Resource {
|
|
7606
7473
|
readonly type: CouponCodesPromotionRuleType;
|
|
7607
7474
|
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | FlexPromotion | null;
|
|
7608
|
-
versions?: Version[] | null;
|
|
7609
7475
|
event_stores?: EventStore[] | null;
|
|
7610
7476
|
coupons?: Coupon[] | null;
|
|
7611
7477
|
}
|
|
@@ -7622,7 +7488,6 @@ declare class CouponCodesPromotionRules extends ApiResource<CouponCodesPromotion
|
|
|
7622
7488
|
create(resource: CouponCodesPromotionRuleCreate, params?: QueryParamsRetrieve<CouponCodesPromotionRule>, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
|
7623
7489
|
update(resource: CouponCodesPromotionRuleUpdate, params?: QueryParamsRetrieve<CouponCodesPromotionRule>, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
|
|
7624
7490
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
7625
|
-
versions(couponCodesPromotionRuleId: string | CouponCodesPromotionRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
7626
7491
|
event_stores(couponCodesPromotionRuleId: string | CouponCodesPromotionRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
7627
7492
|
coupons(couponCodesPromotionRuleId: string | CouponCodesPromotionRule, params?: QueryParamsList<Coupon>, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
|
|
7628
7493
|
isCouponCodesPromotionRule(resource: any): resource is CouponCodesPromotionRule;
|
|
@@ -7754,7 +7619,6 @@ interface BuyXPayYPromotion extends Resource {
|
|
|
7754
7619
|
attachments?: Attachment[] | null;
|
|
7755
7620
|
events?: Event[] | null;
|
|
7756
7621
|
tags?: Tag[] | null;
|
|
7757
|
-
versions?: Version[] | null;
|
|
7758
7622
|
event_stores?: EventStore[] | null;
|
|
7759
7623
|
skus?: Sku[] | null;
|
|
7760
7624
|
}
|
|
@@ -7919,7 +7783,6 @@ declare class BuyXPayYPromotions extends ApiResource<BuyXPayYPromotion> {
|
|
|
7919
7783
|
attachments(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
7920
7784
|
events(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
7921
7785
|
tags(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
7922
|
-
versions(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
7923
7786
|
event_stores(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
7924
7787
|
skus(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
7925
7788
|
_disable(id: string | BuyXPayYPromotion, params?: QueryParamsRetrieve<BuyXPayYPromotion>, options?: ResourcesConfig): Promise<BuyXPayYPromotion>;
|
|
@@ -7977,7 +7840,6 @@ interface SkuListPromotionRule extends Resource {
|
|
|
7977
7840
|
*/
|
|
7978
7841
|
min_quantity?: number | null;
|
|
7979
7842
|
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | FlexPromotion | null;
|
|
7980
|
-
versions?: Version[] | null;
|
|
7981
7843
|
event_stores?: EventStore[] | null;
|
|
7982
7844
|
sku_list?: SkuList | null;
|
|
7983
7845
|
skus?: Sku[] | null;
|
|
@@ -8015,7 +7877,6 @@ declare class SkuListPromotionRules extends ApiResource<SkuListPromotionRule> {
|
|
|
8015
7877
|
create(resource: SkuListPromotionRuleCreate, params?: QueryParamsRetrieve<SkuListPromotionRule>, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
|
8016
7878
|
update(resource: SkuListPromotionRuleUpdate, params?: QueryParamsRetrieve<SkuListPromotionRule>, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
|
|
8017
7879
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
8018
|
-
versions(skuListPromotionRuleId: string | SkuListPromotionRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
8019
7880
|
event_stores(skuListPromotionRuleId: string | SkuListPromotionRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
8020
7881
|
sku_list(skuListPromotionRuleId: string | SkuListPromotionRule, params?: QueryParamsRetrieve<SkuList>, options?: ResourcesConfig): Promise<SkuList>;
|
|
8021
7882
|
skus(skuListPromotionRuleId: string | SkuListPromotionRule, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
@@ -8133,7 +7994,6 @@ interface FreeShippingPromotion extends Resource {
|
|
|
8133
7994
|
attachments?: Attachment[] | null;
|
|
8134
7995
|
events?: Event[] | null;
|
|
8135
7996
|
tags?: Tag[] | null;
|
|
8136
|
-
versions?: Version[] | null;
|
|
8137
7997
|
event_stores?: EventStore[] | null;
|
|
8138
7998
|
}
|
|
8139
7999
|
interface FreeShippingPromotionCreate extends ResourceCreate {
|
|
@@ -8267,7 +8127,6 @@ declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion>
|
|
|
8267
8127
|
attachments(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
8268
8128
|
events(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
8269
8129
|
tags(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
8270
|
-
versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
8271
8130
|
event_stores(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
8272
8131
|
_disable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
|
8273
8132
|
_enable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
|
@@ -8331,7 +8190,6 @@ interface OrderAmountPromotionRule extends Resource {
|
|
|
8331
8190
|
*/
|
|
8332
8191
|
use_subtotal?: boolean | null;
|
|
8333
8192
|
promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | FlexPromotion | null;
|
|
8334
|
-
versions?: Version[] | null;
|
|
8335
8193
|
event_stores?: EventStore[] | null;
|
|
8336
8194
|
}
|
|
8337
8195
|
interface OrderAmountPromotionRuleCreate extends ResourceCreate {
|
|
@@ -8365,7 +8223,6 @@ declare class OrderAmountPromotionRules extends ApiResource<OrderAmountPromotion
|
|
|
8365
8223
|
create(resource: OrderAmountPromotionRuleCreate, params?: QueryParamsRetrieve<OrderAmountPromotionRule>, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
|
|
8366
8224
|
update(resource: OrderAmountPromotionRuleUpdate, params?: QueryParamsRetrieve<OrderAmountPromotionRule>, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
|
|
8367
8225
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
8368
|
-
versions(orderAmountPromotionRuleId: string | OrderAmountPromotionRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
8369
8226
|
event_stores(orderAmountPromotionRuleId: string | OrderAmountPromotionRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
8370
8227
|
isOrderAmountPromotionRule(resource: any): resource is OrderAmountPromotionRule;
|
|
8371
8228
|
relationship(id: string | ResourceId | null): OrderAmountPromotionRuleRel$1;
|
|
@@ -8486,7 +8343,6 @@ interface PercentageDiscountPromotion extends Resource {
|
|
|
8486
8343
|
attachments?: Attachment[] | null;
|
|
8487
8344
|
events?: Event[] | null;
|
|
8488
8345
|
tags?: Tag[] | null;
|
|
8489
|
-
versions?: Version[] | null;
|
|
8490
8346
|
event_stores?: EventStore[] | null;
|
|
8491
8347
|
skus?: Sku[] | null;
|
|
8492
8348
|
}
|
|
@@ -8631,7 +8487,6 @@ declare class PercentageDiscountPromotions extends ApiResource<PercentageDiscoun
|
|
|
8631
8487
|
attachments(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
8632
8488
|
events(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
8633
8489
|
tags(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
8634
|
-
versions(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
8635
8490
|
event_stores(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
8636
8491
|
skus(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
|
8637
8492
|
_disable(id: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve<PercentageDiscountPromotion>, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
|
@@ -9452,7 +9307,6 @@ interface OrderSubscription extends Resource {
|
|
|
9452
9307
|
orders?: Order[] | null;
|
|
9453
9308
|
events?: Event[] | null;
|
|
9454
9309
|
tags?: Tag[] | null;
|
|
9455
|
-
versions?: Version[] | null;
|
|
9456
9310
|
event_stores?: EventStore[] | null;
|
|
9457
9311
|
}
|
|
9458
9312
|
interface OrderSubscriptionCreate extends ResourceCreate {
|
|
@@ -9568,7 +9422,6 @@ declare class OrderSubscriptions extends ApiResource<OrderSubscription> {
|
|
|
9568
9422
|
orders(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
|
9569
9423
|
events(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
9570
9424
|
tags(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
9571
|
-
versions(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
9572
9425
|
event_stores(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
9573
9426
|
_activate(id: string | OrderSubscription, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
|
9574
9427
|
_deactivate(id: string | OrderSubscription, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
|
@@ -9640,10 +9493,10 @@ interface Customer extends Resource {
|
|
|
9640
9493
|
*/
|
|
9641
9494
|
anonymization_info?: Record<string, any> | null;
|
|
9642
9495
|
/**
|
|
9643
|
-
* Status of the current anonymization request (if any).
|
|
9496
|
+
* Status of the current anonymization request (if any). One of 'requested', 'started', 'completed', 'failed', or 'cancelled'.
|
|
9644
9497
|
* @example ```"requested"```
|
|
9645
9498
|
*/
|
|
9646
|
-
anonymization_status?:
|
|
9499
|
+
anonymization_status?: 'requested' | 'started' | 'completed' | 'failed' | 'cancelled' | null;
|
|
9647
9500
|
customer_group?: CustomerGroup | null;
|
|
9648
9501
|
customer_addresses?: CustomerAddress[] | null;
|
|
9649
9502
|
customer_payment_sources?: CustomerPaymentSource[] | null;
|
|
@@ -10605,7 +10458,6 @@ interface Order extends Resource {
|
|
|
10605
10458
|
resource_errors?: ResourceError[] | null;
|
|
10606
10459
|
events?: Event[] | null;
|
|
10607
10460
|
tags?: Tag[] | null;
|
|
10608
|
-
versions?: Version[] | null;
|
|
10609
10461
|
event_stores?: EventStore[] | null;
|
|
10610
10462
|
}
|
|
10611
10463
|
interface OrderCreate extends ResourceCreate {
|
|
@@ -11044,7 +10896,6 @@ declare class Orders extends ApiResource<Order> {
|
|
|
11044
10896
|
resource_errors(orderId: string | Order, params?: QueryParamsList<ResourceError>, options?: ResourcesConfig): Promise<ListResponse<ResourceError>>;
|
|
11045
10897
|
events(orderId: string | Order, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
11046
10898
|
tags(orderId: string | Order, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
11047
|
-
versions(orderId: string | Order, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
11048
10899
|
event_stores(orderId: string | Order, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
11049
10900
|
_archive(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
11050
10901
|
_unarchive(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
@@ -11129,7 +10980,6 @@ interface Package extends Resource {
|
|
|
11129
10980
|
stock_location?: StockLocation | null;
|
|
11130
10981
|
parcels?: Parcel[] | null;
|
|
11131
10982
|
attachments?: Attachment[] | null;
|
|
11132
|
-
versions?: Version[] | null;
|
|
11133
10983
|
event_stores?: EventStore[] | null;
|
|
11134
10984
|
}
|
|
11135
10985
|
interface PackageCreate extends ResourceCreate {
|
|
@@ -11206,7 +11056,6 @@ declare class Packages extends ApiResource<Package> {
|
|
|
11206
11056
|
stock_location(packageId: string | Package, params?: QueryParamsRetrieve<StockLocation>, options?: ResourcesConfig): Promise<StockLocation>;
|
|
11207
11057
|
parcels(packageId: string | Package, params?: QueryParamsList<Parcel>, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
|
|
11208
11058
|
attachments(packageId: string | Package, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
11209
|
-
versions(packageId: string | Package, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
11210
11059
|
event_stores(packageId: string | Package, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
11211
11060
|
isPackage(resource: any): resource is Package;
|
|
11212
11061
|
relationship(id: string | ResourceId | null): PackageRel$2;
|
|
@@ -11254,7 +11103,6 @@ interface ParcelLineItem extends Resource {
|
|
|
11254
11103
|
image_url?: string | null;
|
|
11255
11104
|
parcel?: Parcel | null;
|
|
11256
11105
|
stock_line_item?: StockLineItem | null;
|
|
11257
|
-
versions?: Version[] | null;
|
|
11258
11106
|
event_stores?: EventStore[] | null;
|
|
11259
11107
|
}
|
|
11260
11108
|
interface ParcelLineItemCreate extends ResourceCreate {
|
|
@@ -11274,7 +11122,6 @@ declare class ParcelLineItems extends ApiResource<ParcelLineItem> {
|
|
|
11274
11122
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
11275
11123
|
parcel(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve<Parcel>, options?: ResourcesConfig): Promise<Parcel>;
|
|
11276
11124
|
stock_line_item(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve<StockLineItem>, options?: ResourcesConfig): Promise<StockLineItem>;
|
|
11277
|
-
versions(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
11278
11125
|
event_stores(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
11279
11126
|
isParcelLineItem(resource: any): resource is ParcelLineItem;
|
|
11280
11127
|
relationship(id: string | ResourceId | null): ParcelLineItemRel;
|
|
@@ -11421,7 +11268,6 @@ interface Parcel extends Resource {
|
|
|
11421
11268
|
parcel_line_items?: ParcelLineItem[] | null;
|
|
11422
11269
|
attachments?: Attachment[] | null;
|
|
11423
11270
|
events?: Event[] | null;
|
|
11424
|
-
versions?: Version[] | null;
|
|
11425
11271
|
event_stores?: EventStore[] | null;
|
|
11426
11272
|
}
|
|
11427
11273
|
interface ParcelCreate extends ResourceCreate {
|
|
@@ -11674,7 +11520,6 @@ declare class Parcels extends ApiResource<Parcel> {
|
|
|
11674
11520
|
parcel_line_items(parcelId: string | Parcel, params?: QueryParamsList<ParcelLineItem>, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
|
|
11675
11521
|
attachments(parcelId: string | Parcel, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
11676
11522
|
events(parcelId: string | Parcel, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
11677
|
-
versions(parcelId: string | Parcel, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
11678
11523
|
event_stores(parcelId: string | Parcel, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
11679
11524
|
isParcel(resource: any): resource is Parcel;
|
|
11680
11525
|
relationship(id: string | ResourceId | null): ParcelRel$1;
|
|
@@ -11748,7 +11593,6 @@ interface CarrierAccount extends Resource {
|
|
|
11748
11593
|
credentials: Record<string, any>;
|
|
11749
11594
|
market?: Market | null;
|
|
11750
11595
|
attachments?: Attachment[] | null;
|
|
11751
|
-
versions?: Version[] | null;
|
|
11752
11596
|
event_stores?: EventStore[] | null;
|
|
11753
11597
|
}
|
|
11754
11598
|
interface CarrierAccountCreate extends ResourceCreate {
|
|
@@ -11794,7 +11638,6 @@ declare class CarrierAccounts extends ApiResource<CarrierAccount> {
|
|
|
11794
11638
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
11795
11639
|
market(carrierAccountId: string | CarrierAccount, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
|
11796
11640
|
attachments(carrierAccountId: string | CarrierAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
11797
|
-
versions(carrierAccountId: string | CarrierAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
11798
11641
|
event_stores(carrierAccountId: string | CarrierAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
11799
11642
|
isCarrierAccount(resource: any): resource is CarrierAccount;
|
|
11800
11643
|
relationship(id: string | ResourceId | null): CarrierAccountRel$1;
|
|
@@ -11960,7 +11803,6 @@ interface Shipment extends Resource {
|
|
|
11960
11803
|
attachments?: Attachment[] | null;
|
|
11961
11804
|
events?: Event[] | null;
|
|
11962
11805
|
tags?: Tag[] | null;
|
|
11963
|
-
versions?: Version[] | null;
|
|
11964
11806
|
event_stores?: EventStore[] | null;
|
|
11965
11807
|
}
|
|
11966
11808
|
interface ShipmentCreate extends ResourceCreate {
|
|
@@ -12084,7 +11926,6 @@ declare class Shipments extends ApiResource<Shipment> {
|
|
|
12084
11926
|
attachments(shipmentId: string | Shipment, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12085
11927
|
events(shipmentId: string | Shipment, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
12086
11928
|
tags(shipmentId: string | Shipment, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
12087
|
-
versions(shipmentId: string | Shipment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12088
11929
|
event_stores(shipmentId: string | Shipment, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12089
11930
|
_upcoming(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
|
12090
11931
|
_cancel(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
|
@@ -12179,7 +12020,6 @@ interface StockTransfer extends Resource {
|
|
|
12179
12020
|
stock_reservation?: StockReservation | null;
|
|
12180
12021
|
attachments?: Attachment[] | null;
|
|
12181
12022
|
events?: Event[] | null;
|
|
12182
|
-
versions?: Version[] | null;
|
|
12183
12023
|
event_stores?: EventStore[] | null;
|
|
12184
12024
|
}
|
|
12185
12025
|
interface StockTransferCreate extends ResourceCreate {
|
|
@@ -12269,7 +12109,6 @@ declare class StockTransfers extends ApiResource<StockTransfer> {
|
|
|
12269
12109
|
stock_reservation(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve<StockReservation>, options?: ResourcesConfig): Promise<StockReservation>;
|
|
12270
12110
|
attachments(stockTransferId: string | StockTransfer, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12271
12111
|
events(stockTransferId: string | StockTransfer, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
12272
|
-
versions(stockTransferId: string | StockTransfer, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12273
12112
|
event_stores(stockTransferId: string | StockTransfer, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12274
12113
|
_upcoming(id: string | StockTransfer, params?: QueryParamsRetrieve<StockTransfer>, options?: ResourcesConfig): Promise<StockTransfer>;
|
|
12275
12114
|
_on_hold(id: string | StockTransfer, params?: QueryParamsRetrieve<StockTransfer>, options?: ResourcesConfig): Promise<StockTransfer>;
|
|
@@ -12324,7 +12163,6 @@ interface StockLocation extends Resource {
|
|
|
12324
12163
|
stock_transfers?: StockTransfer[] | null;
|
|
12325
12164
|
stores?: Store[] | null;
|
|
12326
12165
|
attachments?: Attachment[] | null;
|
|
12327
|
-
versions?: Version[] | null;
|
|
12328
12166
|
event_stores?: EventStore[] | null;
|
|
12329
12167
|
}
|
|
12330
12168
|
interface StockLocationCreate extends ResourceCreate {
|
|
@@ -12383,7 +12221,6 @@ declare class StockLocations extends ApiResource<StockLocation> {
|
|
|
12383
12221
|
stock_transfers(stockLocationId: string | StockLocation, params?: QueryParamsList<StockTransfer>, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
|
|
12384
12222
|
stores(stockLocationId: string | StockLocation, params?: QueryParamsList<Store>, options?: ResourcesConfig): Promise<ListResponse<Store>>;
|
|
12385
12223
|
attachments(stockLocationId: string | StockLocation, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12386
|
-
versions(stockLocationId: string | StockLocation, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12387
12224
|
event_stores(stockLocationId: string | StockLocation, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12388
12225
|
isStockLocation(resource: any): resource is StockLocation;
|
|
12389
12226
|
relationship(id: string | ResourceId | null): StockLocationRel$2;
|
|
@@ -12419,7 +12256,6 @@ interface StockItem extends Resource {
|
|
|
12419
12256
|
reserved_stock?: ReservedStock | null;
|
|
12420
12257
|
stock_reservations?: StockReservation[] | null;
|
|
12421
12258
|
attachments?: Attachment[] | null;
|
|
12422
|
-
versions?: Version[] | null;
|
|
12423
12259
|
event_stores?: EventStore[] | null;
|
|
12424
12260
|
}
|
|
12425
12261
|
interface StockItemCreate extends ResourceCreate {
|
|
@@ -12465,7 +12301,6 @@ declare class StockItems extends ApiResource<StockItem> {
|
|
|
12465
12301
|
reserved_stock(stockItemId: string | StockItem, params?: QueryParamsRetrieve<ReservedStock>, options?: ResourcesConfig): Promise<ReservedStock>;
|
|
12466
12302
|
stock_reservations(stockItemId: string | StockItem, params?: QueryParamsList<StockReservation>, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
|
12467
12303
|
attachments(stockItemId: string | StockItem, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12468
|
-
versions(stockItemId: string | StockItem, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12469
12304
|
event_stores(stockItemId: string | StockItem, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12470
12305
|
_validate(id: string | StockItem, params?: QueryParamsRetrieve<StockItem>, options?: ResourcesConfig): Promise<StockItem>;
|
|
12471
12306
|
isStockItem(resource: any): resource is StockItem;
|
|
@@ -12557,7 +12392,6 @@ interface Sku extends Resource {
|
|
|
12557
12392
|
links?: Link[] | null;
|
|
12558
12393
|
events?: Event[] | null;
|
|
12559
12394
|
tags?: Tag[] | null;
|
|
12560
|
-
versions?: Version[] | null;
|
|
12561
12395
|
jwt_customer?: Customer | null;
|
|
12562
12396
|
jwt_markets?: Market[] | null;
|
|
12563
12397
|
jwt_stock_locations?: StockLocation[] | null;
|
|
@@ -12692,7 +12526,6 @@ declare class Skus extends ApiResource<Sku> {
|
|
|
12692
12526
|
links(skuId: string | Sku, params?: QueryParamsList<Link>, options?: ResourcesConfig): Promise<ListResponse<Link>>;
|
|
12693
12527
|
events(skuId: string | Sku, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
12694
12528
|
tags(skuId: string | Sku, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
12695
|
-
versions(skuId: string | Sku, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12696
12529
|
jwt_customer(skuId: string | Sku, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
12697
12530
|
jwt_markets(skuId: string | Sku, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
12698
12531
|
jwt_stock_locations(skuId: string | Sku, params?: QueryParamsList<StockLocation>, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
|
|
@@ -12739,14 +12572,12 @@ interface PriceTier extends Resource {
|
|
|
12739
12572
|
formatted_price_amount?: string | null;
|
|
12740
12573
|
price?: Price | null;
|
|
12741
12574
|
attachments?: Attachment[] | null;
|
|
12742
|
-
versions?: Version[] | null;
|
|
12743
12575
|
event_stores?: EventStore[] | null;
|
|
12744
12576
|
}
|
|
12745
12577
|
declare class PriceTiers extends ApiResource<PriceTier> {
|
|
12746
12578
|
static readonly TYPE: PriceTierType;
|
|
12747
12579
|
price(priceTierId: string | PriceTier, params?: QueryParamsRetrieve<Price>, options?: ResourcesConfig): Promise<Price>;
|
|
12748
12580
|
attachments(priceTierId: string | PriceTier, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12749
|
-
versions(priceTierId: string | PriceTier, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12750
12581
|
event_stores(priceTierId: string | PriceTier, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12751
12582
|
isPriceTier(resource: any): resource is PriceTier;
|
|
12752
12583
|
relationship(id: string | ResourceId | null): PriceTierRel$2;
|
|
@@ -12791,7 +12622,6 @@ interface PriceVolumeTier extends Resource {
|
|
|
12791
12622
|
formatted_price_amount?: string | null;
|
|
12792
12623
|
price?: Price | null;
|
|
12793
12624
|
attachments?: Attachment[] | null;
|
|
12794
|
-
versions?: Version[] | null;
|
|
12795
12625
|
event_stores?: EventStore[] | null;
|
|
12796
12626
|
events?: Event[] | null;
|
|
12797
12627
|
}
|
|
@@ -12838,7 +12668,6 @@ declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
|
|
|
12838
12668
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
12839
12669
|
price(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsRetrieve<Price>, options?: ResourcesConfig): Promise<Price>;
|
|
12840
12670
|
attachments(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12841
|
-
versions(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12842
12671
|
event_stores(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12843
12672
|
events(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
12844
12673
|
isPriceVolumeTier(resource: any): resource is PriceVolumeTier;
|
|
@@ -12884,7 +12713,6 @@ interface PriceFrequencyTier extends Resource {
|
|
|
12884
12713
|
formatted_price_amount?: string | null;
|
|
12885
12714
|
price?: Price | null;
|
|
12886
12715
|
attachments?: Attachment[] | null;
|
|
12887
|
-
versions?: Version[] | null;
|
|
12888
12716
|
event_stores?: EventStore[] | null;
|
|
12889
12717
|
events?: Event[] | null;
|
|
12890
12718
|
}
|
|
@@ -12931,7 +12759,6 @@ declare class PriceFrequencyTiers extends ApiResource<PriceFrequencyTier> {
|
|
|
12931
12759
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
12932
12760
|
price(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsRetrieve<Price>, options?: ResourcesConfig): Promise<Price>;
|
|
12933
12761
|
attachments(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
12934
|
-
versions(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
12935
12762
|
event_stores(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
12936
12763
|
events(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
12937
12764
|
isPriceFrequencyTier(resource: any): resource is PriceFrequencyTier;
|
|
@@ -13037,7 +12864,6 @@ interface Price extends Resource {
|
|
|
13037
12864
|
price_volume_tiers?: PriceVolumeTier[] | null;
|
|
13038
12865
|
price_frequency_tiers?: PriceFrequencyTier[] | null;
|
|
13039
12866
|
attachments?: Attachment[] | null;
|
|
13040
|
-
versions?: Version[] | null;
|
|
13041
12867
|
jwt_customer?: Customer | null;
|
|
13042
12868
|
jwt_markets?: Market[] | null;
|
|
13043
12869
|
jwt_stock_locations?: StockLocation[] | null;
|
|
@@ -13109,7 +12935,6 @@ declare class Prices extends ApiResource<Price> {
|
|
|
13109
12935
|
price_volume_tiers(priceId: string | Price, params?: QueryParamsList<PriceVolumeTier>, options?: ResourcesConfig): Promise<ListResponse<PriceVolumeTier>>;
|
|
13110
12936
|
price_frequency_tiers(priceId: string | Price, params?: QueryParamsList<PriceFrequencyTier>, options?: ResourcesConfig): Promise<ListResponse<PriceFrequencyTier>>;
|
|
13111
12937
|
attachments(priceId: string | Price, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13112
|
-
versions(priceId: string | Price, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13113
12938
|
jwt_customer(priceId: string | Price, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
13114
12939
|
jwt_markets(priceId: string | Price, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13115
12940
|
jwt_stock_locations(priceId: string | Price, params?: QueryParamsList<StockLocation>, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
|
|
@@ -13166,7 +12991,6 @@ interface PriceListScheduler extends Resource {
|
|
|
13166
12991
|
market?: Market | null;
|
|
13167
12992
|
price_list?: PriceList | null;
|
|
13168
12993
|
events?: Event[] | null;
|
|
13169
|
-
versions?: Version[] | null;
|
|
13170
12994
|
event_stores?: EventStore[] | null;
|
|
13171
12995
|
}
|
|
13172
12996
|
interface PriceListSchedulerCreate extends ResourceCreate {
|
|
@@ -13235,7 +13059,6 @@ declare class PriceListSchedulers extends ApiResource<PriceListScheduler> {
|
|
|
13235
13059
|
market(priceListSchedulerId: string | PriceListScheduler, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
|
13236
13060
|
price_list(priceListSchedulerId: string | PriceListScheduler, params?: QueryParamsRetrieve<PriceList>, options?: ResourcesConfig): Promise<PriceList>;
|
|
13237
13061
|
events(priceListSchedulerId: string | PriceListScheduler, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13238
|
-
versions(priceListSchedulerId: string | PriceListScheduler, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13239
13062
|
event_stores(priceListSchedulerId: string | PriceListScheduler, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13240
13063
|
_disable(id: string | PriceListScheduler, params?: QueryParamsRetrieve<PriceListScheduler>, options?: ResourcesConfig): Promise<PriceListScheduler>;
|
|
13241
13064
|
_enable(id: string | PriceListScheduler, params?: QueryParamsRetrieve<PriceListScheduler>, options?: ResourcesConfig): Promise<PriceListScheduler>;
|
|
@@ -13290,7 +13113,6 @@ interface PriceList extends Resource {
|
|
|
13290
13113
|
prices?: Price[] | null;
|
|
13291
13114
|
price_list_schedulers?: PriceListScheduler[] | null;
|
|
13292
13115
|
attachments?: Attachment[] | null;
|
|
13293
|
-
versions?: Version[] | null;
|
|
13294
13116
|
event_stores?: EventStore[] | null;
|
|
13295
13117
|
}
|
|
13296
13118
|
interface PriceListCreate extends ResourceCreate {
|
|
@@ -13355,7 +13177,6 @@ declare class PriceLists extends ApiResource<PriceList> {
|
|
|
13355
13177
|
prices(priceListId: string | PriceList, params?: QueryParamsList<Price>, options?: ResourcesConfig): Promise<ListResponse<Price>>;
|
|
13356
13178
|
price_list_schedulers(priceListId: string | PriceList, params?: QueryParamsList<PriceListScheduler>, options?: ResourcesConfig): Promise<ListResponse<PriceListScheduler>>;
|
|
13357
13179
|
attachments(priceListId: string | PriceList, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13358
|
-
versions(priceListId: string | PriceList, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13359
13180
|
event_stores(priceListId: string | PriceList, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13360
13181
|
isPriceList(resource: any): resource is PriceList;
|
|
13361
13182
|
relationship(id: string | ResourceId | null): PriceListRel$2;
|
|
@@ -13450,7 +13271,6 @@ interface Promotion extends Resource {
|
|
|
13450
13271
|
attachments?: Attachment[] | null;
|
|
13451
13272
|
events?: Event[] | null;
|
|
13452
13273
|
tags?: Tag[] | null;
|
|
13453
|
-
versions?: Version[] | null;
|
|
13454
13274
|
event_stores?: EventStore[] | null;
|
|
13455
13275
|
}
|
|
13456
13276
|
declare class Promotions extends ApiResource<Promotion> {
|
|
@@ -13465,7 +13285,6 @@ declare class Promotions extends ApiResource<Promotion> {
|
|
|
13465
13285
|
attachments(promotionId: string | Promotion, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13466
13286
|
events(promotionId: string | Promotion, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13467
13287
|
tags(promotionId: string | Promotion, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
13468
|
-
versions(promotionId: string | Promotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13469
13288
|
event_stores(promotionId: string | Promotion, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13470
13289
|
isPromotion(resource: any): resource is Promotion;
|
|
13471
13290
|
relationship(id: string | ResourceId | null): PromotionRel$1;
|
|
@@ -13543,7 +13362,6 @@ interface Transaction extends Resource {
|
|
|
13543
13362
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
|
13544
13363
|
attachments?: Attachment[] | null;
|
|
13545
13364
|
events?: Event[] | null;
|
|
13546
|
-
versions?: Version[] | null;
|
|
13547
13365
|
event_stores?: EventStore[] | null;
|
|
13548
13366
|
}
|
|
13549
13367
|
declare class Transactions extends ApiResource<Transaction> {
|
|
@@ -13551,7 +13369,6 @@ declare class Transactions extends ApiResource<Transaction> {
|
|
|
13551
13369
|
order(transactionId: string | Transaction, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
|
13552
13370
|
attachments(transactionId: string | Transaction, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13553
13371
|
events(transactionId: string | Transaction, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13554
|
-
versions(transactionId: string | Transaction, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13555
13372
|
event_stores(transactionId: string | Transaction, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13556
13373
|
isTransaction(resource: any): resource is Transaction;
|
|
13557
13374
|
relationship(id: string | ResourceId | null): TransactionRel$1;
|
|
@@ -13574,7 +13391,6 @@ interface TaxCalculator extends Resource {
|
|
|
13574
13391
|
markets?: Market[] | null;
|
|
13575
13392
|
attachments?: Attachment[] | null;
|
|
13576
13393
|
events?: Event[] | null;
|
|
13577
|
-
versions?: Version[] | null;
|
|
13578
13394
|
event_stores?: EventStore[] | null;
|
|
13579
13395
|
}
|
|
13580
13396
|
declare class TaxCalculators extends ApiResource<TaxCalculator> {
|
|
@@ -13582,7 +13398,6 @@ declare class TaxCalculators extends ApiResource<TaxCalculator> {
|
|
|
13582
13398
|
markets(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13583
13399
|
attachments(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13584
13400
|
events(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13585
|
-
versions(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13586
13401
|
event_stores(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13587
13402
|
isTaxCalculator(resource: any): resource is TaxCalculator;
|
|
13588
13403
|
relationship(id: string | ResourceId | null): TaxCalculatorRel$1;
|
|
@@ -13628,7 +13443,6 @@ interface AvalaraAccount extends Resource {
|
|
|
13628
13443
|
markets?: Market[] | null;
|
|
13629
13444
|
attachments?: Attachment[] | null;
|
|
13630
13445
|
events?: Event[] | null;
|
|
13631
|
-
versions?: Version[] | null;
|
|
13632
13446
|
event_stores?: EventStore[] | null;
|
|
13633
13447
|
tax_categories?: TaxCategory[] | null;
|
|
13634
13448
|
}
|
|
@@ -13706,7 +13520,6 @@ declare class AvalaraAccounts extends ApiResource<AvalaraAccount> {
|
|
|
13706
13520
|
markets(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13707
13521
|
attachments(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13708
13522
|
events(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13709
|
-
versions(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13710
13523
|
event_stores(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13711
13524
|
tax_categories(avalaraAccountId: string | AvalaraAccount, params?: QueryParamsList<TaxCategory>, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
|
|
13712
13525
|
isAvalaraAccount(resource: any): resource is AvalaraAccount;
|
|
@@ -13738,7 +13551,6 @@ interface StripeTaxAccount extends Resource {
|
|
|
13738
13551
|
markets?: Market[] | null;
|
|
13739
13552
|
attachments?: Attachment[] | null;
|
|
13740
13553
|
events?: Event[] | null;
|
|
13741
|
-
versions?: Version[] | null;
|
|
13742
13554
|
event_stores?: EventStore[] | null;
|
|
13743
13555
|
tax_categories?: TaxCategory[] | null;
|
|
13744
13556
|
}
|
|
@@ -13786,7 +13598,6 @@ declare class StripeTaxAccounts extends ApiResource<StripeTaxAccount> {
|
|
|
13786
13598
|
markets(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13787
13599
|
attachments(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13788
13600
|
events(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13789
|
-
versions(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13790
13601
|
event_stores(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13791
13602
|
tax_categories(stripeTaxAccountId: string | StripeTaxAccount, params?: QueryParamsList<TaxCategory>, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
|
|
13792
13603
|
isStripeTaxAccount(resource: any): resource is StripeTaxAccount;
|
|
@@ -13808,7 +13619,7 @@ interface VertexAccount extends Resource {
|
|
|
13808
13619
|
*/
|
|
13809
13620
|
name: string;
|
|
13810
13621
|
/**
|
|
13811
|
-
* The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.
|
|
13622
|
+
* The Vertex account kind. One of 'cloud' (default), 'on_demand', or 'on_premise'.
|
|
13812
13623
|
* @example ```"cloud"```
|
|
13813
13624
|
*/
|
|
13814
13625
|
kind?: 'cloud' | 'on_demand' | 'on_premise' | null;
|
|
@@ -13835,7 +13646,6 @@ interface VertexAccount extends Resource {
|
|
|
13835
13646
|
markets?: Market[] | null;
|
|
13836
13647
|
attachments?: Attachment[] | null;
|
|
13837
13648
|
events?: Event[] | null;
|
|
13838
|
-
versions?: Version[] | null;
|
|
13839
13649
|
event_stores?: EventStore[] | null;
|
|
13840
13650
|
}
|
|
13841
13651
|
interface VertexAccountCreate extends ResourceCreate {
|
|
@@ -13845,7 +13655,7 @@ interface VertexAccountCreate extends ResourceCreate {
|
|
|
13845
13655
|
*/
|
|
13846
13656
|
name: string;
|
|
13847
13657
|
/**
|
|
13848
|
-
* The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.
|
|
13658
|
+
* The Vertex account kind. One of 'cloud' (default), 'on_demand', or 'on_premise'.
|
|
13849
13659
|
* @example ```"cloud"```
|
|
13850
13660
|
*/
|
|
13851
13661
|
kind?: 'cloud' | 'on_demand' | 'on_premise' | null;
|
|
@@ -13877,7 +13687,7 @@ interface VertexAccountUpdate extends ResourceUpdate {
|
|
|
13877
13687
|
*/
|
|
13878
13688
|
name?: string | null;
|
|
13879
13689
|
/**
|
|
13880
|
-
* The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.
|
|
13690
|
+
* The Vertex account kind. One of 'cloud' (default), 'on_demand', or 'on_premise'.
|
|
13881
13691
|
* @example ```"cloud"```
|
|
13882
13692
|
*/
|
|
13883
13693
|
kind?: 'cloud' | 'on_demand' | 'on_premise' | null;
|
|
@@ -13915,7 +13725,6 @@ declare class VertexAccounts extends ApiResource<VertexAccount> {
|
|
|
13915
13725
|
markets(vertexAccountId: string | VertexAccount, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13916
13726
|
attachments(vertexAccountId: string | VertexAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13917
13727
|
events(vertexAccountId: string | VertexAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13918
|
-
versions(vertexAccountId: string | VertexAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13919
13728
|
event_stores(vertexAccountId: string | VertexAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13920
13729
|
_refresh_token(id: string | VertexAccount, params?: QueryParamsRetrieve<VertexAccount>, options?: ResourcesConfig): Promise<VertexAccount>;
|
|
13921
13730
|
isVertexAccount(resource: any): resource is VertexAccount;
|
|
@@ -13942,7 +13751,6 @@ interface TaxjarAccount extends Resource {
|
|
|
13942
13751
|
markets?: Market[] | null;
|
|
13943
13752
|
attachments?: Attachment[] | null;
|
|
13944
13753
|
events?: Event[] | null;
|
|
13945
|
-
versions?: Version[] | null;
|
|
13946
13754
|
event_stores?: EventStore[] | null;
|
|
13947
13755
|
tax_categories?: TaxCategory[] | null;
|
|
13948
13756
|
}
|
|
@@ -13980,7 +13788,6 @@ declare class TaxjarAccounts extends ApiResource<TaxjarAccount> {
|
|
|
13980
13788
|
markets(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
13981
13789
|
attachments(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
13982
13790
|
events(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
13983
|
-
versions(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
13984
13791
|
event_stores(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
13985
13792
|
tax_categories(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList<TaxCategory>, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
|
|
13986
13793
|
isTaxjarAccount(resource: any): resource is TaxjarAccount;
|
|
@@ -14061,7 +13868,6 @@ interface TaxRule extends Resource {
|
|
|
14061
13868
|
*/
|
|
14062
13869
|
not_zip_code_regex?: string | null;
|
|
14063
13870
|
manual_tax_calculator?: ManualTaxCalculator | null;
|
|
14064
|
-
versions?: Version[] | null;
|
|
14065
13871
|
event_stores?: EventStore[] | null;
|
|
14066
13872
|
}
|
|
14067
13873
|
interface TaxRuleCreate extends ResourceCreate {
|
|
@@ -14188,7 +13994,6 @@ declare class TaxRules extends ApiResource<TaxRule> {
|
|
|
14188
13994
|
update(resource: TaxRuleUpdate, params?: QueryParamsRetrieve<TaxRule>, options?: ResourcesConfig): Promise<TaxRule>;
|
|
14189
13995
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
14190
13996
|
manual_tax_calculator(taxRuleId: string | TaxRule, params?: QueryParamsRetrieve<ManualTaxCalculator>, options?: ResourcesConfig): Promise<ManualTaxCalculator>;
|
|
14191
|
-
versions(taxRuleId: string | TaxRule, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14192
13997
|
event_stores(taxRuleId: string | TaxRule, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14193
13998
|
isTaxRule(resource: any): resource is TaxRule;
|
|
14194
13999
|
relationship(id: string | ResourceId | null): TaxRuleRel$1;
|
|
@@ -14214,7 +14019,6 @@ interface ManualTaxCalculator extends Resource {
|
|
|
14214
14019
|
markets?: Market[] | null;
|
|
14215
14020
|
attachments?: Attachment[] | null;
|
|
14216
14021
|
events?: Event[] | null;
|
|
14217
|
-
versions?: Version[] | null;
|
|
14218
14022
|
event_stores?: EventStore[] | null;
|
|
14219
14023
|
tax_rules?: TaxRule[] | null;
|
|
14220
14024
|
}
|
|
@@ -14242,7 +14046,6 @@ declare class ManualTaxCalculators extends ApiResource<ManualTaxCalculator> {
|
|
|
14242
14046
|
markets(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
14243
14047
|
attachments(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
14244
14048
|
events(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
14245
|
-
versions(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14246
14049
|
event_stores(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14247
14050
|
tax_rules(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList<TaxRule>, options?: ResourcesConfig): Promise<ListResponse<TaxRule>>;
|
|
14248
14051
|
isManualTaxCalculator(resource: any): resource is ManualTaxCalculator;
|
|
@@ -14263,11 +14066,6 @@ interface ExternalTaxCalculator extends Resource {
|
|
|
14263
14066
|
* @example ```"Personal tax calculator"```
|
|
14264
14067
|
*/
|
|
14265
14068
|
name: string;
|
|
14266
|
-
/**
|
|
14267
|
-
* The URL to the service that will compute the taxes.
|
|
14268
|
-
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14269
|
-
*/
|
|
14270
|
-
tax_calculator_url: string;
|
|
14271
14069
|
/**
|
|
14272
14070
|
* The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
|
|
14273
14071
|
* @example ```"closed"```
|
|
@@ -14288,10 +14086,14 @@ interface ExternalTaxCalculator extends Resource {
|
|
|
14288
14086
|
* @example ```["order.line_item_options"]```
|
|
14289
14087
|
*/
|
|
14290
14088
|
external_includes?: string[] | null;
|
|
14089
|
+
/**
|
|
14090
|
+
* The URL to the service that will compute the taxes.
|
|
14091
|
+
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14092
|
+
*/
|
|
14093
|
+
tax_calculator_url: string;
|
|
14291
14094
|
markets?: Market[] | null;
|
|
14292
14095
|
attachments?: Attachment[] | null;
|
|
14293
14096
|
events?: Event[] | null;
|
|
14294
|
-
versions?: Version[] | null;
|
|
14295
14097
|
event_stores?: EventStore[] | null;
|
|
14296
14098
|
}
|
|
14297
14099
|
interface ExternalTaxCalculatorCreate extends ResourceCreate {
|
|
@@ -14300,16 +14102,16 @@ interface ExternalTaxCalculatorCreate extends ResourceCreate {
|
|
|
14300
14102
|
* @example ```"Personal tax calculator"```
|
|
14301
14103
|
*/
|
|
14302
14104
|
name: string;
|
|
14303
|
-
/**
|
|
14304
|
-
* The URL to the service that will compute the taxes.
|
|
14305
|
-
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14306
|
-
*/
|
|
14307
|
-
tax_calculator_url: string;
|
|
14308
14105
|
/**
|
|
14309
14106
|
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
14310
14107
|
* @example ```["order.line_item_options"]```
|
|
14311
14108
|
*/
|
|
14312
14109
|
external_includes?: string[] | null;
|
|
14110
|
+
/**
|
|
14111
|
+
* The URL to the service that will compute the taxes.
|
|
14112
|
+
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14113
|
+
*/
|
|
14114
|
+
tax_calculator_url: string;
|
|
14313
14115
|
}
|
|
14314
14116
|
interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
|
|
14315
14117
|
/**
|
|
@@ -14317,11 +14119,6 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
|
|
|
14317
14119
|
* @example ```"Personal tax calculator"```
|
|
14318
14120
|
*/
|
|
14319
14121
|
name?: string | null;
|
|
14320
|
-
/**
|
|
14321
|
-
* The URL to the service that will compute the taxes.
|
|
14322
|
-
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14323
|
-
*/
|
|
14324
|
-
tax_calculator_url?: string | null;
|
|
14325
14122
|
/**
|
|
14326
14123
|
* Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
|
|
14327
14124
|
* @example ```true```
|
|
@@ -14332,6 +14129,11 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
|
|
|
14332
14129
|
* @example ```["order.line_item_options"]```
|
|
14333
14130
|
*/
|
|
14334
14131
|
external_includes?: string[] | null;
|
|
14132
|
+
/**
|
|
14133
|
+
* The URL to the service that will compute the taxes.
|
|
14134
|
+
* @example ```"https://external_calculator.yourbrand.com"```
|
|
14135
|
+
*/
|
|
14136
|
+
tax_calculator_url?: string | null;
|
|
14335
14137
|
}
|
|
14336
14138
|
declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
|
|
14337
14139
|
static readonly TYPE: ExternalTaxCalculatorType;
|
|
@@ -14341,7 +14143,6 @@ declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator>
|
|
|
14341
14143
|
markets(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
14342
14144
|
attachments(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
14343
14145
|
events(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
14344
|
-
versions(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14345
14146
|
event_stores(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14346
14147
|
_reset_circuit(id: string | ExternalTaxCalculator, params?: QueryParamsRetrieve<ExternalTaxCalculator>, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
|
|
14347
14148
|
isExternalTaxCalculator(resource: any): resource is ExternalTaxCalculator;
|
|
@@ -14391,7 +14192,6 @@ interface TaxCategory extends Resource {
|
|
|
14391
14192
|
sku?: Sku | null;
|
|
14392
14193
|
tax_calculator?: AvalaraAccount | StripeTaxAccount | VertexAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
|
|
14393
14194
|
attachments?: Attachment[] | null;
|
|
14394
|
-
versions?: Version[] | null;
|
|
14395
14195
|
event_stores?: EventStore[] | null;
|
|
14396
14196
|
}
|
|
14397
14197
|
interface TaxCategoryCreate extends ResourceCreate {
|
|
@@ -14428,7 +14228,6 @@ declare class TaxCategories extends ApiResource<TaxCategory> {
|
|
|
14428
14228
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
14429
14229
|
sku(taxCategoryId: string | TaxCategory, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
|
14430
14230
|
attachments(taxCategoryId: string | TaxCategory, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
14431
|
-
versions(taxCategoryId: string | TaxCategory, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14432
14231
|
event_stores(taxCategoryId: string | TaxCategory, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14433
14232
|
isTaxCategory(resource: any): resource is TaxCategory;
|
|
14434
14233
|
relationship(id: string | ResourceId | null): TaxCategoryRel$1;
|
|
@@ -14640,7 +14439,6 @@ interface Merchant extends Resource {
|
|
|
14640
14439
|
name: string;
|
|
14641
14440
|
address?: Address | null;
|
|
14642
14441
|
attachments?: Attachment[] | null;
|
|
14643
|
-
versions?: Version[] | null;
|
|
14644
14442
|
event_stores?: EventStore[] | null;
|
|
14645
14443
|
}
|
|
14646
14444
|
interface MerchantCreate extends ResourceCreate {
|
|
@@ -14666,7 +14464,6 @@ declare class Merchants extends ApiResource<Merchant> {
|
|
|
14666
14464
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
14667
14465
|
address(merchantId: string | Merchant, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
|
14668
14466
|
attachments(merchantId: string | Merchant, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
14669
|
-
versions(merchantId: string | Merchant, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14670
14467
|
event_stores(merchantId: string | Merchant, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14671
14468
|
isMerchant(resource: any): resource is Merchant;
|
|
14672
14469
|
relationship(id: string | ResourceId | null): MerchantRel$1;
|
|
@@ -14800,7 +14597,6 @@ interface Market extends Resource {
|
|
|
14800
14597
|
stores?: Store[] | null;
|
|
14801
14598
|
price_list_schedulers?: PriceListScheduler[] | null;
|
|
14802
14599
|
attachments?: Attachment[] | null;
|
|
14803
|
-
versions?: Version[] | null;
|
|
14804
14600
|
event_stores?: EventStore[] | null;
|
|
14805
14601
|
}
|
|
14806
14602
|
interface MarketCreate extends ResourceCreate {
|
|
@@ -14945,7 +14741,6 @@ declare class Markets extends ApiResource<Market> {
|
|
|
14945
14741
|
stores(marketId: string | Market, params?: QueryParamsList<Store>, options?: ResourcesConfig): Promise<ListResponse<Store>>;
|
|
14946
14742
|
price_list_schedulers(marketId: string | Market, params?: QueryParamsList<PriceListScheduler>, options?: ResourcesConfig): Promise<ListResponse<PriceListScheduler>>;
|
|
14947
14743
|
attachments(marketId: string | Market, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
14948
|
-
versions(marketId: string | Market, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
14949
14744
|
event_stores(marketId: string | Market, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
14950
14745
|
_disable(id: string | Market, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
|
14951
14746
|
_enable(id: string | Market, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
|
@@ -15119,7 +14914,6 @@ interface Address extends Resource {
|
|
|
15119
14914
|
geocoder?: Geocoder | null;
|
|
15120
14915
|
events?: Event[] | null;
|
|
15121
14916
|
tags?: Tag[] | null;
|
|
15122
|
-
versions?: Version[] | null;
|
|
15123
14917
|
event_stores?: EventStore[] | null;
|
|
15124
14918
|
}
|
|
15125
14919
|
interface AddressCreate extends ResourceCreate {
|
|
@@ -15304,7 +15098,6 @@ declare class Addresses extends ApiResource<Address> {
|
|
|
15304
15098
|
geocoder(addressId: string | Address, params?: QueryParamsRetrieve<Geocoder>, options?: ResourcesConfig): Promise<Geocoder>;
|
|
15305
15099
|
events(addressId: string | Address, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
15306
15100
|
tags(addressId: string | Address, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
15307
|
-
versions(addressId: string | Address, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15308
15101
|
event_stores(addressId: string | Address, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15309
15102
|
_add_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
|
15310
15103
|
_remove_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
|
@@ -15334,6 +15127,11 @@ interface AdyenGateway extends Resource {
|
|
|
15334
15127
|
* @example ```true```
|
|
15335
15128
|
*/
|
|
15336
15129
|
force_payments?: boolean | null;
|
|
15130
|
+
/**
|
|
15131
|
+
* The payment gateway's API credential keys last digits.
|
|
15132
|
+
* @example ```{"api_key":"********BW989"}```
|
|
15133
|
+
*/
|
|
15134
|
+
credential_keys?: Record<string, any> | null;
|
|
15337
15135
|
/**
|
|
15338
15136
|
* Time at which this resource was disabled.
|
|
15339
15137
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -15379,7 +15177,6 @@ interface AdyenGateway extends Resource {
|
|
|
15379
15177
|
*/
|
|
15380
15178
|
webhook_endpoint_url?: string | null;
|
|
15381
15179
|
payment_methods?: PaymentMethod[] | null;
|
|
15382
|
-
versions?: Version[] | null;
|
|
15383
15180
|
event_stores?: EventStore[] | null;
|
|
15384
15181
|
adyen_payments?: AdyenPayment[] | null;
|
|
15385
15182
|
}
|
|
@@ -15404,6 +15201,11 @@ interface AdyenGatewayCreate extends ResourceCreate {
|
|
|
15404
15201
|
* @example ```true```
|
|
15405
15202
|
*/
|
|
15406
15203
|
_enable?: boolean | null;
|
|
15204
|
+
/**
|
|
15205
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15206
|
+
* @example ```true```
|
|
15207
|
+
*/
|
|
15208
|
+
_check?: boolean | null;
|
|
15407
15209
|
/**
|
|
15408
15210
|
* The gateway merchant account.
|
|
15409
15211
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15476,6 +15278,11 @@ interface AdyenGatewayUpdate extends ResourceUpdate {
|
|
|
15476
15278
|
* @example ```true```
|
|
15477
15279
|
*/
|
|
15478
15280
|
_enable?: boolean | null;
|
|
15281
|
+
/**
|
|
15282
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15283
|
+
* @example ```true```
|
|
15284
|
+
*/
|
|
15285
|
+
_check?: boolean | null;
|
|
15479
15286
|
/**
|
|
15480
15287
|
* The gateway merchant account.
|
|
15481
15288
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15533,11 +15340,11 @@ declare class AdyenGateways extends ApiResource<AdyenGateway> {
|
|
|
15533
15340
|
update(resource: AdyenGatewayUpdate, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15534
15341
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
15535
15342
|
payment_methods(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
15536
|
-
versions(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15537
15343
|
event_stores(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15538
15344
|
adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<AdyenPayment>, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
|
|
15539
15345
|
_disable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15540
15346
|
_enable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15347
|
+
_check(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15541
15348
|
isAdyenGateway(resource: any): resource is AdyenGateway;
|
|
15542
15349
|
relationship(id: string | ResourceId | null): AdyenGatewayRel;
|
|
15543
15350
|
relationshipToMany(...ids: string[]): AdyenGatewayRel[];
|
|
@@ -15606,6 +15413,11 @@ interface AxerveGateway extends Resource {
|
|
|
15606
15413
|
* @example ```true```
|
|
15607
15414
|
*/
|
|
15608
15415
|
force_payments?: boolean | null;
|
|
15416
|
+
/**
|
|
15417
|
+
* The payment gateway's API credential keys last digits.
|
|
15418
|
+
* @example ```{"api_key":"********BW989"}```
|
|
15419
|
+
*/
|
|
15420
|
+
credential_keys?: Record<string, any> | null;
|
|
15609
15421
|
/**
|
|
15610
15422
|
* Time at which this resource was disabled.
|
|
15611
15423
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -15622,7 +15434,6 @@ interface AxerveGateway extends Resource {
|
|
|
15622
15434
|
*/
|
|
15623
15435
|
webhook_endpoint_url?: string | null;
|
|
15624
15436
|
payment_methods?: PaymentMethod[] | null;
|
|
15625
|
-
versions?: Version[] | null;
|
|
15626
15437
|
event_stores?: EventStore[] | null;
|
|
15627
15438
|
axerve_payments?: AxervePayment[] | null;
|
|
15628
15439
|
}
|
|
@@ -15698,7 +15509,6 @@ declare class AxerveGateways extends ApiResource<AxerveGateway> {
|
|
|
15698
15509
|
update(resource: AxerveGatewayUpdate, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
|
|
15699
15510
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
15700
15511
|
payment_methods(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
15701
|
-
versions(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15702
15512
|
event_stores(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15703
15513
|
axerve_payments(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<AxervePayment>, options?: ResourcesConfig): Promise<ListResponse<AxervePayment>>;
|
|
15704
15514
|
_disable(id: string | AxerveGateway, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
|
|
@@ -15785,6 +15595,11 @@ interface BraintreeGateway extends Resource {
|
|
|
15785
15595
|
* @example ```true```
|
|
15786
15596
|
*/
|
|
15787
15597
|
force_payments?: boolean | null;
|
|
15598
|
+
/**
|
|
15599
|
+
* The payment gateway's API credential keys last digits.
|
|
15600
|
+
* @example ```{"api_key":"********BW989"}```
|
|
15601
|
+
*/
|
|
15602
|
+
credential_keys?: Record<string, any> | null;
|
|
15788
15603
|
/**
|
|
15789
15604
|
* Time at which this resource was disabled.
|
|
15790
15605
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -15811,7 +15626,6 @@ interface BraintreeGateway extends Resource {
|
|
|
15811
15626
|
*/
|
|
15812
15627
|
webhook_endpoint_url?: string | null;
|
|
15813
15628
|
payment_methods?: PaymentMethod[] | null;
|
|
15814
|
-
versions?: Version[] | null;
|
|
15815
15629
|
event_stores?: EventStore[] | null;
|
|
15816
15630
|
braintree_payments?: BraintreePayment[] | null;
|
|
15817
15631
|
}
|
|
@@ -15836,6 +15650,11 @@ interface BraintreeGatewayCreate extends ResourceCreate {
|
|
|
15836
15650
|
* @example ```true```
|
|
15837
15651
|
*/
|
|
15838
15652
|
_enable?: boolean | null;
|
|
15653
|
+
/**
|
|
15654
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15655
|
+
* @example ```true```
|
|
15656
|
+
*/
|
|
15657
|
+
_check?: boolean | null;
|
|
15839
15658
|
/**
|
|
15840
15659
|
* The gateway merchant account ID.
|
|
15841
15660
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15894,6 +15713,11 @@ interface BraintreeGatewayUpdate extends ResourceUpdate {
|
|
|
15894
15713
|
* @example ```true```
|
|
15895
15714
|
*/
|
|
15896
15715
|
_enable?: boolean | null;
|
|
15716
|
+
/**
|
|
15717
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15718
|
+
* @example ```true```
|
|
15719
|
+
*/
|
|
15720
|
+
_check?: boolean | null;
|
|
15897
15721
|
/**
|
|
15898
15722
|
* The gateway merchant account ID.
|
|
15899
15723
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15937,11 +15761,11 @@ declare class BraintreeGateways extends ApiResource<BraintreeGateway> {
|
|
|
15937
15761
|
update(resource: BraintreeGatewayUpdate, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15938
15762
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
15939
15763
|
payment_methods(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
15940
|
-
versions(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15941
15764
|
event_stores(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15942
15765
|
braintree_payments(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<BraintreePayment>, options?: ResourcesConfig): Promise<ListResponse<BraintreePayment>>;
|
|
15943
15766
|
_disable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15944
15767
|
_enable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15768
|
+
_check(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15945
15769
|
isBraintreeGateway(resource: any): resource is BraintreeGateway;
|
|
15946
15770
|
relationship(id: string | ResourceId | null): BraintreeGatewayRel;
|
|
15947
15771
|
relationshipToMany(...ids: string[]): BraintreeGatewayRel[];
|
|
@@ -15968,6 +15792,11 @@ interface CheckoutComGateway extends Resource {
|
|
|
15968
15792
|
* @example ```true```
|
|
15969
15793
|
*/
|
|
15970
15794
|
force_payments?: boolean | null;
|
|
15795
|
+
/**
|
|
15796
|
+
* The payment gateway's API credential keys last digits.
|
|
15797
|
+
* @example ```{"api_key":"********BW989"}```
|
|
15798
|
+
*/
|
|
15799
|
+
credential_keys?: Record<string, any> | null;
|
|
15971
15800
|
/**
|
|
15972
15801
|
* Time at which this resource was disabled.
|
|
15973
15802
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -15989,7 +15818,6 @@ interface CheckoutComGateway extends Resource {
|
|
|
15989
15818
|
*/
|
|
15990
15819
|
webhook_endpoint_url?: string | null;
|
|
15991
15820
|
payment_methods?: PaymentMethod[] | null;
|
|
15992
|
-
versions?: Version[] | null;
|
|
15993
15821
|
event_stores?: EventStore[] | null;
|
|
15994
15822
|
checkout_com_payments?: CheckoutComPayment[] | null;
|
|
15995
15823
|
}
|
|
@@ -16014,6 +15842,11 @@ interface CheckoutComGatewayCreate extends ResourceCreate {
|
|
|
16014
15842
|
* @example ```true```
|
|
16015
15843
|
*/
|
|
16016
15844
|
_enable?: boolean | null;
|
|
15845
|
+
/**
|
|
15846
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15847
|
+
* @example ```true```
|
|
15848
|
+
*/
|
|
15849
|
+
_check?: boolean | null;
|
|
16017
15850
|
/**
|
|
16018
15851
|
* The gateway secret key.
|
|
16019
15852
|
* @example ```"sk_test_xxxx-yyyy-zzzz"```
|
|
@@ -16047,6 +15880,11 @@ interface CheckoutComGatewayUpdate extends ResourceUpdate {
|
|
|
16047
15880
|
* @example ```true```
|
|
16048
15881
|
*/
|
|
16049
15882
|
_enable?: boolean | null;
|
|
15883
|
+
/**
|
|
15884
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
15885
|
+
* @example ```true```
|
|
15886
|
+
*/
|
|
15887
|
+
_check?: boolean | null;
|
|
16050
15888
|
/**
|
|
16051
15889
|
* The gateway secret key.
|
|
16052
15890
|
* @example ```"sk_test_xxxx-yyyy-zzzz"```
|
|
@@ -16065,11 +15903,11 @@ declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
|
|
|
16065
15903
|
update(resource: CheckoutComGatewayUpdate, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
16066
15904
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
16067
15905
|
payment_methods(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
16068
|
-
versions(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16069
15906
|
event_stores(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16070
15907
|
checkout_com_payments(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<CheckoutComPayment>, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
|
|
16071
15908
|
_disable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
16072
15909
|
_enable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
15910
|
+
_check(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
16073
15911
|
isCheckoutComGateway(resource: any): resource is CheckoutComGateway;
|
|
16074
15912
|
relationship(id: string | ResourceId | null): CheckoutComGatewayRel;
|
|
16075
15913
|
relationshipToMany(...ids: string[]): CheckoutComGatewayRel[];
|
|
@@ -16084,10 +15922,10 @@ type CleanupSort = Pick<Cleanup, 'id' | 'resource_type' | 'status' | 'started_at
|
|
|
16084
15922
|
interface Cleanup extends Resource {
|
|
16085
15923
|
readonly type: CleanupType;
|
|
16086
15924
|
/**
|
|
16087
|
-
* The type of resource being cleaned.
|
|
15925
|
+
* The type of resource being cleaned. One of 'promotions', 'skus', 'bundles', 'sku_lists', 'stock_items', 'gift_cards', 'sku_options', or 'prices'.
|
|
16088
15926
|
* @example ```"skus"```
|
|
16089
15927
|
*/
|
|
16090
|
-
resource_type:
|
|
15928
|
+
resource_type: 'promotions' | 'skus' | 'bundles' | 'sku_lists' | 'stock_items' | 'gift_cards' | 'sku_options' | 'prices';
|
|
16091
15929
|
/**
|
|
16092
15930
|
* The cleanup job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
|
|
16093
15931
|
* @example ```"in_progress"```
|
|
@@ -16134,15 +15972,14 @@ interface Cleanup extends Resource {
|
|
|
16134
15972
|
*/
|
|
16135
15973
|
errors_log?: Record<string, any> | null;
|
|
16136
15974
|
events?: Event[] | null;
|
|
16137
|
-
versions?: Version[] | null;
|
|
16138
15975
|
event_stores?: EventStore[] | null;
|
|
16139
15976
|
}
|
|
16140
15977
|
interface CleanupCreate extends ResourceCreate {
|
|
16141
15978
|
/**
|
|
16142
|
-
* The type of resource being cleaned.
|
|
15979
|
+
* The type of resource being cleaned. One of 'promotions', 'skus', 'bundles', 'sku_lists', 'stock_items', 'gift_cards', 'sku_options', or 'prices'.
|
|
16143
15980
|
* @example ```"skus"```
|
|
16144
15981
|
*/
|
|
16145
|
-
resource_type:
|
|
15982
|
+
resource_type: 'promotions' | 'skus' | 'bundles' | 'sku_lists' | 'stock_items' | 'gift_cards' | 'sku_options' | 'prices';
|
|
16146
15983
|
/**
|
|
16147
15984
|
* The filters used to select the records to be cleaned.
|
|
16148
15985
|
* @example ```{"code_eq":"AAA"}```
|
|
@@ -16162,7 +15999,6 @@ declare class Cleanups extends ApiResource<Cleanup> {
|
|
|
16162
15999
|
update(resource: CleanupUpdate, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
|
|
16163
16000
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
16164
16001
|
events(cleanupId: string | Cleanup, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
16165
|
-
versions(cleanupId: string | Cleanup, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16166
16002
|
event_stores(cleanupId: string | Cleanup, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16167
16003
|
_interrupt(id: string | Cleanup, params?: QueryParamsRetrieve<Cleanup>, options?: ResourcesConfig): Promise<Cleanup>;
|
|
16168
16004
|
isCleanup(resource: any): resource is Cleanup;
|
|
@@ -16346,15 +16182,15 @@ type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 's
|
|
|
16346
16182
|
interface Export extends Resource {
|
|
16347
16183
|
readonly type: ExportType;
|
|
16348
16184
|
/**
|
|
16349
|
-
* The type of resource being exported.
|
|
16185
|
+
* The type of resource being exported. One of 'applications', 'event_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price_lists', 'payment_gateways', 'payment_methods', 'markets', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'adyen_payments', 'orders', 'transactions', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'payment_options', 'resource_errors', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.
|
|
16350
16186
|
* @example ```"skus"```
|
|
16351
16187
|
*/
|
|
16352
|
-
resource_type:
|
|
16188
|
+
resource_type: 'applications' | 'event_stores' | 'organizations' | 'addresses' | 'geocoders' | 'events' | 'tags' | 'adjustments' | 'price_lists' | 'payment_gateways' | 'payment_methods' | 'markets' | 'customer_groups' | 'line_items' | 'discount_engine_items' | 'promotions' | 'adyen_payments' | 'orders' | 'transactions' | 'order_factories' | 'attachments' | 'tax_calculators' | 'tax_categories' | 'skus' | 'shipping_categories' | 'axerve_payments' | 'order_validation_rules' | 'braintree_payments' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'promotion_rules' | 'coupons' | 'returns' | 'carrier_accounts' | 'checkout_com_payments' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'order_subscriptions' | 'customer_password_resets' | 'delivery_lead_times' | 'shipping_methods' | 'shipments' | 'discount_engines' | 'pickups' | 'parcels' | 'webhooks' | 'event_callbacks' | 'external_payments' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_stock_locations' | 'inventory_return_locations' | 'klarna_payments' | 'line_item_options' | 'return_line_items' | 'stock_line_items' | 'stock_reservations' | 'stock_transfers' | 'notifications' | 'sku_options' | 'links' | 'tax_rules' | 'merchants' | 'subscription_models' | 'stores' | 'price_list_schedulers' | 'order_subscription_items' | 'payment_options' | 'resource_errors' | 'paypal_payments' | 'packages' | 'parcel_line_items' | 'prices' | 'price_tiers' | 'reserved_stocks' | 'satispay_payments' | 'shipping_method_tiers' | 'shipping_zones' | 'stripe_payments' | 'wire_transfers';
|
|
16353
16189
|
/**
|
|
16354
|
-
* The format of the export
|
|
16190
|
+
* The format of the export. One of 'csv', or 'json' (default).
|
|
16355
16191
|
* @example ```"json"```
|
|
16356
16192
|
*/
|
|
16357
|
-
format?:
|
|
16193
|
+
format?: 'csv' | 'json' | null;
|
|
16358
16194
|
/**
|
|
16359
16195
|
* The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.
|
|
16360
16196
|
* @example ```"in_progress"```
|
|
@@ -16430,20 +16266,19 @@ interface Export extends Resource {
|
|
|
16430
16266
|
*/
|
|
16431
16267
|
errors_log?: Record<string, any> | null;
|
|
16432
16268
|
events?: Event[] | null;
|
|
16433
|
-
versions?: Version[] | null;
|
|
16434
16269
|
event_stores?: EventStore[] | null;
|
|
16435
16270
|
}
|
|
16436
16271
|
interface ExportCreate extends ResourceCreate {
|
|
16437
16272
|
/**
|
|
16438
|
-
* The type of resource being exported.
|
|
16273
|
+
* The type of resource being exported. One of 'applications', 'event_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price_lists', 'payment_gateways', 'payment_methods', 'markets', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'adyen_payments', 'orders', 'transactions', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'payment_options', 'resource_errors', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.
|
|
16439
16274
|
* @example ```"skus"```
|
|
16440
16275
|
*/
|
|
16441
|
-
resource_type:
|
|
16276
|
+
resource_type: 'applications' | 'event_stores' | 'organizations' | 'addresses' | 'geocoders' | 'events' | 'tags' | 'adjustments' | 'price_lists' | 'payment_gateways' | 'payment_methods' | 'markets' | 'customer_groups' | 'line_items' | 'discount_engine_items' | 'promotions' | 'adyen_payments' | 'orders' | 'transactions' | 'order_factories' | 'attachments' | 'tax_calculators' | 'tax_categories' | 'skus' | 'shipping_categories' | 'axerve_payments' | 'order_validation_rules' | 'braintree_payments' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'promotion_rules' | 'coupons' | 'returns' | 'carrier_accounts' | 'checkout_com_payments' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'order_subscriptions' | 'customer_password_resets' | 'delivery_lead_times' | 'shipping_methods' | 'shipments' | 'discount_engines' | 'pickups' | 'parcels' | 'webhooks' | 'event_callbacks' | 'external_payments' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_stock_locations' | 'inventory_return_locations' | 'klarna_payments' | 'line_item_options' | 'return_line_items' | 'stock_line_items' | 'stock_reservations' | 'stock_transfers' | 'notifications' | 'sku_options' | 'links' | 'tax_rules' | 'merchants' | 'subscription_models' | 'stores' | 'price_list_schedulers' | 'order_subscription_items' | 'payment_options' | 'resource_errors' | 'paypal_payments' | 'packages' | 'parcel_line_items' | 'prices' | 'price_tiers' | 'reserved_stocks' | 'satispay_payments' | 'shipping_method_tiers' | 'shipping_zones' | 'stripe_payments' | 'wire_transfers';
|
|
16442
16277
|
/**
|
|
16443
|
-
* The format of the export
|
|
16278
|
+
* The format of the export. One of 'csv', or 'json' (default).
|
|
16444
16279
|
* @example ```"json"```
|
|
16445
16280
|
*/
|
|
16446
|
-
format?:
|
|
16281
|
+
format?: 'csv' | 'json' | null;
|
|
16447
16282
|
/**
|
|
16448
16283
|
* List of related resources that should be included in the export (redundant when 'fields' are specified).
|
|
16449
16284
|
* @example ```["prices.price_tiers"]```
|
|
@@ -16487,7 +16322,6 @@ declare class Exports extends ApiResource<Export> {
|
|
|
16487
16322
|
update(resource: ExportUpdate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
|
|
16488
16323
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
16489
16324
|
events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
16490
|
-
versions(exportId: string | Export, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16491
16325
|
event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16492
16326
|
_start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
|
|
16493
16327
|
_interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
|
|
@@ -16514,11 +16348,36 @@ interface ExternalGateway extends Resource {
|
|
|
16514
16348
|
* @example ```true```
|
|
16515
16349
|
*/
|
|
16516
16350
|
force_payments?: boolean | null;
|
|
16351
|
+
/**
|
|
16352
|
+
* The payment gateway's API credential keys last digits.
|
|
16353
|
+
* @example ```{"api_key":"********BW989"}```
|
|
16354
|
+
*/
|
|
16355
|
+
credential_keys?: Record<string, any> | null;
|
|
16517
16356
|
/**
|
|
16518
16357
|
* Time at which this resource was disabled.
|
|
16519
16358
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
16520
16359
|
*/
|
|
16521
16360
|
disabled_at?: string | null;
|
|
16361
|
+
/**
|
|
16362
|
+
* The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
|
|
16363
|
+
* @example ```"closed"```
|
|
16364
|
+
*/
|
|
16365
|
+
circuit_state?: string | null;
|
|
16366
|
+
/**
|
|
16367
|
+
* The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.
|
|
16368
|
+
* @example ```5```
|
|
16369
|
+
*/
|
|
16370
|
+
circuit_failure_count?: number | null;
|
|
16371
|
+
/**
|
|
16372
|
+
* The shared secret used to sign the external request payload.
|
|
16373
|
+
* @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
|
|
16374
|
+
*/
|
|
16375
|
+
shared_secret: string;
|
|
16376
|
+
/**
|
|
16377
|
+
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16378
|
+
* @example ```["order.line_item_options"]```
|
|
16379
|
+
*/
|
|
16380
|
+
external_includes?: string[] | null;
|
|
16522
16381
|
/**
|
|
16523
16382
|
* The endpoint used by the external gateway to authorize payments.
|
|
16524
16383
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16544,28 +16403,7 @@ interface ExternalGateway extends Resource {
|
|
|
16544
16403
|
* @example ```"https://external_gateway.com/token"```
|
|
16545
16404
|
*/
|
|
16546
16405
|
token_url?: string | null;
|
|
16547
|
-
/**
|
|
16548
|
-
* The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
|
|
16549
|
-
* @example ```"closed"```
|
|
16550
|
-
*/
|
|
16551
|
-
circuit_state?: string | null;
|
|
16552
|
-
/**
|
|
16553
|
-
* The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.
|
|
16554
|
-
* @example ```5```
|
|
16555
|
-
*/
|
|
16556
|
-
circuit_failure_count?: number | null;
|
|
16557
|
-
/**
|
|
16558
|
-
* The shared secret used to sign the external request payload.
|
|
16559
|
-
* @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
|
|
16560
|
-
*/
|
|
16561
|
-
shared_secret: string;
|
|
16562
|
-
/**
|
|
16563
|
-
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16564
|
-
* @example ```["order.line_item_options"]```
|
|
16565
|
-
*/
|
|
16566
|
-
external_includes?: string[] | null;
|
|
16567
16406
|
payment_methods?: PaymentMethod[] | null;
|
|
16568
|
-
versions?: Version[] | null;
|
|
16569
16407
|
event_stores?: EventStore[] | null;
|
|
16570
16408
|
external_payments?: ExternalPayment[] | null;
|
|
16571
16409
|
}
|
|
@@ -16590,6 +16428,11 @@ interface ExternalGatewayCreate extends ResourceCreate {
|
|
|
16590
16428
|
* @example ```true```
|
|
16591
16429
|
*/
|
|
16592
16430
|
_enable?: boolean | null;
|
|
16431
|
+
/**
|
|
16432
|
+
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16433
|
+
* @example ```["order.line_item_options"]```
|
|
16434
|
+
*/
|
|
16435
|
+
external_includes?: string[] | null;
|
|
16593
16436
|
/**
|
|
16594
16437
|
* The endpoint used by the external gateway to authorize payments.
|
|
16595
16438
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16615,11 +16458,6 @@ interface ExternalGatewayCreate extends ResourceCreate {
|
|
|
16615
16458
|
* @example ```"https://external_gateway.com/token"```
|
|
16616
16459
|
*/
|
|
16617
16460
|
token_url?: string | null;
|
|
16618
|
-
/**
|
|
16619
|
-
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16620
|
-
* @example ```["order.line_item_options"]```
|
|
16621
|
-
*/
|
|
16622
|
-
external_includes?: string[] | null;
|
|
16623
16461
|
}
|
|
16624
16462
|
interface ExternalGatewayUpdate extends ResourceUpdate {
|
|
16625
16463
|
/**
|
|
@@ -16642,6 +16480,16 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
|
|
|
16642
16480
|
* @example ```true```
|
|
16643
16481
|
*/
|
|
16644
16482
|
_enable?: boolean | null;
|
|
16483
|
+
/**
|
|
16484
|
+
* Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
|
|
16485
|
+
* @example ```true```
|
|
16486
|
+
*/
|
|
16487
|
+
_reset_circuit?: boolean | null;
|
|
16488
|
+
/**
|
|
16489
|
+
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16490
|
+
* @example ```["order.line_item_options"]```
|
|
16491
|
+
*/
|
|
16492
|
+
external_includes?: string[] | null;
|
|
16645
16493
|
/**
|
|
16646
16494
|
* The endpoint used by the external gateway to authorize payments.
|
|
16647
16495
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16667,16 +16515,6 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
|
|
|
16667
16515
|
* @example ```"https://external_gateway.com/token"```
|
|
16668
16516
|
*/
|
|
16669
16517
|
token_url?: string | null;
|
|
16670
|
-
/**
|
|
16671
|
-
* Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
|
|
16672
|
-
* @example ```true```
|
|
16673
|
-
*/
|
|
16674
|
-
_reset_circuit?: boolean | null;
|
|
16675
|
-
/**
|
|
16676
|
-
* List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
|
|
16677
|
-
* @example ```["order.line_item_options"]```
|
|
16678
|
-
*/
|
|
16679
|
-
external_includes?: string[] | null;
|
|
16680
16518
|
}
|
|
16681
16519
|
declare class ExternalGateways extends ApiResource<ExternalGateway> {
|
|
16682
16520
|
static readonly TYPE: ExternalGatewayType;
|
|
@@ -16684,7 +16522,6 @@ declare class ExternalGateways extends ApiResource<ExternalGateway> {
|
|
|
16684
16522
|
update(resource: ExternalGatewayUpdate, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
|
|
16685
16523
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
16686
16524
|
payment_methods(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
16687
|
-
versions(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16688
16525
|
event_stores(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16689
16526
|
external_payments(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<ExternalPayment>, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
|
|
16690
16527
|
_disable(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
|
|
@@ -16760,15 +16597,15 @@ type ImportSort = Pick<Import, 'id' | 'resource_type' | 'format' | 'parent_resou
|
|
|
16760
16597
|
interface Import extends Resource {
|
|
16761
16598
|
readonly type: ImportType;
|
|
16762
16599
|
/**
|
|
16763
|
-
* The type of resource being imported.
|
|
16600
|
+
* The type of resource being imported. One of 'addresses', 'tags', 'price_lists', 'line_items', 'orders', 'tax_categories', 'skus', 'shipping_categories', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'coupons', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'gift_cards', 'line_item_options', 'stock_transfers', 'sku_options', 'prices', or 'price_tiers'.
|
|
16764
16601
|
* @example ```"skus"```
|
|
16765
16602
|
*/
|
|
16766
|
-
resource_type:
|
|
16603
|
+
resource_type: 'addresses' | 'tags' | 'price_lists' | 'line_items' | 'orders' | 'tax_categories' | 'skus' | 'shipping_categories' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'coupons' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'gift_cards' | 'line_item_options' | 'stock_transfers' | 'sku_options' | 'prices' | 'price_tiers';
|
|
16767
16604
|
/**
|
|
16768
|
-
* The format of the import
|
|
16605
|
+
* The format of the import. One of 'csv', or 'json' (default).
|
|
16769
16606
|
* @example ```"json"```
|
|
16770
16607
|
*/
|
|
16771
|
-
format?:
|
|
16608
|
+
format?: 'csv' | 'json' | null;
|
|
16772
16609
|
/**
|
|
16773
16610
|
* The ID of the parent resource to be associated with imported data.
|
|
16774
16611
|
* @example ```"1234"```
|
|
@@ -16844,15 +16681,15 @@ interface Import extends Resource {
|
|
|
16844
16681
|
}
|
|
16845
16682
|
interface ImportCreate extends ResourceCreate {
|
|
16846
16683
|
/**
|
|
16847
|
-
* The type of resource being imported.
|
|
16684
|
+
* The type of resource being imported. One of 'addresses', 'tags', 'price_lists', 'line_items', 'orders', 'tax_categories', 'skus', 'shipping_categories', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'coupons', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'gift_cards', 'line_item_options', 'stock_transfers', 'sku_options', 'prices', or 'price_tiers'.
|
|
16848
16685
|
* @example ```"skus"```
|
|
16849
16686
|
*/
|
|
16850
|
-
resource_type:
|
|
16687
|
+
resource_type: 'addresses' | 'tags' | 'price_lists' | 'line_items' | 'orders' | 'tax_categories' | 'skus' | 'shipping_categories' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'coupons' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'gift_cards' | 'line_item_options' | 'stock_transfers' | 'sku_options' | 'prices' | 'price_tiers';
|
|
16851
16688
|
/**
|
|
16852
|
-
* The format of the import
|
|
16689
|
+
* The format of the import. One of 'csv', or 'json' (default).
|
|
16853
16690
|
* @example ```"json"```
|
|
16854
16691
|
*/
|
|
16855
|
-
format?:
|
|
16692
|
+
format?: 'csv' | 'json' | null;
|
|
16856
16693
|
/**
|
|
16857
16694
|
* The ID of the parent resource to be associated with imported data.
|
|
16858
16695
|
* @example ```"1234"```
|
|
@@ -16930,7 +16767,6 @@ interface InStockSubscription extends Resource {
|
|
|
16930
16767
|
customer?: Customer | null;
|
|
16931
16768
|
sku?: Sku | null;
|
|
16932
16769
|
events?: Event[] | null;
|
|
16933
|
-
versions?: Version[] | null;
|
|
16934
16770
|
event_stores?: EventStore[] | null;
|
|
16935
16771
|
}
|
|
16936
16772
|
interface InStockSubscriptionCreate extends ResourceCreate {
|
|
@@ -16987,7 +16823,6 @@ declare class InStockSubscriptions extends ApiResource<InStockSubscription> {
|
|
|
16987
16823
|
customer(inStockSubscriptionId: string | InStockSubscription, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
|
16988
16824
|
sku(inStockSubscriptionId: string | InStockSubscription, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
|
16989
16825
|
events(inStockSubscriptionId: string | InStockSubscription, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
16990
|
-
versions(inStockSubscriptionId: string | InStockSubscription, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16991
16826
|
event_stores(inStockSubscriptionId: string | InStockSubscription, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16992
16827
|
_activate(id: string | InStockSubscription, params?: QueryParamsRetrieve<InStockSubscription>, options?: ResourcesConfig): Promise<InStockSubscription>;
|
|
16993
16828
|
_deactivate(id: string | InStockSubscription, params?: QueryParamsRetrieve<InStockSubscription>, options?: ResourcesConfig): Promise<InStockSubscription>;
|
|
@@ -17017,13 +16852,17 @@ interface KlarnaGateway extends Resource {
|
|
|
17017
16852
|
* @example ```true```
|
|
17018
16853
|
*/
|
|
17019
16854
|
force_payments?: boolean | null;
|
|
16855
|
+
/**
|
|
16856
|
+
* The payment gateway's API credential keys last digits.
|
|
16857
|
+
* @example ```{"api_key":"********BW989"}```
|
|
16858
|
+
*/
|
|
16859
|
+
credential_keys?: Record<string, any> | null;
|
|
17020
16860
|
/**
|
|
17021
16861
|
* Time at which this resource was disabled.
|
|
17022
16862
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17023
16863
|
*/
|
|
17024
16864
|
disabled_at?: string | null;
|
|
17025
16865
|
payment_methods?: PaymentMethod[] | null;
|
|
17026
|
-
versions?: Version[] | null;
|
|
17027
16866
|
event_stores?: EventStore[] | null;
|
|
17028
16867
|
klarna_payments?: KlarnaPayment[] | null;
|
|
17029
16868
|
}
|
|
@@ -17109,7 +16948,6 @@ declare class KlarnaGateways extends ApiResource<KlarnaGateway> {
|
|
|
17109
16948
|
update(resource: KlarnaGatewayUpdate, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
|
|
17110
16949
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
17111
16950
|
payment_methods(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
17112
|
-
versions(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17113
16951
|
event_stores(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17114
16952
|
klarna_payments(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<KlarnaPayment>, options?: ResourcesConfig): Promise<ListResponse<KlarnaPayment>>;
|
|
17115
16953
|
_disable(id: string | KlarnaGateway, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
|
|
@@ -17137,13 +16975,17 @@ interface ManualGateway extends Resource {
|
|
|
17137
16975
|
* @example ```true```
|
|
17138
16976
|
*/
|
|
17139
16977
|
force_payments?: boolean | null;
|
|
16978
|
+
/**
|
|
16979
|
+
* The payment gateway's API credential keys last digits.
|
|
16980
|
+
* @example ```{"api_key":"********BW989"}```
|
|
16981
|
+
*/
|
|
16982
|
+
credential_keys?: Record<string, any> | null;
|
|
17140
16983
|
/**
|
|
17141
16984
|
* Time at which this resource was disabled.
|
|
17142
16985
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17143
16986
|
*/
|
|
17144
16987
|
disabled_at?: string | null;
|
|
17145
16988
|
payment_methods?: PaymentMethod[] | null;
|
|
17146
|
-
versions?: Version[] | null;
|
|
17147
16989
|
event_stores?: EventStore[] | null;
|
|
17148
16990
|
}
|
|
17149
16991
|
interface ManualGatewayCreate extends ResourceCreate {
|
|
@@ -17196,7 +17038,6 @@ declare class ManualGateways extends ApiResource<ManualGateway> {
|
|
|
17196
17038
|
update(resource: ManualGatewayUpdate, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
|
|
17197
17039
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
17198
17040
|
payment_methods(manualGatewayId: string | ManualGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
17199
|
-
versions(manualGatewayId: string | ManualGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17200
17041
|
event_stores(manualGatewayId: string | ManualGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17201
17042
|
_disable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
|
|
17202
17043
|
_enable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
|
|
@@ -17273,6 +17114,10 @@ interface Organization extends Resource {
|
|
|
17273
17114
|
* @example ```true```
|
|
17274
17115
|
*/
|
|
17275
17116
|
api_auth_redirect?: boolean | null;
|
|
17117
|
+
/**
|
|
17118
|
+
* Enables fragment caching for resources with related directive.
|
|
17119
|
+
*/
|
|
17120
|
+
api_fragment_caching_enabled?: boolean | null;
|
|
17276
17121
|
/**
|
|
17277
17122
|
* Enables the rules engine for flex promotions and price list rules.
|
|
17278
17123
|
*/
|
|
@@ -17479,6 +17324,14 @@ interface Organization extends Resource {
|
|
|
17479
17324
|
* @example ```true```
|
|
17480
17325
|
*/
|
|
17481
17326
|
external_prices_errors?: boolean | null;
|
|
17327
|
+
/**
|
|
17328
|
+
* Enables the Sku discovery by similarity search.
|
|
17329
|
+
*/
|
|
17330
|
+
skus_discovery?: boolean | null;
|
|
17331
|
+
/**
|
|
17332
|
+
* Enables the creation of the authorization when the gateway event is received, even if there is no reference on Commerce Layer.
|
|
17333
|
+
*/
|
|
17334
|
+
payment_gateways_transaction_on_event?: boolean | null;
|
|
17482
17335
|
event_stores?: EventStore[] | null;
|
|
17483
17336
|
}
|
|
17484
17337
|
declare class Organizations extends ApiSingleton<Organization> {
|
|
@@ -17508,13 +17361,17 @@ interface PaypalGateway extends Resource {
|
|
|
17508
17361
|
* @example ```true```
|
|
17509
17362
|
*/
|
|
17510
17363
|
force_payments?: boolean | null;
|
|
17364
|
+
/**
|
|
17365
|
+
* The payment gateway's API credential keys last digits.
|
|
17366
|
+
* @example ```{"api_key":"********BW989"}```
|
|
17367
|
+
*/
|
|
17368
|
+
credential_keys?: Record<string, any> | null;
|
|
17511
17369
|
/**
|
|
17512
17370
|
* Time at which this resource was disabled.
|
|
17513
17371
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17514
17372
|
*/
|
|
17515
17373
|
disabled_at?: string | null;
|
|
17516
17374
|
payment_methods?: PaymentMethod[] | null;
|
|
17517
|
-
versions?: Version[] | null;
|
|
17518
17375
|
event_stores?: EventStore[] | null;
|
|
17519
17376
|
paypal_payments?: PaypalPayment[] | null;
|
|
17520
17377
|
}
|
|
@@ -17539,6 +17396,11 @@ interface PaypalGatewayCreate extends ResourceCreate {
|
|
|
17539
17396
|
* @example ```true```
|
|
17540
17397
|
*/
|
|
17541
17398
|
_enable?: boolean | null;
|
|
17399
|
+
/**
|
|
17400
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
17401
|
+
* @example ```true```
|
|
17402
|
+
*/
|
|
17403
|
+
_check?: boolean | null;
|
|
17542
17404
|
/**
|
|
17543
17405
|
* The gateway client ID.
|
|
17544
17406
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -17571,6 +17433,11 @@ interface PaypalGatewayUpdate extends ResourceUpdate {
|
|
|
17571
17433
|
* @example ```true```
|
|
17572
17434
|
*/
|
|
17573
17435
|
_enable?: boolean | null;
|
|
17436
|
+
/**
|
|
17437
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
17438
|
+
* @example ```true```
|
|
17439
|
+
*/
|
|
17440
|
+
_check?: boolean | null;
|
|
17574
17441
|
/**
|
|
17575
17442
|
* The gateway client ID.
|
|
17576
17443
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -17588,11 +17455,11 @@ declare class PaypalGateways extends ApiResource<PaypalGateway> {
|
|
|
17588
17455
|
update(resource: PaypalGatewayUpdate, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17589
17456
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
17590
17457
|
payment_methods(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
17591
|
-
versions(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17592
17458
|
event_stores(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17593
17459
|
paypal_payments(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<PaypalPayment>, options?: ResourcesConfig): Promise<ListResponse<PaypalPayment>>;
|
|
17594
17460
|
_disable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17595
17461
|
_enable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17462
|
+
_check(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17596
17463
|
isPaypalGateway(resource: any): resource is PaypalGateway;
|
|
17597
17464
|
relationship(id: string | ResourceId | null): PaypalGatewayRel;
|
|
17598
17465
|
relationshipToMany(...ids: string[]): PaypalGatewayRel[];
|
|
@@ -17619,6 +17486,11 @@ interface SatispayGateway extends Resource {
|
|
|
17619
17486
|
* @example ```true```
|
|
17620
17487
|
*/
|
|
17621
17488
|
force_payments?: boolean | null;
|
|
17489
|
+
/**
|
|
17490
|
+
* The payment gateway's API credential keys last digits.
|
|
17491
|
+
* @example ```{"api_key":"********BW989"}```
|
|
17492
|
+
*/
|
|
17493
|
+
credential_keys?: Record<string, any> | null;
|
|
17622
17494
|
/**
|
|
17623
17495
|
* Time at which this resource was disabled.
|
|
17624
17496
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -17640,7 +17512,6 @@ interface SatispayGateway extends Resource {
|
|
|
17640
17512
|
*/
|
|
17641
17513
|
webhook_endpoint_url?: string | null;
|
|
17642
17514
|
payment_methods?: PaymentMethod[] | null;
|
|
17643
|
-
versions?: Version[] | null;
|
|
17644
17515
|
event_stores?: EventStore[] | null;
|
|
17645
17516
|
satispay_payments?: SatispayPayment[] | null;
|
|
17646
17517
|
}
|
|
@@ -17701,7 +17572,6 @@ declare class SatispayGateways extends ApiResource<SatispayGateway> {
|
|
|
17701
17572
|
update(resource: SatispayGatewayUpdate, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
|
|
17702
17573
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
17703
17574
|
payment_methods(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
17704
|
-
versions(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17705
17575
|
event_stores(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17706
17576
|
satispay_payments(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<SatispayPayment>, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
|
|
17707
17577
|
_disable(id: string | SatispayGateway, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
|
|
@@ -17725,6 +17595,11 @@ interface StripeGateway extends Resource {
|
|
|
17725
17595
|
*/
|
|
17726
17596
|
name: string;
|
|
17727
17597
|
force_payments?: boolean | null;
|
|
17598
|
+
/**
|
|
17599
|
+
* The payment gateway's API credential keys last digits.
|
|
17600
|
+
* @example ```{"api_key":"********BW989"}```
|
|
17601
|
+
*/
|
|
17602
|
+
credential_keys?: Record<string, any> | null;
|
|
17728
17603
|
/**
|
|
17729
17604
|
* Time at which this resource was disabled.
|
|
17730
17605
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -17756,7 +17631,6 @@ interface StripeGateway extends Resource {
|
|
|
17756
17631
|
*/
|
|
17757
17632
|
webhook_endpoint_url?: string | null;
|
|
17758
17633
|
payment_methods?: PaymentMethod[] | null;
|
|
17759
|
-
versions?: Version[] | null;
|
|
17760
17634
|
event_stores?: EventStore[] | null;
|
|
17761
17635
|
stripe_payments?: StripePayment[] | null;
|
|
17762
17636
|
}
|
|
@@ -17777,6 +17651,11 @@ interface StripeGatewayCreate extends ResourceCreate {
|
|
|
17777
17651
|
* @example ```true```
|
|
17778
17652
|
*/
|
|
17779
17653
|
_enable?: boolean | null;
|
|
17654
|
+
/**
|
|
17655
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
17656
|
+
* @example ```true```
|
|
17657
|
+
*/
|
|
17658
|
+
_check?: boolean | null;
|
|
17780
17659
|
/**
|
|
17781
17660
|
* The gateway login.
|
|
17782
17661
|
* @example ```"sk_live_xxxx-yyyy-zzzz"```
|
|
@@ -17815,6 +17694,11 @@ interface StripeGatewayUpdate extends ResourceUpdate {
|
|
|
17815
17694
|
* @example ```true```
|
|
17816
17695
|
*/
|
|
17817
17696
|
_enable?: boolean | null;
|
|
17697
|
+
/**
|
|
17698
|
+
* Send this attribute if you want to check the credentials against the payment gateway's APIs.
|
|
17699
|
+
* @example ```true```
|
|
17700
|
+
*/
|
|
17701
|
+
_check?: boolean | null;
|
|
17818
17702
|
/**
|
|
17819
17703
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
|
17820
17704
|
* @example ```"acct_xxxx-yyyy-zzzz"```
|
|
@@ -17832,11 +17716,11 @@ declare class StripeGateways extends ApiResource<StripeGateway> {
|
|
|
17832
17716
|
update(resource: StripeGatewayUpdate, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17833
17717
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
17834
17718
|
payment_methods(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
17835
|
-
versions(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17836
17719
|
event_stores(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17837
17720
|
stripe_payments(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<StripePayment>, options?: ResourcesConfig): Promise<ListResponse<StripePayment>>;
|
|
17838
17721
|
_disable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17839
17722
|
_enable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17723
|
+
_check(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17840
17724
|
isStripeGateway(resource: any): resource is StripeGateway;
|
|
17841
17725
|
relationship(id: string | ResourceId | null): StripeGatewayRel;
|
|
17842
17726
|
relationshipToMany(...ids: string[]): StripeGatewayRel[];
|
|
@@ -17867,7 +17751,6 @@ interface TalonOneAccount extends Resource {
|
|
|
17867
17751
|
markets?: Market[] | null;
|
|
17868
17752
|
discount_engine_items?: DiscountEngineItem[] | null;
|
|
17869
17753
|
attachments?: Attachment[] | null;
|
|
17870
|
-
versions?: Version[] | null;
|
|
17871
17754
|
event_stores?: EventStore[] | null;
|
|
17872
17755
|
}
|
|
17873
17756
|
interface TalonOneAccountCreate extends ResourceCreate {
|
|
@@ -17920,7 +17803,6 @@ declare class TalonOneAccounts extends ApiResource<TalonOneAccount> {
|
|
|
17920
17803
|
markets(talonOneAccountId: string | TalonOneAccount, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
|
17921
17804
|
discount_engine_items(talonOneAccountId: string | TalonOneAccount, params?: QueryParamsList<DiscountEngineItem>, options?: ResourcesConfig): Promise<ListResponse<DiscountEngineItem>>;
|
|
17922
17805
|
attachments(talonOneAccountId: string | TalonOneAccount, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
17923
|
-
versions(talonOneAccountId: string | TalonOneAccount, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17924
17806
|
event_stores(talonOneAccountId: string | TalonOneAccount, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17925
17807
|
isTalonOneAccount(resource: any): resource is TalonOneAccount;
|
|
17926
17808
|
relationship(id: string | ResourceId | null): TalonOneAccountRel;
|
|
@@ -17928,7 +17810,7 @@ declare class TalonOneAccounts extends ApiResource<TalonOneAccount> {
|
|
|
17928
17810
|
type(): TalonOneAccountType;
|
|
17929
17811
|
}
|
|
17930
17812
|
|
|
17931
|
-
type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'applications' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'custom_promotion_rules' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'discount_engine_items' | 'discount_engines' | 'easypost_pickups' | 'event_callbacks' | 'event_stores' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'links' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'notifications' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'organizations' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'pickups' | 'price_frequency_tiers' | 'price_list_schedulers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'reserved_stocks' | 'resource_errors' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_reservations' | 'stock_transfers' | 'stores' | 'stripe_gateways' | 'stripe_payments' | 'stripe_tax_accounts' | 'subscription_models' | 'tags' | 'talon_one_accounts' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | '
|
|
17813
|
+
type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'applications' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'custom_promotion_rules' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'discount_engine_items' | 'discount_engines' | 'easypost_pickups' | 'event_callbacks' | 'event_stores' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'links' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'notifications' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'organizations' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'pickups' | 'price_frequency_tiers' | 'price_list_schedulers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'reserved_stocks' | 'resource_errors' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_reservations' | 'stock_transfers' | 'stores' | 'stripe_gateways' | 'stripe_payments' | 'stripe_tax_accounts' | 'subscription_models' | 'tags' | 'talon_one_accounts' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'vertex_accounts' | 'voids' | 'webhooks' | 'wire_transfers';
|
|
17932
17814
|
declare const resourceList: ResourceTypeLock[];
|
|
17933
17815
|
declare const singletonList: ResourceTypeLock[];
|
|
17934
17816
|
type RetrievableResourceType = ResourceTypeLock;
|
|
@@ -17958,13 +17840,6 @@ type TaggableResource = Resource & {
|
|
|
17958
17840
|
type: TagType;
|
|
17959
17841
|
}> | null;
|
|
17960
17842
|
};
|
|
17961
|
-
type VersionableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'custom_promotion_rules' | 'customer_addresses' | 'customer_groups' | 'customer_payment_sources' | 'customer_subscriptions' | 'delivery_lead_times' | 'discount_engines' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_list_schedulers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | 'reserved_stocks' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stores' | 'stripe_gateways' | 'stripe_payments' | 'stripe_tax_accounts' | 'talon_one_accounts' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'vertex_accounts' | 'voids' | 'webhooks' | 'wire_transfers';
|
|
17962
|
-
type VersionableResource = Resource & {
|
|
17963
|
-
type: VersionableResourceType;
|
|
17964
|
-
versions?: Array<ResourceRel & {
|
|
17965
|
-
type: VersionType;
|
|
17966
|
-
}> | null;
|
|
17967
|
-
};
|
|
17968
17843
|
type ResourceFields = {
|
|
17969
17844
|
addresses: Address;
|
|
17970
17845
|
adjustments: Adjustment;
|
|
@@ -18093,7 +17968,6 @@ type ResourceFields = {
|
|
|
18093
17968
|
tax_rules: TaxRule;
|
|
18094
17969
|
taxjar_accounts: TaxjarAccount;
|
|
18095
17970
|
transactions: Transaction;
|
|
18096
|
-
versions: Version;
|
|
18097
17971
|
vertex_accounts: VertexAccount;
|
|
18098
17972
|
voids: Void;
|
|
18099
17973
|
webhooks: Webhook;
|
|
@@ -18227,7 +18101,6 @@ type ResourceSortFields = {
|
|
|
18227
18101
|
tax_rules: TaxRuleSort;
|
|
18228
18102
|
taxjar_accounts: TaxjarAccountSort;
|
|
18229
18103
|
transactions: TransactionSort;
|
|
18230
|
-
versions: VersionSort;
|
|
18231
18104
|
vertex_accounts: VertexAccountSort;
|
|
18232
18105
|
voids: VoidSort;
|
|
18233
18106
|
webhooks: WebhookSort;
|
|
@@ -18271,7 +18144,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
|
18271
18144
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
|
18272
18145
|
declare class CommerceLayerClient {
|
|
18273
18146
|
#private;
|
|
18274
|
-
readonly openApiSchemaVersion = "7.
|
|
18147
|
+
readonly openApiSchemaVersion = "7.10.3";
|
|
18275
18148
|
constructor(config: CommerceLayerInitConfig);
|
|
18276
18149
|
get addresses(): Addresses;
|
|
18277
18150
|
get adjustments(): Adjustments;
|
|
@@ -18400,7 +18273,6 @@ declare class CommerceLayerClient {
|
|
|
18400
18273
|
get tax_rules(): TaxRules;
|
|
18401
18274
|
get taxjar_accounts(): TaxjarAccounts;
|
|
18402
18275
|
get transactions(): Transactions;
|
|
18403
|
-
get versions(): Versions;
|
|
18404
18276
|
get vertex_accounts(): VertexAccounts;
|
|
18405
18277
|
get voids(): Voids;
|
|
18406
18278
|
get webhooks(): Webhooks;
|
|
@@ -18438,4 +18310,4 @@ declare const CommerceLayerStatic: {
|
|
|
18438
18310
|
|
|
18439
18311
|
// @ts-ignore
|
|
18440
18312
|
export = CommerceLayer;
|
|
18441
|
-
export { type Address, type AddressCreate, type AddressSort, type AddressUpdate, Addresses, type Adjustment, type AdjustmentCreate, type AdjustmentSort, type AdjustmentUpdate, Adjustments, type AdyenGateway, type AdyenGatewayCreate, type AdyenGatewaySort, type AdyenGatewayUpdate, AdyenGateways, type AdyenPayment, type AdyenPaymentCreate, type AdyenPaymentSort, type AdyenPaymentUpdate, AdyenPayments, ApiError, ApiResource, ApiSingleton, type Application, type ApplicationSort, Applications, type Attachment, type AttachmentCreate, type AttachmentSort, type AttachmentUpdate, Attachments, type Authorization, type AuthorizationSort, type AuthorizationUpdate, Authorizations, type AvalaraAccount, type AvalaraAccountCreate, type AvalaraAccountSort, type AvalaraAccountUpdate, AvalaraAccounts, type AxerveGateway, type AxerveGatewayCreate, type AxerveGatewaySort, type AxerveGatewayUpdate, AxerveGateways, type AxervePayment, type AxervePaymentCreate, type AxervePaymentSort, type AxervePaymentUpdate, AxervePayments, type BingGeocoder, type BingGeocoderCreate, type BingGeocoderSort, type BingGeocoderUpdate, BingGeocoders, type BraintreeGateway, type BraintreeGatewayCreate, type BraintreeGatewaySort, type BraintreeGatewayUpdate, BraintreeGateways, type BraintreePayment, type BraintreePaymentCreate, type BraintreePaymentSort, type BraintreePaymentUpdate, BraintreePayments, type Bundle, type BundleCreate, type BundleSort, type BundleUpdate, Bundles, type BuyXPayYPromotion, type BuyXPayYPromotionCreate, type BuyXPayYPromotionSort, type BuyXPayYPromotionUpdate, BuyXPayYPromotions, type Capture, type CaptureSort, type CaptureUpdate, Captures, type CarrierAccount, type CarrierAccountCreate, type CarrierAccountSort, type CarrierAccountUpdate, CarrierAccounts, type CheckoutComGateway, type CheckoutComGatewayCreate, type CheckoutComGatewaySort, type CheckoutComGatewayUpdate, CheckoutComGateways, type CheckoutComPayment, type CheckoutComPaymentCreate, type CheckoutComPaymentSort, type CheckoutComPaymentUpdate, CheckoutComPayments, type Cleanup, type CleanupCreate, type CleanupSort, type CleanupUpdate, Cleanups, CommerceLayer, CommerceLayerClient, type CommerceLayerConfig, type CommerceLayerInitConfig, CommerceLayerStatic, type Coupon, type CouponCodesPromotionRule, type CouponCodesPromotionRuleCreate, type CouponCodesPromotionRuleSort, type CouponCodesPromotionRuleUpdate, CouponCodesPromotionRules, type CouponCreate, type CouponRecipient, type CouponRecipientCreate, type CouponRecipientSort, type CouponRecipientUpdate, CouponRecipients, type CouponSort, type CouponUpdate, Coupons, type CreatableResource, type CreatableResourceType, type CustomPromotionRule, type CustomPromotionRuleCreate, type CustomPromotionRuleSort, type CustomPromotionRuleUpdate, CustomPromotionRules, type Customer, type CustomerAddress, type CustomerAddressCreate, type CustomerAddressSort, type CustomerAddressUpdate, CustomerAddresses, type CustomerCreate, type CustomerGroup, type CustomerGroupCreate, type CustomerGroupSort, type CustomerGroupUpdate, CustomerGroups, type CustomerPasswordReset, type CustomerPasswordResetCreate, type CustomerPasswordResetSort, type CustomerPasswordResetUpdate, CustomerPasswordResets, type CustomerPaymentSource, type CustomerPaymentSourceCreate, type CustomerPaymentSourceSort, type CustomerPaymentSourceUpdate, CustomerPaymentSources, type CustomerSort, type CustomerSubscription, type CustomerSubscriptionCreate, type CustomerSubscriptionSort, type CustomerSubscriptionUpdate, CustomerSubscriptions, type CustomerUpdate, Customers, type DeletableResource, type DeletableResourceType, type DeliveryLeadTime, type DeliveryLeadTimeCreate, type DeliveryLeadTimeSort, type DeliveryLeadTimeUpdate, DeliveryLeadTimes, type DiscountEngine, type DiscountEngineItem, type DiscountEngineItemSort, DiscountEngineItems, type DiscountEngineSort, DiscountEngines, type EasypostPickup, type EasypostPickupCreate, type EasypostPickupSort, type EasypostPickupUpdate, EasypostPickups, type ErrorObj, ErrorType, type Event, type EventCallback, type EventCallbackSort, EventCallbacks, type EventSort, type EventStore, type EventStoreSort, EventStores, type EventUpdate, Events, type Export, type ExportCreate, type ExportSort, type ExportUpdate, Exports, type ExternalGateway, type ExternalGatewayCreate, type ExternalGatewaySort, type ExternalGatewayUpdate, ExternalGateways, type ExternalPayment, type ExternalPaymentCreate, type ExternalPaymentSort, type ExternalPaymentUpdate, ExternalPayments, type ExternalPromotion, type ExternalPromotionCreate, type ExternalPromotionSort, type ExternalPromotionUpdate, ExternalPromotions, type ExternalTaxCalculator, type ExternalTaxCalculatorCreate, type ExternalTaxCalculatorSort, type ExternalTaxCalculatorUpdate, ExternalTaxCalculators, type FixedAmountPromotion, type FixedAmountPromotionCreate, type FixedAmountPromotionSort, type FixedAmountPromotionUpdate, FixedAmountPromotions, type FixedPricePromotion, type FixedPricePromotionCreate, type FixedPricePromotionSort, type FixedPricePromotionUpdate, FixedPricePromotions, type FlexPromotion, type FlexPromotionCreate, type FlexPromotionSort, type FlexPromotionUpdate, FlexPromotions, type FreeGiftPromotion, type FreeGiftPromotionCreate, type FreeGiftPromotionSort, type FreeGiftPromotionUpdate, FreeGiftPromotions, type FreeShippingPromotion, type FreeShippingPromotionCreate, type FreeShippingPromotionSort, type FreeShippingPromotionUpdate, FreeShippingPromotions, type Geocoder, type GeocoderSort, Geocoders, type GiftCard, type GiftCardCreate, type GiftCardRecipient, type GiftCardRecipientCreate, type GiftCardRecipientSort, type GiftCardRecipientUpdate, GiftCardRecipients, type GiftCardSort, type GiftCardUpdate, GiftCards, type GoogleGeocoder, type GoogleGeocoderCreate, type GoogleGeocoderSort, type GoogleGeocoderUpdate, GoogleGeocoders, type HeadersObj, type Import, type ImportCreate, type ImportSort, type ImportUpdate, Imports, type InStockSubscription, type InStockSubscriptionCreate, type InStockSubscriptionSort, type InStockSubscriptionUpdate, InStockSubscriptions, type InventoryModel, type InventoryModelCreate, type InventoryModelSort, type InventoryModelUpdate, InventoryModels, type InventoryReturnLocation, type InventoryReturnLocationCreate, type InventoryReturnLocationSort, type InventoryReturnLocationUpdate, InventoryReturnLocations, type InventoryStockLocation, type InventoryStockLocationCreate, type InventoryStockLocationSort, type InventoryStockLocationUpdate, InventoryStockLocations, type KlarnaGateway, type KlarnaGatewayCreate, type KlarnaGatewaySort, type KlarnaGatewayUpdate, KlarnaGateways, type KlarnaPayment, type KlarnaPaymentCreate, type KlarnaPaymentSort, type KlarnaPaymentUpdate, KlarnaPayments, type LineItem, type LineItemCreate, type LineItemOption, type LineItemOptionCreate, type LineItemOptionSort, type LineItemOptionUpdate, LineItemOptions, type LineItemSort, type LineItemUpdate, LineItems, type Link, type LinkCreate, type LinkSort, type LinkUpdate, Links, type ListMeta, ListResponse, type ListableResource, type ListableResourceType, type ManualGateway, type ManualGatewayCreate, type ManualGatewaySort, type ManualGatewayUpdate, ManualGateways, type ManualTaxCalculator, type ManualTaxCalculatorCreate, type ManualTaxCalculatorSort, type ManualTaxCalculatorUpdate, ManualTaxCalculators, type Market, type MarketCreate, type MarketSort, type MarketUpdate, Markets, type Merchant, type MerchantCreate, type MerchantSort, type MerchantUpdate, Merchants, type Metadata, type Notification, type NotificationCreate, type NotificationSort, type NotificationUpdate, Notifications, type Order, type OrderAmountPromotionRule, type OrderAmountPromotionRuleCreate, type OrderAmountPromotionRuleSort, type OrderAmountPromotionRuleUpdate, OrderAmountPromotionRules, OrderCopies, type OrderCopy, type OrderCopyCreate, type OrderCopySort, type OrderCopyUpdate, type OrderCreate, OrderFactories, type OrderFactory, type OrderFactorySort, type OrderSort, type OrderSubscription, type OrderSubscriptionCreate, type OrderSubscriptionItem, type OrderSubscriptionItemCreate, type OrderSubscriptionItemSort, type OrderSubscriptionItemUpdate, OrderSubscriptionItems, type OrderSubscriptionSort, type OrderSubscriptionUpdate, OrderSubscriptions, type OrderUpdate, Orders, type Organization, type OrganizationSort, Organizations, type Package, type PackageCreate, type PackageSort, type PackageUpdate, Packages, type Parcel, type ParcelCreate, type ParcelLineItem, type ParcelLineItemCreate, type ParcelLineItemSort, type ParcelLineItemUpdate, ParcelLineItems, type ParcelSort, type ParcelUpdate, Parcels, type PaymentGateway, type PaymentGatewaySort, PaymentGateways, type PaymentMethod, type PaymentMethodCreate, type PaymentMethodSort, type PaymentMethodUpdate, PaymentMethods, type PaymentOption, type PaymentOptionCreate, type PaymentOptionSort, type PaymentOptionUpdate, PaymentOptions, type PaypalGateway, type PaypalGatewayCreate, type PaypalGatewaySort, type PaypalGatewayUpdate, PaypalGateways, type PaypalPayment, type PaypalPaymentCreate, type PaypalPaymentSort, type PaypalPaymentUpdate, PaypalPayments, type PercentageDiscountPromotion, type PercentageDiscountPromotionCreate, type PercentageDiscountPromotionSort, type PercentageDiscountPromotionUpdate, PercentageDiscountPromotions, type Pickup, type PickupSort, Pickups, type Price, type PriceCreate, type PriceFrequencyTier, type PriceFrequencyTierCreate, type PriceFrequencyTierSort, type PriceFrequencyTierUpdate, PriceFrequencyTiers, type PriceList, type PriceListCreate, type PriceListScheduler, type PriceListSchedulerCreate, type PriceListSchedulerSort, type PriceListSchedulerUpdate, PriceListSchedulers, type PriceListSort, type PriceListUpdate, PriceLists, type PriceSort, type PriceTier, type PriceTierSort, PriceTiers, type PriceUpdate, type PriceVolumeTier, type PriceVolumeTierCreate, type PriceVolumeTierSort, type PriceVolumeTierUpdate, PriceVolumeTiers, Prices, type Promotion, type PromotionRule, type PromotionRuleSort, PromotionRules, type PromotionSort, Promotions, type QueryArrayFields, type QueryArraySortable, type QueryFields, type QueryFilter, type QueryInclude, type QueryPageNumber, type QueryPageSize, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type QueryRecordFields, type QueryRecordSortable, type QuerySort, RecurringOrderCopies, type RecurringOrderCopy, type RecurringOrderCopyCreate, type RecurringOrderCopySort, type RecurringOrderCopyUpdate, type Refund, type RefundSort, type RefundUpdate, Refunds, type RequestObj, type ReservedStock, type ReservedStockSort, ReservedStocks, type Resource, ResourceAdapter, type ResourceCreate, type ResourceError, type ResourceErrorSort, ResourceErrors, type ResourceFields, type ResourceFilter, type ResourceId, type ResourceRel, type ResourceSort, type ResourceSortFields, type ResourceType, type ResourceTypeLock, type ResourceUpdate, type ResourcesConfig, type ResourcesInitConfig, type ResponseObj, type RetrievableResource, type RetrievableResourceType, type Return, type ReturnCreate, type ReturnLineItem, type ReturnLineItemCreate, type ReturnLineItemSort, type ReturnLineItemUpdate, ReturnLineItems, type ReturnSort, type ReturnUpdate, Returns, type SatispayGateway, type SatispayGatewayCreate, type SatispayGatewaySort, type SatispayGatewayUpdate, SatispayGateways, type SatispayPayment, type SatispayPaymentCreate, type SatispayPaymentSort, type SatispayPaymentUpdate, SatispayPayments, SdkError, type Shipment, type ShipmentCreate, type ShipmentSort, type ShipmentUpdate, Shipments, ShippingCategories, type ShippingCategory, type ShippingCategoryCreate, type ShippingCategorySort, type ShippingCategoryUpdate, type ShippingMethod, type ShippingMethodCreate, type ShippingMethodSort, type ShippingMethodTier, type ShippingMethodTierSort, ShippingMethodTiers, type ShippingMethodUpdate, ShippingMethods, type ShippingWeightTier, type ShippingWeightTierCreate, type ShippingWeightTierSort, type ShippingWeightTierUpdate, ShippingWeightTiers, type ShippingZone, type ShippingZoneCreate, type ShippingZoneSort, type ShippingZoneUpdate, ShippingZones, type Sku, type SkuCreate, type SkuList, type SkuListCreate, type SkuListItem, type SkuListItemCreate, type SkuListItemSort, type SkuListItemUpdate, SkuListItems, type SkuListPromotionRule, type SkuListPromotionRuleCreate, type SkuListPromotionRuleSort, type SkuListPromotionRuleUpdate, SkuListPromotionRules, type SkuListSort, type SkuListUpdate, SkuLists, type SkuOption, type SkuOptionCreate, type SkuOptionSort, type SkuOptionUpdate, SkuOptions, type SkuSort, type SkuUpdate, Skus, type StockItem, type StockItemCreate, type StockItemSort, type StockItemUpdate, StockItems, type StockLineItem, type StockLineItemCreate, type StockLineItemSort, type StockLineItemUpdate, StockLineItems, type StockLocation, type StockLocationCreate, type StockLocationSort, type StockLocationUpdate, StockLocations, type StockReservation, type StockReservationCreate, type StockReservationSort, type StockReservationUpdate, StockReservations, type StockTransfer, type StockTransferCreate, type StockTransferSort, type StockTransferUpdate, StockTransfers, type Store, type StoreCreate, type StoreSort, type StoreUpdate, Stores, type StripeGateway, type StripeGatewayCreate, type StripeGatewaySort, type StripeGatewayUpdate, StripeGateways, type StripePayment, type StripePaymentCreate, type StripePaymentSort, type StripePaymentUpdate, StripePayments, type StripeTaxAccount, type StripeTaxAccountCreate, type StripeTaxAccountSort, type StripeTaxAccountUpdate, StripeTaxAccounts, type SubscriptionModel, type SubscriptionModelCreate, type SubscriptionModelSort, type SubscriptionModelUpdate, SubscriptionModels, type Tag, type TagCreate, type TagSort, type TagUpdate, type TaggableResource, type TaggableResourceType, Tags, type TalonOneAccount, type TalonOneAccountCreate, type TalonOneAccountSort, type TalonOneAccountUpdate, TalonOneAccounts, type TaxCalculator, type TaxCalculatorSort, TaxCalculators, TaxCategories, type TaxCategory, type TaxCategoryCreate, type TaxCategorySort, type TaxCategoryUpdate, type TaxRule, type TaxRuleCreate, type TaxRuleSort, type TaxRuleUpdate, TaxRules, type TaxjarAccount, type TaxjarAccountCreate, type TaxjarAccountSort, type TaxjarAccountUpdate, TaxjarAccounts, type Transaction, type TransactionSort, Transactions, type UpdatableResource, type UpdatableResourceType, type Version, type VersionSort, type VersionableResource, type VersionableResourceType, Versions, type VertexAccount, type VertexAccountCreate, type VertexAccountSort, type VertexAccountUpdate, VertexAccounts, type Void, type VoidSort, type VoidUpdate, Voids, type Webhook, type WebhookCreate, type WebhookSort, type WebhookUpdate, Webhooks, type WireTransfer, type WireTransferCreate, type WireTransferSort, type WireTransferUpdate, WireTransfers, apiResourceAdapter, generateQueryStringParams, generateSearchString, isParamsList, resourceList, singletonList };
|
|
18313
|
+
export { type Address, type AddressCreate, type AddressSort, type AddressUpdate, Addresses, type Adjustment, type AdjustmentCreate, type AdjustmentSort, type AdjustmentUpdate, Adjustments, type AdyenGateway, type AdyenGatewayCreate, type AdyenGatewaySort, type AdyenGatewayUpdate, AdyenGateways, type AdyenPayment, type AdyenPaymentCreate, type AdyenPaymentSort, type AdyenPaymentUpdate, AdyenPayments, ApiError, ApiResource, ApiSingleton, type Application, type ApplicationSort, Applications, type Attachment, type AttachmentCreate, type AttachmentSort, type AttachmentUpdate, Attachments, type Authorization, type AuthorizationSort, type AuthorizationUpdate, Authorizations, type AvalaraAccount, type AvalaraAccountCreate, type AvalaraAccountSort, type AvalaraAccountUpdate, AvalaraAccounts, type AxerveGateway, type AxerveGatewayCreate, type AxerveGatewaySort, type AxerveGatewayUpdate, AxerveGateways, type AxervePayment, type AxervePaymentCreate, type AxervePaymentSort, type AxervePaymentUpdate, AxervePayments, type BingGeocoder, type BingGeocoderCreate, type BingGeocoderSort, type BingGeocoderUpdate, BingGeocoders, type BraintreeGateway, type BraintreeGatewayCreate, type BraintreeGatewaySort, type BraintreeGatewayUpdate, BraintreeGateways, type BraintreePayment, type BraintreePaymentCreate, type BraintreePaymentSort, type BraintreePaymentUpdate, BraintreePayments, type Bundle, type BundleCreate, type BundleSort, type BundleUpdate, Bundles, type BuyXPayYPromotion, type BuyXPayYPromotionCreate, type BuyXPayYPromotionSort, type BuyXPayYPromotionUpdate, BuyXPayYPromotions, type Capture, type CaptureSort, type CaptureUpdate, Captures, type CarrierAccount, type CarrierAccountCreate, type CarrierAccountSort, type CarrierAccountUpdate, CarrierAccounts, type CheckoutComGateway, type CheckoutComGatewayCreate, type CheckoutComGatewaySort, type CheckoutComGatewayUpdate, CheckoutComGateways, type CheckoutComPayment, type CheckoutComPaymentCreate, type CheckoutComPaymentSort, type CheckoutComPaymentUpdate, CheckoutComPayments, type Cleanup, type CleanupCreate, type CleanupSort, type CleanupUpdate, Cleanups, CommerceLayer, CommerceLayerClient, type CommerceLayerConfig, type CommerceLayerInitConfig, CommerceLayerStatic, type Coupon, type CouponCodesPromotionRule, type CouponCodesPromotionRuleCreate, type CouponCodesPromotionRuleSort, type CouponCodesPromotionRuleUpdate, CouponCodesPromotionRules, type CouponCreate, type CouponRecipient, type CouponRecipientCreate, type CouponRecipientSort, type CouponRecipientUpdate, CouponRecipients, type CouponSort, type CouponUpdate, Coupons, type CreatableResource, type CreatableResourceType, type CustomPromotionRule, type CustomPromotionRuleCreate, type CustomPromotionRuleSort, type CustomPromotionRuleUpdate, CustomPromotionRules, type Customer, type CustomerAddress, type CustomerAddressCreate, type CustomerAddressSort, type CustomerAddressUpdate, CustomerAddresses, type CustomerCreate, type CustomerGroup, type CustomerGroupCreate, type CustomerGroupSort, type CustomerGroupUpdate, CustomerGroups, type CustomerPasswordReset, type CustomerPasswordResetCreate, type CustomerPasswordResetSort, type CustomerPasswordResetUpdate, CustomerPasswordResets, type CustomerPaymentSource, type CustomerPaymentSourceCreate, type CustomerPaymentSourceSort, type CustomerPaymentSourceUpdate, CustomerPaymentSources, type CustomerSort, type CustomerSubscription, type CustomerSubscriptionCreate, type CustomerSubscriptionSort, type CustomerSubscriptionUpdate, CustomerSubscriptions, type CustomerUpdate, Customers, type DeletableResource, type DeletableResourceType, type DeliveryLeadTime, type DeliveryLeadTimeCreate, type DeliveryLeadTimeSort, type DeliveryLeadTimeUpdate, DeliveryLeadTimes, type DiscountEngine, type DiscountEngineItem, type DiscountEngineItemSort, DiscountEngineItems, type DiscountEngineSort, DiscountEngines, type EasypostPickup, type EasypostPickupCreate, type EasypostPickupSort, type EasypostPickupUpdate, EasypostPickups, type ErrorObj, ErrorType, type Event, type EventCallback, type EventCallbackSort, EventCallbacks, type EventSort, type EventStore, type EventStoreSort, EventStores, type EventUpdate, Events, type Export, type ExportCreate, type ExportSort, type ExportUpdate, Exports, type ExternalGateway, type ExternalGatewayCreate, type ExternalGatewaySort, type ExternalGatewayUpdate, ExternalGateways, type ExternalPayment, type ExternalPaymentCreate, type ExternalPaymentSort, type ExternalPaymentUpdate, ExternalPayments, type ExternalPromotion, type ExternalPromotionCreate, type ExternalPromotionSort, type ExternalPromotionUpdate, ExternalPromotions, type ExternalTaxCalculator, type ExternalTaxCalculatorCreate, type ExternalTaxCalculatorSort, type ExternalTaxCalculatorUpdate, ExternalTaxCalculators, type FixedAmountPromotion, type FixedAmountPromotionCreate, type FixedAmountPromotionSort, type FixedAmountPromotionUpdate, FixedAmountPromotions, type FixedPricePromotion, type FixedPricePromotionCreate, type FixedPricePromotionSort, type FixedPricePromotionUpdate, FixedPricePromotions, type FlexPromotion, type FlexPromotionCreate, type FlexPromotionSort, type FlexPromotionUpdate, FlexPromotions, type FreeGiftPromotion, type FreeGiftPromotionCreate, type FreeGiftPromotionSort, type FreeGiftPromotionUpdate, FreeGiftPromotions, type FreeShippingPromotion, type FreeShippingPromotionCreate, type FreeShippingPromotionSort, type FreeShippingPromotionUpdate, FreeShippingPromotions, type Geocoder, type GeocoderSort, Geocoders, type GiftCard, type GiftCardCreate, type GiftCardRecipient, type GiftCardRecipientCreate, type GiftCardRecipientSort, type GiftCardRecipientUpdate, GiftCardRecipients, type GiftCardSort, type GiftCardUpdate, GiftCards, type GoogleGeocoder, type GoogleGeocoderCreate, type GoogleGeocoderSort, type GoogleGeocoderUpdate, GoogleGeocoders, type HeadersObj, type Import, type ImportCreate, type ImportSort, type ImportUpdate, Imports, type InStockSubscription, type InStockSubscriptionCreate, type InStockSubscriptionSort, type InStockSubscriptionUpdate, InStockSubscriptions, type InventoryModel, type InventoryModelCreate, type InventoryModelSort, type InventoryModelUpdate, InventoryModels, type InventoryReturnLocation, type InventoryReturnLocationCreate, type InventoryReturnLocationSort, type InventoryReturnLocationUpdate, InventoryReturnLocations, type InventoryStockLocation, type InventoryStockLocationCreate, type InventoryStockLocationSort, type InventoryStockLocationUpdate, InventoryStockLocations, type KlarnaGateway, type KlarnaGatewayCreate, type KlarnaGatewaySort, type KlarnaGatewayUpdate, KlarnaGateways, type KlarnaPayment, type KlarnaPaymentCreate, type KlarnaPaymentSort, type KlarnaPaymentUpdate, KlarnaPayments, type LineItem, type LineItemCreate, type LineItemOption, type LineItemOptionCreate, type LineItemOptionSort, type LineItemOptionUpdate, LineItemOptions, type LineItemSort, type LineItemUpdate, LineItems, type Link, type LinkCreate, type LinkSort, type LinkUpdate, Links, type ListMeta, ListResponse, type ListableResource, type ListableResourceType, type ManualGateway, type ManualGatewayCreate, type ManualGatewaySort, type ManualGatewayUpdate, ManualGateways, type ManualTaxCalculator, type ManualTaxCalculatorCreate, type ManualTaxCalculatorSort, type ManualTaxCalculatorUpdate, ManualTaxCalculators, type Market, type MarketCreate, type MarketSort, type MarketUpdate, Markets, type Merchant, type MerchantCreate, type MerchantSort, type MerchantUpdate, Merchants, type Metadata, type Notification, type NotificationCreate, type NotificationSort, type NotificationUpdate, Notifications, type Order, type OrderAmountPromotionRule, type OrderAmountPromotionRuleCreate, type OrderAmountPromotionRuleSort, type OrderAmountPromotionRuleUpdate, OrderAmountPromotionRules, OrderCopies, type OrderCopy, type OrderCopyCreate, type OrderCopySort, type OrderCopyUpdate, type OrderCreate, OrderFactories, type OrderFactory, type OrderFactorySort, type OrderSort, type OrderSubscription, type OrderSubscriptionCreate, type OrderSubscriptionItem, type OrderSubscriptionItemCreate, type OrderSubscriptionItemSort, type OrderSubscriptionItemUpdate, OrderSubscriptionItems, type OrderSubscriptionSort, type OrderSubscriptionUpdate, OrderSubscriptions, type OrderUpdate, Orders, type Organization, type OrganizationSort, Organizations, type Package, type PackageCreate, type PackageSort, type PackageUpdate, Packages, type Parcel, type ParcelCreate, type ParcelLineItem, type ParcelLineItemCreate, type ParcelLineItemSort, type ParcelLineItemUpdate, ParcelLineItems, type ParcelSort, type ParcelUpdate, Parcels, type PaymentGateway, type PaymentGatewaySort, PaymentGateways, type PaymentMethod, type PaymentMethodCreate, type PaymentMethodSort, type PaymentMethodUpdate, PaymentMethods, type PaymentOption, type PaymentOptionCreate, type PaymentOptionSort, type PaymentOptionUpdate, PaymentOptions, type PaypalGateway, type PaypalGatewayCreate, type PaypalGatewaySort, type PaypalGatewayUpdate, PaypalGateways, type PaypalPayment, type PaypalPaymentCreate, type PaypalPaymentSort, type PaypalPaymentUpdate, PaypalPayments, type PercentageDiscountPromotion, type PercentageDiscountPromotionCreate, type PercentageDiscountPromotionSort, type PercentageDiscountPromotionUpdate, PercentageDiscountPromotions, type Pickup, type PickupSort, Pickups, type Price, type PriceCreate, type PriceFrequencyTier, type PriceFrequencyTierCreate, type PriceFrequencyTierSort, type PriceFrequencyTierUpdate, PriceFrequencyTiers, type PriceList, type PriceListCreate, type PriceListScheduler, type PriceListSchedulerCreate, type PriceListSchedulerSort, type PriceListSchedulerUpdate, PriceListSchedulers, type PriceListSort, type PriceListUpdate, PriceLists, type PriceSort, type PriceTier, type PriceTierSort, PriceTiers, type PriceUpdate, type PriceVolumeTier, type PriceVolumeTierCreate, type PriceVolumeTierSort, type PriceVolumeTierUpdate, PriceVolumeTiers, Prices, type Promotion, type PromotionRule, type PromotionRuleSort, PromotionRules, type PromotionSort, Promotions, type QueryArrayFields, type QueryArraySortable, type QueryFields, type QueryFilter, type QueryInclude, type QueryPageNumber, type QueryPageSize, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type QueryRecordFields, type QueryRecordSortable, type QuerySort, RecurringOrderCopies, type RecurringOrderCopy, type RecurringOrderCopyCreate, type RecurringOrderCopySort, type RecurringOrderCopyUpdate, type Refund, type RefundSort, type RefundUpdate, Refunds, type RequestObj, type ReservedStock, type ReservedStockSort, ReservedStocks, type Resource, ResourceAdapter, type ResourceCreate, type ResourceError, type ResourceErrorSort, ResourceErrors, type ResourceFields, type ResourceFilter, type ResourceId, type ResourceRel, type ResourceSort, type ResourceSortFields, type ResourceType, type ResourceTypeLock, type ResourceUpdate, type ResourcesConfig, type ResourcesInitConfig, type ResponseObj, type RetrievableResource, type RetrievableResourceType, type Return, type ReturnCreate, type ReturnLineItem, type ReturnLineItemCreate, type ReturnLineItemSort, type ReturnLineItemUpdate, ReturnLineItems, type ReturnSort, type ReturnUpdate, Returns, type SatispayGateway, type SatispayGatewayCreate, type SatispayGatewaySort, type SatispayGatewayUpdate, SatispayGateways, type SatispayPayment, type SatispayPaymentCreate, type SatispayPaymentSort, type SatispayPaymentUpdate, SatispayPayments, SdkError, type Shipment, type ShipmentCreate, type ShipmentSort, type ShipmentUpdate, Shipments, ShippingCategories, type ShippingCategory, type ShippingCategoryCreate, type ShippingCategorySort, type ShippingCategoryUpdate, type ShippingMethod, type ShippingMethodCreate, type ShippingMethodSort, type ShippingMethodTier, type ShippingMethodTierSort, ShippingMethodTiers, type ShippingMethodUpdate, ShippingMethods, type ShippingWeightTier, type ShippingWeightTierCreate, type ShippingWeightTierSort, type ShippingWeightTierUpdate, ShippingWeightTiers, type ShippingZone, type ShippingZoneCreate, type ShippingZoneSort, type ShippingZoneUpdate, ShippingZones, type Sku, type SkuCreate, type SkuList, type SkuListCreate, type SkuListItem, type SkuListItemCreate, type SkuListItemSort, type SkuListItemUpdate, SkuListItems, type SkuListPromotionRule, type SkuListPromotionRuleCreate, type SkuListPromotionRuleSort, type SkuListPromotionRuleUpdate, SkuListPromotionRules, type SkuListSort, type SkuListUpdate, SkuLists, type SkuOption, type SkuOptionCreate, type SkuOptionSort, type SkuOptionUpdate, SkuOptions, type SkuSort, type SkuUpdate, Skus, type StockItem, type StockItemCreate, type StockItemSort, type StockItemUpdate, StockItems, type StockLineItem, type StockLineItemCreate, type StockLineItemSort, type StockLineItemUpdate, StockLineItems, type StockLocation, type StockLocationCreate, type StockLocationSort, type StockLocationUpdate, StockLocations, type StockReservation, type StockReservationCreate, type StockReservationSort, type StockReservationUpdate, StockReservations, type StockTransfer, type StockTransferCreate, type StockTransferSort, type StockTransferUpdate, StockTransfers, type Store, type StoreCreate, type StoreSort, type StoreUpdate, Stores, type StripeGateway, type StripeGatewayCreate, type StripeGatewaySort, type StripeGatewayUpdate, StripeGateways, type StripePayment, type StripePaymentCreate, type StripePaymentSort, type StripePaymentUpdate, StripePayments, type StripeTaxAccount, type StripeTaxAccountCreate, type StripeTaxAccountSort, type StripeTaxAccountUpdate, StripeTaxAccounts, type SubscriptionModel, type SubscriptionModelCreate, type SubscriptionModelSort, type SubscriptionModelUpdate, SubscriptionModels, type Tag, type TagCreate, type TagSort, type TagUpdate, type TaggableResource, type TaggableResourceType, Tags, type TalonOneAccount, type TalonOneAccountCreate, type TalonOneAccountSort, type TalonOneAccountUpdate, TalonOneAccounts, type TaxCalculator, type TaxCalculatorSort, TaxCalculators, TaxCategories, type TaxCategory, type TaxCategoryCreate, type TaxCategorySort, type TaxCategoryUpdate, type TaxRule, type TaxRuleCreate, type TaxRuleSort, type TaxRuleUpdate, TaxRules, type TaxjarAccount, type TaxjarAccountCreate, type TaxjarAccountSort, type TaxjarAccountUpdate, TaxjarAccounts, type Transaction, type TransactionSort, Transactions, type UpdatableResource, type UpdatableResourceType, type VertexAccount, type VertexAccountCreate, type VertexAccountSort, type VertexAccountUpdate, VertexAccounts, type Void, type VoidSort, type VoidUpdate, Voids, type Webhook, type WebhookCreate, type WebhookSort, type WebhookUpdate, Webhooks, type WireTransfer, type WireTransferCreate, type WireTransferSort, type WireTransferUpdate, WireTransfers, apiResourceAdapter, generateQueryStringParams, generateSearchString, isParamsList, resourceList, singletonList };
|