@commercelayer/sdk 6.53.0 → 6.55.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 +74 -15
- package/lib/index.d.ts +74 -15
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +2 -2
package/lib/index.d.mts
CHANGED
|
@@ -243,7 +243,7 @@ declare class EventStores extends ApiResource<EventStore> {
|
|
|
243
243
|
}
|
|
244
244
|
|
|
245
245
|
type TagType = 'tags';
|
|
246
|
-
type TagRel$
|
|
246
|
+
type TagRel$m = ResourceRel & {
|
|
247
247
|
type: TagType;
|
|
248
248
|
};
|
|
249
249
|
type TagSort = Pick<Tag, 'id' | 'name'> & ResourceSort;
|
|
@@ -277,8 +277,8 @@ declare class Tags extends ApiResource<Tag> {
|
|
|
277
277
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
278
278
|
event_stores(tagId: string | Tag, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
279
279
|
isTag(resource: any): resource is Tag;
|
|
280
|
-
relationship(id: string | ResourceId | null): TagRel$
|
|
281
|
-
relationshipToMany(...ids: string[]): TagRel$
|
|
280
|
+
relationship(id: string | ResourceId | null): TagRel$m;
|
|
281
|
+
relationshipToMany(...ids: string[]): TagRel$m[];
|
|
282
282
|
type(): TagType;
|
|
283
283
|
}
|
|
284
284
|
|
|
@@ -2529,7 +2529,7 @@ type SkuOptionRel$2 = ResourceRel & {
|
|
|
2529
2529
|
type MarketRel$h = ResourceRel & {
|
|
2530
2530
|
type: MarketType;
|
|
2531
2531
|
};
|
|
2532
|
-
type TagRel$
|
|
2532
|
+
type TagRel$l = ResourceRel & {
|
|
2533
2533
|
type: TagType;
|
|
2534
2534
|
};
|
|
2535
2535
|
type SkuOptionSort = Pick<SkuOption, 'id' | 'name' | 'currency_code' | 'price_amount_cents' | 'delay_hours' | 'delay_days'> & ResourceSort;
|
|
@@ -2619,7 +2619,7 @@ interface SkuOptionCreate extends ResourceCreate {
|
|
|
2619
2619
|
*/
|
|
2620
2620
|
sku_code_regex?: string | null;
|
|
2621
2621
|
market?: MarketRel$h | null;
|
|
2622
|
-
tags?: TagRel$
|
|
2622
|
+
tags?: TagRel$l[] | null;
|
|
2623
2623
|
}
|
|
2624
2624
|
interface SkuOptionUpdate extends ResourceUpdate {
|
|
2625
2625
|
/**
|
|
@@ -2661,7 +2661,7 @@ interface SkuOptionUpdate extends ResourceUpdate {
|
|
|
2661
2661
|
*/
|
|
2662
2662
|
_remove_tags?: string | null;
|
|
2663
2663
|
market?: MarketRel$h | null;
|
|
2664
|
-
tags?: TagRel$
|
|
2664
|
+
tags?: TagRel$l[] | null;
|
|
2665
2665
|
}
|
|
2666
2666
|
declare class SkuOptions extends ApiResource<SkuOption> {
|
|
2667
2667
|
static readonly TYPE: SkuOptionType;
|
|
@@ -2692,7 +2692,7 @@ type LineItemRel$5 = ResourceRel & {
|
|
|
2692
2692
|
type SkuOptionRel$1 = ResourceRel & {
|
|
2693
2693
|
type: SkuOptionType;
|
|
2694
2694
|
};
|
|
2695
|
-
type TagRel$
|
|
2695
|
+
type TagRel$k = ResourceRel & {
|
|
2696
2696
|
type: TagType;
|
|
2697
2697
|
};
|
|
2698
2698
|
type LineItemOptionSort = Pick<LineItemOption, 'id' | 'name' | 'quantity' | 'currency_code' | 'unit_amount_cents' | 'delay_hours'> & ResourceSort;
|
|
@@ -2787,7 +2787,7 @@ interface LineItemOptionCreate extends ResourceCreate {
|
|
|
2787
2787
|
options: Record<string, any>;
|
|
2788
2788
|
line_item: LineItemRel$5;
|
|
2789
2789
|
sku_option: SkuOptionRel$1;
|
|
2790
|
-
tags?: TagRel$
|
|
2790
|
+
tags?: TagRel$k[] | null;
|
|
2791
2791
|
}
|
|
2792
2792
|
interface LineItemOptionUpdate extends ResourceUpdate {
|
|
2793
2793
|
/**
|
|
@@ -2819,7 +2819,7 @@ interface LineItemOptionUpdate extends ResourceUpdate {
|
|
|
2819
2819
|
*/
|
|
2820
2820
|
_remove_tags?: string | null;
|
|
2821
2821
|
sku_option?: SkuOptionRel$1 | null;
|
|
2822
|
-
tags?: TagRel$
|
|
2822
|
+
tags?: TagRel$k[] | null;
|
|
2823
2823
|
}
|
|
2824
2824
|
declare class LineItemOptions extends ApiResource<LineItemOption> {
|
|
2825
2825
|
static readonly TYPE: LineItemOptionType;
|
|
@@ -3440,7 +3440,7 @@ type StockLocationRel$7 = ResourceRel & {
|
|
|
3440
3440
|
type CaptureRel = ResourceRel & {
|
|
3441
3441
|
type: CaptureType;
|
|
3442
3442
|
};
|
|
3443
|
-
type TagRel$
|
|
3443
|
+
type TagRel$j = ResourceRel & {
|
|
3444
3444
|
type: TagType;
|
|
3445
3445
|
};
|
|
3446
3446
|
type ReturnSort = Pick<Return, 'id' | 'number' | 'status' | 'approved_at' | 'cancelled_at' | 'shipped_at' | 'rejected_at' | 'received_at' | 'refunded_at' | 'archived_at'> & ResourceSort;
|
|
@@ -3535,7 +3535,7 @@ interface ReturnCreate extends ResourceCreate {
|
|
|
3535
3535
|
order: OrderRel$a;
|
|
3536
3536
|
stock_location?: StockLocationRel$7 | null;
|
|
3537
3537
|
reference_capture?: CaptureRel | null;
|
|
3538
|
-
tags?: TagRel$
|
|
3538
|
+
tags?: TagRel$j[] | null;
|
|
3539
3539
|
}
|
|
3540
3540
|
interface ReturnUpdate extends ResourceUpdate {
|
|
3541
3541
|
/**
|
|
@@ -3603,7 +3603,7 @@ interface ReturnUpdate extends ResourceUpdate {
|
|
|
3603
3603
|
_remove_tags?: string | null;
|
|
3604
3604
|
stock_location?: StockLocationRel$7 | null;
|
|
3605
3605
|
reference_capture?: CaptureRel | null;
|
|
3606
|
-
tags?: TagRel$
|
|
3606
|
+
tags?: TagRel$j[] | null;
|
|
3607
3607
|
}
|
|
3608
3608
|
declare class Returns extends ApiResource<Return> {
|
|
3609
3609
|
static readonly TYPE: ReturnType;
|
|
@@ -4357,6 +4357,9 @@ type StockLocationRel$5 = ResourceRel & {
|
|
|
4357
4357
|
type ShippingMethodTierRel$1 = ResourceRel & {
|
|
4358
4358
|
type: ShippingMethodTierType;
|
|
4359
4359
|
};
|
|
4360
|
+
type TagRel$i = ResourceRel & {
|
|
4361
|
+
type: TagType;
|
|
4362
|
+
};
|
|
4360
4363
|
type ShippingMethodSort = Pick<ShippingMethod, 'id' | 'name' | 'scheme' | 'currency_code' | 'price_amount_cents' | 'free_over_amount_cents' | 'disabled_at' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
|
|
4361
4364
|
interface ShippingMethod extends Resource {
|
|
4362
4365
|
readonly type: ShippingMethodType;
|
|
@@ -4482,6 +4485,8 @@ interface ShippingMethod extends Resource {
|
|
|
4482
4485
|
shipping_weight_tiers?: ShippingWeightTier[] | null;
|
|
4483
4486
|
attachments?: Attachment[] | null;
|
|
4484
4487
|
notifications?: Notification[] | null;
|
|
4488
|
+
events?: Event[] | null;
|
|
4489
|
+
tags?: Tag[] | null;
|
|
4485
4490
|
versions?: Version[] | null;
|
|
4486
4491
|
event_stores?: EventStore[] | null;
|
|
4487
4492
|
}
|
|
@@ -4561,6 +4566,7 @@ interface ShippingMethodCreate extends ResourceCreate {
|
|
|
4561
4566
|
shipping_category?: ShippingCategoryRel$3 | null;
|
|
4562
4567
|
stock_location?: StockLocationRel$5 | null;
|
|
4563
4568
|
shipping_method_tiers?: ShippingMethodTierRel$1[] | null;
|
|
4569
|
+
tags?: TagRel$i[] | null;
|
|
4564
4570
|
}
|
|
4565
4571
|
interface ShippingMethodUpdate extends ResourceUpdate {
|
|
4566
4572
|
/**
|
|
@@ -4638,11 +4644,20 @@ interface ShippingMethodUpdate extends ResourceUpdate {
|
|
|
4638
4644
|
* @example ```["order.line_item_options"]```
|
|
4639
4645
|
*/
|
|
4640
4646
|
external_includes?: string[] | null;
|
|
4647
|
+
/**
|
|
4648
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
|
4649
|
+
*/
|
|
4650
|
+
_add_tags?: string | null;
|
|
4651
|
+
/**
|
|
4652
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
|
4653
|
+
*/
|
|
4654
|
+
_remove_tags?: string | null;
|
|
4641
4655
|
market?: MarketRel$g | null;
|
|
4642
4656
|
shipping_zone?: ShippingZoneRel$1 | null;
|
|
4643
4657
|
shipping_category?: ShippingCategoryRel$3 | null;
|
|
4644
4658
|
stock_location?: StockLocationRel$5 | null;
|
|
4645
4659
|
shipping_method_tiers?: ShippingMethodTierRel$1[] | null;
|
|
4660
|
+
tags?: TagRel$i[] | null;
|
|
4646
4661
|
}
|
|
4647
4662
|
declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
4648
4663
|
static readonly TYPE: ShippingMethodType;
|
|
@@ -4658,11 +4673,15 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
|
4658
4673
|
shipping_weight_tiers(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<ShippingWeightTier>, options?: ResourcesConfig): Promise<ListResponse<ShippingWeightTier>>;
|
|
4659
4674
|
attachments(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4660
4675
|
notifications(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Notification>, options?: ResourcesConfig): Promise<ListResponse<Notification>>;
|
|
4676
|
+
events(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
4677
|
+
tags(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
4661
4678
|
versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4662
4679
|
event_stores(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4663
4680
|
_disable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4664
4681
|
_enable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4665
4682
|
_reset_circuit(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4683
|
+
_add_tags(id: string | ShippingMethod, triggerValue: string, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4684
|
+
_remove_tags(id: string | ShippingMethod, triggerValue: string, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4666
4685
|
isShippingMethod(resource: any): resource is ShippingMethod;
|
|
4667
4686
|
relationship(id: string | ResourceId | null): ShippingMethodRel$4;
|
|
4668
4687
|
relationshipToMany(...ids: string[]): ShippingMethodRel$4[];
|
|
@@ -5162,7 +5181,7 @@ type SkuListRel$9 = ResourceRel & {
|
|
|
5162
5181
|
type TagRel$h = ResourceRel & {
|
|
5163
5182
|
type: TagType;
|
|
5164
5183
|
};
|
|
5165
|
-
type BundleSort = Pick<Bundle, 'id' | 'code' | 'currency_code' | 'price_amount_cents' | 'compare_at_amount_cents'> & ResourceSort;
|
|
5184
|
+
type BundleSort = Pick<Bundle, 'id' | 'code' | 'name' | 'currency_code' | 'price_amount_cents' | 'compare_at_amount_cents'> & ResourceSort;
|
|
5166
5185
|
interface Bundle extends Resource {
|
|
5167
5186
|
readonly type: BundleType;
|
|
5168
5187
|
/**
|
|
@@ -6194,6 +6213,11 @@ interface ExternalPromotion extends Resource {
|
|
|
6194
6213
|
* @example ```112```
|
|
6195
6214
|
*/
|
|
6196
6215
|
weight?: number | null;
|
|
6216
|
+
/**
|
|
6217
|
+
* The total number of coupons created for this promotion.
|
|
6218
|
+
* @example ```2```
|
|
6219
|
+
*/
|
|
6220
|
+
coupons_count?: number | null;
|
|
6197
6221
|
/**
|
|
6198
6222
|
* Time at which this resource was disabled.
|
|
6199
6223
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -6496,6 +6520,11 @@ interface FixedAmountPromotion extends Resource {
|
|
|
6496
6520
|
* @example ```112```
|
|
6497
6521
|
*/
|
|
6498
6522
|
weight?: number | null;
|
|
6523
|
+
/**
|
|
6524
|
+
* The total number of coupons created for this promotion.
|
|
6525
|
+
* @example ```2```
|
|
6526
|
+
*/
|
|
6527
|
+
coupons_count?: number | null;
|
|
6499
6528
|
/**
|
|
6500
6529
|
* Time at which this resource was disabled.
|
|
6501
6530
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7007,6 +7036,11 @@ interface FixedPricePromotion extends Resource {
|
|
|
7007
7036
|
* @example ```112```
|
|
7008
7037
|
*/
|
|
7009
7038
|
weight?: number | null;
|
|
7039
|
+
/**
|
|
7040
|
+
* The total number of coupons created for this promotion.
|
|
7041
|
+
* @example ```2```
|
|
7042
|
+
*/
|
|
7043
|
+
coupons_count?: number | null;
|
|
7010
7044
|
/**
|
|
7011
7045
|
* Time at which this resource was disabled.
|
|
7012
7046
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7352,6 +7386,11 @@ interface FreeGiftPromotion extends Resource {
|
|
|
7352
7386
|
* @example ```112```
|
|
7353
7387
|
*/
|
|
7354
7388
|
weight?: number | null;
|
|
7389
|
+
/**
|
|
7390
|
+
* The total number of coupons created for this promotion.
|
|
7391
|
+
* @example ```2```
|
|
7392
|
+
*/
|
|
7393
|
+
coupons_count?: number | null;
|
|
7355
7394
|
/**
|
|
7356
7395
|
* Time at which this resource was disabled.
|
|
7357
7396
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7679,6 +7718,11 @@ interface BuyXPayYPromotion extends Resource {
|
|
|
7679
7718
|
* @example ```112```
|
|
7680
7719
|
*/
|
|
7681
7720
|
weight?: number | null;
|
|
7721
|
+
/**
|
|
7722
|
+
* The total number of coupons created for this promotion.
|
|
7723
|
+
* @example ```2```
|
|
7724
|
+
*/
|
|
7725
|
+
coupons_count?: number | null;
|
|
7682
7726
|
/**
|
|
7683
7727
|
* Time at which this resource was disabled.
|
|
7684
7728
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -8068,6 +8112,11 @@ interface FreeShippingPromotion extends Resource {
|
|
|
8068
8112
|
* @example ```112```
|
|
8069
8113
|
*/
|
|
8070
8114
|
weight?: number | null;
|
|
8115
|
+
/**
|
|
8116
|
+
* The total number of coupons created for this promotion.
|
|
8117
|
+
* @example ```2```
|
|
8118
|
+
*/
|
|
8119
|
+
coupons_count?: number | null;
|
|
8071
8120
|
/**
|
|
8072
8121
|
* Time at which this resource was disabled.
|
|
8073
8122
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -8411,6 +8460,11 @@ interface PercentageDiscountPromotion extends Resource {
|
|
|
8411
8460
|
* @example ```112```
|
|
8412
8461
|
*/
|
|
8413
8462
|
weight?: number | null;
|
|
8463
|
+
/**
|
|
8464
|
+
* The total number of coupons created for this promotion.
|
|
8465
|
+
* @example ```2```
|
|
8466
|
+
*/
|
|
8467
|
+
coupons_count?: number | null;
|
|
8414
8468
|
/**
|
|
8415
8469
|
* Time at which this resource was disabled.
|
|
8416
8470
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -13369,6 +13423,11 @@ interface Promotion extends Resource {
|
|
|
13369
13423
|
* @example ```112```
|
|
13370
13424
|
*/
|
|
13371
13425
|
weight?: number | null;
|
|
13426
|
+
/**
|
|
13427
|
+
* The total number of coupons created for this promotion.
|
|
13428
|
+
* @example ```2```
|
|
13429
|
+
*/
|
|
13430
|
+
coupons_count?: number | null;
|
|
13372
13431
|
/**
|
|
13373
13432
|
* Time at which this resource was disabled.
|
|
13374
13433
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -17855,7 +17914,7 @@ type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'a
|
|
|
17855
17914
|
type DeletableResource = Resource & {
|
|
17856
17915
|
type: DeletableResourceType;
|
|
17857
17916
|
};
|
|
17858
|
-
type TaggableResourceType = 'addresses' | 'bundles' | 'buy_x_pay_y_promotions' | 'coupons' | 'customers' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_cards' | 'line_item_options' | 'line_items' | 'order_subscriptions' | 'orders' | 'percentage_discount_promotions' | 'promotions' | 'returns' | 'shipments' | 'sku_options' | 'skus';
|
|
17917
|
+
type TaggableResourceType = 'addresses' | 'bundles' | 'buy_x_pay_y_promotions' | 'coupons' | 'customers' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_cards' | 'line_item_options' | 'line_items' | 'order_subscriptions' | 'orders' | 'percentage_discount_promotions' | 'promotions' | 'returns' | 'shipments' | 'shipping_methods' | 'sku_options' | 'skus';
|
|
17859
17918
|
type TaggableResource = Resource & {
|
|
17860
17919
|
type: TaggableResourceType;
|
|
17861
17920
|
tags?: Array<ResourceRel & {
|
|
@@ -18175,7 +18234,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
|
18175
18234
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
|
18176
18235
|
declare class CommerceLayerClient {
|
|
18177
18236
|
#private;
|
|
18178
|
-
readonly openApiSchemaVersion = "7.9.
|
|
18237
|
+
readonly openApiSchemaVersion = "7.9.14";
|
|
18179
18238
|
constructor(config: CommerceLayerInitConfig);
|
|
18180
18239
|
get addresses(): Addresses;
|
|
18181
18240
|
get adjustments(): Adjustments;
|
package/lib/index.d.ts
CHANGED
|
@@ -243,7 +243,7 @@ declare class EventStores extends ApiResource<EventStore> {
|
|
|
243
243
|
}
|
|
244
244
|
|
|
245
245
|
type TagType = 'tags';
|
|
246
|
-
type TagRel$
|
|
246
|
+
type TagRel$m = ResourceRel & {
|
|
247
247
|
type: TagType;
|
|
248
248
|
};
|
|
249
249
|
type TagSort = Pick<Tag, 'id' | 'name'> & ResourceSort;
|
|
@@ -277,8 +277,8 @@ declare class Tags extends ApiResource<Tag> {
|
|
|
277
277
|
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
278
278
|
event_stores(tagId: string | Tag, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
279
279
|
isTag(resource: any): resource is Tag;
|
|
280
|
-
relationship(id: string | ResourceId | null): TagRel$
|
|
281
|
-
relationshipToMany(...ids: string[]): TagRel$
|
|
280
|
+
relationship(id: string | ResourceId | null): TagRel$m;
|
|
281
|
+
relationshipToMany(...ids: string[]): TagRel$m[];
|
|
282
282
|
type(): TagType;
|
|
283
283
|
}
|
|
284
284
|
|
|
@@ -2529,7 +2529,7 @@ type SkuOptionRel$2 = ResourceRel & {
|
|
|
2529
2529
|
type MarketRel$h = ResourceRel & {
|
|
2530
2530
|
type: MarketType;
|
|
2531
2531
|
};
|
|
2532
|
-
type TagRel$
|
|
2532
|
+
type TagRel$l = ResourceRel & {
|
|
2533
2533
|
type: TagType;
|
|
2534
2534
|
};
|
|
2535
2535
|
type SkuOptionSort = Pick<SkuOption, 'id' | 'name' | 'currency_code' | 'price_amount_cents' | 'delay_hours' | 'delay_days'> & ResourceSort;
|
|
@@ -2619,7 +2619,7 @@ interface SkuOptionCreate extends ResourceCreate {
|
|
|
2619
2619
|
*/
|
|
2620
2620
|
sku_code_regex?: string | null;
|
|
2621
2621
|
market?: MarketRel$h | null;
|
|
2622
|
-
tags?: TagRel$
|
|
2622
|
+
tags?: TagRel$l[] | null;
|
|
2623
2623
|
}
|
|
2624
2624
|
interface SkuOptionUpdate extends ResourceUpdate {
|
|
2625
2625
|
/**
|
|
@@ -2661,7 +2661,7 @@ interface SkuOptionUpdate extends ResourceUpdate {
|
|
|
2661
2661
|
*/
|
|
2662
2662
|
_remove_tags?: string | null;
|
|
2663
2663
|
market?: MarketRel$h | null;
|
|
2664
|
-
tags?: TagRel$
|
|
2664
|
+
tags?: TagRel$l[] | null;
|
|
2665
2665
|
}
|
|
2666
2666
|
declare class SkuOptions extends ApiResource<SkuOption> {
|
|
2667
2667
|
static readonly TYPE: SkuOptionType;
|
|
@@ -2692,7 +2692,7 @@ type LineItemRel$5 = ResourceRel & {
|
|
|
2692
2692
|
type SkuOptionRel$1 = ResourceRel & {
|
|
2693
2693
|
type: SkuOptionType;
|
|
2694
2694
|
};
|
|
2695
|
-
type TagRel$
|
|
2695
|
+
type TagRel$k = ResourceRel & {
|
|
2696
2696
|
type: TagType;
|
|
2697
2697
|
};
|
|
2698
2698
|
type LineItemOptionSort = Pick<LineItemOption, 'id' | 'name' | 'quantity' | 'currency_code' | 'unit_amount_cents' | 'delay_hours'> & ResourceSort;
|
|
@@ -2787,7 +2787,7 @@ interface LineItemOptionCreate extends ResourceCreate {
|
|
|
2787
2787
|
options: Record<string, any>;
|
|
2788
2788
|
line_item: LineItemRel$5;
|
|
2789
2789
|
sku_option: SkuOptionRel$1;
|
|
2790
|
-
tags?: TagRel$
|
|
2790
|
+
tags?: TagRel$k[] | null;
|
|
2791
2791
|
}
|
|
2792
2792
|
interface LineItemOptionUpdate extends ResourceUpdate {
|
|
2793
2793
|
/**
|
|
@@ -2819,7 +2819,7 @@ interface LineItemOptionUpdate extends ResourceUpdate {
|
|
|
2819
2819
|
*/
|
|
2820
2820
|
_remove_tags?: string | null;
|
|
2821
2821
|
sku_option?: SkuOptionRel$1 | null;
|
|
2822
|
-
tags?: TagRel$
|
|
2822
|
+
tags?: TagRel$k[] | null;
|
|
2823
2823
|
}
|
|
2824
2824
|
declare class LineItemOptions extends ApiResource<LineItemOption> {
|
|
2825
2825
|
static readonly TYPE: LineItemOptionType;
|
|
@@ -3440,7 +3440,7 @@ type StockLocationRel$7 = ResourceRel & {
|
|
|
3440
3440
|
type CaptureRel = ResourceRel & {
|
|
3441
3441
|
type: CaptureType;
|
|
3442
3442
|
};
|
|
3443
|
-
type TagRel$
|
|
3443
|
+
type TagRel$j = ResourceRel & {
|
|
3444
3444
|
type: TagType;
|
|
3445
3445
|
};
|
|
3446
3446
|
type ReturnSort = Pick<Return, 'id' | 'number' | 'status' | 'approved_at' | 'cancelled_at' | 'shipped_at' | 'rejected_at' | 'received_at' | 'refunded_at' | 'archived_at'> & ResourceSort;
|
|
@@ -3535,7 +3535,7 @@ interface ReturnCreate extends ResourceCreate {
|
|
|
3535
3535
|
order: OrderRel$a;
|
|
3536
3536
|
stock_location?: StockLocationRel$7 | null;
|
|
3537
3537
|
reference_capture?: CaptureRel | null;
|
|
3538
|
-
tags?: TagRel$
|
|
3538
|
+
tags?: TagRel$j[] | null;
|
|
3539
3539
|
}
|
|
3540
3540
|
interface ReturnUpdate extends ResourceUpdate {
|
|
3541
3541
|
/**
|
|
@@ -3603,7 +3603,7 @@ interface ReturnUpdate extends ResourceUpdate {
|
|
|
3603
3603
|
_remove_tags?: string | null;
|
|
3604
3604
|
stock_location?: StockLocationRel$7 | null;
|
|
3605
3605
|
reference_capture?: CaptureRel | null;
|
|
3606
|
-
tags?: TagRel$
|
|
3606
|
+
tags?: TagRel$j[] | null;
|
|
3607
3607
|
}
|
|
3608
3608
|
declare class Returns extends ApiResource<Return> {
|
|
3609
3609
|
static readonly TYPE: ReturnType;
|
|
@@ -4357,6 +4357,9 @@ type StockLocationRel$5 = ResourceRel & {
|
|
|
4357
4357
|
type ShippingMethodTierRel$1 = ResourceRel & {
|
|
4358
4358
|
type: ShippingMethodTierType;
|
|
4359
4359
|
};
|
|
4360
|
+
type TagRel$i = ResourceRel & {
|
|
4361
|
+
type: TagType;
|
|
4362
|
+
};
|
|
4360
4363
|
type ShippingMethodSort = Pick<ShippingMethod, 'id' | 'name' | 'scheme' | 'currency_code' | 'price_amount_cents' | 'free_over_amount_cents' | 'disabled_at' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
|
|
4361
4364
|
interface ShippingMethod extends Resource {
|
|
4362
4365
|
readonly type: ShippingMethodType;
|
|
@@ -4482,6 +4485,8 @@ interface ShippingMethod extends Resource {
|
|
|
4482
4485
|
shipping_weight_tiers?: ShippingWeightTier[] | null;
|
|
4483
4486
|
attachments?: Attachment[] | null;
|
|
4484
4487
|
notifications?: Notification[] | null;
|
|
4488
|
+
events?: Event[] | null;
|
|
4489
|
+
tags?: Tag[] | null;
|
|
4485
4490
|
versions?: Version[] | null;
|
|
4486
4491
|
event_stores?: EventStore[] | null;
|
|
4487
4492
|
}
|
|
@@ -4561,6 +4566,7 @@ interface ShippingMethodCreate extends ResourceCreate {
|
|
|
4561
4566
|
shipping_category?: ShippingCategoryRel$3 | null;
|
|
4562
4567
|
stock_location?: StockLocationRel$5 | null;
|
|
4563
4568
|
shipping_method_tiers?: ShippingMethodTierRel$1[] | null;
|
|
4569
|
+
tags?: TagRel$i[] | null;
|
|
4564
4570
|
}
|
|
4565
4571
|
interface ShippingMethodUpdate extends ResourceUpdate {
|
|
4566
4572
|
/**
|
|
@@ -4638,11 +4644,20 @@ interface ShippingMethodUpdate extends ResourceUpdate {
|
|
|
4638
4644
|
* @example ```["order.line_item_options"]```
|
|
4639
4645
|
*/
|
|
4640
4646
|
external_includes?: string[] | null;
|
|
4647
|
+
/**
|
|
4648
|
+
* Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
|
4649
|
+
*/
|
|
4650
|
+
_add_tags?: string | null;
|
|
4651
|
+
/**
|
|
4652
|
+
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
|
4653
|
+
*/
|
|
4654
|
+
_remove_tags?: string | null;
|
|
4641
4655
|
market?: MarketRel$g | null;
|
|
4642
4656
|
shipping_zone?: ShippingZoneRel$1 | null;
|
|
4643
4657
|
shipping_category?: ShippingCategoryRel$3 | null;
|
|
4644
4658
|
stock_location?: StockLocationRel$5 | null;
|
|
4645
4659
|
shipping_method_tiers?: ShippingMethodTierRel$1[] | null;
|
|
4660
|
+
tags?: TagRel$i[] | null;
|
|
4646
4661
|
}
|
|
4647
4662
|
declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
4648
4663
|
static readonly TYPE: ShippingMethodType;
|
|
@@ -4658,11 +4673,15 @@ declare class ShippingMethods extends ApiResource<ShippingMethod> {
|
|
|
4658
4673
|
shipping_weight_tiers(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<ShippingWeightTier>, options?: ResourcesConfig): Promise<ListResponse<ShippingWeightTier>>;
|
|
4659
4674
|
attachments(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
|
4660
4675
|
notifications(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Notification>, options?: ResourcesConfig): Promise<ListResponse<Notification>>;
|
|
4676
|
+
events(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
|
4677
|
+
tags(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
|
4661
4678
|
versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
4662
4679
|
event_stores(shippingMethodId: string | ShippingMethod, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
4663
4680
|
_disable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4664
4681
|
_enable(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4665
4682
|
_reset_circuit(id: string | ShippingMethod, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4683
|
+
_add_tags(id: string | ShippingMethod, triggerValue: string, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4684
|
+
_remove_tags(id: string | ShippingMethod, triggerValue: string, params?: QueryParamsRetrieve<ShippingMethod>, options?: ResourcesConfig): Promise<ShippingMethod>;
|
|
4666
4685
|
isShippingMethod(resource: any): resource is ShippingMethod;
|
|
4667
4686
|
relationship(id: string | ResourceId | null): ShippingMethodRel$4;
|
|
4668
4687
|
relationshipToMany(...ids: string[]): ShippingMethodRel$4[];
|
|
@@ -5162,7 +5181,7 @@ type SkuListRel$9 = ResourceRel & {
|
|
|
5162
5181
|
type TagRel$h = ResourceRel & {
|
|
5163
5182
|
type: TagType;
|
|
5164
5183
|
};
|
|
5165
|
-
type BundleSort = Pick<Bundle, 'id' | 'code' | 'currency_code' | 'price_amount_cents' | 'compare_at_amount_cents'> & ResourceSort;
|
|
5184
|
+
type BundleSort = Pick<Bundle, 'id' | 'code' | 'name' | 'currency_code' | 'price_amount_cents' | 'compare_at_amount_cents'> & ResourceSort;
|
|
5166
5185
|
interface Bundle extends Resource {
|
|
5167
5186
|
readonly type: BundleType;
|
|
5168
5187
|
/**
|
|
@@ -6194,6 +6213,11 @@ interface ExternalPromotion extends Resource {
|
|
|
6194
6213
|
* @example ```112```
|
|
6195
6214
|
*/
|
|
6196
6215
|
weight?: number | null;
|
|
6216
|
+
/**
|
|
6217
|
+
* The total number of coupons created for this promotion.
|
|
6218
|
+
* @example ```2```
|
|
6219
|
+
*/
|
|
6220
|
+
coupons_count?: number | null;
|
|
6197
6221
|
/**
|
|
6198
6222
|
* Time at which this resource was disabled.
|
|
6199
6223
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -6496,6 +6520,11 @@ interface FixedAmountPromotion extends Resource {
|
|
|
6496
6520
|
* @example ```112```
|
|
6497
6521
|
*/
|
|
6498
6522
|
weight?: number | null;
|
|
6523
|
+
/**
|
|
6524
|
+
* The total number of coupons created for this promotion.
|
|
6525
|
+
* @example ```2```
|
|
6526
|
+
*/
|
|
6527
|
+
coupons_count?: number | null;
|
|
6499
6528
|
/**
|
|
6500
6529
|
* Time at which this resource was disabled.
|
|
6501
6530
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7007,6 +7036,11 @@ interface FixedPricePromotion extends Resource {
|
|
|
7007
7036
|
* @example ```112```
|
|
7008
7037
|
*/
|
|
7009
7038
|
weight?: number | null;
|
|
7039
|
+
/**
|
|
7040
|
+
* The total number of coupons created for this promotion.
|
|
7041
|
+
* @example ```2```
|
|
7042
|
+
*/
|
|
7043
|
+
coupons_count?: number | null;
|
|
7010
7044
|
/**
|
|
7011
7045
|
* Time at which this resource was disabled.
|
|
7012
7046
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7352,6 +7386,11 @@ interface FreeGiftPromotion extends Resource {
|
|
|
7352
7386
|
* @example ```112```
|
|
7353
7387
|
*/
|
|
7354
7388
|
weight?: number | null;
|
|
7389
|
+
/**
|
|
7390
|
+
* The total number of coupons created for this promotion.
|
|
7391
|
+
* @example ```2```
|
|
7392
|
+
*/
|
|
7393
|
+
coupons_count?: number | null;
|
|
7355
7394
|
/**
|
|
7356
7395
|
* Time at which this resource was disabled.
|
|
7357
7396
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -7679,6 +7718,11 @@ interface BuyXPayYPromotion extends Resource {
|
|
|
7679
7718
|
* @example ```112```
|
|
7680
7719
|
*/
|
|
7681
7720
|
weight?: number | null;
|
|
7721
|
+
/**
|
|
7722
|
+
* The total number of coupons created for this promotion.
|
|
7723
|
+
* @example ```2```
|
|
7724
|
+
*/
|
|
7725
|
+
coupons_count?: number | null;
|
|
7682
7726
|
/**
|
|
7683
7727
|
* Time at which this resource was disabled.
|
|
7684
7728
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -8068,6 +8112,11 @@ interface FreeShippingPromotion extends Resource {
|
|
|
8068
8112
|
* @example ```112```
|
|
8069
8113
|
*/
|
|
8070
8114
|
weight?: number | null;
|
|
8115
|
+
/**
|
|
8116
|
+
* The total number of coupons created for this promotion.
|
|
8117
|
+
* @example ```2```
|
|
8118
|
+
*/
|
|
8119
|
+
coupons_count?: number | null;
|
|
8071
8120
|
/**
|
|
8072
8121
|
* Time at which this resource was disabled.
|
|
8073
8122
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -8411,6 +8460,11 @@ interface PercentageDiscountPromotion extends Resource {
|
|
|
8411
8460
|
* @example ```112```
|
|
8412
8461
|
*/
|
|
8413
8462
|
weight?: number | null;
|
|
8463
|
+
/**
|
|
8464
|
+
* The total number of coupons created for this promotion.
|
|
8465
|
+
* @example ```2```
|
|
8466
|
+
*/
|
|
8467
|
+
coupons_count?: number | null;
|
|
8414
8468
|
/**
|
|
8415
8469
|
* Time at which this resource was disabled.
|
|
8416
8470
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -13369,6 +13423,11 @@ interface Promotion extends Resource {
|
|
|
13369
13423
|
* @example ```112```
|
|
13370
13424
|
*/
|
|
13371
13425
|
weight?: number | null;
|
|
13426
|
+
/**
|
|
13427
|
+
* The total number of coupons created for this promotion.
|
|
13428
|
+
* @example ```2```
|
|
13429
|
+
*/
|
|
13430
|
+
coupons_count?: number | null;
|
|
13372
13431
|
/**
|
|
13373
13432
|
* Time at which this resource was disabled.
|
|
13374
13433
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
@@ -17855,7 +17914,7 @@ type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'a
|
|
|
17855
17914
|
type DeletableResource = Resource & {
|
|
17856
17915
|
type: DeletableResourceType;
|
|
17857
17916
|
};
|
|
17858
|
-
type TaggableResourceType = 'addresses' | 'bundles' | 'buy_x_pay_y_promotions' | 'coupons' | 'customers' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_cards' | 'line_item_options' | 'line_items' | 'order_subscriptions' | 'orders' | 'percentage_discount_promotions' | 'promotions' | 'returns' | 'shipments' | 'sku_options' | 'skus';
|
|
17917
|
+
type TaggableResourceType = 'addresses' | 'bundles' | 'buy_x_pay_y_promotions' | 'coupons' | 'customers' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_cards' | 'line_item_options' | 'line_items' | 'order_subscriptions' | 'orders' | 'percentage_discount_promotions' | 'promotions' | 'returns' | 'shipments' | 'shipping_methods' | 'sku_options' | 'skus';
|
|
17859
17918
|
type TaggableResource = Resource & {
|
|
17860
17919
|
type: TaggableResourceType;
|
|
17861
17920
|
tags?: Array<ResourceRel & {
|
|
@@ -18175,7 +18234,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
|
18175
18234
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
|
18176
18235
|
declare class CommerceLayerClient {
|
|
18177
18236
|
#private;
|
|
18178
|
-
readonly openApiSchemaVersion = "7.9.
|
|
18237
|
+
readonly openApiSchemaVersion = "7.9.14";
|
|
18179
18238
|
constructor(config: CommerceLayerInitConfig);
|
|
18180
18239
|
get addresses(): Addresses;
|
|
18181
18240
|
get adjustments(): Adjustments;
|