@commercelayer/sdk 6.50.0 → 6.51.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.ts CHANGED
@@ -4433,6 +4433,11 @@ interface ShippingMethod extends Resource {
4433
4433
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
4434
4434
  */
4435
4435
  shared_secret: string;
4436
+ /**
4437
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
4438
+ * @example ```["order.line_item_options"]```
4439
+ */
4440
+ external_includes?: string[] | null;
4436
4441
  market?: Market | null;
4437
4442
  shipping_zone?: ShippingZone | null;
4438
4443
  shipping_category?: ShippingCategory | null;
@@ -4511,6 +4516,11 @@ interface ShippingMethodCreate extends ResourceCreate {
4511
4516
  * @example ```true```
4512
4517
  */
4513
4518
  _enable?: boolean | null;
4519
+ /**
4520
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
4521
+ * @example ```["order.line_item_options"]```
4522
+ */
4523
+ external_includes?: string[] | null;
4514
4524
  market?: MarketRel$g | null;
4515
4525
  shipping_zone?: ShippingZoneRel$1 | null;
4516
4526
  shipping_category?: ShippingCategoryRel$3 | null;
@@ -4588,6 +4598,11 @@ interface ShippingMethodUpdate extends ResourceUpdate {
4588
4598
  * @example ```true```
4589
4599
  */
4590
4600
  _reset_circuit?: boolean | null;
4601
+ /**
4602
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
4603
+ * @example ```["order.line_item_options"]```
4604
+ */
4605
+ external_includes?: string[] | null;
4591
4606
  market?: MarketRel$g | null;
4592
4607
  shipping_zone?: ShippingZoneRel$1 | null;
4593
4608
  shipping_category?: ShippingCategoryRel$3 | null;
@@ -4623,12 +4638,12 @@ type NotificationType = 'notifications';
4623
4638
  type NotificationRel = ResourceRel & {
4624
4639
  type: NotificationType;
4625
4640
  };
4626
- type OrderRel$9 = ResourceRel & {
4627
- type: OrderType;
4628
- };
4629
4641
  type LineItemRel$2 = ResourceRel & {
4630
4642
  type: LineItemType;
4631
4643
  };
4644
+ type OrderRel$9 = ResourceRel & {
4645
+ type: OrderType;
4646
+ };
4632
4647
  type ShippingMethodRel$3 = ResourceRel & {
4633
4648
  type: ShippingMethodType;
4634
4649
  };
@@ -4649,7 +4664,7 @@ interface Notification extends Resource {
4649
4664
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4650
4665
  */
4651
4666
  body?: Record<string, any> | null;
4652
- notifiable?: Order | LineItem | ShippingMethod | null;
4667
+ notifiable?: LineItem | Order | ShippingMethod | null;
4653
4668
  event_stores?: EventStore[] | null;
4654
4669
  }
4655
4670
  interface NotificationCreate extends ResourceCreate {
@@ -4667,7 +4682,7 @@ interface NotificationCreate extends ResourceCreate {
4667
4682
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4668
4683
  */
4669
4684
  body?: Record<string, any> | null;
4670
- notifiable: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3;
4685
+ notifiable: LineItemRel$2 | OrderRel$9 | ShippingMethodRel$3;
4671
4686
  }
4672
4687
  interface NotificationUpdate extends ResourceUpdate {
4673
4688
  /**
@@ -4684,7 +4699,7 @@ interface NotificationUpdate extends ResourceUpdate {
4684
4699
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4685
4700
  */
4686
4701
  body?: Record<string, any> | null;
4687
- notifiable?: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3 | null;
4702
+ notifiable?: LineItemRel$2 | OrderRel$9 | ShippingMethodRel$3 | null;
4688
4703
  }
4689
4704
  declare class Notifications extends ApiResource<Notification> {
4690
4705
  static readonly TYPE: NotificationType;
@@ -6169,6 +6184,11 @@ interface ExternalPromotion extends Resource {
6169
6184
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
6170
6185
  */
6171
6186
  shared_secret: string;
6187
+ /**
6188
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
6189
+ * @example ```["order.line_item_options"]```
6190
+ */
6191
+ external_includes?: string[] | null;
6172
6192
  market?: Market | null;
6173
6193
  promotion_rules?: PromotionRule[] | null;
6174
6194
  order_amount_promotion_rule?: OrderAmountPromotionRule | null;
@@ -6235,6 +6255,11 @@ interface ExternalPromotionCreate extends ResourceCreate {
6235
6255
  * @example ```"https://external_promotion.yourbrand.com"```
6236
6256
  */
6237
6257
  promotion_url: string;
6258
+ /**
6259
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
6260
+ * @example ```["order.line_item_options"]```
6261
+ */
6262
+ external_includes?: string[] | null;
6238
6263
  market?: MarketRel$d | null;
6239
6264
  order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
6240
6265
  sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
@@ -6307,6 +6332,11 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
6307
6332
  * @example ```true```
6308
6333
  */
6309
6334
  _reset_circuit?: boolean | null;
6335
+ /**
6336
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
6337
+ * @example ```["order.line_item_options"]```
6338
+ */
6339
+ external_includes?: string[] | null;
6310
6340
  market?: MarketRel$d | null;
6311
6341
  order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
6312
6342
  sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
@@ -13238,87 +13268,6 @@ declare class PriceLists extends ApiResource<PriceList> {
13238
13268
  type(): PriceListType;
13239
13269
  }
13240
13270
 
13241
- type TransactionType = 'transactions';
13242
- type TransactionRel$1 = ResourceRel & {
13243
- type: TransactionType;
13244
- };
13245
- type TransactionSort = Pick<Transaction, 'id' | 'number' | 'amount_cents'> & ResourceSort;
13246
- interface Transaction extends Resource {
13247
- readonly type: TransactionType;
13248
- /**
13249
- * The transaction number, auto generated.
13250
- * @example ```"42/T/001"```
13251
- */
13252
- number: string;
13253
- /**
13254
- * The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
13255
- * @example ```"EUR"```
13256
- */
13257
- currency_code: string;
13258
- /**
13259
- * The transaction amount, in cents.
13260
- * @example ```1500```
13261
- */
13262
- amount_cents: number;
13263
- /**
13264
- * The transaction amount, float.
13265
- * @example ```15```
13266
- */
13267
- amount_float: number;
13268
- /**
13269
- * The transaction amount, formatted.
13270
- * @example ```"€15,00"```
13271
- */
13272
- formatted_amount: string;
13273
- /**
13274
- * Indicates if the transaction is successful.
13275
- */
13276
- succeeded: boolean;
13277
- /**
13278
- * The message returned by the payment gateway.
13279
- * @example ```"Accepted"```
13280
- */
13281
- message?: string | null;
13282
- /**
13283
- * The error code, if any, returned by the payment gateway.
13284
- * @example ```"00001"```
13285
- */
13286
- error_code?: string | null;
13287
- /**
13288
- * The error detail, if any, returned by the payment gateway.
13289
- * @example ```"Already settled"```
13290
- */
13291
- error_detail?: string | null;
13292
- /**
13293
- * The token identifying the transaction, returned by the payment gateway.
13294
- * @example ```"xxxx-yyyy-zzzz"```
13295
- */
13296
- token?: string | null;
13297
- /**
13298
- * The ID identifying the transaction, returned by the payment gateway.
13299
- * @example ```"xxxx-yyyy-zzzz"```
13300
- */
13301
- gateway_transaction_id?: string | null;
13302
- order?: Order | null;
13303
- payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
13304
- attachments?: Attachment[] | null;
13305
- events?: Event[] | null;
13306
- versions?: Version[] | null;
13307
- event_stores?: EventStore[] | null;
13308
- }
13309
- declare class Transactions extends ApiResource<Transaction> {
13310
- static readonly TYPE: TransactionType;
13311
- order(transactionId: string | Transaction, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
13312
- attachments(transactionId: string | Transaction, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
13313
- events(transactionId: string | Transaction, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
13314
- versions(transactionId: string | Transaction, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
13315
- event_stores(transactionId: string | Transaction, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
13316
- isTransaction(resource: any): resource is Transaction;
13317
- relationship(id: string | ResourceId | null): TransactionRel$1;
13318
- relationshipToMany(...ids: string[]): TransactionRel$1[];
13319
- type(): TransactionType;
13320
- }
13321
-
13322
13271
  type PromotionType = 'promotions';
13323
13272
  type PromotionRel$1 = ResourceRel & {
13324
13273
  type: PromotionType;
@@ -13424,6 +13373,87 @@ declare class Promotions extends ApiResource<Promotion> {
13424
13373
  type(): PromotionType;
13425
13374
  }
13426
13375
 
13376
+ type TransactionType = 'transactions';
13377
+ type TransactionRel$1 = ResourceRel & {
13378
+ type: TransactionType;
13379
+ };
13380
+ type TransactionSort = Pick<Transaction, 'id' | 'number' | 'amount_cents'> & ResourceSort;
13381
+ interface Transaction extends Resource {
13382
+ readonly type: TransactionType;
13383
+ /**
13384
+ * The transaction number, auto generated.
13385
+ * @example ```"42/T/001"```
13386
+ */
13387
+ number: string;
13388
+ /**
13389
+ * The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
13390
+ * @example ```"EUR"```
13391
+ */
13392
+ currency_code: string;
13393
+ /**
13394
+ * The transaction amount, in cents.
13395
+ * @example ```1500```
13396
+ */
13397
+ amount_cents: number;
13398
+ /**
13399
+ * The transaction amount, float.
13400
+ * @example ```15```
13401
+ */
13402
+ amount_float: number;
13403
+ /**
13404
+ * The transaction amount, formatted.
13405
+ * @example ```"€15,00"```
13406
+ */
13407
+ formatted_amount: string;
13408
+ /**
13409
+ * Indicates if the transaction is successful.
13410
+ */
13411
+ succeeded: boolean;
13412
+ /**
13413
+ * The message returned by the payment gateway.
13414
+ * @example ```"Accepted"```
13415
+ */
13416
+ message?: string | null;
13417
+ /**
13418
+ * The error code, if any, returned by the payment gateway.
13419
+ * @example ```"00001"```
13420
+ */
13421
+ error_code?: string | null;
13422
+ /**
13423
+ * The error detail, if any, returned by the payment gateway.
13424
+ * @example ```"Already settled"```
13425
+ */
13426
+ error_detail?: string | null;
13427
+ /**
13428
+ * The token identifying the transaction, returned by the payment gateway.
13429
+ * @example ```"xxxx-yyyy-zzzz"```
13430
+ */
13431
+ token?: string | null;
13432
+ /**
13433
+ * The ID identifying the transaction, returned by the payment gateway.
13434
+ * @example ```"xxxx-yyyy-zzzz"```
13435
+ */
13436
+ gateway_transaction_id?: string | null;
13437
+ order?: Order | null;
13438
+ payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
13439
+ attachments?: Attachment[] | null;
13440
+ events?: Event[] | null;
13441
+ versions?: Version[] | null;
13442
+ event_stores?: EventStore[] | null;
13443
+ }
13444
+ declare class Transactions extends ApiResource<Transaction> {
13445
+ static readonly TYPE: TransactionType;
13446
+ order(transactionId: string | Transaction, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
13447
+ attachments(transactionId: string | Transaction, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
13448
+ events(transactionId: string | Transaction, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
13449
+ versions(transactionId: string | Transaction, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
13450
+ event_stores(transactionId: string | Transaction, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
13451
+ isTransaction(resource: any): resource is Transaction;
13452
+ relationship(id: string | ResourceId | null): TransactionRel$1;
13453
+ relationshipToMany(...ids: string[]): TransactionRel$1[];
13454
+ type(): TransactionType;
13455
+ }
13456
+
13427
13457
  type TaxCalculatorType = 'tax_calculators';
13428
13458
  type TaxCalculatorRel$1 = ResourceRel & {
13429
13459
  type: TaxCalculatorType;
@@ -14148,6 +14178,11 @@ interface ExternalTaxCalculator extends Resource {
14148
14178
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
14149
14179
  */
14150
14180
  shared_secret: string;
14181
+ /**
14182
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14183
+ * @example ```["order.line_item_options"]```
14184
+ */
14185
+ external_includes?: string[] | null;
14151
14186
  markets?: Market[] | null;
14152
14187
  attachments?: Attachment[] | null;
14153
14188
  events?: Event[] | null;
@@ -14165,6 +14200,11 @@ interface ExternalTaxCalculatorCreate extends ResourceCreate {
14165
14200
  * @example ```"https://external_calculator.yourbrand.com"```
14166
14201
  */
14167
14202
  tax_calculator_url: string;
14203
+ /**
14204
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14205
+ * @example ```["order.line_item_options"]```
14206
+ */
14207
+ external_includes?: string[] | null;
14168
14208
  }
14169
14209
  interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
14170
14210
  /**
@@ -14182,6 +14222,11 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
14182
14222
  * @example ```true```
14183
14223
  */
14184
14224
  _reset_circuit?: boolean | null;
14225
+ /**
14226
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14227
+ * @example ```["order.line_item_options"]```
14228
+ */
14229
+ external_includes?: string[] | null;
14185
14230
  }
14186
14231
  declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
14187
14232
  static readonly TYPE: ExternalTaxCalculatorType;
@@ -14305,15 +14350,15 @@ type MarketRel$2 = ResourceRel & {
14305
14350
  type CustomerGroupRel$1 = ResourceRel & {
14306
14351
  type: CustomerGroupType;
14307
14352
  };
14353
+ type PromotionRel = ResourceRel & {
14354
+ type: PromotionType;
14355
+ };
14308
14356
  type OrderRel = ResourceRel & {
14309
14357
  type: OrderType;
14310
14358
  };
14311
14359
  type TransactionRel = ResourceRel & {
14312
14360
  type: TransactionType;
14313
14361
  };
14314
- type PromotionRel = ResourceRel & {
14315
- type: PromotionType;
14316
- };
14317
14362
  type TaxCalculatorRel = ResourceRel & {
14318
14363
  type: TaxCalculatorType;
14319
14364
  };
@@ -14356,12 +14401,12 @@ type DeliveryLeadTimeRel = ResourceRel & {
14356
14401
  type ShippingMethodRel$1 = ResourceRel & {
14357
14402
  type: ShippingMethodType;
14358
14403
  };
14359
- type DiscountEngineRel$1 = ResourceRel & {
14360
- type: DiscountEngineType;
14361
- };
14362
14404
  type ShipmentRel$1 = ResourceRel & {
14363
14405
  type: ShipmentType;
14364
14406
  };
14407
+ type DiscountEngineRel$1 = ResourceRel & {
14408
+ type: DiscountEngineType;
14409
+ };
14365
14410
  type ParcelRel = ResourceRel & {
14366
14411
  type: ParcelType;
14367
14412
  };
@@ -14422,7 +14467,7 @@ interface Attachment extends Resource {
14422
14467
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14423
14468
  */
14424
14469
  url?: string | null;
14425
- attachable?: Geocoder | PriceList | PaymentMethod | Market | CustomerGroup | Order | Transaction | Promotion | TaxCalculator | TaxCategory | Sku | ShippingCategory | Bundle | SkuList | StockItem | StockLocation | Return | CarrierAccount | CouponRecipient | Customer | DeliveryLeadTime | ShippingMethod | DiscountEngine | Shipment | Parcel | GiftCardRecipient | GiftCard | InventoryModel | StockTransfer | SkuOption | Merchant | SubscriptionModel | PaymentOption | Package | Price | PriceTier | ShippingMethodTier | ShippingZone | null;
14470
+ attachable?: Geocoder | PriceList | PaymentMethod | Market | CustomerGroup | Promotion | Order | Transaction | TaxCalculator | TaxCategory | Sku | ShippingCategory | Bundle | SkuList | StockItem | StockLocation | Return | CarrierAccount | CouponRecipient | Customer | DeliveryLeadTime | ShippingMethod | Shipment | DiscountEngine | Parcel | GiftCardRecipient | GiftCard | InventoryModel | StockTransfer | SkuOption | Merchant | SubscriptionModel | PaymentOption | Package | Price | PriceTier | ShippingMethodTier | ShippingZone | null;
14426
14471
  event_stores?: EventStore[] | null;
14427
14472
  }
14428
14473
  interface AttachmentCreate extends ResourceCreate {
@@ -14441,7 +14486,7 @@ interface AttachmentCreate extends ResourceCreate {
14441
14486
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14442
14487
  */
14443
14488
  url?: string | null;
14444
- 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$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
14489
+ attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | PromotionRel | OrderRel | TransactionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | ShipmentRel$1 | DiscountEngineRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
14445
14490
  }
14446
14491
  interface AttachmentUpdate extends ResourceUpdate {
14447
14492
  /**
@@ -14459,7 +14504,7 @@ interface AttachmentUpdate extends ResourceUpdate {
14459
14504
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14460
14505
  */
14461
14506
  url?: string | null;
14462
- 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$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
14507
+ attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | PromotionRel | OrderRel | TransactionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | ShipmentRel$1 | DiscountEngineRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
14463
14508
  }
14464
14509
  declare class Attachments extends ApiResource<Attachment> {
14465
14510
  static readonly TYPE: AttachmentType;
@@ -14631,6 +14676,11 @@ interface Market extends Resource {
14631
14676
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
14632
14677
  */
14633
14678
  shared_secret: string;
14679
+ /**
14680
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14681
+ * @example ```["order.line_item_options"]```
14682
+ */
14683
+ external_includes?: string[] | null;
14634
14684
  merchant?: Merchant | null;
14635
14685
  price_list?: PriceList | null;
14636
14686
  base_price_list?: PriceList | null;
@@ -14694,6 +14744,11 @@ interface MarketCreate extends ResourceCreate {
14694
14744
  * @example ```true```
14695
14745
  */
14696
14746
  _enable?: boolean | null;
14747
+ /**
14748
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14749
+ * @example ```["order.line_item_options"]```
14750
+ */
14751
+ external_includes?: string[] | null;
14697
14752
  merchant: MerchantRel;
14698
14753
  price_list: PriceListRel;
14699
14754
  inventory_model: InventoryModelRel;
@@ -14751,6 +14806,11 @@ interface MarketUpdate extends ResourceUpdate {
14751
14806
  * @example ```true```
14752
14807
  */
14753
14808
  _enable?: boolean | null;
14809
+ /**
14810
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
14811
+ * @example ```["order.line_item_options"]```
14812
+ */
14813
+ external_includes?: string[] | null;
14754
14814
  merchant?: MerchantRel | null;
14755
14815
  price_list?: PriceListRel | null;
14756
14816
  inventory_model?: InventoryModelRel | null;
@@ -16170,6 +16230,11 @@ interface ExternalGateway extends Resource {
16170
16230
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
16171
16231
  */
16172
16232
  shared_secret: string;
16233
+ /**
16234
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
16235
+ * @example ```["order.line_item_options"]```
16236
+ */
16237
+ external_includes?: string[] | null;
16173
16238
  payment_methods?: PaymentMethod[] | null;
16174
16239
  versions?: Version[] | null;
16175
16240
  event_stores?: EventStore[] | null;
@@ -16206,6 +16271,11 @@ interface ExternalGatewayCreate extends ResourceCreate {
16206
16271
  * @example ```"https://external_gateway.com/token"```
16207
16272
  */
16208
16273
  token_url?: string | null;
16274
+ /**
16275
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
16276
+ * @example ```["order.line_item_options"]```
16277
+ */
16278
+ external_includes?: string[] | null;
16209
16279
  }
16210
16280
  interface ExternalGatewayUpdate extends ResourceUpdate {
16211
16281
  /**
@@ -16243,6 +16313,11 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
16243
16313
  * @example ```true```
16244
16314
  */
16245
16315
  _reset_circuit?: boolean | null;
16316
+ /**
16317
+ * List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.
16318
+ * @example ```["order.line_item_options"]```
16319
+ */
16320
+ external_includes?: string[] | null;
16246
16321
  }
16247
16322
  declare class ExternalGateways extends ApiResource<ExternalGateway> {
16248
16323
  static readonly TYPE: ExternalGatewayType;
@@ -16393,6 +16468,11 @@ interface Import extends Resource {
16393
16468
  * @example ```{"ABC":["could not be deleted"]}```
16394
16469
  */
16395
16470
  warnings_log?: Record<string, any> | null;
16471
+ /**
16472
+ * Disables the interruption of the import in case its errors exceeds the 10% threshold.
16473
+ * @example ```true```
16474
+ */
16475
+ skip_errors?: boolean | null;
16396
16476
  /**
16397
16477
  * The URL the the raw inputs file, which will be generated at import start.
16398
16478
  * @example ```"http://cl_imports.s3.amazonaws.com/"```
@@ -16422,6 +16502,11 @@ interface ImportCreate extends ResourceCreate {
16422
16502
  * @example ```[{"code":"ABC","name":"Foo"},{"code":"DEF","name":"Bar"}]```
16423
16503
  */
16424
16504
  inputs: Array<Record<string, any>>;
16505
+ /**
16506
+ * Disables the interruption of the import in case its errors exceeds the 10% threshold.
16507
+ * @example ```true```
16508
+ */
16509
+ skip_errors?: boolean | null;
16425
16510
  }
16426
16511
  interface ImportUpdate extends ResourceUpdate {
16427
16512
  /**
@@ -17642,7 +17727,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
17642
17727
  type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
17643
17728
  declare class CommerceLayerClient {
17644
17729
  #private;
17645
- readonly openApiSchemaVersion = "7.9.9";
17730
+ readonly openApiSchemaVersion = "7.9.10";
17646
17731
  constructor(config: CommerceLayerInitConfig);
17647
17732
  get addresses(): Addresses;
17648
17733
  get adjustments(): Adjustments;