@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/AdyenComponent.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenComponent
-
-# Interface: AdyenComponent
-
-## Table of contents
-
-### Properties
-
-- [componentRef](AdyenComponent.md#componentref)
-- [props](AdyenComponent.md#props)
-- [state](AdyenComponent.md#state)
-
-### Methods
-
-- [mount](AdyenComponent.md#mount)
-- [unmount](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`](CardState.md)
-
-## Methods
-
-### mount
-
-▸ **mount**(`containerId`): `HTMLElement`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `containerId` | `string` |
-
-#### Returns
-
-`HTMLElement`
-
-___
-
-### unmount
-
-▸ **unmount**(): `void`
-
-#### Returns
-
-`void`

package/docs/interfaces/AdyenComponentEvents.md

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

package/docs/interfaces/AdyenComponentEvents_2.md

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

package/docs/interfaces/AdyenComponent_2.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenComponent_2
-
-# Interface: AdyenComponent\_2
-
-## Table of contents
-
-### Properties
-
-- [componentRef](AdyenComponent_2.md#componentref)
-- [props](AdyenComponent_2.md#props)
-- [state](AdyenComponent_2.md#state)
-
-### Methods
-
-- [mount](AdyenComponent_2.md#mount)
-- [unmount](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`](CardState_2.md)
-
-## Methods
-
-### mount
-
-▸ **mount**(`containerId`): `HTMLElement`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `containerId` | `string` |
-
-#### Returns
-
-`HTMLElement`
-
-___
-
-### unmount
-
-▸ **unmount**(): `void`
-
-#### Returns
-
-`void`

package/docs/interfaces/AdyenCreditCardComponentOptions.md

@@ -1,185 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenCreditCardComponentOptions
-
-# Interface: AdyenCreditCardComponentOptions
-
-## Hierarchy
-
-- [`AdyenBaseCardComponentOptions`](AdyenBaseCardComponentOptions.md)
-
-- [`AdyenComponentEvents`](AdyenComponentEvents.md)
-
-  ↳ **`AdyenCreditCardComponentOptions`**
-
-## Table of contents
-
-### Properties
-
-- [brands](AdyenCreditCardComponentOptions.md#brands)
-- [data](AdyenCreditCardComponentOptions.md#data)
-- [details](AdyenCreditCardComponentOptions.md#details)
-- [enableStoreDetails](AdyenCreditCardComponentOptions.md#enablestoredetails)
-- [groupTypes](AdyenCreditCardComponentOptions.md#grouptypes)
-- [hasHolderName](AdyenCreditCardComponentOptions.md#hasholdername)
-- [holderNameRequired](AdyenCreditCardComponentOptions.md#holdernamerequired)
-- [placeholders](AdyenCreditCardComponentOptions.md#placeholders)
-- [styles](AdyenCreditCardComponentOptions.md#styles)
-
-### Methods
-
-- [onChange](AdyenCreditCardComponentOptions.md#onchange)
-- [onError](AdyenCreditCardComponentOptions.md#onerror)
-- [onFieldValid](AdyenCreditCardComponentOptions.md#onfieldvalid)
-
-## Properties
-
-### brands
-
-• `Optional` **brands**: `string`[]
-
-Array of card brands that will be recognized by the component.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions](AdyenBaseCardComponentOptions.md).[brands](AdyenBaseCardComponentOptions.md#brands)
-
-___
-
-### data
-
-• `Optional` **data**: [`AdyenPlaceholderData`](AdyenPlaceholderData.md)
-
-Information to prefill fields.
-
-___
-
-### details
-
-• `Optional` **details**: [`InputDetail`](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`](CreditCardPlaceHolder.md) \| [`SepaPlaceHolder`](SepaPlaceHolder.md)
-
-Specify the sample values you want to appear for card detail input fields.
-
-___
-
-### styles
-
-• `Optional` **styles**: [`StyleOptions`](StyleOptions.md)
-
-Set a style object to customize the input fields. See Styling Secured Fields
-for a list of supported properties.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions](AdyenBaseCardComponentOptions.md).[styles](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`](../README.md#adyencomponentstate) |
-| `component` | [`AdyenComponent`](AdyenComponent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents](AdyenComponentEvents.md).[onChange](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` | [`AdyenComponentState`](../README.md#adyencomponentstate) |
-| `component` | [`AdyenComponent`](AdyenComponent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents](AdyenComponentEvents.md).[onError](AdyenComponentEvents.md#onerror)
-
-___
-
-### onFieldValid
-
-▸ `Optional` **onFieldValid**(`state`, `component`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenComponentState`](../README.md#adyencomponentstate) |
-| `component` | [`AdyenComponent`](AdyenComponent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents](AdyenComponentEvents.md).[onFieldValid](AdyenComponentEvents.md#onfieldvalid)

package/docs/interfaces/AdyenIdealComponentOptions.md

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

package/docs/interfaces/AdyenPaymentMethodState.md

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

package/docs/interfaces/AdyenPaymentMethodState_2.md

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

package/docs/interfaces/AdyenPlaceholderData.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenPlaceholderData
-
-# Interface: AdyenPlaceholderData
-
-## Table of contents
-
-### Properties
-
-- [billingAddress](AdyenPlaceholderData.md#billingaddress)
-- [holderName](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/AdyenPlaceholderData_2.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenPlaceholderData_2
-
-# Interface: AdyenPlaceholderData\_2
-
-## Table of contents
-
-### Properties
-
-- [billingAddress](AdyenPlaceholderData_2.md#billingaddress)
-- [holderName](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/AdyenThreeDS2Options.md

@@ -1,97 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenThreeDS2Options
-
-# Interface: AdyenThreeDS2Options
-
-## Hierarchy
-
-- [`AdyenAdditionalActionCallbacks`](AdyenAdditionalActionCallbacks.md)
-
-  ↳ **`AdyenThreeDS2Options`**
-
-## Table of contents
-
-### Properties
-
-- [widgetSize](AdyenThreeDS2Options.md#widgetsize)
-
-### Methods
-
-- [onBeforeLoad](AdyenThreeDS2Options.md#onbeforeload)
-- [onComplete](AdyenThreeDS2Options.md#oncomplete)
-- [onLoad](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](AdyenAdditionalActionCallbacks.md).[onBeforeLoad](AdyenAdditionalActionCallbacks.md#onbeforeload)
-
-___
-
-### onComplete
-
-▸ `Optional` **onComplete**(): `void`
-
-A callback that gets called when adyen component verification
-is completed
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenAdditionalActionCallbacks](AdyenAdditionalActionCallbacks.md).[onComplete](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](AdyenAdditionalActionCallbacks.md).[onLoad](AdyenAdditionalActionCallbacks.md#onload)