@bigcommerce/checkout-sdk 1.369.0 → 1.369.2

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.
Files changed (27) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/dist/checkout-button.js +1 -1
  3. package/dist/checkout-button.js.map +1 -1
  4. package/dist/checkout-button.umd.js +1 -1
  5. package/dist/checkout-button.umd.js.map +1 -1
  6. package/dist/checkout-sdk.d.ts +95 -214
  7. package/dist/checkout-sdk.js +1 -1
  8. package/dist/checkout-sdk.js.map +1 -1
  9. package/dist/checkout-sdk.umd.js +1 -1
  10. package/dist/checkout-sdk.umd.js.map +1 -1
  11. package/docs/README.md +4 -51
  12. package/docs/interfaces/BasePaymentInitializeOptions.md +1 -1
  13. package/docs/interfaces/DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions.md +17 -0
  14. package/docs/interfaces/{PaypalCommerceCreditCardPaymentInitializeOptions.md → PayPalCommerceCreditCardsPaymentInitializeOptions.md} +8 -8
  15. package/docs/interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md +22 -0
  16. package/package.json +1 -1
  17. package/docs/enums/PaypalCommerceFormFieldType.md +0 -50
  18. package/docs/interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md +0 -15
  19. package/docs/interfaces/PaypalCommerceFormFieldKeyboardEventData.md +0 -15
  20. package/docs/interfaces/PaypalCommerceFormFieldOptions.md +0 -28
  21. package/docs/interfaces/PaypalCommerceFormFieldStylesMap.md +0 -29
  22. package/docs/interfaces/PaypalCommerceFormFieldValidateErrorData.md +0 -29
  23. package/docs/interfaces/PaypalCommerceFormFieldValidateEventData.md +0 -33
  24. package/docs/interfaces/PaypalCommerceFormFieldsMap.md +0 -36
  25. package/docs/interfaces/PaypalCommerceFormOptions.md +0 -148
  26. package/docs/interfaces/PaypalCommerceStoredCardFieldOptions.md +0 -43
  27. package/docs/interfaces/PaypalCommerceStoredCardFieldsMap.md +0 -22
package/docs/README.md CHANGED
@@ -27,7 +27,6 @@
27
27
  - [PaypalButtonStyleLayoutOption](enums/PaypalButtonStyleLayoutOption.md)
28
28
  - [PaypalButtonStyleShapeOption](enums/PaypalButtonStyleShapeOption.md)
29
29
  - [PaypalButtonStyleSizeOption](enums/PaypalButtonStyleSizeOption.md)
30
- - [PaypalCommerceFormFieldType](enums/PaypalCommerceFormFieldType.md)
31
30
  - [RadiusUnit](enums/RadiusUnit.md)
32
31
  - [StyleButtonColor](enums/StyleButtonColor.md)
33
32
  - [StyleButtonLabel](enums/StyleButtonLabel.md)
@@ -192,6 +191,7 @@
192
191
  - [CustomerGroup](interfaces/CustomerGroup.md)
