@bigcommerce/checkout-sdk 1.575.0 → 1.576.1

package/docs/interfaces/AdyenAdditionalActionOptions_2.md

@@ -1,106 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionOptions_2
-
-# Interface: AdyenAdditionalActionOptions\_2
-
-## Hierarchy
-
-- [`AdyenAdditionalActionCallbacks_2`](AdyenAdditionalActionCallbacks_2.md)
-
-  ↳ **`AdyenAdditionalActionOptions_2`**
-
-## Table of contents
-
-### Properties
-
-- [containerId](AdyenAdditionalActionOptions_2.md#containerid)
-- [widgetSize](AdyenAdditionalActionOptions_2.md#widgetsize)
-
-### Methods
-
-- [onBeforeLoad](AdyenAdditionalActionOptions_2.md#onbeforeload)
-- [onComplete](AdyenAdditionalActionOptions_2.md#oncomplete)
-- [onLoad](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](AdyenAdditionalActionCallbacks_2.md).[onBeforeLoad](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](AdyenAdditionalActionCallbacks_2.md).[onComplete](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](AdyenAdditionalActionCallbacks_2.md).[onLoad](AdyenAdditionalActionCallbacks_2.md#onload)

package/docs/interfaces/AdyenBaseCardComponentOptions_2.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenBaseCardComponentOptions_2
-
-# Interface: AdyenBaseCardComponentOptions\_2
-
-## Hierarchy
-
-- **`AdyenBaseCardComponentOptions_2`**
-
-  ↳ [`AdyenV3CreditCardComponentOptions`](AdyenV3CreditCardComponentOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [brands](AdyenBaseCardComponentOptions_2.md#brands)
-- [showBrandsUnderCardNumber](AdyenBaseCardComponentOptions_2.md#showbrandsundercardnumber)
-- [styles](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`](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/AdyenComponentEvents_2.md

@@ -1,94 +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)
-- [onSubmit](AdyenComponentEvents_2.md#onsubmit)
-
-## 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` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFieldValid
-
-▸ `Optional` **onFieldValid**(`state`, `component`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onSubmit
-
-▸ `Optional` **onSubmit**(`state`, `component`): `void`
-
-Called when the shopper selects the Pay button and payment details are valid.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/AdyenComponent_2.md

@@ -1,83 +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)
-- [submit](AdyenComponent_2.md#submit)
-- [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`
-
-___
-
-### submit
-
-▸ **submit**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### unmount
-
-▸ **unmount**(): `void`
-
-#### Returns
-
-`void`

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_2.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenPlaceholderData_2
-
-# Interface: AdyenPlaceholderData\_2
-
-## Table of contents
-
-### Properties
-
-- [billingAddress](AdyenPlaceholderData_2.md#billingaddress)
-- [firstName](AdyenPlaceholderData_2.md#firstname)
-- [holderName](AdyenPlaceholderData_2.md#holdername)
-- [lastName](AdyenPlaceholderData_2.md#lastname)
-- [prefillCardHolderName](AdyenPlaceholderData_2.md#prefillcardholdername)
-
-## Properties
-
-### billingAddress
-
-• `Optional` **billingAddress**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `city` | `string` |
-| `country` | `string` |
-| `houseNumberOrName` | `string` |
-| `postalCode` | `string` |
-| `stateOrProvince` | `string` |
-| `street` | `string` |
-
-___
-
-### firstName
-
-• `Optional` **firstName**: `string`
-
-___
-
-### holderName
-
-• `Optional` **holderName**: `string`
-
-___
-
-### lastName
-
-• `Optional` **lastName**: `string`
-
-___
-
-### prefillCardHolderName
-
-• `Optional` **prefillCardHolderName**: `boolean`

package/docs/interfaces/AdyenV2ValidationState.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenV2ValidationState
-
-# Interface: AdyenV2ValidationState
-
-## Table of contents
-
-### Properties
-
-- [encryptedFieldName](AdyenV2ValidationState.md#encryptedfieldname)
-- [endDigits](AdyenV2ValidationState.md#enddigits)
-- [error](AdyenV2ValidationState.md#error)
-- [errorKey](AdyenV2ValidationState.md#errorkey)
-- [fieldType](AdyenV2ValidationState.md#fieldtype)
-- [i18n](AdyenV2ValidationState.md#i18n)
-- [valid](AdyenV2ValidationState.md#valid)
-
-## Properties
-
-### encryptedFieldName
-
-• `Optional` **encryptedFieldName**: `string`
-
-___
-
-### endDigits
-
-• `Optional` **endDigits**: `string`
-
-___
-
-### error
-
-• `Optional` **error**: `string`
-
-___
-
-### errorKey
-
-• `Optional` **errorKey**: `string`
-
-___
-
-### fieldType
-
-• `Optional` **fieldType**: [`CardNumber`](../enums/AdyenV2CardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenV2CardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenV2CardFields.md#expirydate)
-
-___
-
-### i18n
-
-• `Optional` **i18n**: `string`
-
-___
-
-### valid
-
-• **valid**: `boolean`

package/docs/interfaces/AdyenV3CreditCardComponentOptions.md

@@ -1,220 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenV3CreditCardComponentOptions
-
-# Interface: AdyenV3CreditCardComponentOptions
-
-## Hierarchy
-
-- [`AdyenBaseCardComponentOptions_2`](AdyenBaseCardComponentOptions_2.md)
-
-- [`AdyenComponentEvents_2`](AdyenComponentEvents_2.md)
-
-  ↳ **`AdyenV3CreditCardComponentOptions`**
-
-## Table of contents
-
-### Properties
-
-- [brands](AdyenV3CreditCardComponentOptions.md#brands)
-- [data](AdyenV3CreditCardComponentOptions.md#data)
-- [details](AdyenV3CreditCardComponentOptions.md#details)
-- [enableStoreDetails](AdyenV3CreditCardComponentOptions.md#enablestoredetails)
-- [groupTypes](AdyenV3CreditCardComponentOptions.md#grouptypes)
-- [hasHolderName](AdyenV3CreditCardComponentOptions.md#hasholdername)
-- [holderNameRequired](AdyenV3CreditCardComponentOptions.md#holdernamerequired)
-- [placeholders](AdyenV3CreditCardComponentOptions.md#placeholders)
-- [showBrandsUnderCardNumber](AdyenV3CreditCardComponentOptions.md#showbrandsundercardnumber)
-- [styles](AdyenV3CreditCardComponentOptions.md#styles)
-
-### Methods
-
-- [onChange](AdyenV3CreditCardComponentOptions.md#onchange)
-- [onError](AdyenV3CreditCardComponentOptions.md#onerror)
-- [onFieldValid](AdyenV3CreditCardComponentOptions.md#onfieldvalid)
-- [onSubmit](AdyenV3CreditCardComponentOptions.md#onsubmit)
-
-## Properties
-
-### brands
-
-• `Optional` **brands**: `string`[]
-
-Array of card brands that will be recognized by the component.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[brands](AdyenBaseCardComponentOptions_2.md#brands)
-
-___
-
-### data
-
-• `Optional` **data**: [`AdyenPlaceholderData_2`](AdyenPlaceholderData_2.md)
-
-Information to prefill fields.
-
-___
-
-### details
-
-• `Optional` **details**: [`InputDetail_2`](InputDetail_2.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_2`](CreditCardPlaceHolder_2.md) \| [`SepaPlaceHolder_2`](SepaPlaceHolder_2.md)
-
-Specify the sample values you want to appear for card detail input fields.
-
-___
-
-### showBrandsUnderCardNumber
-
-• `Optional` **showBrandsUnderCardNumber**: `boolean`
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[showBrandsUnderCardNumber](AdyenBaseCardComponentOptions_2.md#showbrandsundercardnumber)
-
-___
-
-### styles
-
-• `Optional` **styles**: [`StyleOptions_2`](StyleOptions_2.md)
-
-Set a style object to customize the input fields. See Styling Secured Fields
-for a list of supported properties.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[styles](AdyenBaseCardComponentOptions_2.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` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onChange](AdyenComponentEvents_2.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` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onError](AdyenComponentEvents_2.md#onerror)
-
-___
-
-### onFieldValid
-
-▸ `Optional` **onFieldValid**(`state`, `component`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onFieldValid](AdyenComponentEvents_2.md#onfieldvalid)
-
-___
-
-### onSubmit
-
-▸ `Optional` **onSubmit**(`state`, `component`): `void`
-
-Called when the shopper selects the Pay button and payment details are valid.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onSubmit](AdyenComponentEvents_2.md#onsubmit)