@commercelayer/sdk 6.34.0 → 6.36.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 +282 -39
- package/lib/index.d.ts +282 -39
- package/lib/index.js +2 -1
- package/lib/index.mjs +2 -1
- package/package.json +3 -3
package/lib/index.d.mts
CHANGED
@@ -1012,7 +1012,7 @@ declare class Stores extends ApiResource<Store> {
|
|
1012
1012
|
}
|
1013
1013
|
|
1014
1014
|
type PaymentMethodType = 'payment_methods';
|
1015
|
-
type PaymentMethodRel$
|
1015
|
+
type PaymentMethodRel$5 = ResourceRel & {
|
1016
1016
|
type: PaymentMethodType;
|
1017
1017
|
};
|
1018
1018
|
type MarketRel$i = ResourceRel & {
|
@@ -1224,8 +1224,8 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
|
|
1224
1224
|
_disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
1225
1225
|
_enable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
1226
1226
|
isPaymentMethod(resource: any): resource is PaymentMethod;
|
1227
|
-
relationship(id: string | ResourceId | null): PaymentMethodRel$
|
1228
|
-
relationshipToMany(...ids: string[]): PaymentMethodRel$
|
1227
|
+
relationship(id: string | ResourceId | null): PaymentMethodRel$5;
|
1228
|
+
relationshipToMany(...ids: string[]): PaymentMethodRel$5[];
|
1229
1229
|
type(): PaymentMethodType;
|
1230
1230
|
}
|
1231
1231
|
|
@@ -2194,7 +2194,7 @@ type CustomerPaymentSourceRel$1 = ResourceRel & {
|
|
2194
2194
|
type CustomerRel$7 = ResourceRel & {
|
2195
2195
|
type: CustomerType;
|
2196
2196
|
};
|
2197
|
-
type PaymentMethodRel$
|
2197
|
+
type PaymentMethodRel$4 = ResourceRel & {
|
2198
2198
|
type: PaymentMethodType;
|
2199
2199
|
};
|
2200
2200
|
type AdyenPaymentRel$2 = ResourceRel & {
|
@@ -2262,7 +2262,7 @@ interface CustomerPaymentSourceCreate extends ResourceCreate {
|
|
2262
2262
|
*/
|
2263
2263
|
payment_source_token?: string | null;
|
2264
2264
|
customer: CustomerRel$7;
|
2265
|
-
payment_method?: PaymentMethodRel$
|
2265
|
+
payment_method?: PaymentMethodRel$4 | null;
|
2266
2266
|
payment_source?: AdyenPaymentRel$2 | AxervePaymentRel$2 | BraintreePaymentRel$2 | CheckoutComPaymentRel$2 | ExternalPaymentRel$1 | KlarnaPaymentRel$2 | PaypalPaymentRel$1 | SatispayPaymentRel$2 | StripePaymentRel$1 | WireTransferRel$1 | null;
|
2267
2267
|
}
|
2268
2268
|
interface CustomerPaymentSourceUpdate extends ResourceUpdate {
|
@@ -2277,7 +2277,7 @@ interface CustomerPaymentSourceUpdate extends ResourceUpdate {
|
|
2277
2277
|
*/
|
2278
2278
|
payment_source_token?: string | null;
|
2279
2279
|
customer?: CustomerRel$7 | null;
|
2280
|
-
payment_method?: PaymentMethodRel$
|
2280
|
+
payment_method?: PaymentMethodRel$4 | null;
|
2281
2281
|
payment_source?: AdyenPaymentRel$2 | AxervePaymentRel$2 | BraintreePaymentRel$2 | CheckoutComPaymentRel$2 | ExternalPaymentRel$1 | KlarnaPaymentRel$2 | PaypalPaymentRel$1 | SatispayPaymentRel$2 | StripePaymentRel$1 | WireTransferRel$1 | null;
|
2282
2282
|
}
|
2283
2283
|
declare class CustomerPaymentSources extends ApiResource<CustomerPaymentSource> {
|
@@ -2562,6 +2562,14 @@ interface SkuOptionUpdate extends ResourceUpdate {
|
|
2562
2562
|
* @example ```"^(A|B).*$"```
|
2563
2563
|
*/
|
2564
2564
|
sku_code_regex?: string | null;
|
2565
|
+
/**
|
2566
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
2567
|
+
*/
|
2568
|
+
_add_tags?: string | null;
|
2569
|
+
/**
|
2570
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
2571
|
+
*/
|
2572
|
+
_remove_tags?: string | null;
|
2565
2573
|
market?: MarketRel$h | null;
|
2566
2574
|
tags?: TagRel$k[] | null;
|
2567
2575
|
}
|
@@ -2575,6 +2583,8 @@ declare class SkuOptions extends ApiResource<SkuOption> {
|
|
2575
2583
|
events(skuOptionId: string | SkuOption, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
2576
2584
|
tags(skuOptionId: string | SkuOption, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
2577
2585
|
versions(skuOptionId: string | SkuOption, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
2586
|
+
_add_tags(id: string | SkuOption, triggerValue: string, params?: QueryParamsRetrieve<SkuOption>, options?: ResourcesConfig): Promise<SkuOption>;
|
2587
|
+
_remove_tags(id: string | SkuOption, triggerValue: string, params?: QueryParamsRetrieve<SkuOption>, options?: ResourcesConfig): Promise<SkuOption>;
|
2578
2588
|
isSkuOption(resource: any): resource is SkuOption;
|
2579
2589
|
relationship(id: string | ResourceId | null): SkuOptionRel$2;
|
2580
2590
|
relationshipToMany(...ids: string[]): SkuOptionRel$2[];
|
@@ -2708,6 +2718,14 @@ interface LineItemOptionUpdate extends ResourceUpdate {
|
|
2708
2718
|
* @example ```{"embossing_text":"Happy Birthday!"}```
|
2709
2719
|
*/
|
2710
2720
|
options?: Record<string, any> | null;
|
2721
|
+
/**
|
2722
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
2723
|
+
*/
|
2724
|
+
_add_tags?: string | null;
|
2725
|
+
/**
|
2726
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
2727
|
+
*/
|
2728
|
+
_remove_tags?: string | null;
|
2711
2729
|
sku_option?: SkuOptionRel$1 | null;
|
2712
2730
|
tags?: TagRel$j[] | null;
|
2713
2731
|
}
|
@@ -2720,6 +2738,8 @@ declare class LineItemOptions extends ApiResource<LineItemOption> {
|
|
2720
2738
|
sku_option(lineItemOptionId: string | LineItemOption, params?: QueryParamsRetrieve<SkuOption>, options?: ResourcesConfig): Promise<SkuOption>;
|
2721
2739
|
events(lineItemOptionId: string | LineItemOption, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
2722
2740
|
tags(lineItemOptionId: string | LineItemOption, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
2741
|
+
_add_tags(id: string | LineItemOption, triggerValue: string, params?: QueryParamsRetrieve<LineItemOption>, options?: ResourcesConfig): Promise<LineItemOption>;
|
2742
|
+
_remove_tags(id: string | LineItemOption, triggerValue: string, params?: QueryParamsRetrieve<LineItemOption>, options?: ResourcesConfig): Promise<LineItemOption>;
|
2723
2743
|
isLineItemOption(resource: any): resource is LineItemOption;
|
2724
2744
|
relationship(id: string | ResourceId | null): LineItemOptionRel;
|
2725
2745
|
relationshipToMany(...ids: string[]): LineItemOptionRel[];
|
@@ -3449,6 +3469,14 @@ interface ReturnUpdate extends ResourceUpdate {
|
|
3449
3469
|
* @example ```500```
|
3450
3470
|
*/
|
3451
3471
|
_refund_amount_cents?: number | null;
|
3472
|
+
/**
|
3473
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
3474
|
+
*/
|
3475
|
+
_add_tags?: string | null;
|
3476
|
+
/**
|
3477
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
3478
|
+
*/
|
3479
|
+
_remove_tags?: string | null;
|
3452
3480
|
stock_location?: StockLocationRel$7 | null;
|
3453
3481
|
reference_capture?: CaptureRel | null;
|
3454
3482
|
tags?: TagRel$i[] | null;
|
@@ -3482,6 +3510,8 @@ declare class Returns extends ApiResource<Return> {
|
|
3482
3510
|
_unarchive(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
3483
3511
|
_refund(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
3484
3512
|
_refund_amount_cents(id: string | Return, triggerValue: number, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
3513
|
+
_add_tags(id: string | Return, triggerValue: string, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
3514
|
+
_remove_tags(id: string | Return, triggerValue: string, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return>;
|
3485
3515
|
isReturn(resource: any): resource is Return;
|
3486
3516
|
relationship(id: string | ResourceId | null): ReturnRel$2;
|
3487
3517
|
relationshipToMany(...ids: string[]): ReturnRel$2[];
|
@@ -3957,7 +3987,7 @@ type DeliveryLeadTimeRel$1 = ResourceRel & {
|
|
3957
3987
|
type StockLocationRel$6 = ResourceRel & {
|
3958
3988
|
type: StockLocationType;
|
3959
3989
|
};
|
3960
|
-
type ShippingMethodRel$
|
3990
|
+
type ShippingMethodRel$6 = ResourceRel & {
|
3961
3991
|
type: ShippingMethodType;
|
3962
3992
|
};
|
3963
3993
|
type DeliveryLeadTimeSort = Pick<DeliveryLeadTime, 'id' | 'min_hours' | 'max_hours' | 'min_days'> & ResourceSort;
|
@@ -4000,7 +4030,7 @@ interface DeliveryLeadTimeCreate extends ResourceCreate {
|
|
4000
4030
|
*/
|
4001
4031
|
max_hours: number;
|
4002
4032
|
stock_location: StockLocationRel$6;
|
4003
|
-
shipping_method: ShippingMethodRel$
|
4033
|
+
shipping_method: ShippingMethodRel$6;
|
4004
4034
|
}
|
4005
4035
|
interface DeliveryLeadTimeUpdate extends ResourceUpdate {
|
4006
4036
|
/**
|
@@ -4014,7 +4044,7 @@ interface DeliveryLeadTimeUpdate extends ResourceUpdate {
|
|
4014
4044
|
*/
|
4015
4045
|
max_hours?: number | null;
|
4016
4046
|
stock_location?: StockLocationRel$6 | null;
|
4017
|
-
shipping_method?: ShippingMethodRel$
|
4047
|
+
shipping_method?: ShippingMethodRel$6 | null;
|
4018
4048
|
}
|
4019
4049
|
declare class DeliveryLeadTimes extends ApiResource<DeliveryLeadTime> {
|
4020
4050
|
static readonly TYPE: DeliveryLeadTimeType;
|
@@ -4082,7 +4112,7 @@ type ShippingWeightTierType = 'shipping_weight_tiers';
|
|
4082
4112
|
type ShippingWeightTierRel = ResourceRel & {
|
4083
4113
|
type: ShippingWeightTierType;
|
4084
4114
|
};
|
4085
|
-
type ShippingMethodRel$
|
4115
|
+
type ShippingMethodRel$5 = ResourceRel & {
|
4086
4116
|
type: ShippingMethodType;
|
4087
4117
|
};
|
4088
4118
|
type ShippingWeightTierSort = Pick<ShippingWeightTier, 'id' | 'name' | 'up_to' | 'price_amount_cents'> & ResourceSort;
|
@@ -4133,7 +4163,7 @@ interface ShippingWeightTierCreate extends ResourceCreate {
|
|
4133
4163
|
* @example ```1000```
|
4134
4164
|
*/
|
4135
4165
|
price_amount_cents: number;
|
4136
|
-
shipping_method: ShippingMethodRel$
|
4166
|
+
shipping_method: ShippingMethodRel$5;
|
4137
4167
|
}
|
4138
4168
|
interface ShippingWeightTierUpdate extends ResourceUpdate {
|
4139
4169
|
/**
|
@@ -4151,7 +4181,7 @@ interface ShippingWeightTierUpdate extends ResourceUpdate {
|
|
4151
4181
|
* @example ```1000```
|
4152
4182
|
*/
|
4153
4183
|
price_amount_cents?: number | null;
|
4154
|
-
shipping_method?: ShippingMethodRel$
|
4184
|
+
shipping_method?: ShippingMethodRel$5 | null;
|
4155
4185
|
}
|
4156
4186
|
declare class ShippingWeightTiers extends ApiResource<ShippingWeightTier> {
|
4157
4187
|
static readonly TYPE: ShippingWeightTierType;
|
@@ -4168,7 +4198,7 @@ declare class ShippingWeightTiers extends ApiResource<ShippingWeightTier> {
|
|
4168
4198
|
}
|
4169
4199
|
|
4170
4200
|
type ShippingMethodType = 'shipping_methods';
|
4171
|
-
type ShippingMethodRel$
|
4201
|
+
type ShippingMethodRel$4 = ResourceRel & {
|
4172
4202
|
type: ShippingMethodType;
|
4173
4203
|
};
|
4174
4204
|
type MarketRel$g = ResourceRel & {
|
@@ -4471,8 +4501,8 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
4471
4501
|
_enable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
4472
4502
|
_reset_circuit(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
4473
4503
|
isShippingMethod(resource: any): resource is ShippingMethod;
|
4474
|
-
relationship(id: string | ResourceId | null): ShippingMethodRel$
|
4475
|
-
relationshipToMany(...ids: string[]): ShippingMethodRel$
|
4504
|
+
relationship(id: string | ResourceId | null): ShippingMethodRel$4;
|
4505
|
+
relationshipToMany(...ids: string[]): ShippingMethodRel$4[];
|
4476
4506
|
type(): ShippingMethodType;
|
4477
4507
|
}
|
4478
4508
|
|
@@ -4486,7 +4516,7 @@ type OrderRel$9 = ResourceRel & {
|
|
4486
4516
|
type LineItemRel$2 = ResourceRel & {
|
4487
4517
|
type: LineItemType;
|
4488
4518
|
};
|
4489
|
-
type ShippingMethodRel$
|
4519
|
+
type ShippingMethodRel$3 = ResourceRel & {
|
4490
4520
|
type: ShippingMethodType;
|
4491
4521
|
};
|
4492
4522
|
type NotificationSort = Pick<Notification, 'id' | 'name' | 'flash'> & ResourceSort;
|
@@ -4523,7 +4553,7 @@ interface NotificationCreate extends ResourceCreate {
|
|
4523
4553
|
* @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
|
4524
4554
|
*/
|
4525
4555
|
body?: Record<string, any> | null;
|
4526
|
-
notifiable: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$
|
4556
|
+
notifiable: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3;
|
4527
4557
|
}
|
4528
4558
|
interface NotificationUpdate extends ResourceUpdate {
|
4529
4559
|
/**
|
@@ -4540,7 +4570,7 @@ interface NotificationUpdate extends ResourceUpdate {
|
|
4540
4570
|
* @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
|
4541
4571
|
*/
|
4542
4572
|
body?: Record<string, any> | null;
|
4543
|
-
notifiable?: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$
|
4573
|
+
notifiable?: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3 | null;
|
4544
4574
|
}
|
4545
4575
|
declare class Notifications extends ApiResource<Notification> {
|
4546
4576
|
static readonly TYPE: NotificationType;
|
@@ -5136,6 +5166,14 @@ interface BundleUpdate extends ResourceUpdate {
|
|
5136
5166
|
* @example ```true```
|
5137
5167
|
*/
|
5138
5168
|
_compute_compare_at_amount?: boolean | null;
|
5169
|
+
/**
|
5170
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5171
|
+
*/
|
5172
|
+
_add_tags?: string | null;
|
5173
|
+
/**
|
5174
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5175
|
+
*/
|
5176
|
+
_remove_tags?: string | null;
|
5139
5177
|
tags?: TagRel$h[] | null;
|
5140
5178
|
}
|
5141
5179
|
declare class Bundles extends ApiResource<Bundle> {
|
@@ -5152,6 +5190,8 @@ declare class Bundles extends ApiResource<Bundle> {
|
|
5152
5190
|
versions(bundleId: string | Bundle, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
5153
5191
|
_compute_price_amount(id: string | Bundle, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
5154
5192
|
_compute_compare_at_amount(id: string | Bundle, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
5193
|
+
_add_tags(id: string | Bundle, triggerValue: string, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
5194
|
+
_remove_tags(id: string | Bundle, triggerValue: string, params?: QueryParamsRetrieve<Bundle>, options?: ResourcesConfig): Promise<Bundle>;
|
5155
5195
|
isBundle(resource: any): resource is Bundle;
|
5156
5196
|
relationship(id: string | ResourceId | null): BundleRel$3;
|
5157
5197
|
relationshipToMany(...ids: string[]): BundleRel$3[];
|
@@ -5478,6 +5518,14 @@ interface GiftCardUpdate extends ResourceUpdate {
|
|
5478
5518
|
* @example ```-5000```
|
5479
5519
|
*/
|
5480
5520
|
_balance_change_cents?: number | null;
|
5521
|
+
/**
|
5522
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5523
|
+
*/
|
5524
|
+
_add_tags?: string | null;
|
5525
|
+
/**
|
5526
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5527
|
+
*/
|
5528
|
+
_remove_tags?: string | null;
|
5481
5529
|
market?: MarketRel$e | null;
|
5482
5530
|
gift_card_recipient?: GiftCardRecipientRel$1 | null;
|
5483
5531
|
tags?: TagRel$g[] | null;
|
@@ -5497,6 +5545,8 @@ declare class GiftCards extends ApiResource<GiftCard> {
|
|
5497
5545
|
_activate(id: string | GiftCard, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
5498
5546
|
_deactivate(id: string | GiftCard, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
5499
5547
|
_balance_change_cents(id: string | GiftCard, triggerValue: number, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
5548
|
+
_add_tags(id: string | GiftCard, triggerValue: string, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
5549
|
+
_remove_tags(id: string | GiftCard, triggerValue: string, params?: QueryParamsRetrieve<GiftCard>, options?: ResourcesConfig): Promise<GiftCard>;
|
5500
5550
|
isGiftCard(resource: any): resource is GiftCard;
|
5501
5551
|
relationship(id: string | ResourceId | null): GiftCardRel$2;
|
5502
5552
|
relationshipToMany(...ids: string[]): GiftCardRel$2[];
|
@@ -5840,6 +5890,14 @@ interface CouponUpdate extends ResourceUpdate {
|
|
5840
5890
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
5841
5891
|
*/
|
5842
5892
|
expires_at?: string | null;
|
5893
|
+
/**
|
5894
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5895
|
+
*/
|
5896
|
+
_add_tags?: string | null;
|
5897
|
+
/**
|
5898
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
5899
|
+
*/
|
5900
|
+
_remove_tags?: string | null;
|
5843
5901
|
promotion_rule?: CouponCodesPromotionRuleRel$9 | null;
|
5844
5902
|
coupon_recipient?: CouponRecipientRel$1 | null;
|
5845
5903
|
tags?: TagRel$f[] | null;
|
@@ -5854,6 +5912,8 @@ declare class Coupons extends ApiResource<Coupon> {
|
|
5854
5912
|
events(couponId: string | Coupon, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
5855
5913
|
tags(couponId: string | Coupon, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
5856
5914
|
versions(couponId: string | Coupon, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
5915
|
+
_add_tags(id: string | Coupon, triggerValue: string, params?: QueryParamsRetrieve<Coupon>, options?: ResourcesConfig): Promise<Coupon>;
|
5916
|
+
_remove_tags(id: string | Coupon, triggerValue: string, params?: QueryParamsRetrieve<Coupon>, options?: ResourcesConfig): Promise<Coupon>;
|
5857
5917
|
isCoupon(resource: any): resource is Coupon;
|
5858
5918
|
relationship(id: string | ResourceId | null): CouponRel$1;
|
5859
5919
|
relationshipToMany(...ids: string[]): CouponRel$1[];
|
@@ -6082,6 +6142,14 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
|
|
6082
6142
|
* @example ```true```
|
6083
6143
|
*/
|
6084
6144
|
_enable?: boolean | null;
|
6145
|
+
/**
|
6146
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6147
|
+
*/
|
6148
|
+
_add_tags?: string | null;
|
6149
|
+
/**
|
6150
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6151
|
+
*/
|
6152
|
+
_remove_tags?: string | null;
|
6085
6153
|
/**
|
6086
6154
|
* The URL to the service that will compute the discount.
|
6087
6155
|
* @example ```"https://external_promotion.yourbrand.com"```
|
@@ -6119,6 +6187,8 @@ declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
|
|
6119
6187
|
skus(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
6120
6188
|
_disable(id: string | ExternalPromotion, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
6121
6189
|
_enable(id: string | ExternalPromotion, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
6190
|
+
_add_tags(id: string | ExternalPromotion, triggerValue: string, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
6191
|
+
_remove_tags(id: string | ExternalPromotion, triggerValue: string, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
6122
6192
|
_reset_circuit(id: string | ExternalPromotion, params?: QueryParamsRetrieve<ExternalPromotion>, options?: ResourcesConfig): Promise<ExternalPromotion>;
|
6123
6193
|
isExternalPromotion(resource: any): resource is ExternalPromotion;
|
6124
6194
|
relationship(id: string | ResourceId | null): ExternalPromotionRel$5;
|
@@ -6343,6 +6413,14 @@ interface FixedAmountPromotionUpdate extends ResourceUpdate {
|
|
6343
6413
|
* @example ```true```
|
6344
6414
|
*/
|
6345
6415
|
_enable?: boolean | null;
|
6416
|
+
/**
|
6417
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6418
|
+
*/
|
6419
|
+
_add_tags?: string | null;
|
6420
|
+
/**
|
6421
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6422
|
+
*/
|
6423
|
+
_remove_tags?: string | null;
|
6346
6424
|
/**
|
6347
6425
|
* The discount fixed amount to be applied, in cents.
|
6348
6426
|
* @example ```1000```
|
@@ -6375,6 +6453,8 @@ declare class FixedAmountPromotions extends ApiResource<FixedAmountPromotion> {
|
|
6375
6453
|
skus(fixedAmountPromotionId: string | FixedAmountPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
6376
6454
|
_disable(id: string | FixedAmountPromotion, params?: QueryParamsRetrieve<FixedAmountPromotion>, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
|
6377
6455
|
_enable(id: string | FixedAmountPromotion, params?: QueryParamsRetrieve<FixedAmountPromotion>, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
|
6456
|
+
_add_tags(id: string | FixedAmountPromotion, triggerValue: string, params?: QueryParamsRetrieve<FixedAmountPromotion>, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
|
6457
|
+
_remove_tags(id: string | FixedAmountPromotion, triggerValue: string, params?: QueryParamsRetrieve<FixedAmountPromotion>, options?: ResourcesConfig): Promise<FixedAmountPromotion>;
|
6378
6458
|
isFixedAmountPromotion(resource: any): resource is FixedAmountPromotion;
|
6379
6459
|
relationship(id: string | ResourceId | null): FixedAmountPromotionRel$5;
|
6380
6460
|
relationshipToMany(...ids: string[]): FixedAmountPromotionRel$5[];
|
@@ -6561,6 +6641,14 @@ interface FlexPromotionUpdate extends ResourceUpdate {
|
|
6561
6641
|
* @example ```true```
|
6562
6642
|
*/
|
6563
6643
|
_enable?: boolean | null;
|
6644
|
+
/**
|
6645
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6646
|
+
*/
|
6647
|
+
_add_tags?: string | null;
|
6648
|
+
/**
|
6649
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6650
|
+
*/
|
6651
|
+
_remove_tags?: string | null;
|
6564
6652
|
coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel$6 | null;
|
6565
6653
|
tags?: TagRel$c[] | null;
|
6566
6654
|
}
|
@@ -6577,6 +6665,8 @@ declare class FlexPromotions extends ApiResource<FlexPromotion> {
|
|
6577
6665
|
versions(flexPromotionId: string | FlexPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
6578
6666
|
_disable(id: string | FlexPromotion, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
6579
6667
|
_enable(id: string | FlexPromotion, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
6668
|
+
_add_tags(id: string | FlexPromotion, triggerValue: string, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
6669
|
+
_remove_tags(id: string | FlexPromotion, triggerValue: string, params?: QueryParamsRetrieve<FlexPromotion>, options?: ResourcesConfig): Promise<FlexPromotion>;
|
6580
6670
|
isFlexPromotion(resource: any): resource is FlexPromotion;
|
6581
6671
|
relationship(id: string | ResourceId | null): FlexPromotionRel$5;
|
6582
6672
|
relationshipToMany(...ids: string[]): FlexPromotionRel$5[];
|
@@ -6819,6 +6909,14 @@ interface FixedPricePromotionUpdate extends ResourceUpdate {
|
|
6819
6909
|
* @example ```true```
|
6820
6910
|
*/
|
6821
6911
|
_enable?: boolean | null;
|
6912
|
+
/**
|
6913
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6914
|
+
*/
|
6915
|
+
_add_tags?: string | null;
|
6916
|
+
/**
|
6917
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
6918
|
+
*/
|
6919
|
+
_remove_tags?: string | null;
|
6822
6920
|
/**
|
6823
6921
|
* The price fixed amount to be applied on matching SKUs, in cents.
|
6824
6922
|
* @example ```1000```
|
@@ -6851,6 +6949,8 @@ declare class FixedPricePromotions extends ApiResource<FixedPricePromotion> {
|
|
6851
6949
|
skus(fixedPricePromotionId: string | FixedPricePromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
6852
6950
|
_disable(id: string | FixedPricePromotion, params?: QueryParamsRetrieve<FixedPricePromotion>, options?: ResourcesConfig): Promise<FixedPricePromotion>;
|
6853
6951
|
_enable(id: string | FixedPricePromotion, params?: QueryParamsRetrieve<FixedPricePromotion>, options?: ResourcesConfig): Promise<FixedPricePromotion>;
|
6952
|
+
_add_tags(id: string | FixedPricePromotion, triggerValue: string, params?: QueryParamsRetrieve<FixedPricePromotion>, options?: ResourcesConfig): Promise<FixedPricePromotion>;
|
6953
|
+
_remove_tags(id: string | FixedPricePromotion, triggerValue: string, params?: QueryParamsRetrieve<FixedPricePromotion>, options?: ResourcesConfig): Promise<FixedPricePromotion>;
|
6854
6954
|
isFixedPricePromotion(resource: any): resource is FixedPricePromotion;
|
6855
6955
|
relationship(id: string | ResourceId | null): FixedPricePromotionRel$5;
|
6856
6956
|
relationshipToMany(...ids: string[]): FixedPricePromotionRel$5[];
|
@@ -7131,6 +7231,14 @@ interface FreeGiftPromotionUpdate extends ResourceUpdate {
|
|
7131
7231
|
* @example ```true```
|
7132
7232
|
*/
|
7133
7233
|
_enable?: boolean | null;
|
7234
|
+
/**
|
7235
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7236
|
+
*/
|
7237
|
+
_add_tags?: string | null;
|
7238
|
+
/**
|
7239
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7240
|
+
*/
|
7241
|
+
_remove_tags?: string | null;
|
7134
7242
|
/**
|
7135
7243
|
* The max quantity of free gifts globally applicable by the promotion.
|
7136
7244
|
* @example ```3```
|
@@ -7163,6 +7271,8 @@ declare class FreeGiftPromotions extends ApiResource<FreeGiftPromotion> {
|
|
7163
7271
|
skus(freeGiftPromotionId: string | FreeGiftPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
7164
7272
|
_disable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve<FreeGiftPromotion>, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
7165
7273
|
_enable(id: string | FreeGiftPromotion, params?: QueryParamsRetrieve<FreeGiftPromotion>, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
7274
|
+
_add_tags(id: string | FreeGiftPromotion, triggerValue: string, params?: QueryParamsRetrieve<FreeGiftPromotion>, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
7275
|
+
_remove_tags(id: string | FreeGiftPromotion, triggerValue: string, params?: QueryParamsRetrieve<FreeGiftPromotion>, options?: ResourcesConfig): Promise<FreeGiftPromotion>;
|
7166
7276
|
isFreeGiftPromotion(resource: any): resource is FreeGiftPromotion;
|
7167
7277
|
relationship(id: string | ResourceId | null): FreeGiftPromotionRel$4;
|
7168
7278
|
relationshipToMany(...ids: string[]): FreeGiftPromotionRel$4[];
|
@@ -7455,6 +7565,14 @@ interface BuyXPayYPromotionUpdate extends ResourceUpdate {
|
|
7455
7565
|
* @example ```true```
|
7456
7566
|
*/
|
7457
7567
|
_enable?: boolean | null;
|
7568
|
+
/**
|
7569
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7570
|
+
*/
|
7571
|
+
_add_tags?: string | null;
|
7572
|
+
/**
|
7573
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7574
|
+
*/
|
7575
|
+
_remove_tags?: string | null;
|
7458
7576
|
/**
|
7459
7577
|
* The quantity which defines the threshold for free items (works by multiple of x).
|
7460
7578
|
* @example ```3```
|
@@ -7497,6 +7615,8 @@ declare class BuyXPayYPromotions extends ApiResource<BuyXPayYPromotion> {
|
|
7497
7615
|
skus(buyXPayYPromotionId: string | BuyXPayYPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
7498
7616
|
_disable(id: string | BuyXPayYPromotion, params?: QueryParamsRetrieve<BuyXPayYPromotion>, options?: ResourcesConfig): Promise<BuyXPayYPromotion>;
|
7499
7617
|
_enable(id: string | BuyXPayYPromotion, params?: QueryParamsRetrieve<BuyXPayYPromotion>, options?: ResourcesConfig): Promise<BuyXPayYPromotion>;
|
7618
|
+
_add_tags(id: string | BuyXPayYPromotion, triggerValue: string, params?: QueryParamsRetrieve<BuyXPayYPromotion>, options?: ResourcesConfig): Promise<BuyXPayYPromotion>;
|
7619
|
+
_remove_tags(id: string | BuyXPayYPromotion, triggerValue: string, params?: QueryParamsRetrieve<BuyXPayYPromotion>, options?: ResourcesConfig): Promise<BuyXPayYPromotion>;
|
7500
7620
|
isBuyXPayYPromotion(resource: any): resource is BuyXPayYPromotion;
|
7501
7621
|
relationship(id: string | ResourceId | null): BuyXPayYPromotionRel$3;
|
7502
7622
|
relationshipToMany(...ids: string[]): BuyXPayYPromotionRel$3[];
|
@@ -7790,6 +7910,14 @@ interface FreeShippingPromotionUpdate extends ResourceUpdate {
|
|
7790
7910
|
* @example ```true```
|
7791
7911
|
*/
|
7792
7912
|
_enable?: boolean | null;
|
7913
|
+
/**
|
7914
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7915
|
+
*/
|
7916
|
+
_add_tags?: string | null;
|
7917
|
+
/**
|
7918
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
7919
|
+
*/
|
7920
|
+
_remove_tags?: string | null;
|
7793
7921
|
market?: MarketRel$8 | null;
|
7794
7922
|
order_amount_promotion_rule?: OrderAmountPromotionRuleRel$2 | null;
|
7795
7923
|
sku_list_promotion_rule?: SkuListPromotionRuleRel$1 | null;
|
@@ -7816,6 +7944,8 @@ declare class FreeShippingPromotions extends ApiResource<FreeShippingPromotion>
|
|
7816
7944
|
versions(freeShippingPromotionId: string | FreeShippingPromotion, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
7817
7945
|
_disable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
7818
7946
|
_enable(id: string | FreeShippingPromotion, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
7947
|
+
_add_tags(id: string | FreeShippingPromotion, triggerValue: string, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
7948
|
+
_remove_tags(id: string | FreeShippingPromotion, triggerValue: string, params?: QueryParamsRetrieve<FreeShippingPromotion>, options?: ResourcesConfig): Promise<FreeShippingPromotion>;
|
7819
7949
|
isFreeShippingPromotion(resource: any): resource is FreeShippingPromotion;
|
7820
7950
|
relationship(id: string | ResourceId | null): FreeShippingPromotionRel$2;
|
7821
7951
|
relationshipToMany(...ids: string[]): FreeShippingPromotionRel$2[];
|
@@ -8121,6 +8251,14 @@ interface PercentageDiscountPromotionUpdate extends ResourceUpdate {
|
|
8121
8251
|
* @example ```true```
|
8122
8252
|
*/
|
8123
8253
|
_enable?: boolean | null;
|
8254
|
+
/**
|
8255
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
8256
|
+
*/
|
8257
|
+
_add_tags?: string | null;
|
8258
|
+
/**
|
8259
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
8260
|
+
*/
|
8261
|
+
_remove_tags?: string | null;
|
8124
8262
|
/**
|
8125
8263
|
* The discount percentage to be applied.
|
8126
8264
|
* @example ```10```
|
@@ -8153,6 +8291,8 @@ declare class PercentageDiscountPromotions extends ApiResource<PercentageDiscoun
|
|
8153
8291
|
skus(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
8154
8292
|
_disable(id: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve<PercentageDiscountPromotion>, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
8155
8293
|
_enable(id: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve<PercentageDiscountPromotion>, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
8294
|
+
_add_tags(id: string | PercentageDiscountPromotion, triggerValue: string, params?: QueryParamsRetrieve<PercentageDiscountPromotion>, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
8295
|
+
_remove_tags(id: string | PercentageDiscountPromotion, triggerValue: string, params?: QueryParamsRetrieve<PercentageDiscountPromotion>, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
|
8156
8296
|
isPercentageDiscountPromotion(resource: any): resource is PercentageDiscountPromotion;
|
8157
8297
|
relationship(id: string | ResourceId | null): PercentageDiscountPromotionRel$1;
|
8158
8298
|
relationshipToMany(...ids: string[]): PercentageDiscountPromotionRel$1[];
|
@@ -8178,7 +8318,7 @@ type GiftCardRel$1 = ResourceRel & {
|
|
8178
8318
|
type ShipmentRel$5 = ResourceRel & {
|
8179
8319
|
type: ShipmentType;
|
8180
8320
|
};
|
8181
|
-
type PaymentMethodRel$
|
8321
|
+
type PaymentMethodRel$3 = ResourceRel & {
|
8182
8322
|
type: PaymentMethodType;
|
8183
8323
|
};
|
8184
8324
|
type AdjustmentRel$1 = ResourceRel & {
|
@@ -8461,7 +8601,7 @@ interface LineItemCreate extends ResourceCreate {
|
|
8461
8601
|
*/
|
8462
8602
|
frequency?: string | null;
|
8463
8603
|
order: OrderRel$7;
|
8464
|
-
item?: SkuRel$8 | BundleRel$2 | GiftCardRel$1 | ShipmentRel$5 | PaymentMethodRel$
|
8604
|
+
item?: SkuRel$8 | BundleRel$2 | GiftCardRel$1 | ShipmentRel$5 | PaymentMethodRel$3 | AdjustmentRel$1 | DiscountEngineItemRel | PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel | FlexPromotionRel | null;
|
8465
8605
|
tags?: TagRel$6[] | null;
|
8466
8606
|
}
|
8467
8607
|
interface LineItemUpdate extends ResourceUpdate {
|
@@ -8525,6 +8665,14 @@ interface LineItemUpdate extends ResourceUpdate {
|
|
8525
8665
|
* @example ```true```
|
8526
8666
|
*/
|
8527
8667
|
_reset_circuit?: boolean | null;
|
8668
|
+
/**
|
8669
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
8670
|
+
*/
|
8671
|
+
_add_tags?: string | null;
|
8672
|
+
/**
|
8673
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
8674
|
+
*/
|
8675
|
+
_remove_tags?: string | null;
|
8528
8676
|
tags?: TagRel$6[] | null;
|
8529
8677
|
}
|
8530
8678
|
declare class LineItems extends ApiResource<LineItem> {
|
@@ -8544,6 +8692,8 @@ declare class LineItems extends ApiResource<LineItem> {
|
|
8544
8692
|
_external_price(id: string | LineItem, params?: QueryParamsRetrieve<LineItem>, options?: ResourcesConfig): Promise<LineItem>;
|
8545
8693
|
_reserve_stock(id: string | LineItem, params?: QueryParamsRetrieve<LineItem>, options?: ResourcesConfig): Promise<LineItem>;
|
8546
8694
|
_reset_circuit(id: string | LineItem, params?: QueryParamsRetrieve<LineItem>, options?: ResourcesConfig): Promise<LineItem>;
|
8695
|
+
_add_tags(id: string | LineItem, triggerValue: string, params?: QueryParamsRetrieve<LineItem>, options?: ResourcesConfig): Promise<LineItem>;
|
8696
|
+
_remove_tags(id: string | LineItem, triggerValue: string, params?: QueryParamsRetrieve<LineItem>, options?: ResourcesConfig): Promise<LineItem>;
|
8547
8697
|
isLineItem(resource: any): resource is LineItem;
|
8548
8698
|
relationship(id: string | ResourceId | null): LineItemRel$1;
|
8549
8699
|
relationshipToMany(...ids: string[]): LineItemRel$1[];
|
@@ -8858,10 +9008,10 @@ interface OrderSubscription extends Resource {
|
|
8858
9008
|
*/
|
8859
9009
|
number?: string | null;
|
8860
9010
|
/**
|
8861
|
-
* The subscription status. One of 'draft' (default), 'inactive', 'active', or 'cancelled'.
|
9011
|
+
* The subscription status. One of 'draft' (default), 'inactive', 'active', 'running', or 'cancelled'.
|
8862
9012
|
* @example ```"draft"```
|
8863
9013
|
*/
|
8864
|
-
status: 'draft' | 'inactive' | 'active' | 'cancelled';
|
9014
|
+
status: 'draft' | 'inactive' | 'active' | 'running' | 'cancelled';
|
8865
9015
|
/**
|
8866
9016
|
* The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.
|
8867
9017
|
* @example ```"monthly"```
|
@@ -9021,6 +9171,14 @@ interface OrderSubscriptionUpdate extends ResourceUpdate {
|
|
9021
9171
|
* @example ```true```
|
9022
9172
|
*/
|
9023
9173
|
_convert?: boolean | null;
|
9174
|
+
/**
|
9175
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9176
|
+
*/
|
9177
|
+
_add_tags?: string | null;
|
9178
|
+
/**
|
9179
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9180
|
+
*/
|
9181
|
+
_remove_tags?: string | null;
|
9024
9182
|
customer_payment_source?: CustomerPaymentSourceRel | null;
|
9025
9183
|
tags?: TagRel$5[] | null;
|
9026
9184
|
}
|
@@ -9045,6 +9203,8 @@ declare class OrderSubscriptions extends ApiResource<OrderSubscription> {
|
|
9045
9203
|
_deactivate(id: string | OrderSubscription, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
9046
9204
|
_cancel(id: string | OrderSubscription, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
9047
9205
|
_convert(id: string | OrderSubscription, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
9206
|
+
_add_tags(id: string | OrderSubscription, triggerValue: string, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
9207
|
+
_remove_tags(id: string | OrderSubscription, triggerValue: string, params?: QueryParamsRetrieve<OrderSubscription>, options?: ResourcesConfig): Promise<OrderSubscription>;
|
9048
9208
|
isOrderSubscription(resource: any): resource is OrderSubscription;
|
9049
9209
|
relationship(id: string | ResourceId | null): OrderSubscriptionRel;
|
9050
9210
|
relationshipToMany(...ids: string[]): OrderSubscriptionRel[];
|
@@ -9165,6 +9325,14 @@ interface CustomerUpdate extends ResourceUpdate {
|
|
9165
9325
|
* @example ```"xxx-yyy-zzz"```
|
9166
9326
|
*/
|
9167
9327
|
tax_exemption_code?: string | null;
|
9328
|
+
/**
|
9329
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9330
|
+
*/
|
9331
|
+
_add_tags?: string | null;
|
9332
|
+
/**
|
9333
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9334
|
+
*/
|
9335
|
+
_remove_tags?: string | null;
|
9168
9336
|
customer_group?: CustomerGroupRel$2 | null;
|
9169
9337
|
tags?: TagRel$4[] | null;
|
9170
9338
|
}
|
@@ -9184,6 +9352,8 @@ declare class Customers extends ApiResource<Customer> {
|
|
9184
9352
|
attachments(customerId: string | Customer, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
9185
9353
|
events(customerId: string | Customer, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
9186
9354
|
tags(customerId: string | Customer, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
9355
|
+
_add_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9356
|
+
_remove_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9187
9357
|
isCustomer(resource: any): resource is Customer;
|
9188
9358
|
relationship(id: string | ResourceId | null): CustomerRel$3;
|
9189
9359
|
relationshipToMany(...ids: string[]): CustomerRel$3[];
|
@@ -9402,7 +9572,7 @@ type AddressRel$4 = ResourceRel & {
|
|
9402
9572
|
type StoreRel = ResourceRel & {
|
9403
9573
|
type: StoreType;
|
9404
9574
|
};
|
9405
|
-
type PaymentMethodRel$
|
9575
|
+
type PaymentMethodRel$2 = ResourceRel & {
|
9406
9576
|
type: PaymentMethodType;
|
9407
9577
|
};
|
9408
9578
|
type AdyenPaymentRel$1 = ResourceRel & {
|
@@ -9977,6 +10147,8 @@ interface Order extends Resource {
|
|
9977
10147
|
shipping_address?: Address | null;
|
9978
10148
|
billing_address?: Address | null;
|
9979
10149
|
store?: Store | null;
|
10150
|
+
default_shipping_method?: ShippingMethod | null;
|
10151
|
+
default_payment_method?: PaymentMethod | null;
|
9980
10152
|
available_payment_methods?: PaymentMethod[] | null;
|
9981
10153
|
available_customer_payment_sources?: CustomerPaymentSource[] | null;
|
9982
10154
|
available_free_skus?: Sku[] | null;
|
@@ -10109,7 +10281,7 @@ interface OrderCreate extends ResourceCreate {
|
|
10109
10281
|
shipping_address?: AddressRel$4 | null;
|
10110
10282
|
billing_address?: AddressRel$4 | null;
|
10111
10283
|
store?: StoreRel | null;
|
10112
|
-
payment_method?: PaymentMethodRel$
|
10284
|
+
payment_method?: PaymentMethodRel$2 | null;
|
10113
10285
|
payment_source?: AdyenPaymentRel$1 | AxervePaymentRel$1 | BraintreePaymentRel$1 | CheckoutComPaymentRel$1 | ExternalPaymentRel | KlarnaPaymentRel$1 | PaypalPaymentRel | SatispayPaymentRel$1 | StripePaymentRel | WireTransferRel | null;
|
10114
10286
|
tags?: TagRel$3[] | null;
|
10115
10287
|
}
|
@@ -10362,12 +10534,20 @@ interface OrderUpdate extends ResourceUpdate {
|
|
10362
10534
|
* @example ```true```
|
10363
10535
|
*/
|
10364
10536
|
_reset_circuit?: boolean | null;
|
10537
|
+
/**
|
10538
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
10539
|
+
*/
|
10540
|
+
_add_tags?: string | null;
|
10541
|
+
/**
|
10542
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
10543
|
+
*/
|
10544
|
+
_remove_tags?: string | null;
|
10365
10545
|
market?: MarketRel$5 | null;
|
10366
10546
|
customer?: CustomerRel$2 | null;
|
10367
10547
|
shipping_address?: AddressRel$4 | null;
|
10368
10548
|
billing_address?: AddressRel$4 | null;
|
10369
10549
|
store?: StoreRel | null;
|
10370
|
-
payment_method?: PaymentMethodRel$
|
10550
|
+
payment_method?: PaymentMethodRel$2 | null;
|
10371
10551
|
payment_source?: AdyenPaymentRel$1 | AxervePaymentRel$1 | BraintreePaymentRel$1 | CheckoutComPaymentRel$1 | ExternalPaymentRel | KlarnaPaymentRel$1 | PaypalPaymentRel | SatispayPaymentRel$1 | StripePaymentRel | WireTransferRel | null;
|
10372
10552
|
tags?: TagRel$3[] | null;
|
10373
10553
|
}
|
@@ -10381,6 +10561,8 @@ declare class Orders extends ApiResource<Order> {
|
|
10381
10561
|
shipping_address(orderId: string | Order, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
10382
10562
|
billing_address(orderId: string | Order, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
10383
10563
|
store(orderId: string | Order, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
|
10564
|
+
default_shipping_method(orderId: string | Order, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
10565
|
+
default_payment_method(orderId: string | Order, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
10384
10566
|
available_payment_methods(orderId: string | Order, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
10385
10567
|
available_customer_payment_sources(orderId: string | Order, params?: QueryParamsList<CustomerPaymentSource>, options?: ResourcesConfig): Promise<ListResponse<CustomerPaymentSource>>;
|
10386
10568
|
available_free_skus(orderId: string | Order, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
@@ -10441,6 +10623,8 @@ declare class Orders extends ApiResource<Order> {
|
|
10441
10623
|
_start_editing(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
10442
10624
|
_stop_editing(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
10443
10625
|
_reset_circuit(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
10626
|
+
_add_tags(id: string | Order, triggerValue: string, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
10627
|
+
_remove_tags(id: string | Order, triggerValue: string, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
|
10444
10628
|
isOrder(resource: any): resource is Order;
|
10445
10629
|
relationship(id: string | ResourceId | null): OrderRel$2;
|
10446
10630
|
relationshipToMany(...ids: string[]): OrderRel$2[];
|
@@ -10752,7 +10936,7 @@ interface Parcel extends Resource {
|
|
10752
10936
|
* The parcel's full tracking history, automatically updated in real time by the shipping carrier.
|
10753
10937
|
* @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]```
|
10754
10938
|
*/
|
10755
|
-
tracking_details?: Record<string, any
|
10939
|
+
tracking_details?: Array<Record<string, any>> | null;
|
10756
10940
|
/**
|
10757
10941
|
* The weight of the parcel as measured by the carrier in ounces (if available).
|
10758
10942
|
* @example ```"42.32"```
|
@@ -10876,7 +11060,7 @@ interface ParcelCreate extends ResourceCreate {
|
|
10876
11060
|
* The parcel's full tracking history, automatically updated in real time by the shipping carrier.
|
10877
11061
|
* @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]```
|
10878
11062
|
*/
|
10879
|
-
tracking_details?: Record<string, any
|
11063
|
+
tracking_details?: Array<Record<string, any>> | null;
|
10880
11064
|
/**
|
10881
11065
|
* The weight of the parcel as measured by the carrier in ounces (if available).
|
10882
11066
|
* @example ```"42.32"```
|
@@ -10996,7 +11180,7 @@ interface ParcelUpdate extends ResourceUpdate {
|
|
10996
11180
|
* The parcel's full tracking history, automatically updated in real time by the shipping carrier.
|
10997
11181
|
* @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]```
|
10998
11182
|
*/
|
10999
|
-
tracking_details?: Record<string, any
|
11183
|
+
tracking_details?: Array<Record<string, any>> | null;
|
11000
11184
|
/**
|
11001
11185
|
* The weight of the parcel as measured by the carrier in ounces (if available).
|
11002
11186
|
* @example ```"42.32"```
|
@@ -11169,7 +11353,7 @@ type InventoryStockLocationRel = ResourceRel & {
|
|
11169
11353
|
type AddressRel$3 = ResourceRel & {
|
11170
11354
|
type: AddressType;
|
11171
11355
|
};
|
11172
|
-
type ShippingMethodRel$
|
11356
|
+
type ShippingMethodRel$2 = ResourceRel & {
|
11173
11357
|
type: ShippingMethodType;
|
11174
11358
|
};
|
11175
11359
|
type TagRel$2 = ResourceRel & {
|
@@ -11313,7 +11497,7 @@ interface ShipmentCreate extends ResourceCreate {
|
|
11313
11497
|
shipping_category?: ShippingCategoryRel$2 | null;
|
11314
11498
|
inventory_stock_location: InventoryStockLocationRel;
|
11315
11499
|
shipping_address?: AddressRel$3 | null;
|
11316
|
-
shipping_method?: ShippingMethodRel$
|
11500
|
+
shipping_method?: ShippingMethodRel$2 | null;
|
11317
11501
|
tags?: TagRel$2[] | null;
|
11318
11502
|
}
|
11319
11503
|
interface ShipmentUpdate extends ResourceUpdate {
|
@@ -11392,10 +11576,18 @@ interface ShipmentUpdate extends ResourceUpdate {
|
|
11392
11576
|
* @example ```true```
|
11393
11577
|
*/
|
11394
11578
|
_purchase?: boolean | null;
|
11579
|
+
/**
|
11580
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
11581
|
+
*/
|
11582
|
+
_add_tags?: string | null;
|
11583
|
+
/**
|
11584
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
11585
|
+
*/
|
11586
|
+
_remove_tags?: string | null;
|
11395
11587
|
shipping_category?: ShippingCategoryRel$2 | null;
|
11396
11588
|
inventory_stock_location?: InventoryStockLocationRel | null;
|
11397
11589
|
shipping_address?: AddressRel$3 | null;
|
11398
|
-
shipping_method?: ShippingMethodRel$
|
11590
|
+
shipping_method?: ShippingMethodRel$2 | null;
|
11399
11591
|
tags?: TagRel$2[] | null;
|
11400
11592
|
}
|
11401
11593
|
declare class Shipments extends ApiResource<Shipment> {
|
@@ -11435,6 +11627,8 @@ declare class Shipments extends ApiResource<Shipment> {
|
|
11435
11627
|
_decrement_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
11436
11628
|
_get_rates(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
11437
11629
|
_purchase(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
11630
|
+
_add_tags(id: string | Shipment, triggerValue: string, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
11631
|
+
_remove_tags(id: string | Shipment, triggerValue: string, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
|
11438
11632
|
isShipment(resource: any): resource is Shipment;
|
11439
11633
|
relationship(id: string | ResourceId | null): ShipmentRel$3;
|
11440
11634
|
relationshipToMany(...ids: string[]): ShipmentRel$3[];
|
@@ -11991,6 +12185,14 @@ interface SkuUpdate extends ResourceUpdate {
|
|
11991
12185
|
* Indicates if the SKU doesn't track the stock inventory.
|
11992
12186
|
*/
|
11993
12187
|
do_not_track?: boolean | null;
|
12188
|
+
/**
|
12189
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
12190
|
+
*/
|
12191
|
+
_add_tags?: string | null;
|
12192
|
+
/**
|
12193
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
12194
|
+
*/
|
12195
|
+
_remove_tags?: string | null;
|
11994
12196
|
shipping_category?: ShippingCategoryRel$1 | null;
|
11995
12197
|
tags?: TagRel$1[] | null;
|
11996
12198
|
}
|
@@ -12015,6 +12217,8 @@ declare class Skus extends ApiResource<Sku> {
|
|
12015
12217
|
jwt_customer(skuId: string | Sku, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
12016
12218
|
jwt_markets(skuId: string | Sku, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
12017
12219
|
jwt_stock_locations(skuId: string | Sku, params?: QueryParamsList<StockLocation>, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
|
12220
|
+
_add_tags(id: string | Sku, triggerValue: string, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
12221
|
+
_remove_tags(id: string | Sku, triggerValue: string, params?: QueryParamsRetrieve<Sku>, options?: ResourcesConfig): Promise<Sku>;
|
12018
12222
|
isSku(resource: any): resource is Sku;
|
12019
12223
|
relationship(id: string | ResourceId | null): SkuRel$4;
|
12020
12224
|
relationshipToMany(...ids: string[]): SkuRel$4[];
|
@@ -13694,7 +13898,7 @@ type GeocoderRel$3 = ResourceRel & {
|
|
13694
13898
|
type PriceListRel$1 = ResourceRel & {
|
13695
13899
|
type: PriceListType;
|
13696
13900
|
};
|
13697
|
-
type PaymentMethodRel = ResourceRel & {
|
13901
|
+
type PaymentMethodRel$1 = ResourceRel & {
|
13698
13902
|
type: PaymentMethodType;
|
13699
13903
|
};
|
13700
13904
|
type MarketRel$2 = ResourceRel & {
|
@@ -13751,7 +13955,7 @@ type CustomerRel$1 = ResourceRel & {
|
|
13751
13955
|
type DeliveryLeadTimeRel = ResourceRel & {
|
13752
13956
|
type: DeliveryLeadTimeType;
|
13753
13957
|
};
|
13754
|
-
type ShippingMethodRel = ResourceRel & {
|
13958
|
+
type ShippingMethodRel$1 = ResourceRel & {
|
13755
13959
|
type: ShippingMethodType;
|
13756
13960
|
};
|
13757
13961
|
type DiscountEngineRel = ResourceRel & {
|
@@ -13838,7 +14042,7 @@ interface AttachmentCreate extends ResourceCreate {
|
|
13838
14042
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
13839
14043
|
*/
|
13840
14044
|
url?: string | null;
|
13841
|
-
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
14045
|
+
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
13842
14046
|
}
|
13843
14047
|
interface AttachmentUpdate extends ResourceUpdate {
|
13844
14048
|
/**
|
@@ -13856,7 +14060,7 @@ interface AttachmentUpdate extends ResourceUpdate {
|
|
13856
14060
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
13857
14061
|
*/
|
13858
14062
|
url?: string | null;
|
13859
|
-
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
14063
|
+
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
13860
14064
|
}
|
13861
14065
|
declare class Attachments extends ApiResource<Attachment> {
|
13862
14066
|
static readonly TYPE: AttachmentType;
|
@@ -13958,6 +14162,12 @@ type CustomerGroupRel = ResourceRel & {
|
|
13958
14162
|
type GeocoderRel$2 = ResourceRel & {
|
13959
14163
|
type: GeocoderType;
|
13960
14164
|
};
|
14165
|
+
type ShippingMethodRel = ResourceRel & {
|
14166
|
+
type: ShippingMethodType;
|
14167
|
+
};
|
14168
|
+
type PaymentMethodRel = ResourceRel & {
|
14169
|
+
type: PaymentMethodType;
|
14170
|
+
};
|
13961
14171
|
type MarketSort = Pick<Market, 'id' | 'name' | 'code' | 'disabled_at'> & ResourceSort;
|
13962
14172
|
interface Market extends Resource {
|
13963
14173
|
readonly type: MarketType;
|
@@ -14024,6 +14234,8 @@ interface Market extends Resource {
|
|
14024
14234
|
tax_calculator?: AvalaraAccount | StripeTaxAccount | VertexAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
|
14025
14235
|
customer_group?: CustomerGroup | null;
|
14026
14236
|
geocoder?: Geocoder | null;
|
14237
|
+
default_shipping_method?: ShippingMethod | null;
|
14238
|
+
default_payment_method?: PaymentMethod | null;
|
14027
14239
|
stores?: Store[] | null;
|
14028
14240
|
price_list_schedulers?: PriceListScheduler[] | null;
|
14029
14241
|
attachments?: Attachment[] | null;
|
@@ -14082,6 +14294,8 @@ interface MarketCreate extends ResourceCreate {
|
|
14082
14294
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14083
14295
|
customer_group?: CustomerGroupRel | null;
|
14084
14296
|
geocoder?: GeocoderRel$2 | null;
|
14297
|
+
default_shipping_method?: ShippingMethodRel | null;
|
14298
|
+
default_payment_method?: PaymentMethodRel | null;
|
14085
14299
|
}
|
14086
14300
|
interface MarketUpdate extends ResourceUpdate {
|
14087
14301
|
/**
|
@@ -14136,6 +14350,8 @@ interface MarketUpdate extends ResourceUpdate {
|
|
14136
14350
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14137
14351
|
customer_group?: CustomerGroupRel | null;
|
14138
14352
|
geocoder?: GeocoderRel$2 | null;
|
14353
|
+
default_shipping_method?: ShippingMethodRel | null;
|
14354
|
+
default_payment_method?: PaymentMethodRel | null;
|
14139
14355
|
}
|
14140
14356
|
declare class Markets extends ApiResource<Market> {
|
14141
14357
|
static readonly TYPE: MarketType;
|
@@ -14150,6 +14366,8 @@ declare class Markets extends ApiResource<Market> {
|
|
14150
14366
|
tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve<TaxCalculator>, options?: ResourcesConfig): Promise<TaxCalculator>;
|
14151
14367
|
customer_group(marketId: string | Market, params?: QueryParamsRetrieve<CustomerGroup>, options?: ResourcesConfig): Promise<CustomerGroup>;
|
14152
14368
|
geocoder(marketId: string | Market, params?: QueryParamsRetrieve<Geocoder>, options?: ResourcesConfig): Promise<Geocoder>;
|
14369
|
+
default_shipping_method(marketId: string | Market, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
14370
|
+
default_payment_method(marketId: string | Market, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
14153
14371
|
stores(marketId: string | Market, params?: QueryParamsList<Store>, options?: ResourcesConfig): Promise<ListResponse<Store>>;
|
14154
14372
|
price_list_schedulers(marketId: string | Market, params?: QueryParamsList<PriceListScheduler>, options?: ResourcesConfig): Promise<ListResponse<PriceListScheduler>>;
|
14155
14373
|
attachments(marketId: string | Market, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
@@ -14489,6 +14707,14 @@ interface AddressUpdate extends ResourceUpdate {
|
|
14489
14707
|
* @example ```"VAT ID IT02382940977"```
|
14490
14708
|
*/
|
14491
14709
|
billing_info?: string | null;
|
14710
|
+
/**
|
14711
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
14712
|
+
*/
|
14713
|
+
_add_tags?: string | null;
|
14714
|
+
/**
|
14715
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
14716
|
+
*/
|
14717
|
+
_remove_tags?: string | null;
|
14492
14718
|
geocoder?: GeocoderRel | null;
|
14493
14719
|
tags?: TagRel[] | null;
|
14494
14720
|
}
|
@@ -14501,6 +14727,8 @@ declare class Addresses extends ApiResource<Address> {
|
|
14501
14727
|
events(addressId: string | Address, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
14502
14728
|
tags(addressId: string | Address, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
14503
14729
|
versions(addressId: string | Address, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
14730
|
+
_add_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
14731
|
+
_remove_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address>;
|
14504
14732
|
isAddress(resource: any): resource is Address;
|
14505
14733
|
relationship(id: string | ResourceId | null): AddressRel;
|
14506
14734
|
relationshipToMany(...ids: string[]): AddressRel[];
|
@@ -16393,7 +16621,7 @@ interface StripeGateway extends Resource {
|
|
16393
16621
|
name: string;
|
16394
16622
|
/**
|
16395
16623
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
16396
|
-
* @example ```"
|
16624
|
+
* @example ```"acct_xxxx-yyyy-zzzz"```
|
16397
16625
|
*/
|
16398
16626
|
connected_account?: string | null;
|
16399
16627
|
/**
|
@@ -16401,6 +16629,11 @@ interface StripeGateway extends Resource {
|
|
16401
16629
|
* @example ```true```
|
16402
16630
|
*/
|
16403
16631
|
auto_payments?: boolean | null;
|
16632
|
+
/**
|
16633
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
16634
|
+
* @example ```true```
|
16635
|
+
*/
|
16636
|
+
force_payments?: boolean | null;
|
16404
16637
|
/**
|
16405
16638
|
* The gateway webhook endpoint ID, generated automatically.
|
16406
16639
|
* @example ```"xxxx-yyyy-zzzz"```
|
@@ -16438,7 +16671,7 @@ interface StripeGatewayCreate extends ResourceCreate {
|
|
16438
16671
|
publishable_key?: string | null;
|
16439
16672
|
/**
|
16440
16673
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
16441
|
-
* @example ```"
|
16674
|
+
* @example ```"acct_xxxx-yyyy-zzzz"```
|
16442
16675
|
*/
|
16443
16676
|
connected_account?: string | null;
|
16444
16677
|
/**
|
@@ -16446,6 +16679,11 @@ interface StripeGatewayCreate extends ResourceCreate {
|
|
16446
16679
|
* @example ```true```
|
16447
16680
|
*/
|
16448
16681
|
auto_payments?: boolean | null;
|
16682
|
+
/**
|
16683
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
16684
|
+
* @example ```true```
|
16685
|
+
*/
|
16686
|
+
force_payments?: boolean | null;
|
16449
16687
|
}
|
16450
16688
|
interface StripeGatewayUpdate extends ResourceUpdate {
|
16451
16689
|
/**
|
@@ -16455,7 +16693,7 @@ interface StripeGatewayUpdate extends ResourceUpdate {
|
|
16455
16693
|
name?: string | null;
|
16456
16694
|
/**
|
16457
16695
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
16458
|
-
* @example ```"
|
16696
|
+
* @example ```"acct_xxxx-yyyy-zzzz"```
|
16459
16697
|
*/
|
16460
16698
|
connected_account?: string | null;
|
16461
16699
|
/**
|
@@ -16463,6 +16701,11 @@ interface StripeGatewayUpdate extends ResourceUpdate {
|
|
16463
16701
|
* @example ```true```
|
16464
16702
|
*/
|
16465
16703
|
auto_payments?: boolean | null;
|
16704
|
+
/**
|
16705
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
16706
|
+
* @example ```true```
|
16707
|
+
*/
|
16708
|
+
force_payments?: boolean | null;
|
16466
16709
|
}
|
16467
16710
|
declare class StripeGateways extends ApiResource<StripeGateway> {
|
16468
16711
|
static readonly TYPE: StripeGatewayType;
|
@@ -16894,7 +17137,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
16894
17137
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
16895
17138
|
declare class CommerceLayerClient {
|
16896
17139
|
#private;
|
16897
|
-
readonly openApiSchemaVersion = "7.8.
|
17140
|
+
readonly openApiSchemaVersion = "7.8.2";
|
16898
17141
|
constructor(config: CommerceLayerInitConfig);
|
16899
17142
|
get addresses(): Addresses;
|
16900
17143
|
get adjustments(): Adjustments;
|