@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.AdyenCreditCardComponentOptions.md

@@ -0,0 +1,187 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenCreditCardComponentOptions
+
+# Interface: AdyenCreditCardComponentOptions
+
+[<internal>](../modules/internal_.md).AdyenCreditCardComponentOptions
+
+## Hierarchy
+
+- [`AdyenBaseCardComponentOptions`](internal_.AdyenBaseCardComponentOptions.md)
+
+- [`AdyenComponentEvents`](internal_.AdyenComponentEvents.md)
+
+  ↳ **`AdyenCreditCardComponentOptions`**
+
+## Table of contents
+
+### Properties
+
+- [brands](internal_.AdyenCreditCardComponentOptions.md#brands)
+- [data](internal_.AdyenCreditCardComponentOptions.md#data)
+- [details](internal_.AdyenCreditCardComponentOptions.md#details)
+- [enableStoreDetails](internal_.AdyenCreditCardComponentOptions.md#enablestoredetails)
+- [groupTypes](internal_.AdyenCreditCardComponentOptions.md#grouptypes)
+- [hasHolderName](internal_.AdyenCreditCardComponentOptions.md#hasholdername)
+- [holderNameRequired](internal_.AdyenCreditCardComponentOptions.md#holdernamerequired)
+- [placeholders](internal_.AdyenCreditCardComponentOptions.md#placeholders)
+- [styles](internal_.AdyenCreditCardComponentOptions.md#styles)
+
+### Methods
+
+- [onChange](internal_.AdyenCreditCardComponentOptions.md#onchange)
+- [onError](internal_.AdyenCreditCardComponentOptions.md#onerror)
+- [onFieldValid](internal_.AdyenCreditCardComponentOptions.md#onfieldvalid)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+#### Inherited from
+
+[AdyenBaseCardComponentOptions](internal_.AdyenBaseCardComponentOptions.md).[brands](internal_.AdyenBaseCardComponentOptions.md#brands)
+
+___
+
+### data
+
+• `Optional` **data**: [`AdyenPlaceholderData`](internal_.AdyenPlaceholderData.md)
+
+Information to prefill fields.
+
+___
+
+### details
+
+• `Optional` **details**: [`InputDetail`](internal_.InputDetail.md)[]
+
+Set an object containing the details array for type: scheme from
+the /paymentMethods response.
+
+___
+
+### enableStoreDetails
+
+• `Optional` **enableStoreDetails**: `boolean`
+
+Set to true to show the checkbox to save card details for the next payment.
+
+___
+
+### groupTypes
+
+• `Optional` **groupTypes**: `string`[]
+
+Defaults to ['mc','visa','amex']. Configure supported card types to
+facilitate brand recognition used in the Secured Fields onBrand callback.
+See list of available card types. If a shopper enters a card type not
+specified in the GroupTypes configuration, the onBrand callback will not be invoked.
+
+___
+
+### hasHolderName
+
+• `Optional` **hasHolderName**: `boolean`
+
+Set to true to request the name of the card holder.
+
+___
+
+### holderNameRequired
+
+• `Optional` **holderNameRequired**: `boolean`
+
+Set to true to require the card holder name.
+
+___
+
+### placeholders
+
+• `Optional` **placeholders**: [`CreditCardPlaceHolder`](internal_.CreditCardPlaceHolder.md) \| [`SepaPlaceHolder`](internal_.SepaPlaceHolder.md)
+
+Specify the sample values you want to appear for card detail input fields.
+
+___
+
+### styles
+
+• `Optional` **styles**: [`StyleOptions`](internal_.StyleOptions.md)
+
+Set a style object to customize the input fields. See Styling Secured Fields
+for a list of supported properties.
+
+#### Inherited from
+
+[AdyenBaseCardComponentOptions](internal_.AdyenBaseCardComponentOptions.md).[styles](internal_.AdyenBaseCardComponentOptions.md#styles)
+
+## Methods
+
+### onChange
+
+▸ `Optional` **onChange**(`state`, `component`): `void`
+
+Called when the shopper enters data in the card input fields.
+Here you have the option to override your main Adyen Checkout configuration.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenComponentState`](../modules/internal_.md#adyencomponentstate) |
+| `component` | [`AdyenComponent`](internal_.AdyenComponent.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents](internal_.AdyenComponentEvents.md).[onChange](internal_.AdyenComponentEvents.md#onchange)
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`state`, `component`): `void`
+
+Called in case of an invalid card number, invalid expiry date, or
+ incomplete field. Called again when errors are cleared.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV2ValidationState`](internal_.AdyenV2ValidationState.md) |
+| `component` | [`AdyenComponent`](internal_.AdyenComponent.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents](internal_.AdyenComponentEvents.md).[onError](internal_.AdyenComponentEvents.md#onerror)
+
+___
+
+### onFieldValid
+
+▸ `Optional` **onFieldValid**(`state`, `component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV2ValidationState`](internal_.AdyenV2ValidationState.md) |
+| `component` | [`AdyenComponent`](internal_.AdyenComponent.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents](internal_.AdyenComponentEvents.md).[onFieldValid](internal_.AdyenComponentEvents.md#onfieldvalid)

package/docs/interfaces/internal_.AdyenIdealComponentOptions.md

@@ -0,0 +1,19 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenIdealComponentOptions
+
+# Interface: AdyenIdealComponentOptions
+
+[<internal>](../modules/internal_.md).AdyenIdealComponentOptions
+
+## Table of contents
+
+### Properties
+
+- [showImage](internal_.AdyenIdealComponentOptions.md#showimage)
+
+## Properties
+
+### showImage
+
+• `Optional` **showImage**: `boolean`
+
+Optional. Set to **false** to remove the bank logos from the iDEAL form.

package/docs/interfaces/internal_.AdyenPaymentMethodState.md

@@ -0,0 +1,23 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenPaymentMethodState
+
+# Interface: AdyenPaymentMethodState
+
+[<internal>](../modules/internal_.md).AdyenPaymentMethodState
+
+## Hierarchy
+
+- **`AdyenPaymentMethodState`**
+
+  ↳ [`CardPaymentMethodState`](internal_.CardPaymentMethodState.md)
+
+## Table of contents
+
+### Properties
+
+- [type](internal_.AdyenPaymentMethodState.md#type)
+
+## Properties
+
+### type
+
+• **type**: `string`

package/docs/interfaces/internal_.AdyenPaymentMethodState_2.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenPaymentMethodState\_2
+
+# Interface: AdyenPaymentMethodState\_2
+
+[<internal>](../modules/internal_.md).AdyenPaymentMethodState_2
+
+## Table of contents
+
+### Properties
+
+- [type](internal_.AdyenPaymentMethodState_2.md#type)
+
+## Properties
+
+### type
+
+• **type**: `string`

package/docs/interfaces/internal_.AdyenPlaceholderData.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenPlaceholderData
+
+# Interface: AdyenPlaceholderData
+
+[<internal>](../modules/internal_.md).AdyenPlaceholderData
+
+## Table of contents
+
+### Properties
+
+- [billingAddress](internal_.AdyenPlaceholderData.md#billingaddress)
+- [holderName](internal_.AdyenPlaceholderData.md#holdername)
+
+## Properties
+
+### billingAddress
+
+• `Optional` **billingAddress**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `city` | `string` |
+| `country` | `string` |
+| `houseNumberOrName` | `string` |
+| `postalCode` | `string` |
+| `stateOrProvince` | `string` |
+| `street` | `string` |
+
+___
+
+### holderName
+
+• `Optional` **holderName**: `string`

package/docs/interfaces/internal_.AdyenPlaceholderData_2.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenPlaceholderData\_2
+
+# Interface: AdyenPlaceholderData\_2
+
+[<internal>](../modules/internal_.md).AdyenPlaceholderData_2
+
+## Table of contents
+
+### Properties
+
+- [billingAddress](internal_.AdyenPlaceholderData_2.md#billingaddress)
+- [holderName](internal_.AdyenPlaceholderData_2.md#holdername)
+
+## Properties
+
+### billingAddress
+
+• `Optional` **billingAddress**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `city` | `string` |
+| `country` | `string` |
+| `houseNumberOrName` | `string` |
+| `postalCode` | `string` |
+| `stateOrProvince` | `string` |
+| `street` | `string` |
+
+___
+
+### holderName
+
+• `Optional` **holderName**: `string`

package/docs/interfaces/internal_.AdyenThreeDS2Options.md

@@ -0,0 +1,99 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenThreeDS2Options
+
+# Interface: AdyenThreeDS2Options
+
+[<internal>](../modules/internal_.md).AdyenThreeDS2Options
+
+## Hierarchy
+
+- [`AdyenAdditionalActionCallbacks`](internal_.AdyenAdditionalActionCallbacks.md)
+
+  ↳ **`AdyenThreeDS2Options`**
+
+## Table of contents
+
+### Properties
+
+- [widgetSize](internal_.AdyenThreeDS2Options.md#widgetsize)
+
+### Methods
+
+- [onBeforeLoad](internal_.AdyenThreeDS2Options.md#onbeforeload)
+- [onComplete](internal_.AdyenThreeDS2Options.md#oncomplete)
+- [onLoad](internal_.AdyenThreeDS2Options.md#onload)
+
+## Properties
+
+### widgetSize
+
+• `Optional` **widgetSize**: `string`
+
+Specify Three3DS2Challenge Widget Size
+
+Values
+'01' = 250px x 400px
+'02' = 390px x 400px
+'03' = 500px x 600px
+'04' = 600px x 400px
+'05' = 100% x 100%
+
+## Methods
+
+### onBeforeLoad
+
+▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
+
+A callback that gets called before adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shopperInteraction?` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](internal_.AdyenAdditionalActionCallbacks.md).[onBeforeLoad](internal_.AdyenAdditionalActionCallbacks.md#onbeforeload)
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](internal_.AdyenAdditionalActionCallbacks.md).[onComplete](internal_.AdyenAdditionalActionCallbacks.md#oncomplete)
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`cancel?`): `void`
+
+A callback that gets called when adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cancel?` | () => `void` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](internal_.AdyenAdditionalActionCallbacks.md).[onLoad](internal_.AdyenAdditionalActionCallbacks.md#onload)

package/docs/interfaces/internal_.AdyenV2PaymentInitializeOptions.md

@@ -0,0 +1,162 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV2PaymentInitializeOptions
+
+# Interface: AdyenV2PaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).AdyenV2PaymentInitializeOptions
+
+A set of options that are required to initialize the AdyenV2 payment method.
+
+Once AdyenV2 payment is initialized, credit card form fields, provided by the
+payment provider as IFrames, will be inserted into the current page. These
+options provide a location and styling for each of the form fields.
+
+```html
+<!-- This is where the credit card component will be inserted -->
+<div id="container"></div>
+
+<!-- This is where the secondary components (i.e.: 3DS) will be inserted -->
+<div id="additional-action-container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'adyenv2',
+    adyenv2: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+        },
+    },
+});
+```
+
+Additional options can be passed in to customize the components and register
+event callbacks.
+
+```js
+service.initializePayment({
+    methodId: 'adyenv2',
+    adyenv2: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+            onBeforeLoad(shopperInteraction) {
+                console.log(shopperInteraction);
+            },
+            onLoad(cancel) {
+                console.log(cancel);
+            },
+            onComplete() {
+                console.log('Completed');
+            },
+        },
+        options: {
+            scheme: {
+                hasHolderName: true,
+            },
+            bcmc: {
+                hasHolderName: true,
+            },
+            ideal: {
+                showImage: true,
+            },
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [additionalActionOptions](internal_.AdyenV2PaymentInitializeOptions.md#additionalactionoptions)
+- [cardVerificationContainerId](internal_.AdyenV2PaymentInitializeOptions.md#cardverificationcontainerid)
+- [containerId](internal_.AdyenV2PaymentInitializeOptions.md#containerid)
+- [hasVaultedInstruments](internal_.AdyenV2PaymentInitializeOptions.md#hasvaultedinstruments)
+- [options](internal_.AdyenV2PaymentInitializeOptions.md#options)
+- [shouldShowNumberField](internal_.AdyenV2PaymentInitializeOptions.md#shouldshownumberfield)
+- [threeDS2ContainerId](internal_.AdyenV2PaymentInitializeOptions.md#threeds2containerid)
+- [threeDS2Options](internal_.AdyenV2PaymentInitializeOptions.md#threeds2options)
+
+### Methods
+
+- [validateCardFields](internal_.AdyenV2PaymentInitializeOptions.md#validatecardfields)
+
+## Properties
+
+### additionalActionOptions
+
+• **additionalActionOptions**: [`AdyenAdditionalActionOptions`](internal_.AdyenAdditionalActionOptions.md)
+
+A set of options that are required to initialize additional payment actions.
+
+___
+
+### cardVerificationContainerId
+
+• `Optional` **cardVerificationContainerId**: `string`
+
+The location to insert the Adyen custom card component
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the Adyen component.
+
+___
+
+### hasVaultedInstruments
+
+• `Optional` **hasVaultedInstruments**: `boolean`
+
+True if the Adyen component has some Vaulted instrument
+
+___
+
+### options
+
+• `Optional` **options**: [`Omit_3`](../modules/internal_.md#omit_3)<[`AdyenCreditCardComponentOptions`](internal_.AdyenCreditCardComponentOptions.md), ``"onChange"``\> \| [`AdyenIdealComponentOptions`](internal_.AdyenIdealComponentOptions.md)
+
+Optional. Overwriting the default options
+
+___
+
+### shouldShowNumberField
+
+• `Optional` **shouldShowNumberField**: `boolean`
+
+___
+
+### threeDS2ContainerId
+
+• **threeDS2ContainerId**: `string`
+
+**`deprecated`** The location to insert the Adyen 3DS V2 component.
+Use additionalActionOptions instead as this property will be removed in the future
+
+___
+
+### threeDS2Options
+
+• `Optional` **threeDS2Options**: [`AdyenThreeDS2Options`](internal_.AdyenThreeDS2Options.md)
+
+**`deprecated`** Use additionalActionOptions instead as this property will be removed in the future
+
+## Methods
+
+### validateCardFields
+
+▸ **validateCardFields**(`validateState`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `validateState` | [`AdyenV2ValidationState`](internal_.AdyenV2ValidationState.md) |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.AdyenV2ValidationState.md

@@ -0,0 +1,59 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV2ValidationState
+
+# Interface: AdyenV2ValidationState
+
+[<internal>](../modules/internal_.md).AdyenV2ValidationState
+
+## Table of contents
+
+### Properties
+
+- [encryptedFieldName](internal_.AdyenV2ValidationState.md#encryptedfieldname)
+- [endDigits](internal_.AdyenV2ValidationState.md#enddigits)
+- [error](internal_.AdyenV2ValidationState.md#error)
+- [errorKey](internal_.AdyenV2ValidationState.md#errorkey)
+- [fieldType](internal_.AdyenV2ValidationState.md#fieldtype)
+- [i18n](internal_.AdyenV2ValidationState.md#i18n)
+- [valid](internal_.AdyenV2ValidationState.md#valid)
+
+## Properties
+
+### encryptedFieldName
+
+• `Optional` **encryptedFieldName**: `string`
+
+___
+
+### endDigits
+
+• `Optional` **endDigits**: `string`
+
+___
+
+### error
+
+• `Optional` **error**: `string`
+
+___
+
+### errorKey
+
+• `Optional` **errorKey**: `string`
+
+___
+
+### fieldType
+
+• `Optional` **fieldType**: [`AdyenV2CardFields`](../enums/internal_.AdyenV2CardFields.md)
+
+___
+
+### i18n
+
+• `Optional` **i18n**: `string`
+
+___
+
+### valid
+
+• **valid**: `boolean`