@bigcommerce/checkout-sdk 1.272.3 → 1.275.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/CHANGELOG.md +26 -0
- package/dist/checkout-button.d.ts +168 -101
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +562 -453
- 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/dist/hosted-form.js.map +1 -1
- package/dist/hosted-form.umd.js.map +1 -1
- package/docs/README.md +44 -4
- package/docs/classes/CheckoutButtonInitializer.md +1 -1
- package/docs/classes/CheckoutService.md +2 -2
- package/docs/enums/AdyenV2CardFields.md +29 -0
- package/docs/enums/AdyenV3CardFields.md +29 -0
- package/docs/enums/AmazonPayV2ButtonColor.md +29 -0
- package/docs/interfaces/AdyenComponentEvents.md +2 -2
- package/docs/interfaces/AdyenComponentEvents_2.md +2 -2
- package/docs/interfaces/AdyenCreditCardComponentOptions.md +2 -2
- package/docs/interfaces/AdyenV2PaymentInitializeOptions.md +2 -2
- package/docs/interfaces/AdyenV2ValidationState.md +57 -0
- package/docs/interfaces/AdyenV3CreditCardComponentOptions.md +2 -2
- package/docs/interfaces/AdyenV3PaymentInitializeOptions.md +2 -2
- package/docs/interfaces/AdyenV3ValidationState.md +57 -0
- package/docs/interfaces/AmazonPayV2ButtonConfig.md +80 -0
- package/docs/interfaces/AmazonPayV2ButtonParams.md +45 -1
- package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md +36 -0
- package/docs/interfaces/AmazonPayV2NewButtonParams.md +125 -0
- package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +38 -0
- package/docs/interfaces/{CheckoutButtonInitializeOptions.md → BaseCheckoutButtonInitializeOptions.md} +26 -26
- package/docs/interfaces/{CustomerInitializeOptions.md → BaseCustomerInitializeOptions.md} +21 -31
- package/docs/interfaces/{PaymentInitializeOptions.md → BasePaymentInitializeOptions.md} +39 -49
- package/docs/interfaces/CheckoutButtonOptions.md +1 -1
- package/docs/interfaces/CustomerRequestOptions.md +1 -1
- package/docs/interfaces/PaymentRequestOptions.md +1 -1
- package/docs/interfaces/WithApplePayButtonInitializeOptions.md +15 -0
- package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +18 -0
- package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +18 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -6,6 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
### Enumerations
|
|
8
8
|
|
|
9
|
+
- [AdyenV2CardFields](enums/AdyenV2CardFields.md)
|
|
10
|
+
- [AdyenV3CardFields](enums/AdyenV3CardFields.md)
|
|
11
|
+
- [AmazonPayV2ButtonColor](enums/AmazonPayV2ButtonColor.md)
|
|
9
12
|
- [AmazonPayV2CheckoutLanguage](enums/AmazonPayV2CheckoutLanguage.md)
|
|
10
13
|
- [AmazonPayV2LedgerCurrency](enums/AmazonPayV2LedgerCurrency.md)
|
|
11
14
|
- [AmazonPayV2PayOptions](enums/AmazonPayV2PayOptions.md)
|
|
@@ -66,28 +69,37 @@
|
|
|
66
69
|
- [AdyenPlaceholderData_2](interfaces/AdyenPlaceholderData_2.md)
|
|
67
70
|
- [AdyenThreeDS2Options](interfaces/AdyenThreeDS2Options.md)
|
|
68
71
|
- [AdyenV2PaymentInitializeOptions](interfaces/AdyenV2PaymentInitializeOptions.md)
|
|
72
|
+
- [AdyenV2ValidationState](interfaces/AdyenV2ValidationState.md)
|
|
69
73
|
- [AdyenV3CreditCardComponentOptions](interfaces/AdyenV3CreditCardComponentOptions.md)
|
|
70
74
|
- [AdyenV3PaymentInitializeOptions](interfaces/AdyenV3PaymentInitializeOptions.md)
|
|
75
|
+
- [AdyenV3ValidationState](interfaces/AdyenV3ValidationState.md)
|
|
71
76
|
- [AmazonPayCustomerInitializeOptions](interfaces/AmazonPayCustomerInitializeOptions.md)
|
|
72
77
|
- [AmazonPayOrderReference](interfaces/AmazonPayOrderReference.md)
|
|
73
78
|
- [AmazonPayPaymentInitializeOptions](interfaces/AmazonPayPaymentInitializeOptions.md)
|
|
74
79
|
- [AmazonPayShippingInitializeOptions](interfaces/AmazonPayShippingInitializeOptions.md)
|
|
80
|
+
- [AmazonPayV2ButtonConfig](interfaces/AmazonPayV2ButtonConfig.md)
|
|
75
81
|
- [AmazonPayV2ButtonParams](interfaces/AmazonPayV2ButtonParams.md)
|
|
76
82
|
- [AmazonPayV2CheckoutSession](interfaces/AmazonPayV2CheckoutSession.md)
|
|
83
|
+
- [AmazonPayV2CheckoutSessionConfig](interfaces/AmazonPayV2CheckoutSessionConfig.md)
|
|
77
84
|
- [AmazonPayV2CustomerInitializeOptions](interfaces/AmazonPayV2CustomerInitializeOptions.md)
|
|
85
|
+
- [AmazonPayV2NewButtonParams](interfaces/AmazonPayV2NewButtonParams.md)
|
|
78
86
|
- [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
|
|
79
87
|
- [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
|
|
80
88
|
- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
|
|
81
89
|
- [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
|
|
90
|
+
- [ApplePayButtonInitializeOptions_2](interfaces/ApplePayButtonInitializeOptions_2.md)
|
|
82
91
|
- [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)
|
|
83
92
|
- [ApplePayPaymentInitializeOptions](interfaces/ApplePayPaymentInitializeOptions.md)
|
|
84
93
|
- [BankInstrument](interfaces/BankInstrument.md)
|
|
85
94
|
- [Banner](interfaces/Banner.md)
|
|
86
95
|
- [BaseAccountInstrument](interfaces/BaseAccountInstrument.md)
|
|
96
|
+
- [BaseCheckoutButtonInitializeOptions](interfaces/BaseCheckoutButtonInitializeOptions.md)
|
|
97
|
+
- [BaseCustomerInitializeOptions](interfaces/BaseCustomerInitializeOptions.md)
|
|
87
98
|
- [BaseElementOptions](interfaces/BaseElementOptions.md)
|
|
88
99
|
- [BaseElementOptions_2](interfaces/BaseElementOptions_2.md)
|
|
89
100
|
- [BaseIndividualElementOptions](interfaces/BaseIndividualElementOptions.md)
|
|
90
101
|
- [BaseInstrument](interfaces/BaseInstrument.md)
|
|
102
|
+
- [BasePaymentInitializeOptions](interfaces/BasePaymentInitializeOptions.md)
|
|
91
103
|
- [BillingAddress](interfaces/BillingAddress.md)
|
|
92
104
|
- [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
|
|
93
105
|
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
@@ -137,7 +149,6 @@
|
|
|
137
149
|
- [CheckableInputStyles](interfaces/CheckableInputStyles.md)
|
|
138
150
|
- [ChecklistStyles](interfaces/ChecklistStyles.md)
|
|
139
151
|
- [Checkout](interfaces/Checkout.md)
|
|
140
|
-
- [CheckoutButtonInitializeOptions](interfaces/CheckoutButtonInitializeOptions.md)
|
|
141
152
|
- [CheckoutButtonInitializerOptions](interfaces/CheckoutButtonInitializerOptions.md)
|
|
142
153
|
- [CheckoutButtonOptions](interfaces/CheckoutButtonOptions.md)
|
|
143
154
|
- [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
|
|
@@ -174,7 +185,6 @@
|
|
|
174
185
|
- [CustomerAddress](interfaces/CustomerAddress.md)
|
|
175
186
|
- [CustomerCredentials](interfaces/CustomerCredentials.md)
|
|
176
187
|
- [CustomerGroup](interfaces/CustomerGroup.md)
|
|
177
|
-
- [CustomerInitializeOptions](interfaces/CustomerInitializeOptions.md)
|
|
178
188
|
- [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
|
|
179
189
|
- [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
|
|
180
190
|
- [DigitalItem](interfaces/DigitalItem.md)
|
|
@@ -264,7 +274,6 @@
|
|
|
264
274
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
265
275
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
266
276
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
267
|
-
- [PaymentInitializeOptions](interfaces/PaymentInitializeOptions.md)
|
|
268
277
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
269
278
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
270
279
|
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
@@ -341,6 +350,9 @@
|
|
|
341
350
|
- [WechatState](interfaces/WechatState.md)
|
|
342
351
|
- [WechatState_2](interfaces/WechatState_2.md)
|
|
343
352
|
- [WithAccountCreation](interfaces/WithAccountCreation.md)
|
|
353
|
+
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
354
|
+
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
355
|
+
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
344
356
|
- [WithCheckoutcomFawryInstrument](interfaces/WithCheckoutcomFawryInstrument.md)
|
|
345
357
|
- [WithCheckoutcomSEPAInstrument](interfaces/WithCheckoutcomSEPAInstrument.md)
|
|
346
358
|
- [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
|
|
@@ -356,16 +368,19 @@
|
|
|
356
368
|
- [AdyenComponentState](README.md#adyencomponentstate)
|
|
357
369
|
- [AdyenV3ComponentState](README.md#adyenv3componentstate)
|
|
358
370
|
- [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
|
|
371
|
+
- [AmazonPayV2ButtonParameters](README.md#amazonpayv2buttonparameters)
|
|
359
372
|
- [AnalyticStepType](README.md#analyticsteptype)
|
|
360
373
|
- [BraintreeFormFieldBlurEventData](README.md#braintreeformfieldblureventdata)
|
|
361
374
|
- [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
|
|
362
375
|
- [BraintreeFormFieldFocusEventData](README.md#braintreeformfieldfocuseventdata)
|
|
363
376
|
- [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
|
|
377
|
+
- [CheckoutButtonInitializeOptions](README.md#checkoutbuttoninitializeoptions)
|
|
364
378
|
- [CheckoutIncludeParam](README.md#checkoutincludeparam)
|
|
365
379
|
- [ComparableCheckout](README.md#comparablecheckout)
|
|
366
380
|
- [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
|
|
367
381
|
- [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
|
|
368
382
|
- [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
|
|
383
|
+
- [CustomerInitializeOptions](README.md#customerinitializeoptions)
|
|
369
384
|
- [FlashMessageType](README.md#flashmessagetype)
|
|
370
385
|
- [FormFieldFieldType](README.md#formfieldfieldtype)
|
|
371
386
|
- [FormFieldType](README.md#formfieldtype)
|
|
@@ -384,6 +399,7 @@
|
|
|
384
399
|
- [Omit](README.md#omit)
|
|
385
400
|
- [OrderPaymentInstrument](README.md#orderpaymentinstrument)
|
|
386
401
|
- [OrderPayments](README.md#orderpayments)
|
|
402
|
+
- [PaymentInitializeOptions](README.md#paymentinitializeoptions)
|
|
387
403
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
388
404
|
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
389
405
|
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
@@ -430,12 +446,18 @@ ___
|
|
|
430
446
|
|
|
431
447
|
### AmazonPayV2ButtonInitializeOptions
|
|
432
448
|
|
|
433
|
-
Ƭ **AmazonPayV2ButtonInitializeOptions**: [`
|
|
449
|
+
Ƭ **AmazonPayV2ButtonInitializeOptions**: [`AmazonPayV2ButtonParameters`](README.md#amazonpayv2buttonparameters)
|
|
434
450
|
|
|
435
451
|
The required config to render the AmazonPayV2 buttton.
|
|
436
452
|
|
|
437
453
|
___
|
|
438
454
|
|
|
455
|
+
### AmazonPayV2ButtonParameters
|
|
456
|
+
|
|
457
|
+
Ƭ **AmazonPayV2ButtonParameters**: [`AmazonPayV2ButtonParams`](interfaces/AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](interfaces/AmazonPayV2NewButtonParams.md)
|
|
458
|
+
|
|
459
|
+
___
|
|
460
|
+
|
|
439
461
|
### AnalyticStepType
|
|
440
462
|
|
|
441
463
|
Ƭ **AnalyticStepType**: ``"customer"`` \| ``"shipping"`` \| ``"billing"`` \| ``"payment"``
|
|
@@ -466,6 +488,12 @@ ___
|
|
|
466
488
|
|
|
467
489
|
___
|
|
468
490
|
|
|
491
|
+
### CheckoutButtonInitializeOptions
|
|
492
|
+
|
|
493
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
494
|
+
|
|
495
|
+
___
|
|
496
|
+
|
|
469
497
|
### CheckoutIncludeParam
|
|
470
498
|
|
|
471
499
|
Ƭ **CheckoutIncludeParam**: { [key in CheckoutIncludes]?: boolean }
|
|
@@ -496,6 +524,12 @@ ___
|
|
|
496
524
|
|
|
497
525
|
___
|
|
498
526
|
|
|
527
|
+
### CustomerInitializeOptions
|
|
528
|
+
|
|
529
|
+
Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
530
|
+
|
|
531
|
+
___
|
|
532
|
+
|
|
499
533
|
### FlashMessageType
|
|
500
534
|
|
|
501
535
|
Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``
|
|
@@ -611,6 +645,12 @@ ___
|
|
|
611
645
|
|
|
612
646
|
___
|
|
613
647
|
|
|
648
|
+
### PaymentInitializeOptions
|
|
649
|
+
|
|
650
|
+
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
651
|
+
|
|
652
|
+
___
|
|
653
|
+
|
|
614
654
|
### PaymentInstrument
|
|
615
655
|
|
|
616
656
|
Ƭ **PaymentInstrument**: [`CardInstrument`](interfaces/CardInstrument.md) \| [`AccountInstrument`](README.md#accountinstrument)
|
|
@@ -95,7 +95,7 @@ initializer.initializeButton({
|
|
|
95
95
|
|
|
96
96
|
| Name | Type | Description |
|
|
97
97
|
| :------ | :------ | :------ |
|
|
98
|
-
| `options` | [`CheckoutButtonInitializeOptions`](../
|
|
98
|
+
| `options` | [`CheckoutButtonInitializeOptions`](../README.md#checkoutbuttoninitializeoptions) | Options for initializing the checkout button. |
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -661,7 +661,7 @@ await service.initializeCustomer({
|
|
|
661
661
|
|
|
662
662
|
| Name | Type | Description |
|
|
663
663
|
| :------ | :------ | :------ |
|
|
664
|
-
| `options?` | [`CustomerInitializeOptions`](../
|
|
664
|
+
| `options?` | [`CustomerInitializeOptions`](../README.md#customerinitializeoptions) | Options for initializing the customer step of checkout. |
|
|
665
665
|
|
|
666
666
|
#### Returns
|
|
667
667
|
|
|
@@ -695,7 +695,7 @@ await service.initializePayment({
|
|
|
695
695
|
|
|
696
696
|
| Name | Type | Description |
|
|
697
697
|
| :------ | :------ | :------ |
|
|
698
|
-
| `options` | [`PaymentInitializeOptions`](../
|
|
698
|
+
| `options` | [`PaymentInitializeOptions`](../README.md#paymentinitializeoptions) | Options for initializing the payment step of checkout. |
|
|
699
699
|
|
|
700
700
|
#### Returns
|
|
701
701
|
|
|
@@ -0,0 +1,29 @@
|
|
|
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** = `"encryptedCardNumber"`
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### ExpiryDate
|
|
22
|
+
|
|
23
|
+
• **ExpiryDate** = `"encryptedExpiryDate"`
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### SecurityCode
|
|
28
|
+
|
|
29
|
+
• **SecurityCode** = `"encryptedSecurityCode"`
|
|
@@ -0,0 +1,29 @@
|
|
|
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** = `"encryptedCardNumber"`
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### ExpiryDate
|
|
22
|
+
|
|
23
|
+
• **ExpiryDate** = `"encryptedExpiryDate"`
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### SecurityCode
|
|
28
|
+
|
|
29
|
+
• **SecurityCode** = `"encryptedSecurityCode"`
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonColor
|
|
2
|
+
|
|
3
|
+
# Enumeration: AmazonPayV2ButtonColor
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration members
|
|
8
|
+
|
|
9
|
+
- [DarkGray](AmazonPayV2ButtonColor.md#darkgray)
|
|
10
|
+
- [Gold](AmazonPayV2ButtonColor.md#gold)
|
|
11
|
+
- [LightGray](AmazonPayV2ButtonColor.md#lightgray)
|
|
12
|
+
|
|
13
|
+
## Enumeration members
|
|
14
|
+
|
|
15
|
+
### DarkGray
|
|
16
|
+
|
|
17
|
+
• **DarkGray** = `"DarkGray"`
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### Gold
|
|
22
|
+
|
|
23
|
+
• **Gold** = `"Gold"`
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### LightGray
|
|
28
|
+
|
|
29
|
+
• **LightGray** = `"LightGray"`
|
|
@@ -49,7 +49,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
49
49
|
|
|
50
50
|
| Name | Type |
|
|
51
51
|
| :------ | :------ |
|
|
52
|
-
| `state` | [`
|
|
52
|
+
| `state` | [`AdyenV2ValidationState`](AdyenV2ValidationState.md) |
|
|
53
53
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
54
54
|
|
|
55
55
|
#### Returns
|
|
@@ -66,7 +66,7 @@ ___
|
|
|
66
66
|
|
|
67
67
|
| Name | Type |
|
|
68
68
|
| :------ | :------ |
|
|
69
|
-
| `state` | [`
|
|
69
|
+
| `state` | [`AdyenV2ValidationState`](AdyenV2ValidationState.md) |
|
|
70
70
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
71
71
|
|
|
72
72
|
#### Returns
|
|
@@ -49,7 +49,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
49
49
|
|
|
50
50
|
| Name | Type |
|
|
51
51
|
| :------ | :------ |
|
|
52
|
-
| `state` | [`
|
|
52
|
+
| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
|
|
53
53
|
| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
|
|
54
54
|
|
|
55
55
|
#### Returns
|
|
@@ -66,7 +66,7 @@ ___
|
|
|
66
66
|
|
|
67
67
|
| Name | Type |
|
|
68
68
|
| :------ | :------ |
|
|
69
|
-
| `state` | [`
|
|
69
|
+
| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
|
|
70
70
|
| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
|
|
71
71
|
|
|
72
72
|
#### Returns
|
|
@@ -152,7 +152,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
152
152
|
|
|
153
153
|
| Name | Type |
|
|
154
154
|
| :------ | :------ |
|
|
155
|
-
| `state` | [`
|
|
155
|
+
| `state` | [`AdyenV2ValidationState`](AdyenV2ValidationState.md) |
|
|
156
156
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
157
157
|
|
|
158
158
|
#### Returns
|
|
@@ -173,7 +173,7 @@ ___
|
|
|
173
173
|
|
|
174
174
|
| Name | Type |
|
|
175
175
|
| :------ | :------ |
|
|
176
|
-
| `state` | [`
|
|
176
|
+
| `state` | [`AdyenV2ValidationState`](AdyenV2ValidationState.md) |
|
|
177
177
|
| `component` | [`AdyenComponent`](AdyenComponent.md) |
|
|
178
178
|
|
|
179
179
|
#### Returns
|
|
@@ -148,13 +148,13 @@ Use additionalActionOptions instead as this property will be removed in the futu
|
|
|
148
148
|
|
|
149
149
|
### validateCardFields
|
|
150
150
|
|
|
151
|
-
▸ **validateCardFields**(`
|
|
151
|
+
▸ **validateCardFields**(`validateState`): `void`
|
|
152
152
|
|
|
153
153
|
#### Parameters
|
|
154
154
|
|
|
155
155
|
| Name | Type |
|
|
156
156
|
| :------ | :------ |
|
|
157
|
-
| `
|
|
157
|
+
| `validateState` | [`AdyenV2ValidationState`](AdyenV2ValidationState.md) |
|
|
158
158
|
|
|
159
159
|
#### Returns
|
|
160
160
|
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AdyenV2ValidationState
|
|
2
|
+
|
|
3
|
+
# Interface: AdyenV2ValidationState
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [encryptedFieldName](AdyenV2ValidationState.md#encryptedfieldname)
|
|
10
|
+
- [endDigits](AdyenV2ValidationState.md#enddigits)
|
|
11
|
+
- [error](AdyenV2ValidationState.md#error)
|
|
12
|
+
- [errorKey](AdyenV2ValidationState.md#errorkey)
|
|
13
|
+
- [fieldType](AdyenV2ValidationState.md#fieldtype)
|
|
14
|
+
- [i18n](AdyenV2ValidationState.md#i18n)
|
|
15
|
+
- [valid](AdyenV2ValidationState.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/AdyenV2CardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenV2CardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenV2CardFields.md#expirydate)
|
|
46
|
+
|
|
47
|
+
___
|
|
48
|
+
|
|
49
|
+
### i18n
|
|
50
|
+
|
|
51
|
+
• `Optional` **i18n**: `string`
|
|
52
|
+
|
|
53
|
+
___
|
|
54
|
+
|
|
55
|
+
### valid
|
|
56
|
+
|
|
57
|
+
• **valid**: `boolean`
|
|
@@ -152,7 +152,7 @@ Called in case of an invalid card number, invalid expiry date, or
|
|
|
152
152
|
|
|
153
153
|
| Name | Type |
|
|
154
154
|
| :------ | :------ |
|
|
155
|
-
| `state` | [`
|
|
155
|
+
| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
|
|
156
156
|
| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
|
|
157
157
|
|
|
158
158
|
#### Returns
|
|
@@ -173,7 +173,7 @@ ___
|
|
|
173
173
|
|
|
174
174
|
| Name | Type |
|
|
175
175
|
| :------ | :------ |
|
|
176
|
-
| `state` | [`
|
|
176
|
+
| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
|
|
177
177
|
| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
|
|
178
178
|
|
|
179
179
|
#### Returns
|
|
@@ -122,13 +122,13 @@ ___
|
|
|
122
122
|
|
|
123
123
|
### validateCardFields
|
|
124
124
|
|
|
125
|
-
▸ **validateCardFields**(`
|
|
125
|
+
▸ **validateCardFields**(`validateState`): `void`
|
|
126
126
|
|
|
127
127
|
#### Parameters
|
|
128
128
|
|
|
129
129
|
| Name | Type |
|
|
130
130
|
| :------ | :------ |
|
|
131
|
-
| `
|
|
131
|
+
| `validateState` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
|
|
132
132
|
|
|
133
133
|
#### Returns
|
|
134
134
|
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AdyenV3ValidationState
|
|
2
|
+
|
|
3
|
+
# Interface: AdyenV3ValidationState
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [encryptedFieldName](AdyenV3ValidationState.md#encryptedfieldname)
|
|
10
|
+
- [endDigits](AdyenV3ValidationState.md#enddigits)
|
|
11
|
+
- [error](AdyenV3ValidationState.md#error)
|
|
12
|
+
- [errorKey](AdyenV3ValidationState.md#errorkey)
|
|
13
|
+
- [fieldType](AdyenV3ValidationState.md#fieldtype)
|
|
14
|
+
- [i18n](AdyenV3ValidationState.md#i18n)
|
|
15
|
+
- [valid](AdyenV3ValidationState.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/AdyenV3CardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenV3CardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenV3CardFields.md#expirydate)
|
|
46
|
+
|
|
47
|
+
___
|
|
48
|
+
|
|
49
|
+
### i18n
|
|
50
|
+
|
|
51
|
+
• `Optional` **i18n**: `string`
|
|
52
|
+
|
|
53
|
+
___
|
|
54
|
+
|
|
55
|
+
### valid
|
|
56
|
+
|
|
57
|
+
• **valid**: `boolean`
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonConfig
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2ButtonConfig
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- **`AmazonPayV2ButtonConfig`**
|
|
8
|
+
|
|
9
|
+
↳ [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
|
|
10
|
+
|
|
11
|
+
↳ [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
|
|
12
|
+
|
|
13
|
+
## Table of contents
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
- [buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
18
|
+
- [checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
19
|
+
- [ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
20
|
+
- [merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
21
|
+
- [placement](AmazonPayV2ButtonConfig.md#placement)
|
|
22
|
+
- [productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
23
|
+
- [sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
### buttonColor
|
|
28
|
+
|
|
29
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
30
|
+
|
|
31
|
+
Color of the Amazon Pay button.
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### checkoutLanguage
|
|
36
|
+
|
|
37
|
+
• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
|
|
38
|
+
|
|
39
|
+
Language used to render the button and text on Amazon Pay hosted pages.
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### ledgerCurrency
|
|
44
|
+
|
|
45
|
+
• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
|
|
46
|
+
|
|
47
|
+
Ledger currency provided during registration for the given merchant identifier.
|
|
48
|
+
|
|
49
|
+
___
|
|
50
|
+
|
|
51
|
+
### merchantId
|
|
52
|
+
|
|
53
|
+
• **merchantId**: `string`
|
|
54
|
+
|
|
55
|
+
Amazon Pay merchant account identifier.
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### placement
|
|
60
|
+
|
|
61
|
+
• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
|
|
62
|
+
|
|
63
|
+
Placement of the Amazon Pay button on your website.
|
|
64
|
+
|
|
65
|
+
___
|
|
66
|
+
|
|
67
|
+
### productType
|
|
68
|
+
|
|
69
|
+
• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
|
|
70
|
+
|
|
71
|
+
Product type selected for checkout. Default is 'PayAndShip'.
|
|
72
|
+
|
|
73
|
+
___
|
|
74
|
+
|
|
75
|
+
### sandbox
|
|
76
|
+
|
|
77
|
+
• `Optional` **sandbox**: `boolean`
|
|
78
|
+
|
|
79
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
80
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
@@ -2,10 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: AmazonPayV2ButtonParams
|
|
4
4
|
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
|
|
8
|
+
|
|
9
|
+
↳ **`AmazonPayV2ButtonParams`**
|
|
10
|
+
|
|
5
11
|
## Table of contents
|
|
6
12
|
|
|
7
13
|
### Properties
|
|
8
14
|
|
|
15
|
+
- [buttonColor](AmazonPayV2ButtonParams.md#buttoncolor)
|
|
9
16
|
- [checkoutLanguage](AmazonPayV2ButtonParams.md#checkoutlanguage)
|
|
10
17
|
- [createCheckoutSession](AmazonPayV2ButtonParams.md#createcheckoutsession)
|
|
11
18
|
- [ledgerCurrency](AmazonPayV2ButtonParams.md#ledgercurrency)
|
|
@@ -16,12 +23,28 @@
|
|
|
16
23
|
|
|
17
24
|
## Properties
|
|
18
25
|
|
|
26
|
+
### buttonColor
|
|
27
|
+
|
|
28
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
29
|
+
|
|
30
|
+
Color of the Amazon Pay button.
|
|
31
|
+
|
|
32
|
+
#### Inherited from
|
|
33
|
+
|
|
34
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
35
|
+
|
|
36
|
+
___
|
|
37
|
+
|
|
19
38
|
### checkoutLanguage
|
|
20
39
|
|
|
21
40
|
• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
|
|
22
41
|
|
|
23
42
|
Language used to render the button and text on Amazon Pay hosted pages.
|
|
24
43
|
|
|
44
|
+
#### Inherited from
|
|
45
|
+
|
|
46
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
47
|
+
|
|
25
48
|
___
|
|
26
49
|
|
|
27
50
|
### createCheckoutSession
|
|
@@ -38,6 +61,10 @@ ___
|
|
|
38
61
|
|
|
39
62
|
Ledger currency provided during registration for the given merchant identifier.
|
|
40
63
|
|
|
64
|
+
#### Inherited from
|
|
65
|
+
|
|
66
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
67
|
+
|
|
41
68
|
___
|
|
42
69
|
|
|
43
70
|
### merchantId
|
|
@@ -46,6 +73,10 @@ ___
|
|
|
46
73
|
|
|
47
74
|
Amazon Pay merchant account identifier.
|
|
48
75
|
|
|
76
|
+
#### Inherited from
|
|
77
|
+
|
|
78
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
79
|
+
|
|
49
80
|
___
|
|
50
81
|
|
|
51
82
|
### placement
|
|
@@ -54,6 +85,10 @@ ___
|
|
|
54
85
|
|
|
55
86
|
Placement of the Amazon Pay button on your website.
|
|
56
87
|
|
|
88
|
+
#### Inherited from
|
|
89
|
+
|
|
90
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
|
|
91
|
+
|
|
57
92
|
___
|
|
58
93
|
|
|
59
94
|
### productType
|
|
@@ -62,10 +97,19 @@ ___
|
|
|
62
97
|
|
|
63
98
|
Product type selected for checkout. Default is 'PayAndShip'.
|
|
64
99
|
|
|
100
|
+
#### Inherited from
|
|
101
|
+
|
|
102
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
103
|
+
|
|
65
104
|
___
|
|
66
105
|
|
|
67
106
|
### sandbox
|
|
68
107
|
|
|
69
108
|
• `Optional` **sandbox**: `boolean`
|
|
70
109
|
|
|
71
|
-
Sets button to Sandbox environment.
|
|
110
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
111
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
112
|
+
|
|
113
|
+
#### Inherited from
|
|
114
|
+
|
|
115
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|