@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.GooglePayPaymentInitializeOptions.md

@@ -1,95 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / GooglePayPaymentInitializeOptions
-
-# Interface: GooglePayPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).GooglePayPaymentInitializeOptions
-
-A set of options that are required to initialize the GooglePay payment method
-
-If the customer chooses to pay with GooglePay, they will be asked to
-enter their payment details via a modal. You can hook into events emitted by
-the modal by providing the callbacks listed below.
-
-```html
-<!-- This is where the GooglePay button will be inserted -->
-<div id="wallet-button"></div>
-```
-
-```js
-service.initializePayment({
-    // Using GooglePay provided by Braintree as an example
-    methodId: 'googlepaybraintree',
-    googlepaybraintree: {
-        walletButton: 'wallet-button'
-    },
-});
-```
-
-Additional event callbacks can be registered.
-
-```js
-service.initializePayment({
-    methodId: 'googlepaybraintree',
-    googlepaybraintree: {
-        walletButton: 'wallet-button',
-        onError(error) {
-            console.log(error);
-        },
-        onPaymentSelect() {
-            console.log('Selected');
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [walletButton](internal_.GooglePayPaymentInitializeOptions.md#walletbutton)
-
-### Methods
-
-- [onError](internal_.GooglePayPaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](internal_.GooglePayPaymentInitializeOptions.md#onpaymentselect)
-
-## Properties
-
-### walletButton
-
-• `Optional` **walletButton**: `string`
-
-This walletButton is used to set an event listener, provide an element ID if you want
-users to be able to launch the GooglePay wallet modal by clicking on a button.
-It should be an HTML element.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called when GooglePay fails to initialize or
-selects a payment option.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | `Error` | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(): `void`
-
-A callback that gets called when the customer selects a payment option.
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.HostedCardFieldOptions.md

@@ -1,37 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedCardFieldOptions
-
-# Interface: HostedCardFieldOptions
-
-[<internal>](../modules/internal_.md).HostedCardFieldOptions
-
-## Hierarchy
-
-- **`HostedCardFieldOptions`**
-
-  ↳ [`HostedStoredCardFieldOptions`](internal_.HostedStoredCardFieldOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [accessibilityLabel](internal_.HostedCardFieldOptions.md#accessibilitylabel)
-- [containerId](internal_.HostedCardFieldOptions.md#containerid)
-- [placeholder](internal_.HostedCardFieldOptions.md#placeholder)
-
-## Properties
-
-### accessibilityLabel
-
-• `Optional` **accessibilityLabel**: `string`
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`

