@bigcommerce/checkout-sdk 1.575.0 → 1.576.1
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/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +20 -330
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/docs/README.md +4 -34
- package/docs/enums/AdyenCardFields.md +29 -0
- package/docs/interfaces/AdyenBaseCardComponentOptions.md +7 -0
- package/docs/interfaces/AdyenComponent.md +11 -0
- package/docs/interfaces/AdyenComponentEvents.md +22 -2
- package/docs/interfaces/AdyenCreditCardComponentOptions.md +37 -2
- package/docs/interfaces/AdyenIdealComponentOptions.md +11 -0
- package/docs/interfaces/AdyenPlaceholderData.md +14 -0
- package/docs/interfaces/AdyenV2PaymentInitializeOptions.md +2 -2
- package/docs/interfaces/AdyenV3PaymentInitializeOptions.md +3 -3
- package/docs/interfaces/AdyenValidationState.md +57 -0
- package/docs/interfaces/BoletoDataPaymentMethodState.md +1 -7
- package/package.json +1 -1
- package/docs/enums/AdyenV2CardFields.md +0 -29
- package/docs/enums/AdyenV3CardFields.md +0 -29
- package/docs/interfaces/AdyenAdditionalActionCallbacks_2.md +0 -66
- package/docs/interfaces/AdyenAdditionalActionOptions_2.md +0 -106
- package/docs/interfaces/AdyenBaseCardComponentOptions_2.md +0 -40
- package/docs/interfaces/AdyenComponentEvents_2.md +0 -94
- package/docs/interfaces/AdyenComponent_2.md +0 -83
- package/docs/interfaces/AdyenPaymentMethodState_2.md +0 -15
- package/docs/interfaces/AdyenPlaceholderData_2.md +0 -54
- package/docs/interfaces/AdyenV2ValidationState.md +0 -57
- package/docs/interfaces/AdyenV3CreditCardComponentOptions.md +0 -220
- package/docs/interfaces/AdyenV3ValidationState.md +0 -57
- package/docs/interfaces/CardDataPaymentMethodState_2.md +0 -15
- package/docs/interfaces/CardPaymentMethodState_2.md +0 -43
- package/docs/interfaces/CardStateErrors_2.md +0 -7
- package/docs/interfaces/CardState_2.md +0 -40
- package/docs/interfaces/CreditCardPlaceHolder_2.md +0 -29
- package/docs/interfaces/CssProperties_2.md +0 -218
- package/docs/interfaces/InputDetail_2.md +0 -80
- package/docs/interfaces/Item_3.md +0 -26
- package/docs/interfaces/SepaPlaceHolder_2.md +0 -22
- package/docs/interfaces/StyleOptions_2.md +0 -44
- package/docs/interfaces/SubInputDetail_2.md +0 -62
- package/docs/interfaces/WechatDataPaymentMethodState_2.md +0 -15
- package/docs/interfaces/WechatState_2.md +0 -15
package/docs/README.md
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
### Enumerations
|
|
8
8
|
|
|
9
|
-
- [
|
|
10
|
-
- [AdyenV3CardFields](enums/AdyenV3CardFields.md)
|
|
9
|
+
- [AdyenCardFields](enums/AdyenCardFields.md)
|
|
11
10
|
- [BraintreeFormFieldType](enums/BraintreeFormFieldType.md)
|
|
12
11
|
- [ButtonColor](enums/ButtonColor.md)
|
|
13
12
|
- [ButtonType](enums/ButtonType.md)
|
|
@@ -66,27 +65,18 @@
|
|
|
66
65
|
- [Address](interfaces/Address.md)
|
|
67
66
|
- [AddressRequestBody](interfaces/AddressRequestBody.md)
|
|
68
67
|
- [AdyenAdditionalActionCallbacks](interfaces/AdyenAdditionalActionCallbacks.md)
|
|
69
|
-
- [AdyenAdditionalActionCallbacks_2](interfaces/AdyenAdditionalActionCallbacks_2.md)
|
|
70
68
|
- [AdyenAdditionalActionOptions](interfaces/AdyenAdditionalActionOptions.md)
|
|
71
|
-
- [AdyenAdditionalActionOptions_2](interfaces/AdyenAdditionalActionOptions_2.md)
|
|
72
69
|
- [AdyenBaseCardComponentOptions](interfaces/AdyenBaseCardComponentOptions.md)
|
|
73
|
-
- [AdyenBaseCardComponentOptions_2](interfaces/AdyenBaseCardComponentOptions_2.md)
|
|
74
70
|
- [AdyenComponent](interfaces/AdyenComponent.md)
|
|
75
71
|
- [AdyenComponentEvents](interfaces/AdyenComponentEvents.md)
|
|
76
|
-
- [AdyenComponentEvents_2](interfaces/AdyenComponentEvents_2.md)
|
|
77
|
-
- [AdyenComponent_2](interfaces/AdyenComponent_2.md)
|
|
78
72
|
- [AdyenCreditCardComponentOptions](interfaces/AdyenCreditCardComponentOptions.md)
|
|
79
73
|
- [AdyenIdealComponentOptions](interfaces/AdyenIdealComponentOptions.md)
|
|
80
74
|
- [AdyenPaymentMethodState](interfaces/AdyenPaymentMethodState.md)
|
|
81
|
-
- [AdyenPaymentMethodState_2](interfaces/AdyenPaymentMethodState_2.md)
|
|
82
75
|
- [AdyenPlaceholderData](interfaces/AdyenPlaceholderData.md)
|
|
83
|
-
- [AdyenPlaceholderData_2](interfaces/AdyenPlaceholderData_2.md)
|
|
84
76
|
- [AdyenThreeDS2Options](interfaces/AdyenThreeDS2Options.md)
|
|
85
77
|
- [AdyenV2PaymentInitializeOptions](interfaces/AdyenV2PaymentInitializeOptions.md)
|
|
86
|
-
- [AdyenV2ValidationState](interfaces/AdyenV2ValidationState.md)
|
|
87
|
-
- [AdyenV3CreditCardComponentOptions](interfaces/AdyenV3CreditCardComponentOptions.md)
|
|
88
78
|
- [AdyenV3PaymentInitializeOptions](interfaces/AdyenV3PaymentInitializeOptions.md)
|
|
89
|
-
- [
|
|
79
|
+
- [AdyenValidationState](interfaces/AdyenValidationState.md)
|
|
90
80
|
- [AmazonPayRemoteCheckout](interfaces/AmazonPayRemoteCheckout.md)
|
|
91
81
|
- [AmazonPayV2CustomerInitializeOptions](interfaces/AmazonPayV2CustomerInitializeOptions.md)
|
|
92
82
|
- [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
|
|
@@ -157,17 +147,13 @@
|
|
|
157
147
|
- [BuyNowCartRequestBody](interfaces/BuyNowCartRequestBody.md)
|
|
158
148
|
- [CardCvcElementOptions](interfaces/CardCvcElementOptions.md)
|
|
159
149
|
- [CardDataPaymentMethodState](interfaces/CardDataPaymentMethodState.md)
|
|
160
|
-
- [CardDataPaymentMethodState_2](interfaces/CardDataPaymentMethodState_2.md)
|
|
161
150
|
- [CardElementOptions](interfaces/CardElementOptions.md)
|
|
162
151
|
- [CardExpiryElementOptions](interfaces/CardExpiryElementOptions.md)
|
|
163
152
|
- [CardInstrument](interfaces/CardInstrument.md)
|
|
164
153
|
- [CardNumberElementOptions](interfaces/CardNumberElementOptions.md)
|
|
165
154
|
- [CardPaymentMethodState](interfaces/CardPaymentMethodState.md)
|
|
166
|
-
- [CardPaymentMethodState_2](interfaces/CardPaymentMethodState_2.md)
|
|
167
155
|
- [CardState](interfaces/CardState.md)
|
|
168
156
|
- [CardStateErrors](interfaces/CardStateErrors.md)
|
|
169
|
-
- [CardStateErrors_2](interfaces/CardStateErrors_2.md)
|
|
170
|
-
- [CardState_2](interfaces/CardState_2.md)
|
|
171
157
|
- [CardingProtectionActionData](interfaces/CardingProtectionActionData.md)
|
|
172
158
|
- [Cart](interfaces/Cart.md)
|
|
173
159
|
- [CartSelector](interfaces/CartSelector.md)
|
|
@@ -214,9 +200,7 @@
|
|
|
214
200
|
- [CreditCardInstrument](interfaces/CreditCardInstrument.md)
|
|
215
201
|
- [CreditCardPaymentInitializeOptions_2](interfaces/CreditCardPaymentInitializeOptions_2.md)
|
|
216
202
|
- [CreditCardPlaceHolder](interfaces/CreditCardPlaceHolder.md)
|
|
217
|
-
- [CreditCardPlaceHolder_2](interfaces/CreditCardPlaceHolder_2.md)
|
|
218
203
|
- [CssProperties](interfaces/CssProperties.md)
|
|
219
|
-
- [CssProperties_2](interfaces/CssProperties_2.md)
|
|
220
204
|
- [Currency](interfaces/Currency.md)
|
|
221
205
|
- [CustomError](interfaces/CustomError.md)
|
|
222
206
|
- [CustomItem](interfaces/CustomItem.md)
|
|
@@ -312,7 +296,6 @@
|
|
|
312
296
|
- [InitializationStrategy](interfaces/InitializationStrategy.md)
|
|
313
297
|
- [InlineElementStyles](interfaces/InlineElementStyles.md)
|
|
314
298
|
- [InputDetail](interfaces/InputDetail.md)
|
|
315
|
-
- [InputDetail_2](interfaces/InputDetail_2.md)
|
|
316
299
|
- [InputStyles](interfaces/InputStyles.md)
|
|
317
300
|
- [InstrumentSelector](interfaces/InstrumentSelector.md)
|
|
318
301
|
- [InternalAddress](interfaces/InternalAddress.md)
|
|
@@ -321,7 +304,6 @@
|
|
|
321
304
|
- [InternalOrderPayment](interfaces/InternalOrderPayment.md)
|
|
322
305
|
- [Item](interfaces/Item.md)
|
|
323
306
|
- [Item_2](interfaces/Item_2.md)
|
|
324
|
-
- [Item_3](interfaces/Item_3.md)
|
|
325
307
|
- [LabelStyles](interfaces/LabelStyles.md)
|
|
326
308
|
- [LanguageConfig](interfaces/LanguageConfig.md)
|
|
327
309
|
- [LineItem](interfaces/LineItem.md)
|
|
@@ -405,7 +387,6 @@
|
|
|
405
387
|
- [RequestOptions](interfaces/RequestOptions.md)
|
|
406
388
|
- [SearchArea](interfaces/SearchArea.md)
|
|
407
389
|
- [SepaPlaceHolder](interfaces/SepaPlaceHolder.md)
|
|
408
|
-
- [SepaPlaceHolder_2](interfaces/SepaPlaceHolder_2.md)
|
|
409
390
|
- [SetIframeStyleCommand](interfaces/SetIframeStyleCommand.md)
|
|
410
391
|
- [ShippingAddressSelector](interfaces/ShippingAddressSelector.md)
|
|
411
392
|
- [ShippingCountrySelector](interfaces/ShippingCountrySelector.md)
|
|
@@ -447,9 +428,7 @@
|
|
|
447
428
|
- [StripeUPEShippingInitializeOptions](interfaces/StripeUPEShippingInitializeOptions.md)
|
|
448
429
|
- [StripeV3PaymentInitializeOptions](interfaces/StripeV3PaymentInitializeOptions.md)
|
|
449
430
|
- [StyleOptions](interfaces/StyleOptions.md)
|
|
450
|
-
- [StyleOptions_2](interfaces/StyleOptions_2.md)
|
|
451
431
|
- [SubInputDetail](interfaces/SubInputDetail.md)
|
|
452
|
-
- [SubInputDetail_2](interfaces/SubInputDetail_2.md)
|
|
453
432
|
- [Subscriptions](interfaces/Subscriptions.md)
|
|
454
433
|
- [SubscriptionsSelector](interfaces/SubscriptionsSelector.md)
|
|
455
434
|
- [Tax](interfaces/Tax.md)
|
|
@@ -463,9 +442,7 @@
|
|
|
463
442
|
- [VaultAccessToken](interfaces/VaultAccessToken.md)
|
|
464
443
|
- [VaultedInstrument](interfaces/VaultedInstrument.md)
|
|
465
444
|
- [WechatDataPaymentMethodState](interfaces/WechatDataPaymentMethodState.md)
|
|
466
|
-
- [WechatDataPaymentMethodState_2](interfaces/WechatDataPaymentMethodState_2.md)
|
|
467
445
|
- [WechatState](interfaces/WechatState.md)
|
|
468
|
-
- [WechatState_2](interfaces/WechatState_2.md)
|
|
469
446
|
- [WithAdyenV2PaymentInitializeOptions](interfaces/WithAdyenV2PaymentInitializeOptions.md)
|
|
470
447
|
- [WithAdyenV3PaymentInitializeOptions](interfaces/WithAdyenV3PaymentInitializeOptions.md)
|
|
471
448
|
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
@@ -515,7 +492,6 @@
|
|
|
515
492
|
- [AccountInstrument](README.md#accountinstrument)
|
|
516
493
|
- [AddressKey](README.md#addresskey)
|
|
517
494
|
- [AdyenComponentState](README.md#adyencomponentstate)
|
|
518
|
-
- [AdyenV3ComponentState](README.md#adyenv3componentstate)
|
|
519
495
|
- [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
|
|
520
496
|
- [AnalyticStepType](README.md#analyticsteptype)
|
|
521
497
|
- [BraintreeFormErrorData](README.md#braintreeformerrordata)
|
|
@@ -598,13 +574,7 @@ ___
|
|
|
598
574
|
|
|
599
575
|
### AdyenComponentState
|
|
600
576
|
|
|
601
|
-
Ƭ **AdyenComponentState**: [`CardState`](interfaces/CardState.md) \| [`WechatState`](interfaces/WechatState.md)
|
|
602
|
-
|
|
603
|
-
___
|
|
604
|
-
|
|
605
|
-
### AdyenV3ComponentState
|
|
606
|
-
|
|
607
|
-
Ƭ **AdyenV3ComponentState**: [`CardState_2`](interfaces/CardState_2.md) \| [`WechatState_2`](interfaces/WechatState_2.md) \| [`BoletoState`](interfaces/BoletoState.md)
|
|
577
|
+
Ƭ **AdyenComponentState**: [`CardState`](interfaces/CardState.md) \| [`BoletoState`](interfaces/BoletoState.md) \| [`WechatState`](interfaces/WechatState.md)
|
|
608
578
|
|
|
609
579
|
___
|
|
610
580
|
|
|
@@ -883,7 +853,7 @@ ___
|
|
|
883
853
|
|
|
884
854
|
### PaymentInitializeOptions
|
|
885
855
|
|
|
886
|
-
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`
|
|
856
|
+
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreeAchPaymentInitializeOptions`](interfaces/WithBraintreeAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeFastlanePaymentInitializeOptions`](interfaces/WithBraintreeFastlanePaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithMolliePaymentInitializeOptions`](interfaces/WithMolliePaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithPayPalCommerceRatePayPaymentInitializeOptions`](interfaces/WithPayPalCommerceRatePayPaymentInitializeOptions.md) & [`WithPayPalCommerceFastlanePaymentInitializeOptions`](interfaces/WithPayPalCommerceFastlanePaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md) & [`WithStripeV3PaymentInitializeOptions`](interfaces/WithStripeV3PaymentInitializeOptions.md) & [`WithStripeUPEPaymentInitializeOptions`](interfaces/WithStripeUPEPaymentInitializeOptions.md)
|
|
887
857
|
|
|
888
858
|
___
|
|
889
859
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AdyenCardFields
|
|
2
|
+
|
|
3
|
+
# Enumeration: AdyenCardFields
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration Members
|
|
8
|
+
|
|
9
|
+
- [CardNumber](AdyenCardFields.md#cardnumber)
|
|
10
|
+
- [ExpiryDate](AdyenCardFields.md#expirydate)
|
|
11
|
+
- [SecurityCode](AdyenCardFields.md#securitycode)
|
|
12
|
+
|
|
13
|
+
## Enumeration Members
|
|
14
|
+
|
|
15
|
+
### CardNumber
|
|
16
|
+
|
|
17
|
+
• **CardNumber**
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### ExpiryDate
|
|
22
|
+
|
|
23
|
+
• **ExpiryDate**
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### SecurityCode
|
|
28
|
+
|
|
29
|
+
• **SecurityCode**
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
### Properties
|
|
16
16
|
|
|
17
17
|
- [brands](AdyenBaseCardComponentOptions.md#brands)
|
|
18
|
+
- [showBrandsUnderCardNumber](AdyenBaseCardComponentOptions.md#showbrandsundercardnumber)
|
|
18
19
|
- [styles](AdyenBaseCardComponentOptions.md#styles)
|
|
19
20
|
|
|
20
21
|
## Properties
|
|
@@ -27,6 +28,12 @@ Array of card brands that will be recognized by the component.
|
|
|
27
28
|
|
|
28
29
|
___
|
|
29
30
|
|
|
31
|
+
### showBrandsUnderCardNumber
|
|
32
|
+
|
|
33
|
+
• `Optional` **showBrandsUnderCardNumber**: `boolean`
|
|
34
|
+
|
|
35
|
+
___
|
|
36
|
+
|
|
30
37
|
### styles
|
|
31
38
|
|
|
32
39
|
• `Optional` **styles**: [`StyleOptions`](StyleOptions.md)
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
### Methods
|
|
14
14
|
|
|
15
15
|
- [mount](AdyenComponent.md#mount)
|
|
16
|
+
- [submit](AdyenComponent.md#submit)
|
|
16
17
|
- [unmount](AdyenComponent.md#unmount)
|
|
17
18
|
|
|
18
19
|
## Properties
|
|
@@ -63,6 +64,16 @@ ___
|
|
|
63
64
|
|
|
64
65
|
___
|
|
65
66
|
|
|
67
|
+
### submit
|
|
68
|
+
|
|
69
|
+
▸ **submit**(): `void`
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`void`
|
|
74
|
+
|
|
75
|
+
___
|
|
76
|
+
|
|
66
77
|
### unmount
|
|
67
78
|
|
|
68
79
|
▸ **unmount**(): `void`
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
- [onChange](AdyenComponentEvents.md#onchange)
|
|
16
16
|
- [onError](AdyenComponentEvents.md#onerror)
|
|
17
17
|
- [onFieldValid](AdyenComponentEvents.md#onfieldvalid)
|
|
18
|
+
- [onSubmit](AdyenComponentEvents.md#onsubmit)
|
|
18
19
|
|
|
19
20
|
## Methods
|
|
20
21
|
|
|
@@ -49,7 +50,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
49
50
|
|
|
50
51
|
| Name | Type |
|
|
51
52
|
| :------ | :------ |
|
|
52
|
-
| `state` | [`
|
|
53
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
53
54
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
54
55
|
|
|
55
56
|
#### Returns
|
|
@@ -66,7 +67,26 @@ ___
|
|
|
66
67
|
|
|
67
68
|
| Name | Type |
|
|
68
69
|
| :------ | :------ |
|
|
69
|
-
| `state` | [`
|
|
70
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
71
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
72
|
+
|
|
73
|
+
#### Returns
|
|
74
|
+
|
|
75
|
+
`void`
|
|
76
|
+
|
|
77
|
+
___
|
|
78
|
+
|
|
79
|
+
### onSubmit
|
|
80
|
+
|
|
81
|
+
▸ `Optional` **onSubmit**(`state`, `component`): `void`
|
|
82
|
+
|
|
83
|
+
Called when the shopper selects the Pay button and payment details are valid.
|
|
84
|
+
|
|
85
|
+
#### Parameters
|
|
86
|
+
|
|
87
|
+
| Name | Type |
|
|
88
|
+
| :------ | :------ |
|
|
89
|
+
| `state` | [`AdyenComponentState`](../README.md#adyencomponentstate) |
|
|
70
90
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
71
91
|
|
|
72
92
|
#### Returns
|
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
- [hasHolderName](AdyenCreditCardComponentOptions.md#hasholdername)
|
|
23
23
|
- [holderNameRequired](AdyenCreditCardComponentOptions.md#holdernamerequired)
|
|
24
24
|
- [placeholders](AdyenCreditCardComponentOptions.md#placeholders)
|
|
25
|
+
- [showBrandsUnderCardNumber](AdyenCreditCardComponentOptions.md#showbrandsundercardnumber)
|
|
25
26
|
- [styles](AdyenCreditCardComponentOptions.md#styles)
|
|
26
27
|
|
|
27
28
|
### Methods
|
|
@@ -29,6 +30,7 @@
|
|
|
29
30
|
- [onChange](AdyenCreditCardComponentOptions.md#onchange)
|
|
30
31
|
- [onError](AdyenCreditCardComponentOptions.md#onerror)
|
|
31
32
|
- [onFieldValid](AdyenCreditCardComponentOptions.md#onfieldvalid)
|
|
33
|
+
- [onSubmit](AdyenCreditCardComponentOptions.md#onsubmit)
|
|
32
34
|
|
|
33
35
|
## Properties
|
|
34
36
|
|
|
@@ -104,6 +106,16 @@ Specify the sample values you want to appear for card detail input fields.
|
|
|
104
106
|
|
|
105
107
|
___
|
|
106
108
|
|
|
109
|
+
### showBrandsUnderCardNumber
|
|
110
|
+
|
|
111
|
+
• `Optional` **showBrandsUnderCardNumber**: `boolean`
|
|
112
|
+
|
|
113
|
+
#### Inherited from
|
|
114
|
+
|
|
115
|
+
[AdyenBaseCardComponentOptions](AdyenBaseCardComponentOptions.md).[showBrandsUnderCardNumber](AdyenBaseCardComponentOptions.md#showbrandsundercardnumber)
|
|
116
|
+
|
|
117
|
+
___
|
|
118
|
+
|
|
107
119
|
### styles
|
|
108
120
|
|
|
109
121
|
• `Optional` **styles**: [`StyleOptions`](StyleOptions.md)
|
|
@@ -152,7 +164,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
152
164
|
|
|
153
165
|
| Name | Type |
|
|
154
166
|
| :------ | :------ |
|
|
155
|
-
| `state` | [`
|
|
167
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
156
168
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
157
169
|
|
|
158
170
|
#### Returns
|
|
@@ -173,7 +185,7 @@ ___
|
|
|
173
185
|
|
|
174
186
|
| Name | Type |
|
|
175
187
|
| :------ | :------ |
|
|
176
|
-
| `state` | [`
|
|
188
|
+
| `state` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
177
189
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
178
190
|
|
|
179
191
|
#### Returns
|
|
@@ -183,3 +195,26 @@ ___
|
|
|
183
195
|
#### Inherited from
|
|
184
196
|
|
|
185
197
|
[AdyenComponentEvents](AdyenComponentEvents.md).[onFieldValid](AdyenComponentEvents.md#onfieldvalid)
|
|
198
|
+
|
|
199
|
+
___
|
|
200
|
+
|
|
201
|
+
### onSubmit
|
|
202
|
+
|
|
203
|
+
▸ `Optional` **onSubmit**(`state`, `component`): `void`
|
|
204
|
+
|
|
205
|
+
Called when the shopper selects the Pay button and payment details are valid.
|
|
206
|
+
|
|
207
|
+
#### Parameters
|
|
208
|
+
|
|
209
|
+
| Name | Type |
|
|
210
|
+
| :------ | :------ |
|
|
211
|
+
| `state` | [`AdyenComponentState`](../README.md#adyencomponentstate) |
|
|
212
|
+
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
213
|
+
|
|
214
|
+
#### Returns
|
|
215
|
+
|
|
216
|
+
`void`
|
|
217
|
+
|
|
218
|
+
#### Inherited from
|
|
219
|
+
|
|
220
|
+
[AdyenComponentEvents](AdyenComponentEvents.md).[onSubmit](AdyenComponentEvents.md#onsubmit)
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
### Properties
|
|
14
14
|
|
|
15
15
|
- [brands](AdyenIdealComponentOptions.md#brands)
|
|
16
|
+
- [showBrandsUnderCardNumber](AdyenIdealComponentOptions.md#showbrandsundercardnumber)
|
|
16
17
|
- [showImage](AdyenIdealComponentOptions.md#showimage)
|
|
17
18
|
- [styles](AdyenIdealComponentOptions.md#styles)
|
|
18
19
|
|
|
@@ -30,6 +31,16 @@ Array of card brands that will be recognized by the component.
|
|
|
30
31
|
|
|
31
32
|
___
|
|
32
33
|
|
|
34
|
+
### showBrandsUnderCardNumber
|
|
35
|
+
|
|
36
|
+
• `Optional` **showBrandsUnderCardNumber**: `boolean`
|
|
37
|
+
|
|
38
|
+
#### Inherited from
|
|
39
|
+
|
|
40
|
+
[AdyenBaseCardComponentOptions](AdyenBaseCardComponentOptions.md).[showBrandsUnderCardNumber](AdyenBaseCardComponentOptions.md#showbrandsundercardnumber)
|
|
41
|
+
|
|
42
|
+
___
|
|
43
|
+
|
|
33
44
|
### showImage
|
|
34
45
|
|
|
35
46
|
• `Optional` **showImage**: `boolean`
|
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
9
|
- [billingAddress](AdyenPlaceholderData.md#billingaddress)
|
|
10
|
+
- [firstName](AdyenPlaceholderData.md#firstname)
|
|
10
11
|
- [holderName](AdyenPlaceholderData.md#holdername)
|
|
12
|
+
- [lastName](AdyenPlaceholderData.md#lastname)
|
|
11
13
|
- [prefillCardHolderName](AdyenPlaceholderData.md#prefillcardholdername)
|
|
12
14
|
|
|
13
15
|
## Properties
|
|
@@ -29,12 +31,24 @@
|
|
|
29
31
|
|
|
30
32
|
___
|
|
31
33
|
|
|
34
|
+
### firstName
|
|
35
|
+
|
|
36
|
+
• `Optional` **firstName**: `string`
|
|
37
|
+
|
|
38
|
+
___
|
|
39
|
+
|
|
32
40
|
### holderName
|
|
33
41
|
|
|
34
42
|
• `Optional` **holderName**: `string`
|
|
35
43
|
|
|
36
44
|
___
|
|
37
45
|
|
|
46
|
+
### lastName
|
|
47
|
+
|
|
48
|
+
• `Optional` **lastName**: `string`
|
|
49
|
+
|
|
50
|
+
___
|
|
51
|
+
|
|
38
52
|
### prefillCardHolderName
|
|
39
53
|
|
|
40
54
|
• `Optional` **prefillCardHolderName**: `boolean`
|
|
@@ -116,7 +116,7 @@ ___
|
|
|
116
116
|
|
|
117
117
|
### options
|
|
118
118
|
|
|
119
|
-
• `Optional` **options**: [`AdyenIdealComponentOptions`](AdyenIdealComponentOptions.md) \| `Pick`<[`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md), ``"details"`` \| ``"enableStoreDetails"`` \| ``"hasHolderName"`` \| ``"holderNameRequired"`` \| ``"data"`` \| ``"groupTypes"`` \| ``"placeholders"`` \| ``"brands"`` \| ``"styles"`` \| ``"onError"`` \| ``"onFieldValid"``\>
|
|
119
|
+
• `Optional` **options**: [`AdyenIdealComponentOptions`](AdyenIdealComponentOptions.md) \| `Pick`<[`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md), ``"details"`` \| ``"enableStoreDetails"`` \| ``"hasHolderName"`` \| ``"holderNameRequired"`` \| ``"data"`` \| ``"groupTypes"`` \| ``"placeholders"`` \| ``"brands"`` \| ``"styles"`` \| ``"showBrandsUnderCardNumber"`` \| ``"onSubmit"`` \| ``"onError"`` \| ``"onFieldValid"``\>
|
|
120
120
|
|
|
121
121
|
Optional. Overwriting the default options
|
|
122
122
|
|
|
@@ -154,7 +154,7 @@ Use additionalActionOptions instead as this property will be removed in the futu
|
|
|
154
154
|
|
|
155
155
|
| Name | Type |
|
|
156
156
|
| :------ | :------ |
|
|
157
|
-
| `validateState` | [`
|
|
157
|
+
| `validateState` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
158
158
|
|
|
159
159
|
#### Returns
|
|
160
160
|
|
|
@@ -76,7 +76,7 @@ service.initializePayment({
|
|
|
76
76
|
|
|
77
77
|
### additionalActionOptions
|
|
78
78
|
|
|
79
|
-
• **additionalActionOptions**: [`
|
|
79
|
+
• **additionalActionOptions**: [`AdyenAdditionalActionOptions`](AdyenAdditionalActionOptions.md)
|
|
80
80
|
|
|
81
81
|
A set of options that are required to initialize additional payment actions.
|
|
82
82
|
|
|
@@ -108,7 +108,7 @@ ___
|
|
|
108
108
|
|
|
109
109
|
### options
|
|
110
110
|
|
|
111
|
-
• `Optional` **options**: `Pick`<[`
|
|
111
|
+
• `Optional` **options**: `Pick`<[`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md), ``"details"`` \| ``"enableStoreDetails"`` \| ``"hasHolderName"`` \| ``"holderNameRequired"`` \| ``"data"`` \| ``"groupTypes"`` \| ``"placeholders"`` \| ``"brands"`` \| ``"styles"`` \| ``"showBrandsUnderCardNumber"`` \| ``"onSubmit"`` \| ``"onError"`` \| ``"onFieldValid"``\>
|
|
112
112
|
|
|
113
113
|
Optional. Overwriting the default options
|
|
114
114
|
|
|
@@ -128,7 +128,7 @@ ___
|
|
|
128
128
|
|
|
129
129
|
| Name | Type |
|
|
130
130
|
| :------ | :------ |
|
|
131
|
-
| `validateState` | [`
|
|
131
|
+
| `validateState` | [`AdyenValidationState`](AdyenValidationState.md) |
|
|
132
132
|
|
|
133
133
|
#### Returns
|
|
134
134
|
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AdyenValidationState
|
|
2
|
+
|
|
3
|
+
# Interface: AdyenValidationState
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [encryptedFieldName](AdyenValidationState.md#encryptedfieldname)
|
|
10
|
+
- [endDigits](AdyenValidationState.md#enddigits)
|
|
11
|
+
- [error](AdyenValidationState.md#error)
|
|
12
|
+
- [errorKey](AdyenValidationState.md#errorkey)
|
|
13
|
+
- [fieldType](AdyenValidationState.md#fieldtype)
|
|
14
|
+
- [i18n](AdyenValidationState.md#i18n)
|
|
15
|
+
- [valid](AdyenValidationState.md#valid)
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### encryptedFieldName
|
|
20
|
+
|
|
21
|
+
• `Optional` **encryptedFieldName**: `string`
|
|
22
|
+
|
|
23
|
+
___
|
|
24
|
+
|
|
25
|
+
### endDigits
|
|
26
|
+
|
|
27
|
+
• `Optional` **endDigits**: `string`
|
|
28
|
+
|
|
29
|
+
___
|
|
30
|
+
|
|
31
|
+
### error
|
|
32
|
+
|
|
33
|
+
• `Optional` **error**: `string`
|
|
34
|
+
|
|
35
|
+
___
|
|
36
|
+
|
|
37
|
+
### errorKey
|
|
38
|
+
|
|
39
|
+
• `Optional` **errorKey**: `string`
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### fieldType
|
|
44
|
+
|
|
45
|
+
• `Optional` **fieldType**: [`CardNumber`](../enums/AdyenCardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenCardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenCardFields.md#expirydate)
|
|
46
|
+
|
|
47
|
+
___
|
|
48
|
+
|
|
49
|
+
### i18n
|
|
50
|
+
|
|
51
|
+
• `Optional` **i18n**: `string`
|
|
52
|
+
|
|
53
|
+
___
|
|
54
|
+
|
|
55
|
+
### valid
|
|
56
|
+
|
|
57
|
+
• **valid**: `boolean`
|
|
@@ -14,13 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
### paymentMethod
|
|
16
16
|
|
|
17
|
-
• **paymentMethod**: `
|
|
18
|
-
|
|
19
|
-
#### Type declaration
|
|
20
|
-
|
|
21
|
-
| Name | Type |
|
|
22
|
-
| :------ | :------ |
|
|
23
|
-
| `type` | `string` |
|
|
17
|
+
• **paymentMethod**: [`AdyenPaymentMethodState`](AdyenPaymentMethodState.md)
|
|
24
18
|
|
|
25
19
|
___
|
|
26
20
|
|
package/package.json
CHANGED
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / AdyenV2CardFields
|
|
2
|
-
|
|
3
|
-
# Enumeration: AdyenV2CardFields
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumeration Members
|
|
8
|
-
|
|
9
|
-
- [CardNumber](AdyenV2CardFields.md#cardnumber)
|
|
10
|
-
- [ExpiryDate](AdyenV2CardFields.md#expirydate)
|
|
11
|
-
- [SecurityCode](AdyenV2CardFields.md#securitycode)
|
|
12
|
-
|
|
13
|
-
## Enumeration Members
|
|
14
|
-
|
|
15
|
-
### CardNumber
|
|
16
|
-
|
|
17
|
-
• **CardNumber**
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### ExpiryDate
|
|
22
|
-
|
|
23
|
-
• **ExpiryDate**
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### SecurityCode
|
|
28
|
-
|
|
29
|
-
• **SecurityCode**
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / AdyenV3CardFields
|
|
2
|
-
|
|
3
|
-
# Enumeration: AdyenV3CardFields
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumeration Members
|
|
8
|
-
|
|
9
|
-
- [CardNumber](AdyenV3CardFields.md#cardnumber)
|
|
10
|
-
- [ExpiryDate](AdyenV3CardFields.md#expirydate)
|
|
11
|
-
- [SecurityCode](AdyenV3CardFields.md#securitycode)
|
|
12
|
-
|
|
13
|
-
## Enumeration Members
|
|
14
|
-
|
|
15
|
-
### CardNumber
|
|
16
|
-
|
|
17
|
-
• **CardNumber**
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### ExpiryDate
|
|
22
|
-
|
|
23
|
-
• **ExpiryDate**
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### SecurityCode
|
|
28
|
-
|
|
29
|
-
• **SecurityCode**
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionCallbacks_2
|
|
2
|
-
|
|
3
|
-
# Interface: AdyenAdditionalActionCallbacks\_2
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- **`AdyenAdditionalActionCallbacks_2`**
|
|
8
|
-
|
|
9
|
-
↳ [`AdyenAdditionalActionOptions_2`](AdyenAdditionalActionOptions_2.md)
|
|
10
|
-
|
|
11
|
-
## Table of contents
|
|
12
|
-
|
|
13
|
-
### Methods
|
|
14
|
-
|
|
15
|
-
- [onBeforeLoad](AdyenAdditionalActionCallbacks_2.md#onbeforeload)
|
|
16
|
-
- [onComplete](AdyenAdditionalActionCallbacks_2.md#oncomplete)
|
|
17
|
-
- [onLoad](AdyenAdditionalActionCallbacks_2.md#onload)
|
|
18
|
-
|
|
19
|
-
## Methods
|
|
20
|
-
|
|
21
|
-
### onBeforeLoad
|
|
22
|
-
|
|
23
|
-
▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
|
|
24
|
-
|
|
25
|
-
A callback that gets called before adyen component is loaded
|
|
26
|
-
|
|
27
|
-
#### Parameters
|
|
28
|
-
|
|
29
|
-
| Name | Type |
|
|
30
|
-
| :------ | :------ |
|
|
31
|
-
| `shopperInteraction?` | `boolean` |
|
|
32
|
-
|
|
33
|
-
#### Returns
|
|
34
|
-
|
|
35
|
-
`void`
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### onComplete
|
|
40
|
-
|
|
41
|
-
▸ `Optional` **onComplete**(): `void`
|
|
42
|
-
|
|
43
|
-
A callback that gets called when adyen component verification
|
|
44
|
-
is completed
|
|
45
|
-
|
|
46
|
-
#### Returns
|
|
47
|
-
|
|
48
|
-
`void`
|
|
49
|
-
|
|
50
|
-
___
|
|
51
|
-
|
|
52
|
-
### onLoad
|
|
53
|
-
|
|
54
|
-
▸ `Optional` **onLoad**(`cancel?`): `void`
|
|
55
|
-
|
|
56
|
-
A callback that gets called when adyen component is loaded
|
|
57
|
-
|
|
58
|
-
#### Parameters
|
|
59
|
-
|
|
60
|
-
| Name | Type |
|
|
61
|
-
| :------ | :------ |
|
|
62
|
-
| `cancel?` | () => `void` |
|
|
63
|
-
|
|
64
|
-
#### Returns
|
|
65
|
-
|
|
66
|
-
`void`
|