@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.AdyenV3CreditCardComponentOptions.md

@@ -1,198 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV3CreditCardComponentOptions
-
-# Interface: AdyenV3CreditCardComponentOptions
-
-[<internal>](../modules/internal_.md).AdyenV3CreditCardComponentOptions
-
-## Hierarchy
-
-- [`AdyenBaseCardComponentOptions_2`](internal_.AdyenBaseCardComponentOptions_2.md)
-
-- [`AdyenComponentEvents_2`](internal_.AdyenComponentEvents_2.md)
-
-  ↳ **`AdyenV3CreditCardComponentOptions`**
-
-## Table of contents
-
-### Properties
-
-- [brands](internal_.AdyenV3CreditCardComponentOptions.md#brands)
-- [data](internal_.AdyenV3CreditCardComponentOptions.md#data)
-- [details](internal_.AdyenV3CreditCardComponentOptions.md#details)
-- [enableStoreDetails](internal_.AdyenV3CreditCardComponentOptions.md#enablestoredetails)
-- [groupTypes](internal_.AdyenV3CreditCardComponentOptions.md#grouptypes)
-- [hasHolderName](internal_.AdyenV3CreditCardComponentOptions.md#hasholdername)
-- [holderNameRequired](internal_.AdyenV3CreditCardComponentOptions.md#holdernamerequired)
-- [placeholders](internal_.AdyenV3CreditCardComponentOptions.md#placeholders)
-- [showBrandsUnderCardNumber](internal_.AdyenV3CreditCardComponentOptions.md#showbrandsundercardnumber)
-- [styles](internal_.AdyenV3CreditCardComponentOptions.md#styles)
-
-### Methods
-
-- [onChange](internal_.AdyenV3CreditCardComponentOptions.md#onchange)
-- [onError](internal_.AdyenV3CreditCardComponentOptions.md#onerror)
-- [onFieldValid](internal_.AdyenV3CreditCardComponentOptions.md#onfieldvalid)
-
-## Properties
-
-### brands
-
-• `Optional` **brands**: `string`[]
-
-Array of card brands that will be recognized by the component.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](internal_.AdyenBaseCardComponentOptions_2.md).[brands](internal_.AdyenBaseCardComponentOptions_2.md#brands)
-
-___
-
-### data
-
-• `Optional` **data**: [`AdyenPlaceholderData_2`](internal_.AdyenPlaceholderData_2.md)
-
-Information to prefill fields.
-
-___
-
-### details
-
-• `Optional` **details**: [`InputDetail_2`](internal_.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`](internal_.CreditCardPlaceHolder_2.md) \| [`SepaPlaceHolder_2`](internal_.SepaPlaceHolder_2.md)
-
-Specify the sample values you want to appear for card detail input fields.
-
-___
-
-### showBrandsUnderCardNumber
-
-• `Optional` **showBrandsUnderCardNumber**: `boolean`
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](internal_.AdyenBaseCardComponentOptions_2.md).[showBrandsUnderCardNumber](internal_.AdyenBaseCardComponentOptions_2.md#showbrandsundercardnumber)
-
-___
-
-### 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.
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](internal_.AdyenBaseCardComponentOptions_2.md).[styles](internal_.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`](../modules/internal_.md#adyenv3componentstate) |
-| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](internal_.AdyenComponentEvents_2.md).[onChange](internal_.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`](internal_.AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](internal_.AdyenComponentEvents_2.md).[onError](internal_.AdyenComponentEvents_2.md#onerror)
-
-___
-
-### onFieldValid
-
-▸ `Optional` **onFieldValid**(`state`, `component`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ValidationState`](internal_.AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](internal_.AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](internal_.AdyenComponentEvents_2.md).[onFieldValid](internal_.AdyenComponentEvents_2.md#onfieldvalid)

package/docs/interfaces/internal_.AdyenV3PaymentInitializeOptions.md

@@ -1,137 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AdyenV3PaymentInitializeOptions
-
-# Interface: AdyenV3PaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).AdyenV3PaymentInitializeOptions
-
-A set of options that are required to initialize the Adyenv3 payment method.
-
-Once Adyenv3 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: 'adyenv3',
-    adyenv3: {
-        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: 'adyenv3',
-    adyenv3: {
-        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,
-            },
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [additionalActionOptions](internal_.AdyenV3PaymentInitializeOptions.md#additionalactionoptions)
-- [cardVerificationContainerId](internal_.AdyenV3PaymentInitializeOptions.md#cardverificationcontainerid)
-- [containerId](internal_.AdyenV3PaymentInitializeOptions.md#containerid)
-- [hasVaultedInstruments](internal_.AdyenV3PaymentInitializeOptions.md#hasvaultedinstruments)
-- [options](internal_.AdyenV3PaymentInitializeOptions.md#options)
-- [shouldShowNumberField](internal_.AdyenV3PaymentInitializeOptions.md#shouldshownumberfield)
-
-### Methods
-
-- [validateCardFields](internal_.AdyenV3PaymentInitializeOptions.md#validatecardfields)
-
-## Properties
-
-### additionalActionOptions
-
-• **additionalActionOptions**: [`AdyenAdditionalActionOptions_2`](internal_.AdyenAdditionalActionOptions_2.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)<[`AdyenV3CreditCardComponentOptions`](internal_.AdyenV3CreditCardComponentOptions.md), ``"onChange"``\>
-
-Optional. Overwriting the default options
-
-___
-
-### shouldShowNumberField
-
-• `Optional` **shouldShowNumberField**: `boolean`
-
-## Methods
-
-### validateCardFields
-
-▸ **validateCardFields**(`validateState`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `validateState` | [`AdyenV3ValidationState`](internal_.AdyenV3ValidationState.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.AdyenV3ValidationState.md

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

package/docs/interfaces/internal_.AmazonPayCustomerInitializeOptions.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayCustomerInitializeOptions
-
-# Interface: AmazonPayCustomerInitializeOptions
-
-[<internal>](../modules/internal_.md).AmazonPayCustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout to support Amazon Pay.
-
-When AmazonPay is initialized, a sign-in button will be inserted into the
-DOM. When the customer clicks on it, they will be redirected to Amazon to
-sign in.
-
-## Table of contents
-
-### Properties
-
-- [color](internal_.AmazonPayCustomerInitializeOptions.md#color)
-- [container](internal_.AmazonPayCustomerInitializeOptions.md#container)
-- [size](internal_.AmazonPayCustomerInitializeOptions.md#size)
-
-### Methods
-
-- [onError](internal_.AmazonPayCustomerInitializeOptions.md#onerror)
-
-## Properties
-
-### color
-
-• `Optional` **color**: ``"Gold"`` \| ``"LightGray"`` \| ``"DarkGray"``
-
-The colour of the sign-in button.
-
-___
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.
-
-___
-
-### size
-
-• `Optional` **size**: ``"small"`` \| ``"medium"`` \| ``"large"`` \| ``"x-large"``
-
-The size of the sign-in button.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the address options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`AmazonPayWidgetError`](internal_.AmazonPayWidgetError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.AmazonPayOrderReference.md

@@ -1,32 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayOrderReference
-
-# Interface: AmazonPayOrderReference
-
-[<internal>](../modules/internal_.md).AmazonPayOrderReference
-
-## Table of contents
-
-### Methods
-
-- [getAmazonBillingAgreementId](internal_.AmazonPayOrderReference.md#getamazonbillingagreementid)
-- [getAmazonOrderReferenceId](internal_.AmazonPayOrderReference.md#getamazonorderreferenceid)
-
-## Methods
-
-### getAmazonBillingAgreementId
-
-▸ **getAmazonBillingAgreementId**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### getAmazonOrderReferenceId
-
-▸ **getAmazonOrderReferenceId**(): `string`
-
-#### Returns
-
-`string`

package/docs/interfaces/internal_.AmazonPayPaymentInitializeOptions.md

@@ -1,102 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayPaymentInitializeOptions
-
-# Interface: AmazonPayPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).AmazonPayPaymentInitializeOptions
-
-A set of options that are required to initialize the Amazon Pay payment
-method.
-
-When AmazonPay is initialized, a widget will be inserted into the DOM. The
-widget has a list of payment options for the customer to choose from.
-
-```html
-<!-- This is where the widget will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'amazon',
-    amazon: {
-        container: 'container',
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [container](internal_.AmazonPayPaymentInitializeOptions.md#container)
-
-### Methods
-
-- [onError](internal_.AmazonPayPaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](internal_.AmazonPayPaymentInitializeOptions.md#onpaymentselect)
-- [onReady](internal_.AmazonPayPaymentInitializeOptions.md#onready)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the payment widget should insert into.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the payment options.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`AmazonPayWidgetError`](internal_.AmazonPayWidgetError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(`reference`): `void`
-
-A callback that gets called when the customer selects one of the payment
-options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](internal_.AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`
-
-___
-
-### onReady
-
-▸ `Optional` **onReady**(`reference`): `void`
-
-A callback that gets called when the widget is loaded and ready to be
-interacted with.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](internal_.AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.AmazonPayShippingInitializeOptions.md

@@ -1,87 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayShippingInitializeOptions
-
-# Interface: AmazonPayShippingInitializeOptions
-
-[<internal>](../modules/internal_.md).AmazonPayShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of
-checkout in order to support Amazon Pay.
-
-When Amazon Pay is initialized, a widget will be inserted into the DOM. The
-widget has a list of shipping addresses for the customer to choose from.
-
-## Table of contents
-
-### Properties
-
-- [container](internal_.AmazonPayShippingInitializeOptions.md#container)
-
-### Methods
-
-- [onAddressSelect](internal_.AmazonPayShippingInitializeOptions.md#onaddressselect)
-- [onError](internal_.AmazonPayShippingInitializeOptions.md#onerror)
-- [onReady](internal_.AmazonPayShippingInitializeOptions.md#onready)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the address widget should insert into.
-
-## Methods
-
-### onAddressSelect
-
-▸ `Optional` **onAddressSelect**(`reference`): `void`
-
-A callback that gets called when the customer selects an address option.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](internal_.AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the address options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`AmazonPayWidgetError`](internal_.AmazonPayWidgetError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure of the initialization. |
-
-#### Returns
-
-`void`
-
-___
-
-### onReady
-
-▸ `Optional` **onReady**(`reference`): `void`
-
-A callback that gets called when the widget is loaded and ready to be
-interacted with.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](internal_.AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.AmazonPayV2CustomerInitializeOptions.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2CustomerInitializeOptions
-
-# Interface: AmazonPayV2CustomerInitializeOptions
-
-[<internal>](../modules/internal_.md).AmazonPayV2CustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout in order to support AmazonPayV2.
-
-When AmazonPayV2 is initialized, a sign-in button will be inserted into the
-DOM. When the customer clicks on it, they will be redirected to Amazon to
-sign in.
-
-## Table of contents
-
-### Properties
-
-- [container](internal_.AmazonPayV2CustomerInitializeOptions.md#container)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.