@commercelayer/sdk 6.51.0 → 6.53.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 +476 -28
- package/lib/index.d.ts +476 -28
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +3 -3
package/lib/index.d.ts
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;
|
|
@@ -1340,6 +1350,11 @@ interface AdyenPayment extends Resource {
|
|
|
1340
1350
|
* @example ```1000```
|
|
1341
1351
|
*/
|
|
1342
1352
|
balance?: number | null;
|
|
1353
|
+
/**
|
|
1354
|
+
* The expiration date/time of this Adyen payment (valid for partial payments only).
|
|
1355
|
+
* @example ```"2018-01-02T12:00:00.000Z"```
|
|
1356
|
+
*/
|
|
1357
|
+
expires_at?: string | null;
|
|
1343
1358
|
/**
|
|
1344
1359
|
* Information about the payment instrument used in the transaction.
|
|
1345
1360
|
* @example ```{"issuer":"cl bank","card_type":"visa"}```
|
|
@@ -1984,7 +1999,7 @@ type SatispayPaymentRel$3 = ResourceRel & {
|
|
|
1984
1999
|
type OrderRel$d = ResourceRel & {
|
|
1985
2000
|
type: OrderType;
|
|
1986
2001
|
};
|
|
1987
|
-
type SatispayPaymentSort = Pick<SatispayPayment, 'id' | 'flow' | 'status'> & ResourceSort;
|
|
2002
|
+
type SatispayPaymentSort = Pick<SatispayPayment, 'id' | 'payment_id' | 'flow' | 'status'> & ResourceSort;
|
|
1988
2003
|
interface SatispayPayment extends Resource {
|
|
1989
2004
|
readonly type: SatispayPaymentType;
|
|
1990
2005
|
/**
|
|
@@ -2836,6 +2851,11 @@ interface Void extends Resource {
|
|
|
2836
2851
|
* @example ```"42/T/001"```
|
|
2837
2852
|
*/
|
|
2838
2853
|
number: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* Information about the payment method used in the transaction.
|
|
2856
|
+
* @example ```"credit card"```
|
|
2857
|
+
*/
|
|
2858
|
+
payment_method_type?: string | null;
|
|
2839
2859
|
/**
|
|
2840
2860
|
* The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
|
|
2841
2861
|
* @example ```"EUR"```
|
|
@@ -2932,6 +2952,11 @@ interface Authorization extends Resource {
|
|
|
2932
2952
|
* @example ```"42/T/001"```
|
|
2933
2953
|
*/
|
|
2934
2954
|
number: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* Information about the payment method used in the transaction.
|
|
2957
|
+
* @example ```"credit card"```
|
|
2958
|
+
*/
|
|
2959
|
+
payment_method_type?: string | null;
|
|
2935
2960
|
/**
|
|
2936
2961
|
* The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
|
|
2937
2962
|
* @example ```"EUR"```
|
|
@@ -3124,6 +3149,11 @@ interface Refund extends Resource {
|
|
|
3124
3149
|
* @example ```"42/T/001"```
|
|
3125
3150
|
*/
|
|
3126
3151
|
number: string;
|
|
3152
|
+
/**
|
|
3153
|
+
* Information about the payment method used in the transaction.
|
|
3154
|
+
* @example ```"credit card"```
|
|
3155
|
+
*/
|
|
3156
|
+
payment_method_type?: string | null;
|
|
3127
3157
|
/**
|
|
3128
3158
|
* The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
|
|
3129
3159
|
* @example ```"EUR"```
|
|
@@ -3222,6 +3252,11 @@ interface Capture extends Resource {
|
|
|
3222
3252
|
* @example ```"42/T/001"```
|
|
3223
3253
|
*/
|
|
3224
3254
|
number: string;
|
|
3255
|
+
/**
|
|
3256
|
+
* Information about the payment method used in the transaction.
|
|
3257
|
+
* @example ```"credit card"```
|
|
3258
|
+
*/
|
|
3259
|
+
payment_method_type?: string | null;
|
|
3225
3260
|
/**
|
|
3226
3261
|
* The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
|
|
3227
3262
|
* @example ```"EUR"```
|
|
@@ -13385,6 +13420,11 @@ interface Transaction extends Resource {
|
|
|
13385
13420
|
* @example ```"42/T/001"```
|
|
13386
13421
|
*/
|
|
13387
13422
|
number: string;
|
|
13423
|
+
/**
|
|
13424
|
+
* Information about the payment method used in the transaction.
|
|
13425
|
+
* @example ```"credit card"```
|
|
13426
|
+
*/
|
|
13427
|
+
payment_method_type?: string | null;
|
|
13388
13428
|
/**
|
|
13389
13429
|
* The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
|
|
13390
13430
|
* @example ```"EUR"```
|
|
@@ -15216,7 +15256,7 @@ type AdyenGatewayRel = ResourceRel & {
|
|
|
15216
15256
|
type AdyenPaymentRel = ResourceRel & {
|
|
15217
15257
|
type: AdyenPaymentType;
|
|
15218
15258
|
};
|
|
15219
|
-
type AdyenGatewaySort = Pick<AdyenGateway, 'id' | 'name'> & ResourceSort;
|
|
15259
|
+
type AdyenGatewaySort = Pick<AdyenGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
15220
15260
|
interface AdyenGateway extends Resource {
|
|
15221
15261
|
readonly type: AdyenGatewayType;
|
|
15222
15262
|
/**
|
|
@@ -15224,6 +15264,16 @@ interface AdyenGateway extends Resource {
|
|
|
15224
15264
|
* @example ```"US payment gateway"```
|
|
15225
15265
|
*/
|
|
15226
15266
|
name: string;
|
|
15267
|
+
/**
|
|
15268
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15269
|
+
* @example ```true```
|
|
15270
|
+
*/
|
|
15271
|
+
force_payments?: boolean | null;
|
|
15272
|
+
/**
|
|
15273
|
+
* Time at which this resource was disabled.
|
|
15274
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
15275
|
+
*/
|
|
15276
|
+
disabled_at?: string | null;
|
|
15227
15277
|
/**
|
|
15228
15278
|
* The prefix of the endpoint used for live transactions.
|
|
15229
15279
|
* @example ```"1797a841fbb37ca7-AdyenDemo"```
|
|
@@ -15243,6 +15293,11 @@ interface AdyenGateway extends Resource {
|
|
|
15243
15293
|
* Send this attribute if you want to enable partial payments for the order.
|
|
15244
15294
|
*/
|
|
15245
15295
|
partial_payments?: boolean | null;
|
|
15296
|
+
/**
|
|
15297
|
+
* The minutes after which the order created for partial payments automatically expires.
|
|
15298
|
+
* @example ```30```
|
|
15299
|
+
*/
|
|
15300
|
+
order_expiration_mins?: number | null;
|
|
15246
15301
|
/**
|
|
15247
15302
|
* Indicates if the gateway will use the native customer payment sources.
|
|
15248
15303
|
* @example ```true```
|
|
@@ -15269,6 +15324,21 @@ interface AdyenGatewayCreate extends ResourceCreate {
|
|
|
15269
15324
|
* @example ```"US payment gateway"```
|
|
15270
15325
|
*/
|
|
15271
15326
|
name: string;
|
|
15327
|
+
/**
|
|
15328
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15329
|
+
* @example ```true```
|
|
15330
|
+
*/
|
|
15331
|
+
force_payments?: boolean | null;
|
|
15332
|
+
/**
|
|
15333
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15334
|
+
* @example ```true```
|
|
15335
|
+
*/
|
|
15336
|
+
_disable?: boolean | null;
|
|
15337
|
+
/**
|
|
15338
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15339
|
+
* @example ```true```
|
|
15340
|
+
*/
|
|
15341
|
+
_enable?: boolean | null;
|
|
15272
15342
|
/**
|
|
15273
15343
|
* The gateway merchant account.
|
|
15274
15344
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15303,6 +15373,11 @@ interface AdyenGatewayCreate extends ResourceCreate {
|
|
|
15303
15373
|
* Send this attribute if you want to enable partial payments for the order.
|
|
15304
15374
|
*/
|
|
15305
15375
|
partial_payments?: boolean | null;
|
|
15376
|
+
/**
|
|
15377
|
+
* The minutes after which the order created for partial payments automatically expires.
|
|
15378
|
+
* @example ```30```
|
|
15379
|
+
*/
|
|
15380
|
+
order_expiration_mins?: number | null;
|
|
15306
15381
|
/**
|
|
15307
15382
|
* Indicates if the gateway will use the native customer payment sources.
|
|
15308
15383
|
* @example ```true```
|
|
@@ -15321,6 +15396,21 @@ interface AdyenGatewayUpdate extends ResourceUpdate {
|
|
|
15321
15396
|
* @example ```"US payment gateway"```
|
|
15322
15397
|
*/
|
|
15323
15398
|
name?: string | null;
|
|
15399
|
+
/**
|
|
15400
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15401
|
+
* @example ```true```
|
|
15402
|
+
*/
|
|
15403
|
+
force_payments?: boolean | null;
|
|
15404
|
+
/**
|
|
15405
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15406
|
+
* @example ```true```
|
|
15407
|
+
*/
|
|
15408
|
+
_disable?: boolean | null;
|
|
15409
|
+
/**
|
|
15410
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15411
|
+
* @example ```true```
|
|
15412
|
+
*/
|
|
15413
|
+
_enable?: boolean | null;
|
|
15324
15414
|
/**
|
|
15325
15415
|
* The gateway merchant account.
|
|
15326
15416
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15355,6 +15445,11 @@ interface AdyenGatewayUpdate extends ResourceUpdate {
|
|
|
15355
15445
|
* Send this attribute if you want to enable partial payments for the order.
|
|
15356
15446
|
*/
|
|
15357
15447
|
partial_payments?: boolean | null;
|
|
15448
|
+
/**
|
|
15449
|
+
* The minutes after which the order created for partial payments automatically expires.
|
|
15450
|
+
* @example ```30```
|
|
15451
|
+
*/
|
|
15452
|
+
order_expiration_mins?: number | null;
|
|
15358
15453
|
/**
|
|
15359
15454
|
* Indicates if the gateway will use the native customer payment sources.
|
|
15360
15455
|
* @example ```true```
|
|
@@ -15376,6 +15471,8 @@ declare class AdyenGateways extends ApiResource<AdyenGateway> {
|
|
|
15376
15471
|
versions(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15377
15472
|
event_stores(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15378
15473
|
adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList<AdyenPayment>, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
|
|
15474
|
+
_disable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15475
|
+
_enable(id: string | AdyenGateway, params?: QueryParamsRetrieve<AdyenGateway>, options?: ResourcesConfig): Promise<AdyenGateway>;
|
|
15379
15476
|
isAdyenGateway(resource: any): resource is AdyenGateway;
|
|
15380
15477
|
relationship(id: string | ResourceId | null): AdyenGatewayRel;
|
|
15381
15478
|
relationshipToMany(...ids: string[]): AdyenGatewayRel[];
|
|
@@ -15431,7 +15528,7 @@ type AxerveGatewayRel = ResourceRel & {
|
|
|
15431
15528
|
type AxervePaymentRel = ResourceRel & {
|
|
15432
15529
|
type: AxervePaymentType;
|
|
15433
15530
|
};
|
|
15434
|
-
type AxerveGatewaySort = Pick<AxerveGateway, 'id' | 'name'> & ResourceSort;
|
|
15531
|
+
type AxerveGatewaySort = Pick<AxerveGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
15435
15532
|
interface AxerveGateway extends Resource {
|
|
15436
15533
|
readonly type: AxerveGatewayType;
|
|
15437
15534
|
/**
|
|
@@ -15439,6 +15536,16 @@ interface AxerveGateway extends Resource {
|
|
|
15439
15536
|
* @example ```"US payment gateway"```
|
|
15440
15537
|
*/
|
|
15441
15538
|
name: string;
|
|
15539
|
+
/**
|
|
15540
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15541
|
+
* @example ```true```
|
|
15542
|
+
*/
|
|
15543
|
+
force_payments?: boolean | null;
|
|
15544
|
+
/**
|
|
15545
|
+
* Time at which this resource was disabled.
|
|
15546
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
15547
|
+
*/
|
|
15548
|
+
disabled_at?: string | null;
|
|
15442
15549
|
/**
|
|
15443
15550
|
* The merchant login code.
|
|
15444
15551
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15460,6 +15567,21 @@ interface AxerveGatewayCreate extends ResourceCreate {
|
|
|
15460
15567
|
* @example ```"US payment gateway"```
|
|
15461
15568
|
*/
|
|
15462
15569
|
name: string;
|
|
15570
|
+
/**
|
|
15571
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15572
|
+
* @example ```true```
|
|
15573
|
+
*/
|
|
15574
|
+
force_payments?: boolean | null;
|
|
15575
|
+
/**
|
|
15576
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15577
|
+
* @example ```true```
|
|
15578
|
+
*/
|
|
15579
|
+
_disable?: boolean | null;
|
|
15580
|
+
/**
|
|
15581
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15582
|
+
* @example ```true```
|
|
15583
|
+
*/
|
|
15584
|
+
_enable?: boolean | null;
|
|
15463
15585
|
/**
|
|
15464
15586
|
* The merchant login code.
|
|
15465
15587
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15478,6 +15600,21 @@ interface AxerveGatewayUpdate extends ResourceUpdate {
|
|
|
15478
15600
|
* @example ```"US payment gateway"```
|
|
15479
15601
|
*/
|
|
15480
15602
|
name?: string | null;
|
|
15603
|
+
/**
|
|
15604
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15605
|
+
* @example ```true```
|
|
15606
|
+
*/
|
|
15607
|
+
force_payments?: boolean | null;
|
|
15608
|
+
/**
|
|
15609
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15610
|
+
* @example ```true```
|
|
15611
|
+
*/
|
|
15612
|
+
_disable?: boolean | null;
|
|
15613
|
+
/**
|
|
15614
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15615
|
+
* @example ```true```
|
|
15616
|
+
*/
|
|
15617
|
+
_enable?: boolean | null;
|
|
15481
15618
|
/**
|
|
15482
15619
|
* The merchant login code.
|
|
15483
15620
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15499,6 +15636,8 @@ declare class AxerveGateways extends ApiResource<AxerveGateway> {
|
|
|
15499
15636
|
versions(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15500
15637
|
event_stores(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15501
15638
|
axerve_payments(axerveGatewayId: string | AxerveGateway, params?: QueryParamsList<AxervePayment>, options?: ResourcesConfig): Promise<ListResponse<AxervePayment>>;
|
|
15639
|
+
_disable(id: string | AxerveGateway, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
|
|
15640
|
+
_enable(id: string | AxerveGateway, params?: QueryParamsRetrieve<AxerveGateway>, options?: ResourcesConfig): Promise<AxerveGateway>;
|
|
15502
15641
|
isAxerveGateway(resource: any): resource is AxerveGateway;
|
|
15503
15642
|
relationship(id: string | ResourceId | null): AxerveGatewayRel;
|
|
15504
15643
|
relationshipToMany(...ids: string[]): AxerveGatewayRel[];
|
|
@@ -15568,7 +15707,7 @@ type BraintreeGatewayRel = ResourceRel & {
|
|
|
15568
15707
|
type BraintreePaymentRel = ResourceRel & {
|
|
15569
15708
|
type: BraintreePaymentType;
|
|
15570
15709
|
};
|
|
15571
|
-
type BraintreeGatewaySort = Pick<BraintreeGateway, 'id' | 'name'> & ResourceSort;
|
|
15710
|
+
type BraintreeGatewaySort = Pick<BraintreeGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
15572
15711
|
interface BraintreeGateway extends Resource {
|
|
15573
15712
|
readonly type: BraintreeGatewayType;
|
|
15574
15713
|
/**
|
|
@@ -15576,6 +15715,16 @@ interface BraintreeGateway extends Resource {
|
|
|
15576
15715
|
* @example ```"US payment gateway"```
|
|
15577
15716
|
*/
|
|
15578
15717
|
name: string;
|
|
15718
|
+
/**
|
|
15719
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15720
|
+
* @example ```true```
|
|
15721
|
+
*/
|
|
15722
|
+
force_payments?: boolean | null;
|
|
15723
|
+
/**
|
|
15724
|
+
* Time at which this resource was disabled.
|
|
15725
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
15726
|
+
*/
|
|
15727
|
+
disabled_at?: string | null;
|
|
15579
15728
|
/**
|
|
15580
15729
|
* 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.
|
|
15581
15730
|
* @example ```"company*productabc1234"```
|
|
@@ -15607,6 +15756,21 @@ interface BraintreeGatewayCreate extends ResourceCreate {
|
|
|
15607
15756
|
* @example ```"US payment gateway"```
|
|
15608
15757
|
*/
|
|
15609
15758
|
name: string;
|
|
15759
|
+
/**
|
|
15760
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15761
|
+
* @example ```true```
|
|
15762
|
+
*/
|
|
15763
|
+
force_payments?: boolean | null;
|
|
15764
|
+
/**
|
|
15765
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15766
|
+
* @example ```true```
|
|
15767
|
+
*/
|
|
15768
|
+
_disable?: boolean | null;
|
|
15769
|
+
/**
|
|
15770
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15771
|
+
* @example ```true```
|
|
15772
|
+
*/
|
|
15773
|
+
_enable?: boolean | null;
|
|
15610
15774
|
/**
|
|
15611
15775
|
* The gateway merchant account ID.
|
|
15612
15776
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15650,6 +15814,21 @@ interface BraintreeGatewayUpdate extends ResourceUpdate {
|
|
|
15650
15814
|
* @example ```"US payment gateway"```
|
|
15651
15815
|
*/
|
|
15652
15816
|
name?: string | null;
|
|
15817
|
+
/**
|
|
15818
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15819
|
+
* @example ```true```
|
|
15820
|
+
*/
|
|
15821
|
+
force_payments?: boolean | null;
|
|
15822
|
+
/**
|
|
15823
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15824
|
+
* @example ```true```
|
|
15825
|
+
*/
|
|
15826
|
+
_disable?: boolean | null;
|
|
15827
|
+
/**
|
|
15828
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15829
|
+
* @example ```true```
|
|
15830
|
+
*/
|
|
15831
|
+
_enable?: boolean | null;
|
|
15653
15832
|
/**
|
|
15654
15833
|
* The gateway merchant account ID.
|
|
15655
15834
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15696,6 +15875,8 @@ declare class BraintreeGateways extends ApiResource<BraintreeGateway> {
|
|
|
15696
15875
|
versions(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15697
15876
|
event_stores(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15698
15877
|
braintree_payments(braintreeGatewayId: string | BraintreeGateway, params?: QueryParamsList<BraintreePayment>, options?: ResourcesConfig): Promise<ListResponse<BraintreePayment>>;
|
|
15878
|
+
_disable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15879
|
+
_enable(id: string | BraintreeGateway, params?: QueryParamsRetrieve<BraintreeGateway>, options?: ResourcesConfig): Promise<BraintreeGateway>;
|
|
15699
15880
|
isBraintreeGateway(resource: any): resource is BraintreeGateway;
|
|
15700
15881
|
relationship(id: string | ResourceId | null): BraintreeGatewayRel;
|
|
15701
15882
|
relationshipToMany(...ids: string[]): BraintreeGatewayRel[];
|
|
@@ -15709,7 +15890,7 @@ type CheckoutComGatewayRel = ResourceRel & {
|
|
|
15709
15890
|
type CheckoutComPaymentRel = ResourceRel & {
|
|
15710
15891
|
type: CheckoutComPaymentType;
|
|
15711
15892
|
};
|
|
15712
|
-
type CheckoutComGatewaySort = Pick<CheckoutComGateway, 'id' | 'name'> & ResourceSort;
|
|
15893
|
+
type CheckoutComGatewaySort = Pick<CheckoutComGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
15713
15894
|
interface CheckoutComGateway extends Resource {
|
|
15714
15895
|
readonly type: CheckoutComGatewayType;
|
|
15715
15896
|
/**
|
|
@@ -15717,6 +15898,16 @@ interface CheckoutComGateway extends Resource {
|
|
|
15717
15898
|
* @example ```"US payment gateway"```
|
|
15718
15899
|
*/
|
|
15719
15900
|
name: string;
|
|
15901
|
+
/**
|
|
15902
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15903
|
+
* @example ```true```
|
|
15904
|
+
*/
|
|
15905
|
+
force_payments?: boolean | null;
|
|
15906
|
+
/**
|
|
15907
|
+
* Time at which this resource was disabled.
|
|
15908
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
15909
|
+
*/
|
|
15910
|
+
disabled_at?: string | null;
|
|
15720
15911
|
/**
|
|
15721
15912
|
* The gateway webhook endpoint ID, generated automatically.
|
|
15722
15913
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -15743,6 +15934,21 @@ interface CheckoutComGatewayCreate extends ResourceCreate {
|
|
|
15743
15934
|
* @example ```"US payment gateway"```
|
|
15744
15935
|
*/
|
|
15745
15936
|
name: string;
|
|
15937
|
+
/**
|
|
15938
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15939
|
+
* @example ```true```
|
|
15940
|
+
*/
|
|
15941
|
+
force_payments?: boolean | null;
|
|
15942
|
+
/**
|
|
15943
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15944
|
+
* @example ```true```
|
|
15945
|
+
*/
|
|
15946
|
+
_disable?: boolean | null;
|
|
15947
|
+
/**
|
|
15948
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15949
|
+
* @example ```true```
|
|
15950
|
+
*/
|
|
15951
|
+
_enable?: boolean | null;
|
|
15746
15952
|
/**
|
|
15747
15953
|
* The gateway secret key.
|
|
15748
15954
|
* @example ```"sk_test_xxxx-yyyy-zzzz"```
|
|
@@ -15761,6 +15967,21 @@ interface CheckoutComGatewayUpdate extends ResourceUpdate {
|
|
|
15761
15967
|
* @example ```"US payment gateway"```
|
|
15762
15968
|
*/
|
|
15763
15969
|
name?: string | null;
|
|
15970
|
+
/**
|
|
15971
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
15972
|
+
* @example ```true```
|
|
15973
|
+
*/
|
|
15974
|
+
force_payments?: boolean | null;
|
|
15975
|
+
/**
|
|
15976
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
15977
|
+
* @example ```true```
|
|
15978
|
+
*/
|
|
15979
|
+
_disable?: boolean | null;
|
|
15980
|
+
/**
|
|
15981
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
15982
|
+
* @example ```true```
|
|
15983
|
+
*/
|
|
15984
|
+
_enable?: boolean | null;
|
|
15764
15985
|
/**
|
|
15765
15986
|
* The gateway secret key.
|
|
15766
15987
|
* @example ```"sk_test_xxxx-yyyy-zzzz"```
|
|
@@ -15782,6 +16003,8 @@ declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
|
|
|
15782
16003
|
versions(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
15783
16004
|
event_stores(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
15784
16005
|
checkout_com_payments(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList<CheckoutComPayment>, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
|
|
16006
|
+
_disable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
16007
|
+
_enable(id: string | CheckoutComGateway, params?: QueryParamsRetrieve<CheckoutComGateway>, options?: ResourcesConfig): Promise<CheckoutComGateway>;
|
|
15785
16008
|
isCheckoutComGateway(resource: any): resource is CheckoutComGateway;
|
|
15786
16009
|
relationship(id: string | ResourceId | null): CheckoutComGatewayRel;
|
|
15787
16010
|
relationshipToMany(...ids: string[]): CheckoutComGatewayRel[];
|
|
@@ -16182,7 +16405,7 @@ type ExternalGatewayType = 'external_gateways';
|
|
|
16182
16405
|
type ExternalGatewayRel = ResourceRel & {
|
|
16183
16406
|
type: ExternalGatewayType;
|
|
16184
16407
|
};
|
|
16185
|
-
type ExternalGatewaySort = Pick<ExternalGateway, 'id' | 'name' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
|
|
16408
|
+
type ExternalGatewaySort = Pick<ExternalGateway, 'id' | 'name' | 'disabled_at' | 'circuit_state' | 'circuit_failure_count'> & ResourceSort;
|
|
16186
16409
|
interface ExternalGateway extends Resource {
|
|
16187
16410
|
readonly type: ExternalGatewayType;
|
|
16188
16411
|
/**
|
|
@@ -16190,6 +16413,16 @@ interface ExternalGateway extends Resource {
|
|
|
16190
16413
|
* @example ```"US payment gateway"```
|
|
16191
16414
|
*/
|
|
16192
16415
|
name: string;
|
|
16416
|
+
/**
|
|
16417
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16418
|
+
* @example ```true```
|
|
16419
|
+
*/
|
|
16420
|
+
force_payments?: boolean | null;
|
|
16421
|
+
/**
|
|
16422
|
+
* Time at which this resource was disabled.
|
|
16423
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
16424
|
+
*/
|
|
16425
|
+
disabled_at?: string | null;
|
|
16193
16426
|
/**
|
|
16194
16427
|
* The endpoint used by the external gateway to authorize payments.
|
|
16195
16428
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16246,6 +16479,21 @@ interface ExternalGatewayCreate extends ResourceCreate {
|
|
|
16246
16479
|
* @example ```"US payment gateway"```
|
|
16247
16480
|
*/
|
|
16248
16481
|
name: string;
|
|
16482
|
+
/**
|
|
16483
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16484
|
+
* @example ```true```
|
|
16485
|
+
*/
|
|
16486
|
+
force_payments?: boolean | null;
|
|
16487
|
+
/**
|
|
16488
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
16489
|
+
* @example ```true```
|
|
16490
|
+
*/
|
|
16491
|
+
_disable?: boolean | null;
|
|
16492
|
+
/**
|
|
16493
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
16494
|
+
* @example ```true```
|
|
16495
|
+
*/
|
|
16496
|
+
_enable?: boolean | null;
|
|
16249
16497
|
/**
|
|
16250
16498
|
* The endpoint used by the external gateway to authorize payments.
|
|
16251
16499
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16283,6 +16531,21 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
|
|
|
16283
16531
|
* @example ```"US payment gateway"```
|
|
16284
16532
|
*/
|
|
16285
16533
|
name?: string | null;
|
|
16534
|
+
/**
|
|
16535
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16536
|
+
* @example ```true```
|
|
16537
|
+
*/
|
|
16538
|
+
force_payments?: boolean | null;
|
|
16539
|
+
/**
|
|
16540
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
16541
|
+
* @example ```true```
|
|
16542
|
+
*/
|
|
16543
|
+
_disable?: boolean | null;
|
|
16544
|
+
/**
|
|
16545
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
16546
|
+
* @example ```true```
|
|
16547
|
+
*/
|
|
16548
|
+
_enable?: boolean | null;
|
|
16286
16549
|
/**
|
|
16287
16550
|
* The endpoint used by the external gateway to authorize payments.
|
|
16288
16551
|
* @example ```"https://external_gateway.com/authorize"```
|
|
@@ -16328,6 +16591,8 @@ declare class ExternalGateways extends ApiResource<ExternalGateway> {
|
|
|
16328
16591
|
versions(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16329
16592
|
event_stores(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16330
16593
|
external_payments(externalGatewayId: string | ExternalGateway, params?: QueryParamsList<ExternalPayment>, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
|
|
16594
|
+
_disable(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
|
|
16595
|
+
_enable(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
|
|
16331
16596
|
_reset_circuit(id: string | ExternalGateway, params?: QueryParamsRetrieve<ExternalGateway>, options?: ResourcesConfig): Promise<ExternalGateway>;
|
|
16332
16597
|
isExternalGateway(resource: any): resource is ExternalGateway;
|
|
16333
16598
|
relationship(id: string | ResourceId | null): ExternalGatewayRel;
|
|
@@ -16643,7 +16908,7 @@ type KlarnaGatewayRel = ResourceRel & {
|
|
|
16643
16908
|
type KlarnaPaymentRel = ResourceRel & {
|
|
16644
16909
|
type: KlarnaPaymentType;
|
|
16645
16910
|
};
|
|
16646
|
-
type KlarnaGatewaySort = Pick<KlarnaGateway, 'id' | 'name'> & ResourceSort;
|
|
16911
|
+
type KlarnaGatewaySort = Pick<KlarnaGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
16647
16912
|
interface KlarnaGateway extends Resource {
|
|
16648
16913
|
readonly type: KlarnaGatewayType;
|
|
16649
16914
|
/**
|
|
@@ -16651,6 +16916,16 @@ interface KlarnaGateway extends Resource {
|
|
|
16651
16916
|
* @example ```"US payment gateway"```
|
|
16652
16917
|
*/
|
|
16653
16918
|
name: string;
|
|
16919
|
+
/**
|
|
16920
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16921
|
+
* @example ```true```
|
|
16922
|
+
*/
|
|
16923
|
+
force_payments?: boolean | null;
|
|
16924
|
+
/**
|
|
16925
|
+
* Time at which this resource was disabled.
|
|
16926
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
16927
|
+
*/
|
|
16928
|
+
disabled_at?: string | null;
|
|
16654
16929
|
payment_methods?: PaymentMethod[] | null;
|
|
16655
16930
|
versions?: Version[] | null;
|
|
16656
16931
|
event_stores?: EventStore[] | null;
|
|
@@ -16662,6 +16937,21 @@ interface KlarnaGatewayCreate extends ResourceCreate {
|
|
|
16662
16937
|
* @example ```"US payment gateway"```
|
|
16663
16938
|
*/
|
|
16664
16939
|
name: string;
|
|
16940
|
+
/**
|
|
16941
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16942
|
+
* @example ```true```
|
|
16943
|
+
*/
|
|
16944
|
+
force_payments?: boolean | null;
|
|
16945
|
+
/**
|
|
16946
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
16947
|
+
* @example ```true```
|
|
16948
|
+
*/
|
|
16949
|
+
_disable?: boolean | null;
|
|
16950
|
+
/**
|
|
16951
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
16952
|
+
* @example ```true```
|
|
16953
|
+
*/
|
|
16954
|
+
_enable?: boolean | null;
|
|
16665
16955
|
/**
|
|
16666
16956
|
* The gateway country code one of EU, US, or OC.
|
|
16667
16957
|
* @example ```"EU"```
|
|
@@ -16685,6 +16975,21 @@ interface KlarnaGatewayUpdate extends ResourceUpdate {
|
|
|
16685
16975
|
* @example ```"US payment gateway"```
|
|
16686
16976
|
*/
|
|
16687
16977
|
name?: string | null;
|
|
16978
|
+
/**
|
|
16979
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
16980
|
+
* @example ```true```
|
|
16981
|
+
*/
|
|
16982
|
+
force_payments?: boolean | null;
|
|
16983
|
+
/**
|
|
16984
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
16985
|
+
* @example ```true```
|
|
16986
|
+
*/
|
|
16987
|
+
_disable?: boolean | null;
|
|
16988
|
+
/**
|
|
16989
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
16990
|
+
* @example ```true```
|
|
16991
|
+
*/
|
|
16992
|
+
_enable?: boolean | null;
|
|
16688
16993
|
/**
|
|
16689
16994
|
* The gateway country code one of EU, US, or OC.
|
|
16690
16995
|
* @example ```"EU"```
|
|
@@ -16711,6 +17016,8 @@ declare class KlarnaGateways extends ApiResource<KlarnaGateway> {
|
|
|
16711
17016
|
versions(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16712
17017
|
event_stores(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
16713
17018
|
klarna_payments(klarnaGatewayId: string | KlarnaGateway, params?: QueryParamsList<KlarnaPayment>, options?: ResourcesConfig): Promise<ListResponse<KlarnaPayment>>;
|
|
17019
|
+
_disable(id: string | KlarnaGateway, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
|
|
17020
|
+
_enable(id: string | KlarnaGateway, params?: QueryParamsRetrieve<KlarnaGateway>, options?: ResourcesConfig): Promise<KlarnaGateway>;
|
|
16714
17021
|
isKlarnaGateway(resource: any): resource is KlarnaGateway;
|
|
16715
17022
|
relationship(id: string | ResourceId | null): KlarnaGatewayRel;
|
|
16716
17023
|
relationshipToMany(...ids: string[]): KlarnaGatewayRel[];
|
|
@@ -16721,7 +17028,7 @@ type ManualGatewayType = 'manual_gateways';
|
|
|
16721
17028
|
type ManualGatewayRel = ResourceRel & {
|
|
16722
17029
|
type: ManualGatewayType;
|
|
16723
17030
|
};
|
|
16724
|
-
type ManualGatewaySort = Pick<ManualGateway, 'id' | 'name'> & ResourceSort;
|
|
17031
|
+
type ManualGatewaySort = Pick<ManualGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
16725
17032
|
interface ManualGateway extends Resource {
|
|
16726
17033
|
readonly type: ManualGatewayType;
|
|
16727
17034
|
/**
|
|
@@ -16729,6 +17036,16 @@ interface ManualGateway extends Resource {
|
|
|
16729
17036
|
* @example ```"US payment gateway"```
|
|
16730
17037
|
*/
|
|
16731
17038
|
name: string;
|
|
17039
|
+
/**
|
|
17040
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17041
|
+
* @example ```true```
|
|
17042
|
+
*/
|
|
17043
|
+
force_payments?: boolean | null;
|
|
17044
|
+
/**
|
|
17045
|
+
* Time at which this resource was disabled.
|
|
17046
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17047
|
+
*/
|
|
17048
|
+
disabled_at?: string | null;
|
|
16732
17049
|
payment_methods?: PaymentMethod[] | null;
|
|
16733
17050
|
versions?: Version[] | null;
|
|
16734
17051
|
event_stores?: EventStore[] | null;
|
|
@@ -16739,6 +17056,21 @@ interface ManualGatewayCreate extends ResourceCreate {
|
|
|
16739
17056
|
* @example ```"US payment gateway"```
|
|
16740
17057
|
*/
|
|
16741
17058
|
name: string;
|
|
17059
|
+
/**
|
|
17060
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17061
|
+
* @example ```true```
|
|
17062
|
+
*/
|
|
17063
|
+
force_payments?: boolean | null;
|
|
17064
|
+
/**
|
|
17065
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17066
|
+
* @example ```true```
|
|
17067
|
+
*/
|
|
17068
|
+
_disable?: boolean | null;
|
|
17069
|
+
/**
|
|
17070
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17071
|
+
* @example ```true```
|
|
17072
|
+
*/
|
|
17073
|
+
_enable?: boolean | null;
|
|
16742
17074
|
}
|
|
16743
17075
|
interface ManualGatewayUpdate extends ResourceUpdate {
|
|
16744
17076
|
/**
|
|
@@ -16746,6 +17078,21 @@ interface ManualGatewayUpdate extends ResourceUpdate {
|
|
|
16746
17078
|
* @example ```"US payment gateway"```
|
|
16747
17079
|
*/
|
|
16748
17080
|
name?: string | null;
|
|
17081
|
+
/**
|
|
17082
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17083
|
+
* @example ```true```
|
|
17084
|
+
*/
|
|
17085
|
+
force_payments?: boolean | null;
|
|
17086
|
+
/**
|
|
17087
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17088
|
+
* @example ```true```
|
|
17089
|
+
*/
|
|
17090
|
+
_disable?: boolean | null;
|
|
17091
|
+
/**
|
|
17092
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17093
|
+
* @example ```true```
|
|
17094
|
+
*/
|
|
17095
|
+
_enable?: boolean | null;
|
|
16749
17096
|
}
|
|
16750
17097
|
declare class ManualGateways extends ApiResource<ManualGateway> {
|
|
16751
17098
|
static readonly TYPE: ManualGatewayType;
|
|
@@ -16755,6 +17102,8 @@ declare class ManualGateways extends ApiResource<ManualGateway> {
|
|
|
16755
17102
|
payment_methods(manualGatewayId: string | ManualGateway, params?: QueryParamsList<PaymentMethod>, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
|
|
16756
17103
|
versions(manualGatewayId: string | ManualGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
16757
17104
|
event_stores(manualGatewayId: string | ManualGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17105
|
+
_disable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
|
|
17106
|
+
_enable(id: string | ManualGateway, params?: QueryParamsRetrieve<ManualGateway>, options?: ResourcesConfig): Promise<ManualGateway>;
|
|
16758
17107
|
isManualGateway(resource: any): resource is ManualGateway;
|
|
16759
17108
|
relationship(id: string | ResourceId | null): ManualGatewayRel;
|
|
16760
17109
|
relationshipToMany(...ids: string[]): ManualGatewayRel[];
|
|
@@ -17050,7 +17399,7 @@ type PaypalGatewayType = 'paypal_gateways';
|
|
|
17050
17399
|
type PaypalGatewayRel = ResourceRel & {
|
|
17051
17400
|
type: PaypalGatewayType;
|
|
17052
17401
|
};
|
|
17053
|
-
type PaypalGatewaySort = Pick<PaypalGateway, 'id' | 'name'> & ResourceSort;
|
|
17402
|
+
type PaypalGatewaySort = Pick<PaypalGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
17054
17403
|
interface PaypalGateway extends Resource {
|
|
17055
17404
|
readonly type: PaypalGatewayType;
|
|
17056
17405
|
/**
|
|
@@ -17058,6 +17407,16 @@ interface PaypalGateway extends Resource {
|
|
|
17058
17407
|
* @example ```"US payment gateway"```
|
|
17059
17408
|
*/
|
|
17060
17409
|
name: string;
|
|
17410
|
+
/**
|
|
17411
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17412
|
+
* @example ```true```
|
|
17413
|
+
*/
|
|
17414
|
+
force_payments?: boolean | null;
|
|
17415
|
+
/**
|
|
17416
|
+
* Time at which this resource was disabled.
|
|
17417
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17418
|
+
*/
|
|
17419
|
+
disabled_at?: string | null;
|
|
17061
17420
|
payment_methods?: PaymentMethod[] | null;
|
|
17062
17421
|
versions?: Version[] | null;
|
|
17063
17422
|
event_stores?: EventStore[] | null;
|
|
@@ -17069,6 +17428,21 @@ interface PaypalGatewayCreate extends ResourceCreate {
|
|
|
17069
17428
|
* @example ```"US payment gateway"```
|
|
17070
17429
|
*/
|
|
17071
17430
|
name: string;
|
|
17431
|
+
/**
|
|
17432
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17433
|
+
* @example ```true```
|
|
17434
|
+
*/
|
|
17435
|
+
force_payments?: boolean | null;
|
|
17436
|
+
/**
|
|
17437
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17438
|
+
* @example ```true```
|
|
17439
|
+
*/
|
|
17440
|
+
_disable?: boolean | null;
|
|
17441
|
+
/**
|
|
17442
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17443
|
+
* @example ```true```
|
|
17444
|
+
*/
|
|
17445
|
+
_enable?: boolean | null;
|
|
17072
17446
|
/**
|
|
17073
17447
|
* The gateway client ID.
|
|
17074
17448
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -17086,6 +17460,21 @@ interface PaypalGatewayUpdate extends ResourceUpdate {
|
|
|
17086
17460
|
* @example ```"US payment gateway"```
|
|
17087
17461
|
*/
|
|
17088
17462
|
name?: string | null;
|
|
17463
|
+
/**
|
|
17464
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17465
|
+
* @example ```true```
|
|
17466
|
+
*/
|
|
17467
|
+
force_payments?: boolean | null;
|
|
17468
|
+
/**
|
|
17469
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17470
|
+
* @example ```true```
|
|
17471
|
+
*/
|
|
17472
|
+
_disable?: boolean | null;
|
|
17473
|
+
/**
|
|
17474
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17475
|
+
* @example ```true```
|
|
17476
|
+
*/
|
|
17477
|
+
_enable?: boolean | null;
|
|
17089
17478
|
/**
|
|
17090
17479
|
* The gateway client ID.
|
|
17091
17480
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -17106,6 +17495,8 @@ declare class PaypalGateways extends ApiResource<PaypalGateway> {
|
|
|
17106
17495
|
versions(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17107
17496
|
event_stores(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17108
17497
|
paypal_payments(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList<PaypalPayment>, options?: ResourcesConfig): Promise<ListResponse<PaypalPayment>>;
|
|
17498
|
+
_disable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17499
|
+
_enable(id: string | PaypalGateway, params?: QueryParamsRetrieve<PaypalGateway>, options?: ResourcesConfig): Promise<PaypalGateway>;
|
|
17109
17500
|
isPaypalGateway(resource: any): resource is PaypalGateway;
|
|
17110
17501
|
relationship(id: string | ResourceId | null): PaypalGatewayRel;
|
|
17111
17502
|
relationshipToMany(...ids: string[]): PaypalGatewayRel[];
|
|
@@ -17119,7 +17510,7 @@ type SatispayGatewayRel = ResourceRel & {
|
|
|
17119
17510
|
type SatispayPaymentRel = ResourceRel & {
|
|
17120
17511
|
type: SatispayPaymentType;
|
|
17121
17512
|
};
|
|
17122
|
-
type SatispayGatewaySort = Pick<SatispayGateway, 'id' | 'name'> & ResourceSort;
|
|
17513
|
+
type SatispayGatewaySort = Pick<SatispayGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
17123
17514
|
interface SatispayGateway extends Resource {
|
|
17124
17515
|
readonly type: SatispayGatewayType;
|
|
17125
17516
|
/**
|
|
@@ -17127,6 +17518,16 @@ interface SatispayGateway extends Resource {
|
|
|
17127
17518
|
* @example ```"US payment gateway"```
|
|
17128
17519
|
*/
|
|
17129
17520
|
name: string;
|
|
17521
|
+
/**
|
|
17522
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17523
|
+
* @example ```true```
|
|
17524
|
+
*/
|
|
17525
|
+
force_payments?: boolean | null;
|
|
17526
|
+
/**
|
|
17527
|
+
* Time at which this resource was disabled.
|
|
17528
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17529
|
+
*/
|
|
17530
|
+
disabled_at?: string | null;
|
|
17130
17531
|
/**
|
|
17131
17532
|
* Activation code generated from the Satispay Dashboard.
|
|
17132
17533
|
* @example ```"623ECX"```
|
|
@@ -17153,6 +17554,21 @@ interface SatispayGatewayCreate extends ResourceCreate {
|
|
|
17153
17554
|
* @example ```"US payment gateway"```
|
|
17154
17555
|
*/
|
|
17155
17556
|
name: string;
|
|
17557
|
+
/**
|
|
17558
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17559
|
+
* @example ```true```
|
|
17560
|
+
*/
|
|
17561
|
+
force_payments?: boolean | null;
|
|
17562
|
+
/**
|
|
17563
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17564
|
+
* @example ```true```
|
|
17565
|
+
*/
|
|
17566
|
+
_disable?: boolean | null;
|
|
17567
|
+
/**
|
|
17568
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17569
|
+
* @example ```true```
|
|
17570
|
+
*/
|
|
17571
|
+
_enable?: boolean | null;
|
|
17156
17572
|
/**
|
|
17157
17573
|
* Activation code generated from the Satispay Dashboard.
|
|
17158
17574
|
* @example ```"623ECX"```
|
|
@@ -17166,6 +17582,21 @@ interface SatispayGatewayUpdate extends ResourceUpdate {
|
|
|
17166
17582
|
* @example ```"US payment gateway"```
|
|
17167
17583
|
*/
|
|
17168
17584
|
name?: string | null;
|
|
17585
|
+
/**
|
|
17586
|
+
* Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.
|
|
17587
|
+
* @example ```true```
|
|
17588
|
+
*/
|
|
17589
|
+
force_payments?: boolean | null;
|
|
17590
|
+
/**
|
|
17591
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17592
|
+
* @example ```true```
|
|
17593
|
+
*/
|
|
17594
|
+
_disable?: boolean | null;
|
|
17595
|
+
/**
|
|
17596
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17597
|
+
* @example ```true```
|
|
17598
|
+
*/
|
|
17599
|
+
_enable?: boolean | null;
|
|
17169
17600
|
satispay_payments?: SatispayPaymentRel[] | null;
|
|
17170
17601
|
}
|
|
17171
17602
|
declare class SatispayGateways extends ApiResource<SatispayGateway> {
|
|
@@ -17177,6 +17608,8 @@ declare class SatispayGateways extends ApiResource<SatispayGateway> {
|
|
|
17177
17608
|
versions(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17178
17609
|
event_stores(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17179
17610
|
satispay_payments(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList<SatispayPayment>, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
|
|
17611
|
+
_disable(id: string | SatispayGateway, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
|
|
17612
|
+
_enable(id: string | SatispayGateway, params?: QueryParamsRetrieve<SatispayGateway>, options?: ResourcesConfig): Promise<SatispayGateway>;
|
|
17180
17613
|
isSatispayGateway(resource: any): resource is SatispayGateway;
|
|
17181
17614
|
relationship(id: string | ResourceId | null): SatispayGatewayRel;
|
|
17182
17615
|
relationshipToMany(...ids: string[]): SatispayGatewayRel[];
|
|
@@ -17187,7 +17620,7 @@ type StripeGatewayType = 'stripe_gateways';
|
|
|
17187
17620
|
type StripeGatewayRel = ResourceRel & {
|
|
17188
17621
|
type: StripeGatewayType;
|
|
17189
17622
|
};
|
|
17190
|
-
type StripeGatewaySort = Pick<StripeGateway, 'id' | 'name'> & ResourceSort;
|
|
17623
|
+
type StripeGatewaySort = Pick<StripeGateway, 'id' | 'name' | 'disabled_at'> & ResourceSort;
|
|
17191
17624
|
interface StripeGateway extends Resource {
|
|
17192
17625
|
readonly type: StripeGatewayType;
|
|
17193
17626
|
/**
|
|
@@ -17195,6 +17628,12 @@ interface StripeGateway extends Resource {
|
|
|
17195
17628
|
* @example ```"US payment gateway"```
|
|
17196
17629
|
*/
|
|
17197
17630
|
name: string;
|
|
17631
|
+
force_payments?: boolean | null;
|
|
17632
|
+
/**
|
|
17633
|
+
* Time at which this resource was disabled.
|
|
17634
|
+
* @example ```"2018-01-01T12:00:00.000Z"```
|
|
17635
|
+
*/
|
|
17636
|
+
disabled_at?: string | null;
|
|
17198
17637
|
/**
|
|
17199
17638
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
|
17200
17639
|
* @example ```"acct_xxxx-yyyy-zzzz"```
|
|
@@ -17205,11 +17644,6 @@ interface StripeGateway extends Resource {
|
|
|
17205
17644
|
* @example ```true```
|
|
17206
17645
|
*/
|
|
17207
17646
|
auto_payments?: boolean | null;
|
|
17208
|
-
/**
|
|
17209
|
-
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
|
17210
|
-
* @example ```true```
|
|
17211
|
-
*/
|
|
17212
|
-
force_payments?: boolean | null;
|
|
17213
17647
|
/**
|
|
17214
17648
|
* The gateway webhook endpoint ID, generated automatically.
|
|
17215
17649
|
* @example ```"xxxx-yyyy-zzzz"```
|
|
@@ -17236,6 +17670,17 @@ interface StripeGatewayCreate extends ResourceCreate {
|
|
|
17236
17670
|
* @example ```"US payment gateway"```
|
|
17237
17671
|
*/
|
|
17238
17672
|
name: string;
|
|
17673
|
+
force_payments?: boolean | null;
|
|
17674
|
+
/**
|
|
17675
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17676
|
+
* @example ```true```
|
|
17677
|
+
*/
|
|
17678
|
+
_disable?: boolean | null;
|
|
17679
|
+
/**
|
|
17680
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17681
|
+
* @example ```true```
|
|
17682
|
+
*/
|
|
17683
|
+
_enable?: boolean | null;
|
|
17239
17684
|
/**
|
|
17240
17685
|
* The gateway login.
|
|
17241
17686
|
* @example ```"sk_live_xxxx-yyyy-zzzz"```
|
|
@@ -17256,11 +17701,6 @@ interface StripeGatewayCreate extends ResourceCreate {
|
|
|
17256
17701
|
* @example ```true```
|
|
17257
17702
|
*/
|
|
17258
17703
|
auto_payments?: boolean | null;
|
|
17259
|
-
/**
|
|
17260
|
-
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
|
17261
|
-
* @example ```true```
|
|
17262
|
-
*/
|
|
17263
|
-
force_payments?: boolean | null;
|
|
17264
17704
|
}
|
|
17265
17705
|
interface StripeGatewayUpdate extends ResourceUpdate {
|
|
17266
17706
|
/**
|
|
@@ -17268,6 +17708,17 @@ interface StripeGatewayUpdate extends ResourceUpdate {
|
|
|
17268
17708
|
* @example ```"US payment gateway"```
|
|
17269
17709
|
*/
|
|
17270
17710
|
name?: string | null;
|
|
17711
|
+
force_payments?: boolean | null;
|
|
17712
|
+
/**
|
|
17713
|
+
* Send this attribute if you want to mark this resource as disabled.
|
|
17714
|
+
* @example ```true```
|
|
17715
|
+
*/
|
|
17716
|
+
_disable?: boolean | null;
|
|
17717
|
+
/**
|
|
17718
|
+
* Send this attribute if you want to mark this resource as enabled.
|
|
17719
|
+
* @example ```true```
|
|
17720
|
+
*/
|
|
17721
|
+
_enable?: boolean | null;
|
|
17271
17722
|
/**
|
|
17272
17723
|
* The account (if any) for which the funds of the PaymentIntent are intended.
|
|
17273
17724
|
* @example ```"acct_xxxx-yyyy-zzzz"```
|
|
@@ -17278,11 +17729,6 @@ interface StripeGatewayUpdate extends ResourceUpdate {
|
|
|
17278
17729
|
* @example ```true```
|
|
17279
17730
|
*/
|
|
17280
17731
|
auto_payments?: boolean | null;
|
|
17281
|
-
/**
|
|
17282
|
-
* Indicates if the payment source is forced on the editable order upon receiving a successful event from Stripe.
|
|
17283
|
-
* @example ```true```
|
|
17284
|
-
*/
|
|
17285
|
-
force_payments?: boolean | null;
|
|
17286
17732
|
}
|
|
17287
17733
|
declare class StripeGateways extends ApiResource<StripeGateway> {
|
|
17288
17734
|
static readonly TYPE: StripeGatewayType;
|
|
@@ -17293,6 +17739,8 @@ declare class StripeGateways extends ApiResource<StripeGateway> {
|
|
|
17293
17739
|
versions(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
17294
17740
|
event_stores(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>>;
|
|
17295
17741
|
stripe_payments(stripeGatewayId: string | StripeGateway, params?: QueryParamsList<StripePayment>, options?: ResourcesConfig): Promise<ListResponse<StripePayment>>;
|
|
17742
|
+
_disable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17743
|
+
_enable(id: string | StripeGateway, params?: QueryParamsRetrieve<StripeGateway>, options?: ResourcesConfig): Promise<StripeGateway>;
|
|
17296
17744
|
isStripeGateway(resource: any): resource is StripeGateway;
|
|
17297
17745
|
relationship(id: string | ResourceId | null): StripeGatewayRel;
|
|
17298
17746
|
relationshipToMany(...ids: string[]): StripeGatewayRel[];
|
|
@@ -17727,7 +18175,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
|
17727
18175
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
|
17728
18176
|
declare class CommerceLayerClient {
|
|
17729
18177
|
#private;
|
|
17730
|
-
readonly openApiSchemaVersion = "7.9.
|
|
18178
|
+
readonly openApiSchemaVersion = "7.9.12";
|
|
17731
18179
|
constructor(config: CommerceLayerInitConfig);
|
|
17732
18180
|
get addresses(): Addresses;
|
|
17733
18181
|
get adjustments(): Adjustments;
|