@commercelayer/sdk 6.50.1 → 6.52.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
@@ -971,7 +971,7 @@ type PaymentGatewayType = 'payment_gateways';
971
971
  type PaymentGatewayRel$1 = ResourceRel & {
972
972
  type: PaymentGatewayType;
973
973
  };
974
- type PaymentGatewaySort = Pick<PaymentGateway, 'id' | 'name'> & ResourceSort;
974
+ type PaymentGatewaySort = Pick<PaymentGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
975
975
  interface PaymentGateway extends Resource {
976
976
  readonly type: PaymentGatewayType;
977
977
  /**
@@ -979,6 +979,16 @@ interface PaymentGateway extends Resource {
979
979
  * @example ```"US payment gateway"```
980
980
  */
981
981
  name: string;
982
+ /**
983
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
984
+ * @example ```true```
985
+ */
986
+ force_payments?: boolean | null;
987
+ /**
988
+ * Time at which this resource was disabled.
989
+ * @example ```"2018-01-01T12:00:00.000Z"```
990
+ */
991
+ disabled_at?: string | null;
982
992
  payment_methods?: PaymentMethod[] | null;
983
993
  versions?: Version[] | null;
984
994
  event_stores?: EventStore[] | null;
@@ -4433,6 +4443,11 @@ interface ShippingMethod extends Resource {
4433
4443
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
4434
4444
  */
4435
4445
  shared_secret: string;
4446
+ /**
4447
+ * 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.
4448
+ * @example ```["order.line_item_options"]```
4449
+ */
4450
+ external_includes?: string[] | null;
4436
4451
  market?: Market | null;
4437
4452
  shipping_zone?: ShippingZone | null;
4438
4453
  shipping_category?: ShippingCategory | null;
@@ -4511,6 +4526,11 @@ interface ShippingMethodCreate extends ResourceCreate {
4511
4526
  * @example ```true```
4512
4527
  */
4513
4528
  _enable?: boolean | null;
4529
+ /**
4530
+ * 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.
4531
+ * @example ```["order.line_item_options"]```
4532
+ */
4533
+ external_includes?: string[] | null;
4514
4534
  market?: MarketRel$g | null;
4515
4535
  shipping_zone?: ShippingZoneRel$1 | null;
4516
4536
  shipping_category?: ShippingCategoryRel$3 | null;
@@ -4588,6 +4608,11 @@ interface ShippingMethodUpdate extends ResourceUpdate {
4588
4608
  * @example ```true```
4589
4609
  */
4590
4610
  _reset_circuit?: boolean | null;
4611
+ /**
4612
+ * 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.
4613
+ * @example ```["order.line_item_options"]```
4614
+ */
4615
+ external_includes?: string[] | null;
4591
4616
  market?: MarketRel$g | null;
4592
4617
  shipping_zone?: ShippingZoneRel$1 | null;
4593
4618
  shipping_category?: ShippingCategoryRel$3 | null;
@@ -4623,12 +4648,12 @@ type NotificationType = 'notifications';
4623
4648
  type NotificationRel = ResourceRel & {
4624
4649
  type: NotificationType;
4625
4650
  };
4626
- type OrderRel$9 = ResourceRel & {
4627
- type: OrderType;
4628
- };
4629
4651
  type LineItemRel$2 = ResourceRel & {
4630
4652
  type: LineItemType;
4631
4653
  };
4654
+ type OrderRel$9 = ResourceRel & {
4655
+ type: OrderType;
4656
+ };
4632
4657
  type ShippingMethodRel$3 = ResourceRel & {
4633
4658
  type: ShippingMethodType;
4634
4659
  };
@@ -4649,7 +4674,7 @@ interface Notification extends Resource {
4649
4674
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4650
4675
  */
4651
4676
  body?: Record<string, any> | null;
4652
- notifiable?: Order | LineItem | ShippingMethod | null;
4677
+ notifiable?: LineItem | Order | ShippingMethod | null;
4653
4678
  event_stores?: EventStore[] | null;
4654
4679
  }
4655
4680
  interface NotificationCreate extends ResourceCreate {
@@ -4667,7 +4692,7 @@ interface NotificationCreate extends ResourceCreate {
4667
4692
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4668
4693
  */
4669
4694
  body?: Record<string, any> | null;
4670
- notifiable: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3;
4695
+ notifiable: LineItemRel$2 | OrderRel$9 | ShippingMethodRel$3;
4671
4696
  }
4672
4697
  interface NotificationUpdate extends ResourceUpdate {
4673
4698
  /**
@@ -4684,7 +4709,7 @@ interface NotificationUpdate extends ResourceUpdate {
4684
4709
  * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}```
4685
4710
  */
4686
4711
  body?: Record<string, any> | null;
4687
- notifiable?: OrderRel$9 | LineItemRel$2 | ShippingMethodRel$3 | null;
4712
+ notifiable?: LineItemRel$2 | OrderRel$9 | ShippingMethodRel$3 | null;
4688
4713
  }
4689
4714
  declare class Notifications extends ApiResource<Notification> {
4690
4715
  static readonly TYPE: NotificationType;
@@ -6169,6 +6194,11 @@ interface ExternalPromotion extends Resource {
6169
6194
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
6170
6195
  */
6171
6196
  shared_secret: string;
6197
+ /**
6198
+ * 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.
6199
+ * @example ```["order.line_item_options"]```
6200
+ */
6201
+ external_includes?: string[] | null;
6172
6202
  market?: Market | null;
6173
6203
  promotion_rules?: PromotionRule[] | null;
6174
6204
  order_amount_promotion_rule?: OrderAmountPromotionRule | null;
@@ -6235,6 +6265,11 @@ interface ExternalPromotionCreate extends ResourceCreate {
6235
6265
  * @example ```"https://external_promotion.yourbrand.com"```
6236
6266
  */
6237
6267
  promotion_url: string;
6268
+ /**
6269
+ * 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.
6270
+ * @example ```["order.line_item_options"]```
6271
+ */
6272
+ external_includes?: string[] | null;
6238
6273
  market?: MarketRel$d | null;
6239
6274
  order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
6240
6275
  sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
@@ -6307,6 +6342,11 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
6307
6342
  * @example ```true```
6308
6343
  */
6309
6344
  _reset_circuit?: boolean | null;
6345
+ /**
6346
+ * 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.
6347
+ * @example ```["order.line_item_options"]```
6348
+ */
6349
+ external_includes?: string[] | null;
6310
6350
  market?: MarketRel$d | null;
6311
6351
  order_amount_promotion_rule?: OrderAmountPromotionRuleRel$7 | null;
6312
6352
  sku_list_promotion_rule?: SkuListPromotionRuleRel$7 | null;
@@ -13238,87 +13278,6 @@ declare class PriceLists extends ApiResource<PriceList> {
13238
13278
  type(): PriceListType;
13239
13279
  }
13240
13280
 
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
13281
  type PromotionType = 'promotions';
13323
13282
  type PromotionRel$1 = ResourceRel & {
13324
13283
  type: PromotionType;
@@ -13424,6 +13383,87 @@ declare class Promotions extends ApiResource<Promotion> {
13424
13383
  type(): PromotionType;
13425
13384
  }
13426
13385
 
13386
+ type TransactionType = 'transactions';
13387
+ type TransactionRel$1 = ResourceRel & {
13388
+ type: TransactionType;
13389
+ };
13390
+ type TransactionSort = Pick<Transaction, 'id' | 'number' | 'amount_cents'> & ResourceSort;
13391
+ interface Transaction extends Resource {
13392
+ readonly type: TransactionType;
13393
+ /**
13394
+ * The transaction number, auto generated.
13395
+ * @example ```"42/T/001"```
13396
+ */
13397
+ number: string;
13398
+ /**
13399
+ * The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
13400
+ * @example ```"EUR"```
13401
+ */
13402
+ currency_code: string;
13403
+ /**
13404
+ * The transaction amount, in cents.
13405
+ * @example ```1500```
13406
+ */
13407
+ amount_cents: number;
13408
+ /**
13409
+ * The transaction amount, float.
13410
+ * @example ```15```
13411
+ */
13412
+ amount_float: number;
13413
+ /**
13414
+ * The transaction amount, formatted.
13415
+ * @example ```"€15,00"```
13416
+ */
13417
+ formatted_amount: string;
13418
+ /**
13419
+ * Indicates if the transaction is successful.
13420
+ */
13421
+ succeeded: boolean;
13422
+ /**
13423
+ * The message returned by the payment gateway.
13424
+ * @example ```"Accepted"```
13425
+ */
13426
+ message?: string | null;
13427
+ /**
13428
+ * The error code, if any, returned by the payment gateway.
13429
+ * @example ```"00001"```
13430
+ */
13431
+ error_code?: string | null;
13432
+ /**
13433
+ * The error detail, if any, returned by the payment gateway.
13434
+ * @example ```"Already settled"```
13435
+ */
13436
+ error_detail?: string | null;
13437
+ /**
13438
+ * The token identifying the transaction, returned by the payment gateway.
13439
+ * @example ```"xxxx-yyyy-zzzz"```
13440
+ */
13441
+ token?: string | null;
13442
+ /**
13443
+ * The ID identifying the transaction, returned by the payment gateway.
13444
+ * @example ```"xxxx-yyyy-zzzz"```
13445
+ */
13446
+ gateway_transaction_id?: string | null;
13447
+ order?: Order | null;
13448
+ payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
13449
+ attachments?: Attachment[] | null;
13450
+ events?: Event[] | null;
13451
+ versions?: Version[] | null;
13452
+ event_stores?: EventStore[] | null;
13453
+ }
13454
+ declare class Transactions extends ApiResource<Transaction> {
13455
+ static readonly TYPE: TransactionType;
13456
+ order(transactionId: string | Transaction, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
13457
+ attachments(transactionId: string | Transaction, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
13458
+ events(transactionId: string | Transaction, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
13459
+ versions(transactionId: string | Transaction, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
13460
+ event_stores(transactionId: string | Transaction, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
13461
+ isTransaction(resource: any): resource is Transaction;
13462
+ relationship(id: string | ResourceId | null): TransactionRel$1;
13463
+ relationshipToMany(...ids: string[]): TransactionRel$1[];
13464
+ type(): TransactionType;
13465
+ }
13466
+
13427
13467
  type TaxCalculatorType = 'tax_calculators';
13428
13468
  type TaxCalculatorRel$1 = ResourceRel & {
13429
13469
  type: TaxCalculatorType;
@@ -14148,6 +14188,11 @@ interface ExternalTaxCalculator extends Resource {
14148
14188
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
14149
14189
  */
14150
14190
  shared_secret: string;
14191
+ /**
14192
+ * 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.
14193
+ * @example ```["order.line_item_options"]```
14194
+ */
14195
+ external_includes?: string[] | null;
14151
14196
  markets?: Market[] | null;
14152
14197
  attachments?: Attachment[] | null;
14153
14198
  events?: Event[] | null;
@@ -14165,6 +14210,11 @@ interface ExternalTaxCalculatorCreate extends ResourceCreate {
14165
14210
  * @example ```"https://external_calculator.yourbrand.com"```
14166
14211
  */
14167
14212
  tax_calculator_url: string;
14213
+ /**
14214
+ * 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.
14215
+ * @example ```["order.line_item_options"]```
14216
+ */
14217
+ external_includes?: string[] | null;
14168
14218
  }
14169
14219
  interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
14170
14220
  /**
@@ -14182,6 +14232,11 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
14182
14232
  * @example ```true```
14183
14233
  */
14184
14234
  _reset_circuit?: boolean | null;
14235
+ /**
14236
+ * 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.
14237
+ * @example ```["order.line_item_options"]```
14238
+ */
14239
+ external_includes?: string[] | null;
14185
14240
  }
14186
14241
  declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
14187
14242
  static readonly TYPE: ExternalTaxCalculatorType;
@@ -14305,15 +14360,15 @@ type MarketRel$2 = ResourceRel & {
14305
14360
  type CustomerGroupRel$1 = ResourceRel & {
14306
14361
  type: CustomerGroupType;
14307
14362
  };
14363
+ type PromotionRel = ResourceRel & {
14364
+ type: PromotionType;
14365
+ };
14308
14366
  type OrderRel = ResourceRel & {
14309
14367
  type: OrderType;
14310
14368
  };
14311
14369
  type TransactionRel = ResourceRel & {
14312
14370
  type: TransactionType;
14313
14371
  };
14314
- type PromotionRel = ResourceRel & {
14315
- type: PromotionType;
14316
- };
14317
14372
  type TaxCalculatorRel = ResourceRel & {
14318
14373
  type: TaxCalculatorType;
14319
14374
  };
@@ -14356,12 +14411,12 @@ type DeliveryLeadTimeRel = ResourceRel & {
14356
14411
  type ShippingMethodRel$1 = ResourceRel & {
14357
14412
  type: ShippingMethodType;
14358
14413
  };
14359
- type DiscountEngineRel$1 = ResourceRel & {
14360
- type: DiscountEngineType;
14361
- };
14362
14414
  type ShipmentRel$1 = ResourceRel & {
14363
14415
  type: ShipmentType;
14364
14416
  };
14417
+ type DiscountEngineRel$1 = ResourceRel & {
14418
+ type: DiscountEngineType;
14419
+ };
14365
14420
  type ParcelRel = ResourceRel & {
14366
14421
  type: ParcelType;
14367
14422
  };
@@ -14422,7 +14477,7 @@ interface Attachment extends Resource {
14422
14477
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14423
14478
  */
14424
14479
  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;
14480
+ 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
14481
  event_stores?: EventStore[] | null;
14427
14482
  }
14428
14483
  interface AttachmentCreate extends ResourceCreate {
@@ -14441,7 +14496,7 @@ interface AttachmentCreate extends ResourceCreate {
14441
14496
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14442
14497
  */
14443
14498
  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;
14499
+ 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
14500
  }
14446
14501
  interface AttachmentUpdate extends ResourceUpdate {
14447
14502
  /**
@@ -14459,7 +14514,7 @@ interface AttachmentUpdate extends ResourceUpdate {
14459
14514
  * @example ```"https://s3.yourdomain.com/attachment.pdf"```
14460
14515
  */
14461
14516
  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;
14517
+ 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
14518
  }
14464
14519
  declare class Attachments extends ApiResource<Attachment> {
14465
14520
  static readonly TYPE: AttachmentType;
@@ -14631,6 +14686,11 @@ interface Market extends Resource {
14631
14686
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
14632
14687
  */
14633
14688
  shared_secret: string;
14689
+ /**
14690
+ * 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.
14691
+ * @example ```["order.line_item_options"]```
14692
+ */
14693
+ external_includes?: string[] | null;
14634
14694
  merchant?: Merchant | null;
14635
14695
  price_list?: PriceList | null;
14636
14696
  base_price_list?: PriceList | null;
@@ -14694,6 +14754,11 @@ interface MarketCreate extends ResourceCreate {
14694
14754
  * @example ```true```
14695
14755
  */
14696
14756
  _enable?: boolean | null;
14757
+ /**
14758
+ * 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.
14759
+ * @example ```["order.line_item_options"]```
14760
+ */
14761
+ external_includes?: string[] | null;
14697
14762
  merchant: MerchantRel;
14698
14763
  price_list: PriceListRel;
14699
14764
  inventory_model: InventoryModelRel;
@@ -14751,6 +14816,11 @@ interface MarketUpdate extends ResourceUpdate {
14751
14816
  * @example ```true```
14752
14817
  */
14753
14818
  _enable?: boolean | null;
14819
+ /**
14820
+ * 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.
14821
+ * @example ```["order.line_item_options"]```
14822
+ */
14823
+ external_includes?: string[] | null;
14754
14824
  merchant?: MerchantRel | null;
14755
14825
  price_list?: PriceListRel | null;
14756
14826
  inventory_model?: InventoryModelRel | null;
@@ -15156,7 +15226,7 @@ type AdyenGatewayRel = ResourceRel & {
15156
15226
  type AdyenPaymentRel = ResourceRel & {
15157
15227
  type: AdyenPaymentType;
15158
15228
  };
15159
- type AdyenGatewaySort = Pick<AdyenGateway, 'id' | 'name'> & ResourceSort;
15229
+ type AdyenGatewaySort = Pick<AdyenGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
15160
15230
  interface AdyenGateway extends Resource {
15161
15231
  readonly type: AdyenGatewayType;
15162
15232
  /**
@@ -15164,6 +15234,16 @@ interface AdyenGateway extends Resource {
15164
15234
  * @example ```"US payment gateway"```
15165
15235
  */
15166
15236
  name: string;
15237
+ /**
15238
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15239
+ * @example ```true```
15240
+ */
15241
+ force_payments?: boolean | null;
15242
+ /**
15243
+ * Time at which this resource was disabled.
15244
+ * @example ```"2018-01-01T12:00:00.000Z"```
15245
+ */
15246
+ disabled_at?: string | null;
15167
15247
  /**
15168
15248
  * The prefix of the endpoint used for live transactions.
15169
15249
  * @example ```"1797a841fbb37ca7-AdyenDemo"```
@@ -15209,6 +15289,21 @@ interface AdyenGatewayCreate extends ResourceCreate {
15209
15289
  * @example ```"US payment gateway"```
15210
15290
  */
15211
15291
  name: string;
15292
+ /**
15293
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15294
+ * @example ```true```
15295
+ */
15296
+ force_payments?: boolean | null;
15297
+ /**
15298
+ * Send this attribute if you want to mark this resource as disabled.
15299
+ * @example ```true```
15300
+ */
15301
+ _disable?: boolean | null;
15302
+ /**
15303
+ * Send this attribute if you want to mark this resource as enabled.
15304
+ * @example ```true```
15305
+ */
15306
+ _enable?: boolean | null;
15212
15307
  /**
15213
15308
  * The gateway merchant account.
15214
15309
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15261,6 +15356,21 @@ interface AdyenGatewayUpdate extends ResourceUpdate {
15261
15356
  * @example ```"US payment gateway"```
15262
15357
  */
15263
15358
  name?: string | null;
15359
+ /**
15360
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15361
+ * @example ```true```
15362
+ */
15363
+ force_payments?: boolean | null;
15364
+ /**
15365
+ * Send this attribute if you want to mark this resource as disabled.
15366
+ * @example ```true```
15367
+ */
15368
+ _disable?: boolean | null;
15369
+ /**
15370
+ * Send this attribute if you want to mark this resource as enabled.
15371
+ * @example ```true```
15372
+ */
15373
+ _enable?: boolean | null;
15264
15374
  /**
15265
15375
  * The gateway merchant account.
15266
15376
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15316,6 +15426,8 @@ declare class AdyenGateways extends ApiResource<AdyenGateway> {
15316
15426
  versions(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
15317
15427
  event_stores(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
15318
15428
  adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<AdyenPayment>, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
15429
+ _disable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
15430
+ _enable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
15319
15431
  isAdyenGateway(resource: any): resource is AdyenGateway;
15320
15432
  relationship(id: string | ResourceId | null): AdyenGatewayRel;
15321
15433
  relationshipToMany(...ids: string[]): AdyenGatewayRel[];
@@ -15371,7 +15483,7 @@ type AxerveGatewayRel = ResourceRel & {
15371
15483
  type AxervePaymentRel = ResourceRel & {
15372
15484
  type: AxervePaymentType;
15373
15485
  };
15374
- type AxerveGatewaySort = Pick<AxerveGateway, 'id' | 'name'> & ResourceSort;
15486
+ type AxerveGatewaySort = Pick<AxerveGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
15375
15487
  interface AxerveGateway extends Resource {
15376
15488
  readonly type: AxerveGatewayType;
15377
15489
  /**
@@ -15380,12 +15492,22 @@ interface AxerveGateway extends Resource {
15380
15492
  */
15381
15493
  name: string;
15382
15494
  /**
15383
- * The merchant login code.
15384
- * @example ```"xxxx-yyyy-zzzz"```
15495
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15496
+ * @example ```true```
15385
15497
  */
15386
- login: string;
15498
+ force_payments?: boolean | null;
15387
15499
  /**
15388
- * The gateway webhook URL, generated automatically.
15500
+ * Time at which this resource was disabled.
15501
+ * @example ```"2018-01-01T12:00:00.000Z"```
15502
+ */
15503
+ disabled_at?: string | null;
15504
+ /**
15505
+ * The merchant login code.
15506
+ * @example ```"xxxx-yyyy-zzzz"```
15507
+ */
15508
+ login: string;
15509
+ /**
15510
+ * The gateway webhook URL, generated automatically.
15389
15511
  * @example ```"https://core.commercelayer.co/webhook_callbacks/axerve_gateways/xxxxx"```
15390
15512
  */
15391
15513
  webhook_endpoint_url?: string | null;
@@ -15400,6 +15522,21 @@ interface AxerveGatewayCreate extends ResourceCreate {
15400
15522
  * @example ```"US payment gateway"```
15401
15523
  */
15402
15524
  name: string;
15525
+ /**
15526
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15527
+ * @example ```true```
15528
+ */
15529
+ force_payments?: boolean | null;
15530
+ /**
15531
+ * Send this attribute if you want to mark this resource as disabled.
15532
+ * @example ```true```
15533
+ */
15534
+ _disable?: boolean | null;
15535
+ /**
15536
+ * Send this attribute if you want to mark this resource as enabled.
15537
+ * @example ```true```
15538
+ */
15539
+ _enable?: boolean | null;
15403
15540
  /**
15404
15541
  * The merchant login code.
15405
15542
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15418,6 +15555,21 @@ interface AxerveGatewayUpdate extends ResourceUpdate {
15418
15555
  * @example ```"US payment gateway"```
15419
15556
  */
15420
15557
  name?: string | null;
15558
+ /**
15559
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15560
+ * @example ```true```
15561
+ */
15562
+ force_payments?: boolean | null;
15563
+ /**
15564
+ * Send this attribute if you want to mark this resource as disabled.
15565
+ * @example ```true```
15566
+ */
15567
+ _disable?: boolean | null;
15568
+ /**
15569
+ * Send this attribute if you want to mark this resource as enabled.
15570
+ * @example ```true```
15571
+ */
15572
+ _enable?: boolean | null;
15421
15573
  /**
15422
15574
  * The merchant login code.
15423
15575
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15439,6 +15591,8 @@ declare class AxerveGateways extends ApiResource<AxerveGateway> {
15439
15591
  versions(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
15440
15592
  event_stores(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
15441
15593
  axerve_payments(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<AxervePayment>, options?: ResourcesConfig): Promise<ListResponse<AxervePayment>>;
15594
+ _disable(id: string | AxerveGateway, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
15595
+ _enable(id: string | AxerveGateway, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
15442
15596
  isAxerveGateway(resource: any): resource is AxerveGateway;
15443
15597
  relationship(id: string | ResourceId | null): AxerveGatewayRel;
15444
15598
  relationshipToMany(...ids: string[]): AxerveGatewayRel[];
@@ -15508,7 +15662,7 @@ type BraintreeGatewayRel = ResourceRel & {
15508
15662
  type BraintreePaymentRel = ResourceRel & {
15509
15663
  type: BraintreePaymentType;
15510
15664
  };
15511
- type BraintreeGatewaySort = Pick<BraintreeGateway, 'id' | 'name'> & ResourceSort;
15665
+ type BraintreeGatewaySort = Pick<BraintreeGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
15512
15666
  interface BraintreeGateway extends Resource {
15513
15667
  readonly type: BraintreeGatewayType;
15514
15668
  /**
@@ -15516,6 +15670,16 @@ interface BraintreeGateway extends Resource {
15516
15670
  * @example ```"US payment gateway"```
15517
15671
  */
15518
15672
  name: string;
15673
+ /**
15674
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15675
+ * @example ```true```
15676
+ */
15677
+ force_payments?: boolean | null;
15678
+ /**
15679
+ * Time at which this resource was disabled.
15680
+ * @example ```"2018-01-01T12:00:00.000Z"```
15681
+ */
15682
+ disabled_at?: string | null;
15519
15683
  /**
15520
15684
  * The dynamic descriptor name. Must be composed by business name (3, 7 or 12 chars), an asterisk (*) and the product name (18, 14 or 9 chars), for a total length of 22 chars.
15521
15685
  * @example ```"company*productabc1234"```
@@ -15547,6 +15711,21 @@ interface BraintreeGatewayCreate extends ResourceCreate {
15547
15711
  * @example ```"US payment gateway"```
15548
15712
  */
15549
15713
  name: string;
15714
+ /**
15715
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15716
+ * @example ```true```
15717
+ */
15718
+ force_payments?: boolean | null;
15719
+ /**
15720
+ * Send this attribute if you want to mark this resource as disabled.
15721
+ * @example ```true```
15722
+ */
15723
+ _disable?: boolean | null;
15724
+ /**
15725
+ * Send this attribute if you want to mark this resource as enabled.
15726
+ * @example ```true```
15727
+ */
15728
+ _enable?: boolean | null;
15550
15729
  /**
15551
15730
  * The gateway merchant account ID.
15552
15731
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15590,6 +15769,21 @@ interface BraintreeGatewayUpdate extends ResourceUpdate {
15590
15769
  * @example ```"US payment gateway"```
15591
15770
  */
15592
15771
  name?: string | null;
15772
+ /**
15773
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15774
+ * @example ```true```
15775
+ */
15776
+ force_payments?: boolean | null;
15777
+ /**
15778
+ * Send this attribute if you want to mark this resource as disabled.
15779
+ * @example ```true```
15780
+ */
15781
+ _disable?: boolean | null;
15782
+ /**
15783
+ * Send this attribute if you want to mark this resource as enabled.
15784
+ * @example ```true```
15785
+ */
15786
+ _enable?: boolean | null;
15593
15787
  /**
15594
15788
  * The gateway merchant account ID.
15595
15789
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15636,6 +15830,8 @@ declare class BraintreeGateways extends ApiResource<BraintreeGateway> {
15636
15830
  versions(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
15637
15831
  event_stores(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
15638
15832
  braintree_payments(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<BraintreePayment>, options?: ResourcesConfig): Promise<ListResponse<BraintreePayment>>;
15833
+ _disable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
15834
+ _enable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
15639
15835
  isBraintreeGateway(resource: any): resource is BraintreeGateway;
15640
15836
  relationship(id: string | ResourceId | null): BraintreeGatewayRel;
15641
15837
  relationshipToMany(...ids: string[]): BraintreeGatewayRel[];
@@ -15649,7 +15845,7 @@ type CheckoutComGatewayRel = ResourceRel & {
15649
15845
  type CheckoutComPaymentRel = ResourceRel & {
15650
15846
  type: CheckoutComPaymentType;
15651
15847
  };
15652
- type CheckoutComGatewaySort = Pick<CheckoutComGateway, 'id' | 'name'> & ResourceSort;
15848
+ type CheckoutComGatewaySort = Pick<CheckoutComGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
15653
15849
  interface CheckoutComGateway extends Resource {
15654
15850
  readonly type: CheckoutComGatewayType;
15655
15851
  /**
@@ -15657,6 +15853,16 @@ interface CheckoutComGateway extends Resource {
15657
15853
  * @example ```"US payment gateway"```
15658
15854
  */
15659
15855
  name: string;
15856
+ /**
15857
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15858
+ * @example ```true```
15859
+ */
15860
+ force_payments?: boolean | null;
15861
+ /**
15862
+ * Time at which this resource was disabled.
15863
+ * @example ```"2018-01-01T12:00:00.000Z"```
15864
+ */
15865
+ disabled_at?: string | null;
15660
15866
  /**
15661
15867
  * The gateway webhook endpoint ID, generated automatically.
15662
15868
  * @example ```"xxxx-yyyy-zzzz"```
@@ -15683,6 +15889,21 @@ interface CheckoutComGatewayCreate extends ResourceCreate {
15683
15889
  * @example ```"US payment gateway"```
15684
15890
  */
15685
15891
  name: string;
15892
+ /**
15893
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15894
+ * @example ```true```
15895
+ */
15896
+ force_payments?: boolean | null;
15897
+ /**
15898
+ * Send this attribute if you want to mark this resource as disabled.
15899
+ * @example ```true```
15900
+ */
15901
+ _disable?: boolean | null;
15902
+ /**
15903
+ * Send this attribute if you want to mark this resource as enabled.
15904
+ * @example ```true```
15905
+ */
15906
+ _enable?: boolean | null;
15686
15907
  /**
15687
15908
  * The gateway secret key.
15688
15909
  * @example ```"sk_test_xxxx-yyyy-zzzz"```
@@ -15701,6 +15922,21 @@ interface CheckoutComGatewayUpdate extends ResourceUpdate {
15701
15922
  * @example ```"US payment gateway"```
15702
15923
  */
15703
15924
  name?: string | null;
15925
+ /**
15926
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
15927
+ * @example ```true```
15928
+ */
15929
+ force_payments?: boolean | null;
15930
+ /**
15931
+ * Send this attribute if you want to mark this resource as disabled.
15932
+ * @example ```true```
15933
+ */
15934
+ _disable?: boolean | null;
15935
+ /**
15936
+ * Send this attribute if you want to mark this resource as enabled.
15937
+ * @example ```true```
15938
+ */
15939
+ _enable?: boolean | null;
15704
15940
  /**
15705
15941
  * The gateway secret key.
15706
15942
  * @example ```"sk_test_xxxx-yyyy-zzzz"```
@@ -15722,6 +15958,8 @@ declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
15722
15958
  versions(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
15723
15959
  event_stores(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
15724
15960
  checkout_com_payments(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<CheckoutComPayment>, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
15961
+ _disable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
15962
+ _enable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
15725
15963
  isCheckoutComGateway(resource: any): resource is CheckoutComGateway;
15726
15964
  relationship(id: string | ResourceId | null): CheckoutComGatewayRel;
15727
15965
  relationshipToMany(...ids: string[]): CheckoutComGatewayRel[];
@@ -16122,7 +16360,7 @@ type ExternalGatewayType = 'external_gateways';
16122
16360
  type ExternalGatewayRel = ResourceRel & {
16123
16361
  type: ExternalGatewayType;
16124
16362
  };
16125
- type ExternalGatewaySort = Pick<ExternalGateway, 'id' | 'name' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
16363
+ type ExternalGatewaySort = Pick<ExternalGateway, 'id' | 'name' | 'disabled_at' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
16126
16364
  interface ExternalGateway extends Resource {
16127
16365
  readonly type: ExternalGatewayType;
16128
16366
  /**
@@ -16130,6 +16368,16 @@ interface ExternalGateway extends Resource {
16130
16368
  * @example ```"US payment gateway"```
16131
16369
  */
16132
16370
  name: string;
16371
+ /**
16372
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16373
+ * @example ```true```
16374
+ */
16375
+ force_payments?: boolean | null;
16376
+ /**
16377
+ * Time at which this resource was disabled.
16378
+ * @example ```"2018-01-01T12:00:00.000Z"```
16379
+ */
16380
+ disabled_at?: string | null;
16133
16381
  /**
16134
16382
  * The endpoint used by the external gateway to authorize payments.
16135
16383
  * @example ```"https://external_gateway.com/authorize"```
@@ -16170,6 +16418,11 @@ interface ExternalGateway extends Resource {
16170
16418
  * @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
16171
16419
  */
16172
16420
  shared_secret: string;
16421
+ /**
16422
+ * 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.
16423
+ * @example ```["order.line_item_options"]```
16424
+ */
16425
+ external_includes?: string[] | null;
16173
16426
  payment_methods?: PaymentMethod[] | null;
16174
16427
  versions?: Version[] | null;
16175
16428
  event_stores?: EventStore[] | null;
@@ -16181,6 +16434,21 @@ interface ExternalGatewayCreate extends ResourceCreate {
16181
16434
  * @example ```"US payment gateway"```
16182
16435
  */
16183
16436
  name: string;
16437
+ /**
16438
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16439
+ * @example ```true```
16440
+ */
16441
+ force_payments?: boolean | null;
16442
+ /**
16443
+ * Send this attribute if you want to mark this resource as disabled.
16444
+ * @example ```true```
16445
+ */
16446
+ _disable?: boolean | null;
16447
+ /**
16448
+ * Send this attribute if you want to mark this resource as enabled.
16449
+ * @example ```true```
16450
+ */
16451
+ _enable?: boolean | null;
16184
16452
  /**
16185
16453
  * The endpoint used by the external gateway to authorize payments.
16186
16454
  * @example ```"https://external_gateway.com/authorize"```
@@ -16206,6 +16474,11 @@ interface ExternalGatewayCreate extends ResourceCreate {
16206
16474
  * @example ```"https://external_gateway.com/token"```
16207
16475
  */
16208
16476
  token_url?: string | null;
16477
+ /**
16478
+ * 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.
16479
+ * @example ```["order.line_item_options"]```
16480
+ */
16481
+ external_includes?: string[] | null;
16209
16482
  }
16210
16483
  interface ExternalGatewayUpdate extends ResourceUpdate {
16211
16484
  /**
@@ -16213,6 +16486,21 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
16213
16486
  * @example ```"US payment gateway"```
16214
16487
  */
16215
16488
  name?: string | null;
16489
+ /**
16490
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16491
+ * @example ```true```
16492
+ */
16493
+ force_payments?: boolean | null;
16494
+ /**
16495
+ * Send this attribute if you want to mark this resource as disabled.
16496
+ * @example ```true```
16497
+ */
16498
+ _disable?: boolean | null;
16499
+ /**
16500
+ * Send this attribute if you want to mark this resource as enabled.
16501
+ * @example ```true```
16502
+ */
16503
+ _enable?: boolean | null;
16216
16504
  /**
16217
16505
  * The endpoint used by the external gateway to authorize payments.
16218
16506
  * @example ```"https://external_gateway.com/authorize"```
@@ -16243,6 +16531,11 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
16243
16531
  * @example ```true```
16244
16532
  */
16245
16533
  _reset_circuit?: boolean | null;
16534
+ /**
16535
+ * 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.
16536
+ * @example ```["order.line_item_options"]```
16537
+ */
16538
+ external_includes?: string[] | null;
16246
16539
  }
16247
16540
  declare class ExternalGateways extends ApiResource<ExternalGateway> {
16248
16541
  static readonly TYPE: ExternalGatewayType;
@@ -16253,6 +16546,8 @@ declare class ExternalGateways extends ApiResource<ExternalGateway> {
16253
16546
  versions(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
16254
16547
  event_stores(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
16255
16548
  external_payments(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<ExternalPayment>, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
16549
+ _disable(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
16550
+ _enable(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
16256
16551
  _reset_circuit(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
16257
16552
  isExternalGateway(resource: any): resource is ExternalGateway;
16258
16553
  relationship(id: string | ResourceId | null): ExternalGatewayRel;
@@ -16393,6 +16688,11 @@ interface Import extends Resource {
16393
16688
  * @example ```{"ABC":["could not be deleted"]}```
16394
16689
  */
16395
16690
  warnings_log?: Record<string, any> | null;
16691
+ /**
16692
+ * Disables the interruption of the import in case its errors exceeds the 10% threshold.
16693
+ * @example ```true```
16694
+ */
16695
+ skip_errors?: boolean | null;
16396
16696
  /**
16397
16697
  * The URL the the raw inputs file, which will be generated at import start.
16398
16698
  * @example ```"http://cl_imports.s3.amazonaws.com/"```
@@ -16422,6 +16722,11 @@ interface ImportCreate extends ResourceCreate {
16422
16722
  * @example ```[{"code":"ABC","name":"Foo"},{"code":"DEF","name":"Bar"}]```
16423
16723
  */
16424
16724
  inputs: Array<Record<string, any>>;
16725
+ /**
16726
+ * Disables the interruption of the import in case its errors exceeds the 10% threshold.
16727
+ * @example ```true```
16728
+ */
16729
+ skip_errors?: boolean | null;
16425
16730
  }
16426
16731
  interface ImportUpdate extends ResourceUpdate {
16427
16732
  /**
@@ -16558,7 +16863,7 @@ type KlarnaGatewayRel = ResourceRel & {
16558
16863
  type KlarnaPaymentRel = ResourceRel & {
16559
16864
  type: KlarnaPaymentType;
16560
16865
  };
16561
- type KlarnaGatewaySort = Pick<KlarnaGateway, 'id' | 'name'> & ResourceSort;
16866
+ type KlarnaGatewaySort = Pick<KlarnaGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
16562
16867
  interface KlarnaGateway extends Resource {
16563
16868
  readonly type: KlarnaGatewayType;
16564
16869
  /**
@@ -16566,6 +16871,16 @@ interface KlarnaGateway extends Resource {
16566
16871
  * @example ```"US payment gateway"```
16567
16872
  */
16568
16873
  name: string;
16874
+ /**
16875
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16876
+ * @example ```true```
16877
+ */
16878
+ force_payments?: boolean | null;
16879
+ /**
16880
+ * Time at which this resource was disabled.
16881
+ * @example ```"2018-01-01T12:00:00.000Z"```
16882
+ */
16883
+ disabled_at?: string | null;
16569
16884
  payment_methods?: PaymentMethod[] | null;
16570
16885
  versions?: Version[] | null;
16571
16886
  event_stores?: EventStore[] | null;
@@ -16577,6 +16892,21 @@ interface KlarnaGatewayCreate extends ResourceCreate {
16577
16892
  * @example ```"US payment gateway"```
16578
16893
  */
16579
16894
  name: string;
16895
+ /**
16896
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16897
+ * @example ```true```
16898
+ */
16899
+ force_payments?: boolean | null;
16900
+ /**
16901
+ * Send this attribute if you want to mark this resource as disabled.
16902
+ * @example ```true```
16903
+ */
16904
+ _disable?: boolean | null;
16905
+ /**
16906
+ * Send this attribute if you want to mark this resource as enabled.
16907
+ * @example ```true```
16908
+ */
16909
+ _enable?: boolean | null;
16580
16910
  /**
16581
16911
  * The gateway country code one of EU, US, or OC.
16582
16912
  * @example ```"EU"```
@@ -16600,6 +16930,21 @@ interface KlarnaGatewayUpdate extends ResourceUpdate {
16600
16930
  * @example ```"US payment gateway"```
16601
16931
  */
16602
16932
  name?: string | null;
16933
+ /**
16934
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16935
+ * @example ```true```
16936
+ */
16937
+ force_payments?: boolean | null;
16938
+ /**
16939
+ * Send this attribute if you want to mark this resource as disabled.
16940
+ * @example ```true```
16941
+ */
16942
+ _disable?: boolean | null;
16943
+ /**
16944
+ * Send this attribute if you want to mark this resource as enabled.
16945
+ * @example ```true```
16946
+ */
16947
+ _enable?: boolean | null;
16603
16948
  /**
16604
16949
  * The gateway country code one of EU, US, or OC.
16605
16950
  * @example ```"EU"```
@@ -16626,6 +16971,8 @@ declare class KlarnaGateways extends ApiResource<KlarnaGateway> {
16626
16971
  versions(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
16627
16972
  event_stores(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
16628
16973
  klarna_payments(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<KlarnaPayment>, options?: ResourcesConfig): Promise<ListResponse<KlarnaPayment>>;
16974
+ _disable(id: string | KlarnaGateway, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
16975
+ _enable(id: string | KlarnaGateway, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
16629
16976
  isKlarnaGateway(resource: any): resource is KlarnaGateway;
16630
16977
  relationship(id: string | ResourceId | null): KlarnaGatewayRel;
16631
16978
  relationshipToMany(...ids: string[]): KlarnaGatewayRel[];
@@ -16636,7 +16983,7 @@ type ManualGatewayType = 'manual_gateways';
16636
16983
  type ManualGatewayRel = ResourceRel & {
16637
16984
  type: ManualGatewayType;
16638
16985
  };
16639
- type ManualGatewaySort = Pick<ManualGateway, 'id' | 'name'> & ResourceSort;
16986
+ type ManualGatewaySort = Pick<ManualGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
16640
16987
  interface ManualGateway extends Resource {
16641
16988
  readonly type: ManualGatewayType;
16642
16989
  /**
@@ -16644,6 +16991,16 @@ interface ManualGateway extends Resource {
16644
16991
  * @example ```"US payment gateway"```
16645
16992
  */
16646
16993
  name: string;
16994
+ /**
16995
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
16996
+ * @example ```true```
16997
+ */
16998
+ force_payments?: boolean | null;
16999
+ /**
17000
+ * Time at which this resource was disabled.
17001
+ * @example ```"2018-01-01T12:00:00.000Z"```
17002
+ */
17003
+ disabled_at?: string | null;
16647
17004
  payment_methods?: PaymentMethod[] | null;
16648
17005
  versions?: Version[] | null;
16649
17006
  event_stores?: EventStore[] | null;
@@ -16654,6 +17011,21 @@ interface ManualGatewayCreate extends ResourceCreate {
16654
17011
  * @example ```"US payment gateway"```
16655
17012
  */
16656
17013
  name: string;
17014
+ /**
17015
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17016
+ * @example ```true```
17017
+ */
17018
+ force_payments?: boolean | null;
17019
+ /**
17020
+ * Send this attribute if you want to mark this resource as disabled.
17021
+ * @example ```true```
17022
+ */
17023
+ _disable?: boolean | null;
17024
+ /**
17025
+ * Send this attribute if you want to mark this resource as enabled.
17026
+ * @example ```true```
17027
+ */
17028
+ _enable?: boolean | null;
16657
17029
  }
16658
17030
  interface ManualGatewayUpdate extends ResourceUpdate {
16659
17031
  /**
@@ -16661,6 +17033,21 @@ interface ManualGatewayUpdate extends ResourceUpdate {
16661
17033
  * @example ```"US payment gateway"```
16662
17034
  */
16663
17035
  name?: string | null;
17036
+ /**
17037
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17038
+ * @example ```true```
17039
+ */
17040
+ force_payments?: boolean | null;
17041
+ /**
17042
+ * Send this attribute if you want to mark this resource as disabled.
17043
+ * @example ```true```
17044
+ */
17045
+ _disable?: boolean | null;
17046
+ /**
17047
+ * Send this attribute if you want to mark this resource as enabled.
17048
+ * @example ```true```
17049
+ */
17050
+ _enable?: boolean | null;
16664
17051
  }
16665
17052
  declare class ManualGateways extends ApiResource<ManualGateway> {
16666
17053
  static readonly TYPE: ManualGatewayType;
@@ -16670,6 +17057,8 @@ declare class ManualGateways extends ApiResource<ManualGateway> {
16670
17057
  payment_methods(manualGatewayId: string | ManualGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
16671
17058
  versions(manualGatewayId: string | ManualGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
16672
17059
  event_stores(manualGatewayId: string | ManualGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
17060
+ _disable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
17061
+ _enable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
16673
17062
  isManualGateway(resource: any): resource is ManualGateway;
16674
17063
  relationship(id: string | ResourceId | null): ManualGatewayRel;
16675
17064
  relationshipToMany(...ids: string[]): ManualGatewayRel[];
@@ -16965,7 +17354,7 @@ type PaypalGatewayType = 'paypal_gateways';
16965
17354
  type PaypalGatewayRel = ResourceRel & {
16966
17355
  type: PaypalGatewayType;
16967
17356
  };
16968
- type PaypalGatewaySort = Pick<PaypalGateway, 'id' | 'name'> & ResourceSort;
17357
+ type PaypalGatewaySort = Pick<PaypalGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
16969
17358
  interface PaypalGateway extends Resource {
16970
17359
  readonly type: PaypalGatewayType;
16971
17360
  /**
@@ -16973,6 +17362,16 @@ interface PaypalGateway extends Resource {
16973
17362
  * @example ```"US payment gateway"```
16974
17363
  */
16975
17364
  name: string;
17365
+ /**
17366
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17367
+ * @example ```true```
17368
+ */
17369
+ force_payments?: boolean | null;
17370
+ /**
17371
+ * Time at which this resource was disabled.
17372
+ * @example ```"2018-01-01T12:00:00.000Z"```
17373
+ */
17374
+ disabled_at?: string | null;
16976
17375
  payment_methods?: PaymentMethod[] | null;
16977
17376
  versions?: Version[] | null;
16978
17377
  event_stores?: EventStore[] | null;
@@ -16984,6 +17383,21 @@ interface PaypalGatewayCreate extends ResourceCreate {
16984
17383
  * @example ```"US payment gateway"```
16985
17384
  */
16986
17385
  name: string;
17386
+ /**
17387
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17388
+ * @example ```true```
17389
+ */
17390
+ force_payments?: boolean | null;
17391
+ /**
17392
+ * Send this attribute if you want to mark this resource as disabled.
17393
+ * @example ```true```
17394
+ */
17395
+ _disable?: boolean | null;
17396
+ /**
17397
+ * Send this attribute if you want to mark this resource as enabled.
17398
+ * @example ```true```
17399
+ */
17400
+ _enable?: boolean | null;
16987
17401
  /**
16988
17402
  * The gateway client ID.
16989
17403
  * @example ```"xxxx-yyyy-zzzz"```
@@ -17001,6 +17415,21 @@ interface PaypalGatewayUpdate extends ResourceUpdate {
17001
17415
  * @example ```"US payment gateway"```
17002
17416
  */
17003
17417
  name?: string | null;
17418
+ /**
17419
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17420
+ * @example ```true```
17421
+ */
17422
+ force_payments?: boolean | null;
17423
+ /**
17424
+ * Send this attribute if you want to mark this resource as disabled.
17425
+ * @example ```true```
17426
+ */
17427
+ _disable?: boolean | null;
17428
+ /**
17429
+ * Send this attribute if you want to mark this resource as enabled.
17430
+ * @example ```true```
17431
+ */
17432
+ _enable?: boolean | null;
17004
17433
  /**
17005
17434
  * The gateway client ID.
17006
17435
  * @example ```"xxxx-yyyy-zzzz"```
@@ -17021,6 +17450,8 @@ declare class PaypalGateways extends ApiResource<PaypalGateway> {
17021
17450
  versions(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
17022
17451
  event_stores(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
17023
17452
  paypal_payments(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<PaypalPayment>, options?: ResourcesConfig): Promise<ListResponse<PaypalPayment>>;
17453
+ _disable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
17454
+ _enable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
17024
17455
  isPaypalGateway(resource: any): resource is PaypalGateway;
17025
17456
  relationship(id: string | ResourceId | null): PaypalGatewayRel;
17026
17457
  relationshipToMany(...ids: string[]): PaypalGatewayRel[];
@@ -17034,7 +17465,7 @@ type SatispayGatewayRel = ResourceRel & {
17034
17465
  type SatispayPaymentRel = ResourceRel & {
17035
17466
  type: SatispayPaymentType;
17036
17467
  };
17037
- type SatispayGatewaySort = Pick<SatispayGateway, 'id' | 'name'> & ResourceSort;
17468
+ type SatispayGatewaySort = Pick<SatispayGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
17038
17469
  interface SatispayGateway extends Resource {
17039
17470
  readonly type: SatispayGatewayType;
17040
17471
  /**
@@ -17042,6 +17473,16 @@ interface SatispayGateway extends Resource {
17042
17473
  * @example ```"US payment gateway"```
17043
17474
  */
17044
17475
  name: string;
17476
+ /**
17477
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17478
+ * @example ```true```
17479
+ */
17480
+ force_payments?: boolean | null;
17481
+ /**
17482
+ * Time at which this resource was disabled.
17483
+ * @example ```"2018-01-01T12:00:00.000Z"```
17484
+ */
17485
+ disabled_at?: string | null;
17045
17486
  /**
17046
17487
  * Activation code generated from the Satispay Dashboard.
17047
17488
  * @example ```"623ECX"```
@@ -17068,6 +17509,21 @@ interface SatispayGatewayCreate extends ResourceCreate {
17068
17509
  * @example ```"US payment gateway"```
17069
17510
  */
17070
17511
  name: string;
17512
+ /**
17513
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17514
+ * @example ```true```
17515
+ */
17516
+ force_payments?: boolean | null;
17517
+ /**
17518
+ * Send this attribute if you want to mark this resource as disabled.
17519
+ * @example ```true```
17520
+ */
17521
+ _disable?: boolean | null;
17522
+ /**
17523
+ * Send this attribute if you want to mark this resource as enabled.
17524
+ * @example ```true```
17525
+ */
17526
+ _enable?: boolean | null;
17071
17527
  /**
17072
17528
  * Activation code generated from the Satispay Dashboard.
17073
17529
  * @example ```"623ECX"```
@@ -17081,6 +17537,21 @@ interface SatispayGatewayUpdate extends ResourceUpdate {
17081
17537
  * @example ```"US payment gateway"```
17082
17538
  */
17083
17539
  name?: string | null;
17540
+ /**
17541
+ * Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
17542
+ * @example ```true```
17543
+ */
17544
+ force_payments?: boolean | null;
17545
+ /**
17546
+ * Send this attribute if you want to mark this resource as disabled.
17547
+ * @example ```true```
17548
+ */
17549
+ _disable?: boolean | null;
17550
+ /**
17551
+ * Send this attribute if you want to mark this resource as enabled.
17552
+ * @example ```true```
17553
+ */
17554
+ _enable?: boolean | null;
17084
17555
  satispay_payments?: SatispayPaymentRel[] | null;
17085
17556
  }
17086
17557
  declare class SatispayGateways extends ApiResource<SatispayGateway> {
@@ -17092,6 +17563,8 @@ declare class SatispayGateways extends ApiResource<SatispayGateway> {
17092
17563
  versions(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
17093
17564
  event_stores(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
17094
17565
  satispay_payments(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<SatispayPayment>, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
17566
+ _disable(id: string | SatispayGateway, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
17567
+ _enable(id: string | SatispayGateway, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
17095
17568
  isSatispayGateway(resource: any): resource is SatispayGateway;
17096
17569
  relationship(id: string | ResourceId | null): SatispayGatewayRel;
17097
17570
  relationshipToMany(...ids: string[]): SatispayGatewayRel[];
@@ -17102,7 +17575,7 @@ type StripeGatewayType = 'stripe_gateways';
17102
17575
  type StripeGatewayRel = ResourceRel & {
17103
17576
  type: StripeGatewayType;
17104
17577
  };
17105
- type StripeGatewaySort = Pick<StripeGateway, 'id' | 'name'> & ResourceSort;
17578
+ type StripeGatewaySort = Pick<StripeGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
17106
17579
  interface StripeGateway extends Resource {
17107
17580
  readonly type: StripeGatewayType;
17108
17581
  /**
@@ -17110,6 +17583,12 @@ interface StripeGateway extends Resource {
17110
17583
  * @example ```"US payment gateway"```
17111
17584
  */
17112
17585
  name: string;
17586
+ force_payments?: boolean | null;
17587
+ /**
17588
+ * Time at which this resource was disabled.
17589
+ * @example ```"2018-01-01T12:00:00.000Z"```
17590
+ */
17591
+ disabled_at?: string | null;
17113
17592
  /**
17114
17593
  * The account (if any) for which the funds of the PaymentIntent are intended.
17115
17594
  * @example ```"acct_xxxx-yyyy-zzzz"```
@@ -17120,11 +17599,6 @@ interface StripeGateway extends Resource {
17120
17599
  * @example ```true```
17121
17600
  */
17122
17601
  auto_payments?: boolean | null;
17123
- /**
17124
- * Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
17125
- * @example ```true```
17126
- */
17127
- force_payments?: boolean | null;
17128
17602
  /**
17129
17603
  * The gateway webhook endpoint ID, generated automatically.
17130
17604
  * @example ```"xxxx-yyyy-zzzz"```
@@ -17151,6 +17625,17 @@ interface StripeGatewayCreate extends ResourceCreate {
17151
17625
  * @example ```"US payment gateway"```
17152
17626
  */
17153
17627
  name: string;
17628
+ force_payments?: boolean | null;
17629
+ /**
17630
+ * Send this attribute if you want to mark this resource as disabled.
17631
+ * @example ```true```
17632
+ */
17633
+ _disable?: boolean | null;
17634
+ /**
17635
+ * Send this attribute if you want to mark this resource as enabled.
17636
+ * @example ```true```
17637
+ */
17638
+ _enable?: boolean | null;
17154
17639
  /**
17155
17640
  * The gateway login.
17156
17641
  * @example ```"sk_live_xxxx-yyyy-zzzz"```
@@ -17171,11 +17656,6 @@ interface StripeGatewayCreate extends ResourceCreate {
17171
17656
  * @example ```true```
17172
17657
  */
17173
17658
  auto_payments?: boolean | null;
17174
- /**
17175
- * Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
17176
- * @example ```true```
17177
- */
17178
- force_payments?: boolean | null;
17179
17659
  }
17180
17660
  interface StripeGatewayUpdate extends ResourceUpdate {
17181
17661
  /**
@@ -17183,6 +17663,17 @@ interface StripeGatewayUpdate extends ResourceUpdate {
17183
17663
  * @example ```"US payment gateway"```
17184
17664
  */
17185
17665
  name?: string | null;
17666
+ force_payments?: boolean | null;
17667
+ /**
17668
+ * Send this attribute if you want to mark this resource as disabled.
17669
+ * @example ```true```
17670
+ */
17671
+ _disable?: boolean | null;
17672
+ /**
17673
+ * Send this attribute if you want to mark this resource as enabled.
17674
+ * @example ```true```
17675
+ */
17676
+ _enable?: boolean | null;
17186
17677
  /**
17187
17678
  * The account (if any) for which the funds of the PaymentIntent are intended.
17188
17679
  * @example ```"acct_xxxx-yyyy-zzzz"```
@@ -17193,11 +17684,6 @@ interface StripeGatewayUpdate extends ResourceUpdate {
17193
17684
  * @example ```true```
17194
17685
  */
17195
17686
  auto_payments?: boolean | null;
17196
- /**
17197
- * Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
17198
- * @example ```true```
17199
- */
17200
- force_payments?: boolean | null;
17201
17687
  }
17202
17688
  declare class StripeGateways extends ApiResource<StripeGateway> {
17203
17689
  static readonly TYPE: StripeGatewayType;
@@ -17208,6 +17694,8 @@ declare class StripeGateways extends ApiResource<StripeGateway> {
17208
17694
  versions(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
17209
17695
  event_stores(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
17210
17696
  stripe_payments(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<StripePayment>, options?: ResourcesConfig): Promise<ListResponse<StripePayment>>;
17697
+ _disable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
17698
+ _enable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
17211
17699
  isStripeGateway(resource: any): resource is StripeGateway;
17212
17700
  relationship(id: string | ResourceId | null): StripeGatewayRel;
17213
17701
  relationshipToMany(...ids: string[]): StripeGatewayRel[];
@@ -17642,7 +18130,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
17642
18130
  type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
17643
18131
  declare class CommerceLayerClient {
17644
18132
  #private;
17645
- readonly openApiSchemaVersion = "7.9.9";
18133
+ readonly openApiSchemaVersion = "7.9.11";
17646
18134
  constructor(config: CommerceLayerInitConfig);
17647
18135
  get addresses(): Addresses;
17648
18136
  get adjustments(): Adjustments;