@commercelayer/sdk 6.54.0 → 6.56.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 CHANGED
@@ -243,7 +243,7 @@ declare class EventStores extends ApiResource<EventStore> {
243
243
  }
244
244
 
245
245
  type TagType = 'tags';
246
- type TagRel$l = ResourceRel & {
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$l;
281
- relationshipToMany(...ids: string[]): TagRel$l[];
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$k = ResourceRel & {
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$k[] | null;
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$k[] | null;
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$j = ResourceRel & {
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$j[] | null;
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$j[] | null;
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$i = ResourceRel & {
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$i[] | null;
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$i[] | null;
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[];
@@ -16317,7 +16336,7 @@ type ExportType = 'exports';
16317
16336
  type ExportRel = ResourceRel & {
16318
16337
  type: ExportType;
16319
16338
  };
16320
- type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'attachment_url'> & ResourceSort;
16339
+ type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url'> & ResourceSort;
16321
16340
  interface Export extends Resource {
16322
16341
  readonly type: ExportType;
16323
16342
  /**
@@ -16331,10 +16350,10 @@ interface Export extends Resource {
16331
16350
  */
16332
16351
  format?: string | null;
16333
16352
  /**
16334
- * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
16353
+ * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.
16335
16354
  * @example ```"in_progress"```
16336
16355
  */
16337
- status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
16356
+ status: 'pending' | 'in_progress' | 'interrupted' | 'completed' | 'failed';
16338
16357
  /**
16339
16358
  * List of related resources that should be included in the export (redundant when 'fields' are specified).
16340
16359
  * @example ```["prices.price_tiers"]```
@@ -16354,6 +16373,11 @@ interface Export extends Resource {
16354
16373
  * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
16355
16374
  */
16356
16375
  dry_data?: boolean | null;
16376
+ /**
16377
+ * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
16378
+ * @example ```true```
16379
+ */
16380
+ jwt_filters?: boolean | null;
16357
16381
  /**
16358
16382
  * Time at which the export was started.
16359
16383
  * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16364,6 +16388,11 @@ interface Export extends Resource {
16364
16388
  * @example ```"2018-01-01T12:00:00.000Z"```
16365
16389
  */
16366
16390
  completed_at?: string | null;
16391
+ /**
16392
+ * Estimated time at which the export should complete (dynamically refres^hed).
16393
+ * @example ```"2018-01-01T12:00:00.000Z"```
16394
+ */
16395
+ estimated_completion_at?: string | null;
16367
16396
  /**
16368
16397
  * Time at which the export was interrupted.
16369
16398
  * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16374,6 +16403,16 @@ interface Export extends Resource {
16374
16403
  * @example ```300```
16375
16404
  */
16376
16405
  records_count?: number | null;
16406
+ /**
16407
+ * Indicates how many records have been processed in real time.
16408
+ * @example ```270```
16409
+ */
16410
+ processed_count?: number | null;
16411
+ /**
16412
+ * The percentage of progress of the export.
16413
+ * @example ```30```
16414
+ */
16415
+ progress?: number | null;
16377
16416
  /**
16378
16417
  * The URL to the output file, which will be generated upon export completion.
16379
16418
  * @example ```"http://cl_exports.s3.amazonaws.com/"```
@@ -16418,8 +16457,18 @@ interface ExportCreate extends ResourceCreate {
16418
16457
  * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
16419
16458
  */
16420
16459
  dry_data?: boolean | null;
16460
+ /**
16461
+ * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
16462
+ * @example ```true```
16463
+ */
16464
+ jwt_filters?: boolean | null;
16421
16465
  }
16422
16466
  interface ExportUpdate extends ResourceUpdate {
16467
+ /**
16468
+ * Send this attribute if you want to restart an 'interrupted' export.
16469
+ * @example ```true```
16470
+ */
16471
+ _start?: boolean | null;
16423
16472
  /**
16424
16473
  * Send this attribute if you want to mark status as 'interrupted'.
16425
16474
  * @example ```true```
@@ -16434,6 +16483,7 @@ declare class Exports extends ApiResource<Export> {
16434
16483
  events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
16435
16484
  versions(exportId: string | Export, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
16436
16485
  event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
16486
+ _start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
16437
16487
  _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
16438
16488
  isExport(resource: any): resource is Export;
16439
16489
  relationship(id: string | ResourceId | null): ExportRel;
@@ -17895,7 +17945,7 @@ type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'a
17895
17945
  type DeletableResource = Resource & {
17896
17946
  type: DeletableResourceType;
17897
17947
  };
17898
- 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';
17948
+ 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';
17899
17949
  type TaggableResource = Resource & {
17900
17950
  type: TaggableResourceType;
17901
17951
  tags?: Array<ResourceRel & {
@@ -18215,7 +18265,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
18215
18265
  type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
18216
18266
  declare class CommerceLayerClient {
18217
18267
  #private;
18218
- readonly openApiSchemaVersion = "7.9.13";
18268
+ readonly openApiSchemaVersion = "7.9.15";
18219
18269
  constructor(config: CommerceLayerInitConfig);
18220
18270
  get addresses(): Addresses;
18221
18271
  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$l = ResourceRel & {
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$l;
281
- relationshipToMany(...ids: string[]): TagRel$l[];
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$k = ResourceRel & {
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$k[] | null;
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$k[] | null;
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$j = ResourceRel & {
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$j[] | null;
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$j[] | null;
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$i = ResourceRel & {
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$i[] | null;
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$i[] | null;
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[];
@@ -16317,7 +16336,7 @@ type ExportType = 'exports';
16317
16336
  type ExportRel = ResourceRel & {
16318
16337
  type: ExportType;
16319
16338
  };
16320
- type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'attachment_url'> & ResourceSort;
16339
+ type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url'> & ResourceSort;
16321
16340
  interface Export extends Resource {
16322
16341
  readonly type: ExportType;
16323
16342
  /**
@@ -16331,10 +16350,10 @@ interface Export extends Resource {
16331
16350
  */
16332
16351
  format?: string | null;
16333
16352
  /**
16334
- * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.
16353
+ * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.
16335
16354
  * @example ```"in_progress"```
16336
16355
  */
16337
- status: 'pending' | 'in_progress' | 'interrupted' | 'completed';
16356
+ status: 'pending' | 'in_progress' | 'interrupted' | 'completed' | 'failed';
16338
16357
  /**
16339
16358
  * List of related resources that should be included in the export (redundant when 'fields' are specified).
16340
16359
  * @example ```["prices.price_tiers"]```
@@ -16354,6 +16373,11 @@ interface Export extends Resource {
16354
16373
  * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
16355
16374
  */
16356
16375
  dry_data?: boolean | null;
16376
+ /**
16377
+ * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
16378
+ * @example ```true```
16379
+ */
16380
+ jwt_filters?: boolean | null;
16357
16381
  /**
16358
16382
  * Time at which the export was started.
16359
16383
  * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16364,6 +16388,11 @@ interface Export extends Resource {
16364
16388
  * @example ```"2018-01-01T12:00:00.000Z"```
16365
16389
  */
16366
16390
  completed_at?: string | null;
16391
+ /**
16392
+ * Estimated time at which the export should complete (dynamically refres^hed).
16393
+ * @example ```"2018-01-01T12:00:00.000Z"```
16394
+ */
16395
+ estimated_completion_at?: string | null;
16367
16396
  /**
16368
16397
  * Time at which the export was interrupted.
16369
16398
  * @example ```"2018-01-01T12:00:00.000Z"```
@@ -16374,6 +16403,16 @@ interface Export extends Resource {
16374
16403
  * @example ```300```
16375
16404
  */
16376
16405
  records_count?: number | null;
16406
+ /**
16407
+ * Indicates how many records have been processed in real time.
16408
+ * @example ```270```
16409
+ */
16410
+ processed_count?: number | null;
16411
+ /**
16412
+ * The percentage of progress of the export.
16413
+ * @example ```30```
16414
+ */
16415
+ progress?: number | null;
16377
16416
  /**
16378
16417
  * The URL to the output file, which will be generated upon export completion.
16379
16418
  * @example ```"http://cl_exports.s3.amazonaws.com/"```
@@ -16418,8 +16457,18 @@ interface ExportCreate extends ResourceCreate {
16418
16457
  * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.
16419
16458
  */
16420
16459
  dry_data?: boolean | null;
16460
+ /**
16461
+ * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.
16462
+ * @example ```true```
16463
+ */
16464
+ jwt_filters?: boolean | null;
16421
16465
  }
16422
16466
  interface ExportUpdate extends ResourceUpdate {
16467
+ /**
16468
+ * Send this attribute if you want to restart an 'interrupted' export.
16469
+ * @example ```true```
16470
+ */
16471
+ _start?: boolean | null;
16423
16472
  /**
16424
16473
  * Send this attribute if you want to mark status as 'interrupted'.
16425
16474
  * @example ```true```
@@ -16434,6 +16483,7 @@ declare class Exports extends ApiResource<Export> {
16434
16483
  events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
16435
16484
  versions(exportId: string | Export, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
16436
16485
  event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
16486
+ _start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
16437
16487
  _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export>;
16438
16488
  isExport(resource: any): resource is Export;
16439
16489
  relationship(id: string | ResourceId | null): ExportRel;
@@ -17895,7 +17945,7 @@ type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'a
17895
17945
  type DeletableResource = Resource & {
17896
17946
  type: DeletableResourceType;
17897
17947
  };
17898
- 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';
17948
+ 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';
17899
17949
  type TaggableResource = Resource & {
17900
17950
  type: TaggableResourceType;
17901
17951
  tags?: Array<ResourceRel & {
@@ -18215,7 +18265,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
18215
18265
  type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
18216
18266
  declare class CommerceLayerClient {
18217
18267
  #private;
18218
- readonly openApiSchemaVersion = "7.9.13";
18268
+ readonly openApiSchemaVersion = "7.9.15";
18219
18269
  constructor(config: CommerceLayerInitConfig);
18220
18270
  get addresses(): Addresses;
18221
18271
  get adjustments(): Adjustments;