193
192
  - [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
194
193
  - [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
194
+ - [DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions.md)
195
195
  - [DigitalItem](interfaces/DigitalItem.md)
196
196
  - [DigitalRiverElementClasses](interfaces/DigitalRiverElementClasses.md)
197
197
  - [DigitalRiverPaymentInitializeOptions](interfaces/DigitalRiverPaymentInitializeOptions.md)
@@ -285,6 +285,7 @@
285
285
  - [PayPalBuyNowInitializeOptions](interfaces/PayPalBuyNowInitializeOptions.md)
286
286
  - [PayPalCommerceButtonInitializeOptions](interfaces/PayPalCommerceButtonInitializeOptions.md)
287
287
  - [PayPalCommerceCreditButtonInitializeOptions](interfaces/PayPalCommerceCreditButtonInitializeOptions.md)
288
+ - [PayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/PayPalCommerceCreditCardsPaymentInitializeOptions.md)
288
289
  - [PayPalCommerceCreditCustomerInitializeOptions](interfaces/PayPalCommerceCreditCustomerInitializeOptions.md)
289
290
  - [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
290
291
  - [PayPalCommerceInlineButtonInitializeOptions](interfaces/PayPalCommerceInlineButtonInitializeOptions.md)
@@ -296,18 +297,7 @@
296
297
  - [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
297
298
  - [PaymentSettings](interfaces/PaymentSettings.md)
298
299
  - [PaypalButtonInitializeOptions](interfaces/PaypalButtonInitializeOptions.md)
299
- - [PaypalCommerceCreditCardPaymentInitializeOptions](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
300
- - [PaypalCommerceFormFieldCardTypeChangeEventData](interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md)
301
- - [PaypalCommerceFormFieldKeyboardEventData](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
302
- - [PaypalCommerceFormFieldOptions](interfaces/PaypalCommerceFormFieldOptions.md)
303
- - [PaypalCommerceFormFieldStylesMap](interfaces/PaypalCommerceFormFieldStylesMap.md)
304
- - [PaypalCommerceFormFieldValidateErrorData](interfaces/PaypalCommerceFormFieldValidateErrorData.md)
305
- - [PaypalCommerceFormFieldValidateEventData](interfaces/PaypalCommerceFormFieldValidateEventData.md)
306
- - [PaypalCommerceFormFieldsMap](interfaces/PaypalCommerceFormFieldsMap.md)
307
- - [PaypalCommerceFormOptions](interfaces/PaypalCommerceFormOptions.md)
308
300
  - [PaypalCommercePaymentInitializeOptions](interfaces/PaypalCommercePaymentInitializeOptions.md)
309
- - [PaypalCommerceStoredCardFieldOptions](interfaces/PaypalCommerceStoredCardFieldOptions.md)
310
- - [PaypalCommerceStoredCardFieldsMap](interfaces/PaypalCommerceStoredCardFieldsMap.md)
311
301
  - [PaypalExpressPaymentInitializeOptions](interfaces/PaypalExpressPaymentInitializeOptions.md)
312
302
  - [PaypalFieldsStyleOptions](interfaces/PaypalFieldsStyleOptions.md)
313
303
  - [PaypalStyleOptions](interfaces/PaypalStyleOptions.md)
@@ -385,6 +375,7 @@
385
375
  - [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
386
376
  - [WithPayPalCommerceButtonInitializeOptions](interfaces/WithPayPalCommerceButtonInitializeOptions.md)
387
377
  - [WithPayPalCommerceCreditButtonInitializeOptions](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md)
378
+ - [WithPayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md)
388
379
  - [WithPayPalCommerceCreditCustomerInitializeOptions](interfaces/WithPayPalCommerceCreditCustomerInitializeOptions.md)
389
380
  - [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
390
381
  - [WithPayPalCommerceInlineButtonInitializeOptions](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md)
@@ -439,11 +430,6 @@
439
430
  - [OrderPayments](README.md#orderpayments)
440
431
  - [PaymentInitializeOptions](README.md#paymentinitializeoptions)
441
432
  - [PaymentInstrument](README.md#paymentinstrument)
442
- - [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
443
- - [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
444
- - [PaypalCommerceFormFieldFocusEventData](README.md#paypalcommerceformfieldfocuseventdata)
445
- - [PaypalCommerceFormFieldStyles](README.md#paypalcommerceformfieldstyles)
446
- - [PaypalCommerceInitializeOptions](README.md#paypalcommerceinitializeoptions)
447
433
  - [StripeElementOptions](README.md#stripeelementoptions)
448
434
  - [StripeEventType](README.md#stripeeventtype)
449
435
 
@@ -717,7 +703,7 @@ ___
717
703
 
718
704
  ### PaymentInitializeOptions
719
705
 
720
- Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
706
+ Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
721
707
 
722
708
  ___
723
709
 
@@ -727,39 +713,6 @@ ___
727
713
 
728
714
  ___
729
715
 
730
- ### PaypalCommerceFormFieldBlurEventData
731
-
732
- Ƭ **PaypalCommerceFormFieldBlurEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
733
-
734
- ___
735
-
736
- ### PaypalCommerceFormFieldEnterEventData
737
-
738
- Ƭ **PaypalCommerceFormFieldEnterEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
739
-
740
- ___
741
-
742
- ### PaypalCommerceFormFieldFocusEventData
743
-
744
- Ƭ **PaypalCommerceFormFieldFocusEventData**: [`PaypalCommerceFormFieldKeyboardEventData`](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
745
-
746
- ___
747
-
748
- ### PaypalCommerceFormFieldStyles
749
-
750
- Ƭ **PaypalCommerceFormFieldStyles**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
751
-
752
- ___
753
-
754
- ### PaypalCommerceInitializeOptions
755
-
756
- Ƭ **PaypalCommerceInitializeOptions**: [`PaypalCommercePaymentInitializeOptions`](interfaces/PaypalCommercePaymentInitializeOptions.md) \| [`PaypalCommerceCreditCardPaymentInitializeOptions`](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
757
-
758
- A set of options that are required to initialize the PayPal Commerce payment
759
- method could be used for PayPal Smart Payment Buttons or PayPal Credit Card methods.
760
-
761
- ___
762
-
763
716
  ### StripeElementOptions
764
717
 
765
718
  Ƭ **StripeElementOptions**: [`CardElementOptions`](interfaces/CardElementOptions.md) \| [`CardExpiryElementOptions`](interfaces/CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](interfaces/CardNumberElementOptions.md) \| [`CardCvcElementOptions`](interfaces/CardCvcElementOptions.md) \| [`IdealElementOptions`](interfaces/IdealElementOptions.md) \| [`IbanElementOptions`](interfaces/IbanElementOptions.md) \| [`ZipCodeElementOptions`](interfaces/ZipCodeElementOptions.md)
@@ -301,7 +301,7 @@ ___
301
301
 
302
302
  ### paypalcommerce
303
303
 
304
- • `Optional` **paypalcommerce**: [`PaypalCommercePaymentInitializeOptions`](PaypalCommercePaymentInitializeOptions.md) \| [`PaypalCommerceCreditCardPaymentInitializeOptions`](PaypalCommerceCreditCardPaymentInitializeOptions.md)
304
+ • `Optional` **paypalcommerce**: [`PaypalCommercePaymentInitializeOptions`](PaypalCommercePaymentInitializeOptions.md)
305
305
 
306
306
  The options that are required to initialize the PayPal Commerce payment method.
307
307
  They can be omitted unless you need to support PayPal Commerce.
@@ -0,0 +1,17 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions
2
+
3
+ # Interface: DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [form](DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions.md#form)
10
+
11
+ ## Properties
12
+
13
+ ### form
14
+
15
+ • `Optional` **form**: `default`
16
+
17
+ The form is data for Credit Card Form
@@ -1,6 +1,6 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceCreditCardPaymentInitializeOptions
1
+ [@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceCreditCardsPaymentInitializeOptions
2
2
 
3
- # Interface: PaypalCommerceCreditCardPaymentInitializeOptions
3
+ # Interface: PayPalCommerceCreditCardsPaymentInitializeOptions
4
4
 
5
5
  A set of options that are required to initialize the PayPal Commerce payment
6
6
  method for presenting its credit card form.
@@ -15,8 +15,8 @@ method for presenting its credit card form.
15
15
 
16
16
  ```js
17
17
  service.initializePayment({
18
- methodId: 'paypalcommerce',
19
- paypalcommerce: {
18
+ methodId: 'paypalcommercecreditcard',
19
+ paypalcommercecreditcard: {
20
20
  form: {
21
21
  fields: {
22
22
  cardNumber: { containerId: 'card-number' },
@@ -34,8 +34,8 @@ event callbacks.
34
34
 
35
35
  ```js
36
36
  service.initializePayment({
37
- methodId: 'paypalcommerce',
38
- creditCard: {
37
+ methodId: 'paypalcommercecreditcard',
38
+ paypalcommercecreditcard: {
39
39
  form: {
40
40
  fields: {
41
41
  cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
@@ -79,12 +79,12 @@ service.initializePayment({
79
79
 
80
80
  ### Properties
81
81
 
82
- - [form](PaypalCommerceCreditCardPaymentInitializeOptions.md#form)
82
+ - [form](PayPalCommerceCreditCardsPaymentInitializeOptions.md#form)
83
83
 
84
84
  ## Properties
85
85
 
86
86
  ### form
87
87
 
88
- • **form**: [`PaypalCommerceFormOptions`](PaypalCommerceFormOptions.md)
88
+ • **form**: `default`
89
89
 
90
90
  The form is data for Credit Card Form
@@ -0,0 +1,22 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceCreditCardsPaymentInitializeOptions
2
+
3
+ # Interface: WithPayPalCommerceCreditCardsPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [paypalcommerce](WithPayPalCommerceCreditCardsPaymentInitializeOptions.md#paypalcommerce)
10
+ - [paypalcommercecreditcards](WithPayPalCommerceCreditCardsPaymentInitializeOptions.md#paypalcommercecreditcards)
11
+
12
+ ## Properties
13
+
14
+ ### paypalcommerce
15
+
16
+ • `Optional` **paypalcommerce**: [`DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions`](DeprecatedPayPalCommerceCreditCardsPaymentInitializeOptions.md)
17
+
18
+ ___
19
+
20
+ ### paypalcommercecreditcards
21
+
22
+ • `Optional` **paypalcommercecreditcards**: [`PayPalCommerceCreditCardsPaymentInitializeOptions`](PayPalCommerceCreditCardsPaymentInitializeOptions.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.369.0",
3
+ "version": "1.369.2",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",
@@ -1,50 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldType
2
-
3
- # Enumeration: PaypalCommerceFormFieldType
4
-
5
- ## Table of contents
6
-
7
- ### Enumeration Members
8
-
9
- - [CardCode](PaypalCommerceFormFieldType.md#cardcode)
10
- - [CardCodeVerification](PaypalCommerceFormFieldType.md#cardcodeverification)
11
- - [CardExpiry](PaypalCommerceFormFieldType.md#cardexpiry)
12
- - [CardName](PaypalCommerceFormFieldType.md#cardname)
13
- - [CardNumber](PaypalCommerceFormFieldType.md#cardnumber)
14
- - [CardNumberVerification](PaypalCommerceFormFieldType.md#cardnumberverification)
15
-
16
- ## Enumeration Members
17
-
18
- ### CardCode
19
-
20
- • **CardCode**
21
-
22
- ___
23
-
24
- ### CardCodeVerification
25
-
26
- • **CardCodeVerification**
27
-
28
- ___
29
-
30
- ### CardExpiry
31
-
32
- • **CardExpiry**
33
-
34
- ___
35
-
36
- ### CardName
37
-
38
- • **CardName**
39
-
40
- ___
41
-
42
- ### CardNumber
43
-
44
- • **CardNumber**
45
-
46
- ___
47
-
48
- ### CardNumberVerification
49
-
50
- • **CardNumberVerification**
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldCardTypeChangeEventData
2
-
3
- # Interface: PaypalCommerceFormFieldCardTypeChangeEventData
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [cardType](PaypalCommerceFormFieldCardTypeChangeEventData.md#cardtype)
10
-
11
- ## Properties
12
-
13
- ### cardType
14
-
15
- • `Optional` **cardType**: `string`
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldKeyboardEventData
2
-
3
- # Interface: PaypalCommerceFormFieldKeyboardEventData
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [fieldType](PaypalCommerceFormFieldKeyboardEventData.md#fieldtype)
10
-
11
- ## Properties
12
-
13
- ### fieldType
14
-
15
- • **fieldType**: `string`
@@ -1,28 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldOptions
2
-
3
- # Interface: PaypalCommerceFormFieldOptions
4
-
5
- ## Hierarchy
6
-
7
- - **`PaypalCommerceFormFieldOptions`**
8
-
9
- ↳ [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [containerId](PaypalCommerceFormFieldOptions.md#containerid)
16
- - [placeholder](PaypalCommerceFormFieldOptions.md#placeholder)
17
-
18
- ## Properties
19
-
20
- ### containerId
21
-
22
- • **containerId**: `string`
23
-
24
- ___
25
-
26
- ### placeholder
27
-
28
- • `Optional` **placeholder**: `string`
@@ -1,29 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldStylesMap
2
-
3
- # Interface: PaypalCommerceFormFieldStylesMap
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [default](PaypalCommerceFormFieldStylesMap.md#default)
10
- - [error](PaypalCommerceFormFieldStylesMap.md#error)
11
- - [focus](PaypalCommerceFormFieldStylesMap.md#focus)
12
-
13
- ## Properties
14
-
15
- ### default
16
-
17
- • `Optional` **default**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
18
-
19
- ___
20
-
21
- ### error
22
-
23
- • `Optional` **error**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
24
-
25
- ___
26
-
27
- ### focus
28
-
29
- • `Optional` **focus**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
@@ -1,29 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldValidateErrorData
2
-
3
- # Interface: PaypalCommerceFormFieldValidateErrorData
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [fieldType](PaypalCommerceFormFieldValidateErrorData.md#fieldtype)
10
- - [message](PaypalCommerceFormFieldValidateErrorData.md#message)
11
- - [type](PaypalCommerceFormFieldValidateErrorData.md#type)
12
-
13
- ## Properties
14
-
15
- ### fieldType
16
-
17
- • **fieldType**: `string`
18
-
19
- ___
20
-
21
- ### message
22
-
23
- • **message**: `string`
24
-
25
- ___
26
-
27
- ### type
28
-
29
- • **type**: `string`
@@ -1,33 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldValidateEventData
2
-
3
- # Interface: PaypalCommerceFormFieldValidateEventData
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [errors](PaypalCommerceFormFieldValidateEventData.md#errors)
10
- - [isValid](PaypalCommerceFormFieldValidateEventData.md#isvalid)
11
-
12
- ## Properties
13
-
14
- ### errors
15
-
16
- • **errors**: `Object`
17
-
18
- #### Type declaration
19
-
20
- | Name | Type |
21
- | :------ | :------ |
22
- | `cardCode?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
23
- | `cardCodeVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
24
- | `cardExpiry?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
25
- | `cardName?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
26
- | `cardNumber?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
27
- | `cardNumberVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](PaypalCommerceFormFieldValidateErrorData.md)[] |
28
-
29
- ___
30
-
31
- ### isValid
32
-
33
- • **isValid**: `boolean`
@@ -1,36 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldsMap
2
-
3
- # Interface: PaypalCommerceFormFieldsMap
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [cardCode](PaypalCommerceFormFieldsMap.md#cardcode)
10
- - [cardExpiry](PaypalCommerceFormFieldsMap.md#cardexpiry)
11
- - [cardName](PaypalCommerceFormFieldsMap.md#cardname)
12
- - [cardNumber](PaypalCommerceFormFieldsMap.md#cardnumber)
13
-
14
- ## Properties
15
-
16
- ### cardCode
17
-
18
- • `Optional` **cardCode**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
19
-
20
- ___
21
-
22
- ### cardExpiry
23
-
24
- • **cardExpiry**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
25
-
26
- ___
27
-
28
- ### cardName
29
-
30
- • **cardName**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
31
-
32
- ___
33
-
34
- ### cardNumber
35
-
36
- • **cardNumber**: [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
@@ -1,148 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormOptions
2
-
3
- # Interface: PaypalCommerceFormOptions
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [fields](PaypalCommerceFormOptions.md#fields)
10
- - [styles](PaypalCommerceFormOptions.md#styles)
11
-
12
- ### Methods
13
-
14
- - [onBlur](PaypalCommerceFormOptions.md#onblur)
15
- - [onCardTypeChange](PaypalCommerceFormOptions.md#oncardtypechange)
16
- - [onEnter](PaypalCommerceFormOptions.md#onenter)
17
- - [onFocus](PaypalCommerceFormOptions.md#onfocus)
18
- - [onValidate](PaypalCommerceFormOptions.md#onvalidate)
19
-
20
- ## Properties
21
-
22
- ### fields
23
-
24
- • **fields**: [`PaypalCommerceFormFieldsMap`](PaypalCommerceFormFieldsMap.md) \| [`PaypalCommerceStoredCardFieldsMap`](PaypalCommerceStoredCardFieldsMap.md)
25
-
26
- Containers for fields can be to present in one set of values
27
-
28
- ```js
29
- { cardNumber: { containerId: 'card-number' },
30
- cardName: { containerId: 'card-name' },
31
- cardExpiry: { containerId: 'card-expiry' },
32
- cardCode: { containerId: 'card-code' }, }
33
- ```
34
-
35
- Or in another set of values.
36
-
37
- ```js
38
- { cardCodeVerification: { containerId: 'card-number' },
39
- cardNumberVerification: { containerId: 'card-name' }, }
40
- ```
41
-
42
- ___
43
-
44
- ### styles
45
-
46
- • `Optional` **styles**: [`PaypalCommerceFormFieldStylesMap`](PaypalCommerceFormFieldStylesMap.md)
47
-
48
- Styles for inputs. Change the width, height and other styling.
49
-
50
- ```js
51
- default: { color: '#000' },
52
- error: { color: '#f00' },
53
- focus: { color: '#0f0' }
54
- ```
55
-
56
- ## Methods
57
-
58
- ### onBlur
59
-
60
- ▸ `Optional` **onBlur**(`data`): `void`
61
-
62
- A callback that gets called when a field loses focus.
63
-
64
- #### Parameters
65
-
66
- | Name | Type |
67
- | :------ | :------ |
68
- | `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
69
-
70
- #### Returns
71
-
72
- `void`
73
-
74
- ___
75
-
76
- ### onCardTypeChange
77
-
78
- ▸ `Optional` **onCardTypeChange**(`data`): `void`
79
-
80
- A callback that gets called when activity within
81
- the number field has changed such that the possible
82
- card type has changed.
83
-
84
- #### Parameters
85
-
86
- | Name | Type |
87
- | :------ | :------ |
88
- | `data` | [`PaypalCommerceFormFieldCardTypeChangeEventData`](PaypalCommerceFormFieldCardTypeChangeEventData.md) |
89
-
90
- #### Returns
91
-
92
- `void`
93
-
94
- ___
95
-
96
- ### onEnter
97
-
98
- ▸ `Optional` **onEnter**(`data`): `void`
99
-
100
- A callback that gets called when the user requests submission
101
- of an input field, by pressing the Enter or Return key
102
- on their keyboard, or mobile equivalent.
103
-
104
- #### Parameters
105
-
106
- | Name | Type |
107
- | :------ | :------ |
108
- | `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
109
-
110
- #### Returns
111
-
112
- `void`
113
-
114
- ___
115
-
116
- ### onFocus
117
-
118
- ▸ `Optional` **onFocus**(`data`): `void`
119
-
120
- A callback that gets called when a field gains focus.
121
-
122
- #### Parameters
123
-
124
- | Name | Type |
125
- | :------ | :------ |
126
- | `data` | [`PaypalCommerceFormFieldKeyboardEventData`](PaypalCommerceFormFieldKeyboardEventData.md) |
127
-
128
- #### Returns
129
-
130
- `void`
131
-
132
- ___
133
-
134
- ### onValidate
135
-
136
- ▸ `Optional` **onValidate**(`data`): `void`
137
-
138
- A callback that gets called when the validity of a field has changed.
139
-
140
- #### Parameters
141
-
142
- | Name | Type |
143
- | :------ | :------ |
144
- | `data` | [`PaypalCommerceFormFieldValidateEventData`](PaypalCommerceFormFieldValidateEventData.md) |
145
-
146
- #### Returns
147
-
148
- `void`
@@ -1,43 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceStoredCardFieldOptions
2
-
3
- # Interface: PaypalCommerceStoredCardFieldOptions
4
-
5
- ## Hierarchy
6
-
7
- - [`PaypalCommerceFormFieldOptions`](PaypalCommerceFormFieldOptions.md)
8
-
9
- ↳ **`PaypalCommerceStoredCardFieldOptions`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [containerId](PaypalCommerceStoredCardFieldOptions.md#containerid)
16
- - [instrumentId](PaypalCommerceStoredCardFieldOptions.md#instrumentid)
17
- - [placeholder](PaypalCommerceStoredCardFieldOptions.md#placeholder)
18
-
19
- ## Properties
20
-
21
- ### containerId
22
-
23
- • **containerId**: `string`
24
-
25
- #### Inherited from
26
-
27
- [PaypalCommerceFormFieldOptions](PaypalCommerceFormFieldOptions.md).[containerId](PaypalCommerceFormFieldOptions.md#containerid)
28
-
29
- ___
30
-
31
- ### instrumentId
32
-
33
- • **instrumentId**: `string`
34
-
35
- ___
36
-
37
- ### placeholder
38
-
39
- • `Optional` **placeholder**: `string`
40
-
41
- #### Inherited from
42
-
43
- [PaypalCommerceFormFieldOptions](PaypalCommerceFormFieldOptions.md).[placeholder](PaypalCommerceFormFieldOptions.md#placeholder)
@@ -1,22 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceStoredCardFieldsMap
2
-
3
- # Interface: PaypalCommerceStoredCardFieldsMap
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [cardCodeVerification](PaypalCommerceStoredCardFieldsMap.md#cardcodeverification)
10
- - [cardNumberVerification](PaypalCommerceStoredCardFieldsMap.md#cardnumberverification)
11
-
12
- ## Properties
13
-
14
- ### cardCodeVerification
15
-
16
- • `Optional` **cardCodeVerification**: [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)
17
-
18
- ___
19
-
20
- ### cardNumberVerification
21
-
22
- • `Optional` **cardNumberVerification**: [`PaypalCommerceStoredCardFieldOptions`](PaypalCommerceStoredCardFieldOptions.md)