@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.AdyenAdditionalActionOptions.md

@@ -0,0 +1,108 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenAdditionalActionOptions
+
+# Interface: AdyenAdditionalActionOptions
+
+[<internal>](../modules/internal_.md).AdyenAdditionalActionOptions
+
+## Hierarchy
+
+- [`AdyenAdditionalActionCallbacks`](internal_.AdyenAdditionalActionCallbacks.md)
+
+  ↳ **`AdyenAdditionalActionOptions`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.AdyenAdditionalActionOptions.md#containerid)
+- [widgetSize](internal_.AdyenAdditionalActionOptions.md#widgetsize)
+
+### Methods
+
+- [onBeforeLoad](internal_.AdyenAdditionalActionOptions.md#onbeforeload)
+- [onComplete](internal_.AdyenAdditionalActionOptions.md#oncomplete)
+- [onLoad](internal_.AdyenAdditionalActionOptions.md#onload)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the additional action component.
+
+___
+
+### 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_.AdyenAdditionalActionOptions_2.md

@@ -0,0 +1,108 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenAdditionalActionOptions\_2
+
+# Interface: AdyenAdditionalActionOptions\_2
+
+[<internal>](../modules/internal_.md).AdyenAdditionalActionOptions_2
+
+## Hierarchy
+
+- [`AdyenAdditionalActionCallbacks_2`](internal_.AdyenAdditionalActionCallbacks_2.md)
+
+  ↳ **`AdyenAdditionalActionOptions_2`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](internal_.AdyenAdditionalActionOptions_2.md#containerid)
+- [widgetSize](internal_.AdyenAdditionalActionOptions_2.md#widgetsize)
+
+### Methods
+
+- [onBeforeLoad](internal_.AdyenAdditionalActionOptions_2.md#onbeforeload)
+- [onComplete](internal_.AdyenAdditionalActionOptions_2.md#oncomplete)
+- [onLoad](internal_.AdyenAdditionalActionOptions_2.md#onload)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the additional action component.
+
+___
+
+### 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_2](internal_.AdyenAdditionalActionCallbacks_2.md).[onBeforeLoad](internal_.AdyenAdditionalActionCallbacks_2.md#onbeforeload)
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks_2](internal_.AdyenAdditionalActionCallbacks_2.md).[onComplete](internal_.AdyenAdditionalActionCallbacks_2.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_2](internal_.AdyenAdditionalActionCallbacks_2.md).[onLoad](internal_.AdyenAdditionalActionCallbacks_2.md#onload)

package/docs/interfaces/internal_.AdyenBaseCardComponentOptions.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenBaseCardComponentOptions
+
+# Interface: AdyenBaseCardComponentOptions
+
+[<internal>](../modules/internal_.md).AdyenBaseCardComponentOptions
+
+## Hierarchy
+
+- **`AdyenBaseCardComponentOptions`**
+
+  ↳ [`AdyenCreditCardComponentOptions`](internal_.AdyenCreditCardComponentOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [brands](internal_.AdyenBaseCardComponentOptions.md#brands)
+- [styles](internal_.AdyenBaseCardComponentOptions.md#styles)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+___
+
+### 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.

package/docs/interfaces/internal_.AdyenBaseCardComponentOptions_2.md

@@ -0,0 +1,42 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenBaseCardComponentOptions\_2
+
+# Interface: AdyenBaseCardComponentOptions\_2
+
+[<internal>](../modules/internal_.md).AdyenBaseCardComponentOptions_2
+
+## Hierarchy
+
+- **`AdyenBaseCardComponentOptions_2`**
+
+  ↳ [`AdyenV3CreditCardComponentOptions`](internal_.AdyenV3CreditCardComponentOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [brands](internal_.AdyenBaseCardComponentOptions_2.md#brands)
+- [showBrandsUnderCardNumber](internal_.AdyenBaseCardComponentOptions_2.md#showbrandsundercardnumber)
+- [styles](internal_.AdyenBaseCardComponentOptions_2.md#styles)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+___
+
+### showBrandsUnderCardNumber
+
+• `Optional` **showBrandsUnderCardNumber**: `boolean`
+
+___
+
+### styles
+
+• `Optional` **styles**: [`StyleOptions_2`](internal_.StyleOptions_2.md)
+
+Set a style object to customize the input fields. See Styling Secured Fields
+for a list of supported properties.

package/docs/interfaces/internal_.AdyenComponent.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenComponent
+
+# Interface: AdyenComponent
+
+[<internal>](../modules/internal_.md).AdyenComponent
+
+## Table of contents
+
+### Properties
+
+- [componentRef](internal_.AdyenComponent.md#componentref)
+- [props](internal_.AdyenComponent.md#props)
+- [state](internal_.AdyenComponent.md#state)
+
+### Methods
+
+- [mount](internal_.AdyenComponent.md#mount)
+- [unmount](internal_.AdyenComponent.md#unmount)
+
+## Properties
+
+### componentRef
+
+• `Optional` **componentRef**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `showValidation` | () => `void` |
+
+___
+
+### props
+
+• `Optional` **props**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `type?` | `string` |
+
+___
+
+### state
+
+• `Optional` **state**: [`CardState`](internal_.CardState.md)
+
+## Methods
+
+### mount
+
+▸ **mount**(`containerId`): `HTMLElement`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `containerId` | `string` |
+
+#### Returns
+
+`HTMLElement`
+
+___
+
+### unmount
+
+▸ **unmount**(): `void`
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.AdyenComponentEvents.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenComponentEvents
+
+# Interface: AdyenComponentEvents
+
+[<internal>](../modules/internal_.md).AdyenComponentEvents
+
+## Hierarchy
+
+- **`AdyenComponentEvents`**
+
+  ↳ [`AdyenCreditCardComponentOptions`](internal_.AdyenCreditCardComponentOptions.md)
+
+## Table of contents
+
+### Methods
+
+- [onChange](internal_.AdyenComponentEvents.md#onchange)
+- [onError](internal_.AdyenComponentEvents.md#onerror)
+- [onFieldValid](internal_.AdyenComponentEvents.md#onfieldvalid)
+
+## 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`
+
+___
+
+### 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`
+
+___
+
+### onFieldValid
+
+▸ `Optional` **onFieldValid**(`state`, `component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV2ValidationState`](internal_.AdyenV2ValidationState.md) |
+| `component` | [`AdyenComponent`](internal_.AdyenComponent.md) |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.AdyenComponentEvents_2.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenComponentEvents\_2
+
+# Interface: AdyenComponentEvents\_2
+
+[<internal>](../modules/internal_.md).AdyenComponentEvents_2
+
+## Hierarchy
+
+- **`AdyenComponentEvents_2`**
+
+  ↳ [`AdyenV3CreditCardComponentOptions`](internal_.AdyenV3CreditCardComponentOptions.md)
+
+## Table of contents
+
+### Methods
+
+- [onChange](internal_.AdyenComponentEvents_2.md#onchange)
+- [onError](internal_.AdyenComponentEvents_2.md#onerror)
+- [onFieldValid](internal_.AdyenComponentEvents_2.md#onfieldvalid)
+
+## 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` | [`AdyenV3ComponentState`](../modules/internal_.md#adyenv3componentstate) |
+| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### 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` | [`AdyenV3ValidationState`](internal_.AdyenV3ValidationState.md) |
+| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onFieldValid
+
+▸ `Optional` **onFieldValid**(`state`, `component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV3ValidationState`](internal_.AdyenV3ValidationState.md) |
+| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.AdyenComponent_2.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenComponent\_2
+
+# Interface: AdyenComponent\_2
+
+[<internal>](../modules/internal_.md).AdyenComponent_2
+
+## Table of contents
+
+### Properties
+
+- [componentRef](internal_.AdyenComponent_2.md#componentref)
+- [props](internal_.AdyenComponent_2.md#props)
+- [state](internal_.AdyenComponent_2.md#state)
+
+### Methods
+
+- [mount](internal_.AdyenComponent_2.md#mount)
+- [unmount](internal_.AdyenComponent_2.md#unmount)
+
+## Properties
+
+### componentRef
+
+• `Optional` **componentRef**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `showValidation` | () => `void` |
+
+___
+
+### props
+
+• `Optional` **props**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `type?` | `string` |
+
+___
+
+### state
+
+• `Optional` **state**: [`CardState_2`](internal_.CardState_2.md)
+
+## Methods
+
+### mount
+
+▸ **mount**(`containerId`): `HTMLElement`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `containerId` | `string` |
+
+#### Returns
+
+`HTMLElement`
+
+___
+
+### unmount
+
+▸ **unmount**(): `void`
+
+#### Returns
+
+`void`