package/docs/interfaces/internal_.HostedCardFieldOptionsMap.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedCardFieldOptionsMap
-
-# Interface: HostedCardFieldOptionsMap
-
-[<internal>](../modules/internal_.md).HostedCardFieldOptionsMap
-
-## Table of contents
-
-### Properties
-
-- [cardCode](internal_.HostedCardFieldOptionsMap.md#cardcode)
-- [cardExpiry](internal_.HostedCardFieldOptionsMap.md#cardexpiry)
-- [cardName](internal_.HostedCardFieldOptionsMap.md#cardname)
-- [cardNumber](internal_.HostedCardFieldOptionsMap.md#cardnumber)
-
-## Properties
-
-### cardCode
-
-• `Optional` **cardCode**: [`HostedCardFieldOptions`](internal_.HostedCardFieldOptions.md)
-
-___
-
-### cardExpiry
-
-• **cardExpiry**: [`HostedCardFieldOptions`](internal_.HostedCardFieldOptions.md)
-
-___
-
-### cardName
-
-• **cardName**: [`HostedCardFieldOptions`](internal_.HostedCardFieldOptions.md)
-
-___
-
-### cardNumber
-
-• **cardNumber**: [`HostedCardFieldOptions`](internal_.HostedCardFieldOptions.md)

package/docs/interfaces/internal_.HostedFieldStylesMap.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedFieldStylesMap
-
-# Interface: HostedFieldStylesMap
-
-[<internal>](../modules/internal_.md).HostedFieldStylesMap
-
-## Table of contents
-
-### Properties
-
-- [default](internal_.HostedFieldStylesMap.md#default)
-- [error](internal_.HostedFieldStylesMap.md#error)
-- [focus](internal_.HostedFieldStylesMap.md#focus)
-
-## Properties
-
-### default
-
-• `Optional` **default**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
-
-___
-
-### error
-
-• `Optional` **error**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
-
-___
-
-### focus
-
-• `Optional` **focus**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>

package/docs/interfaces/internal_.HostedFormOptions.md

@@ -1,116 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedFormOptions
-
-# Interface: HostedFormOptions
-
-[<internal>](../modules/internal_.md).HostedFormOptions
-
-## Table of contents
-
-### Properties
-
-- [fields](internal_.HostedFormOptions.md#fields)
-- [styles](internal_.HostedFormOptions.md#styles)
-
-### Methods
-
-- [onBlur](internal_.HostedFormOptions.md#onblur)
-- [onCardTypeChange](internal_.HostedFormOptions.md#oncardtypechange)
-- [onEnter](internal_.HostedFormOptions.md#onenter)
-- [onFocus](internal_.HostedFormOptions.md#onfocus)
-- [onValidate](internal_.HostedFormOptions.md#onvalidate)
-
-## Properties
-
-### fields
-
-• **fields**: [`HostedFieldOptionsMap`](../modules/internal_.md#hostedfieldoptionsmap)
-
-___
-
-### styles
-
-• `Optional` **styles**: [`HostedFieldStylesMap`](internal_.HostedFieldStylesMap.md)
-
-## Methods
-
-### onBlur
-
-▸ `Optional` **onBlur**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | `Object` |
-| `data.fieldType` | [`HostedFieldType`](../enums/internal_.HostedFieldType.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onCardTypeChange
-
-▸ `Optional` **onCardTypeChange**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | `Object` |
-| `data.cardType?` | `string` |
-
-#### Returns
-
-`void`
-
-___
-
-### onEnter
-
-▸ `Optional` **onEnter**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | `Object` |
-| `data.fieldType` | [`HostedFieldType`](../enums/internal_.HostedFieldType.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFocus
-
-▸ `Optional` **onFocus**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | `Object` |
-| `data.fieldType` | [`HostedFieldType`](../enums/internal_.HostedFieldType.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onValidate
-
-▸ `Optional` **onValidate**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`HostedInputValidateResults`](internal_.HostedInputValidateResults.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.HostedInputValidateErrorData.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedInputValidateErrorData
-
-# Interface: HostedInputValidateErrorData
-
-[<internal>](../modules/internal_.md).HostedInputValidateErrorData
-
-## Table of contents
-
-### Properties
-
-- [fieldType](internal_.HostedInputValidateErrorData.md#fieldtype)
-- [message](internal_.HostedInputValidateErrorData.md#message)
-- [type](internal_.HostedInputValidateErrorData.md#type)
-
-## Properties
-
-### fieldType
-
-• **fieldType**: `string`
-
-___
-
-### message
-
-• **message**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/internal_.HostedInputValidateErrorDataMap.md

@@ -1,52 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedInputValidateErrorDataMap
-
-# Interface: HostedInputValidateErrorDataMap
-
-[<internal>](../modules/internal_.md).HostedInputValidateErrorDataMap
-
-## Table of contents
-
-### Properties
-
-- [cardCode](internal_.HostedInputValidateErrorDataMap.md#cardcode)
-- [cardCodeVerification](internal_.HostedInputValidateErrorDataMap.md#cardcodeverification)
-- [cardExpiry](internal_.HostedInputValidateErrorDataMap.md#cardexpiry)
-- [cardName](internal_.HostedInputValidateErrorDataMap.md#cardname)
-- [cardNumber](internal_.HostedInputValidateErrorDataMap.md#cardnumber)
-- [cardNumberVerification](internal_.HostedInputValidateErrorDataMap.md#cardnumberverification)
-
-## Properties
-
-### cardCode
-
-• `Optional` **cardCode**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]
-
-___
-
-### cardCodeVerification
-
-• `Optional` **cardCodeVerification**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]
-
-___
-
-### cardExpiry
-
-• `Optional` **cardExpiry**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]
-
-___
-
-### cardName
-
-• `Optional` **cardName**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]
-
-___
-
-### cardNumber
-
-• `Optional` **cardNumber**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]
-
-___
-
-### cardNumberVerification
-
-• `Optional` **cardNumberVerification**: [`HostedInputValidateErrorData`](internal_.HostedInputValidateErrorData.md)[]

package/docs/interfaces/internal_.HostedInputValidateResults.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedInputValidateResults
-
-# Interface: HostedInputValidateResults
-
-[<internal>](../modules/internal_.md).HostedInputValidateResults
-
-## Table of contents
-
-### Properties
-
-- [errors](internal_.HostedInputValidateResults.md#errors)
-- [isValid](internal_.HostedInputValidateResults.md#isvalid)
-
-## Properties
-
-### errors
-
-• **errors**: [`HostedInputValidateErrorDataMap`](internal_.HostedInputValidateErrorDataMap.md)
-
-___
-
-### isValid
-
-• **isValid**: `boolean`

package/docs/interfaces/internal_.HostedInstrument.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedInstrument
-
-# Interface: HostedInstrument
-
-[<internal>](../modules/internal_.md).HostedInstrument
-
-## Table of contents
-
-### Properties
-
-- [shouldSaveInstrument](internal_.HostedInstrument.md#shouldsaveinstrument)
-- [shouldSetAsDefaultInstrument](internal_.HostedInstrument.md#shouldsetasdefaultinstrument)
-
-## Properties
-
-### shouldSaveInstrument
-
-• `Optional` **shouldSaveInstrument**: `boolean`
-
-___
-
-### shouldSetAsDefaultInstrument
-
-• `Optional` **shouldSetAsDefaultInstrument**: `boolean`

package/docs/interfaces/internal_.HostedStoredCardFieldOptions.md

@@ -1,56 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedStoredCardFieldOptions
-
-# Interface: HostedStoredCardFieldOptions
-
-[<internal>](../modules/internal_.md).HostedStoredCardFieldOptions
-
-## Hierarchy
-
-- [`HostedCardFieldOptions`](internal_.HostedCardFieldOptions.md)
-
-  ↳ **`HostedStoredCardFieldOptions`**
-
-## Table of contents
-
-### Properties
-
-- [accessibilityLabel](internal_.HostedStoredCardFieldOptions.md#accessibilitylabel)
-- [containerId](internal_.HostedStoredCardFieldOptions.md#containerid)
-- [instrumentId](internal_.HostedStoredCardFieldOptions.md#instrumentid)
-- [placeholder](internal_.HostedStoredCardFieldOptions.md#placeholder)
-
-## Properties
-
-### accessibilityLabel
-
-• `Optional` **accessibilityLabel**: `string`
-
-#### Inherited from
-
-[HostedCardFieldOptions](internal_.HostedCardFieldOptions.md).[accessibilityLabel](internal_.HostedCardFieldOptions.md#accessibilitylabel)
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-#### Inherited from
-
-[HostedCardFieldOptions](internal_.HostedCardFieldOptions.md).[containerId](internal_.HostedCardFieldOptions.md#containerid)
-
-___
-
-### instrumentId
-
-• **instrumentId**: `string`
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-#### Inherited from
-
-[HostedCardFieldOptions](internal_.HostedCardFieldOptions.md).[placeholder](internal_.HostedCardFieldOptions.md#placeholder)

package/docs/interfaces/internal_.HostedStoredCardFieldOptionsMap.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / HostedStoredCardFieldOptionsMap
-
-# Interface: HostedStoredCardFieldOptionsMap
-
-[<internal>](../modules/internal_.md).HostedStoredCardFieldOptionsMap
-
-## Table of contents
-
-### Properties
-
-- [cardCodeVerification](internal_.HostedStoredCardFieldOptionsMap.md#cardcodeverification)
-- [cardNumberVerification](internal_.HostedStoredCardFieldOptionsMap.md#cardnumberverification)
-
-## Properties
-
-### cardCodeVerification
-
-• `Optional` **cardCodeVerification**: [`HostedStoredCardFieldOptions`](internal_.HostedStoredCardFieldOptions.md)
-
-___
-
-### cardNumberVerification
-
-• `Optional` **cardNumberVerification**: [`HostedStoredCardFieldOptions`](internal_.HostedStoredCardFieldOptions.md)

package/docs/interfaces/internal_.IbanElementOptions.md

@@ -1,84 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / IbanElementOptions
-
-# Interface: IbanElementOptions
-
-[<internal>](../modules/internal_.md).IbanElementOptions
-
-## Hierarchy
-
-- [`BaseElementOptions_2`](internal_.BaseElementOptions_2.md)
-
-  ↳ **`IbanElementOptions`**
-
-## Table of contents
-
-### Properties
-
-- [classes](internal_.IbanElementOptions.md#classes)
-- [disabled](internal_.IbanElementOptions.md#disabled)
-- [iconStyle](internal_.IbanElementOptions.md#iconstyle)
-- [placeholderCountry](internal_.IbanElementOptions.md#placeholdercountry)
-- [style](internal_.IbanElementOptions.md#style)
-- [supportedCountries](internal_.IbanElementOptions.md#supportedcountries)
-
-## Properties
-
-### classes
-
-• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
-
-Set custom class names on the container DOM element when the Stripe element is in a particular state.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[classes](internal_.BaseElementOptions_2.md#classes)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[disabled](internal_.BaseElementOptions_2.md#disabled)
-
-___
-
-### iconStyle
-
-• `Optional` **iconStyle**: [`IconStyle`](../enums/internal_.IconStyle.md)
-
-Appearance of the icon in the Element.
-
-___
-
-### placeholderCountry
-
-• `Optional` **placeholderCountry**: `string`
-
-Customize the country and format of the placeholder IBAN. Default is DE.
-
-___
-
-### style
-
-• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
-
-Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
-which consists of CSS properties nested under objects for each variant.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[style](internal_.BaseElementOptions_2.md#style)
-
-___
-
-### supportedCountries
-
-• `Optional` **supportedCountries**: `string`[]
-
-Specify the list of countries or country-groups whose IBANs you want to allow.
-Must be ['SEPA'].

package/docs/interfaces/internal_.IdealElementOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / IdealElementOptions
-
-# Interface: IdealElementOptions
-
-[<internal>](../modules/internal_.md).IdealElementOptions
-
-## Hierarchy
-
-- [`BaseElementOptions_2`](internal_.BaseElementOptions_2.md)
-
-  ↳ **`IdealElementOptions`**
-
-## Table of contents
-
-### Properties
-
-- [classes](internal_.IdealElementOptions.md#classes)
-- [disabled](internal_.IdealElementOptions.md#disabled)
-- [hideIcon](internal_.IdealElementOptions.md#hideicon)
-- [style](internal_.IdealElementOptions.md#style)
-- [value](internal_.IdealElementOptions.md#value)
-
-## Properties
-
-### classes
-
-• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
-
-Set custom class names on the container DOM element when the Stripe element is in a particular state.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[classes](internal_.BaseElementOptions_2.md#classes)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-Applies a disabled state to the Element such that user input is not accepted. Default is false.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[disabled](internal_.BaseElementOptions_2.md#disabled)
-
-___
-
-### hideIcon
-
-• `Optional` **hideIcon**: `boolean`
-
-Hides the icon in the Element. Default is false.
-
-___
-
-### style
-
-• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
-
-Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
-which consists of CSS properties nested under objects for each variant.
-
-#### Inherited from
-
-[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[style](internal_.BaseElementOptions_2.md#style)
-
-___
-
-### value
-
-• `Optional` **value**: `string`