@bigcommerce/checkout-sdk 1.436.0 → 1.436.1

package/docs/interfaces/BoltPaymentInitializeOptions.md

@@ -1,94 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BoltPaymentInitializeOptions
-
-# Interface: BoltPaymentInitializeOptions
-
-A set of options that are required to initialize the Bolt payment method with:
-
-1) Bolt Full Checkout:
-
-If the customer chooses to pay with Bolt, he will be asked to
-enter his payment details via Bolt Full Checkout.
-
-```js
-service.initializePayment({
-    methodId: 'bolt',
-});
-```
-
-2) Bolt Client:
-
-If the customer chooses to pay with Bolt in payment section of Checkout page,
-the Bolt Payment Modal will be shown, and the customer will be asked
-to enter payment details via Bolt Modal
-
-```js
-service.initializePayment({
-    methodId: 'bolt',
-    bolt: {
-        useBigCommerceCheckout: true,
-    }
-});
-```
-
-3) Bolt Embedded:
-
-A set of options that are required to initialize the Bolt payment method
-for presenting its credit card form.
-
-```html
-<!-- These containers are where the hosted (iframed) credit card field will be inserted -->
-<div id="bolt-embedded"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'bolt',
-    bolt: {
-        useBigCommerceCheckout: true,
-        containerId: 'boltEmbeddedContainerId',
-    }
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](BoltPaymentInitializeOptions.md#containerid)
-- [useBigCommerceCheckout](BoltPaymentInitializeOptions.md#usebigcommercecheckout)
-
-### Methods
-
-- [onPaymentSelect](BoltPaymentInitializeOptions.md#onpaymentselect)
-
-## Properties
-
-### containerId
-
-• `Optional` **containerId**: `string`
-
-The CSS selector of a container where the Bolt Embedded payment field should be inserted into.
-
-___
-
-### useBigCommerceCheckout
-
-• **useBigCommerceCheckout**: `boolean`
-
-## Methods
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(`hasBoltAccount`): `void`
-
-A callback that gets called when the customer selects Bolt as payment option.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `hasBoltAccount` | `boolean` |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeAcceleratedCheckoutCustomer.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeAcceleratedCheckoutCustomer
-
-# Interface: BraintreeAcceleratedCheckoutCustomer
-
-## Table of contents
-
-### Properties
-
-- [addresses](BraintreeAcceleratedCheckoutCustomer.md#addresses)
-- [authenticationState](BraintreeAcceleratedCheckoutCustomer.md#authenticationstate)
-- [instruments](BraintreeAcceleratedCheckoutCustomer.md#instruments)
-
-## Properties
-
-### addresses
-
-• `Optional` **addresses**: [`CustomerAddress`](CustomerAddress.md)[]
-
-___
-
-### authenticationState
-
-• `Optional` **authenticationState**: `string`
-
-___
-
-### instruments
-
-• `Optional` **instruments**: [`CardInstrument`](CardInstrument.md)[]

package/docs/interfaces/BraintreeAcceleratedCheckoutPaymentInitializeOptions.md

@@ -1,45 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeAcceleratedCheckoutPaymentInitializeOptions
-
-# Interface: BraintreeAcceleratedCheckoutPaymentInitializeOptions
-
-A set of options that are required to initialize the Braintree Accelerated Checkout payment
-method for presenting on the page.
-
-Also, Braintree requires specific options to initialize Braintree Accelerated Checkout Credit Card Component
-```html
-<!-- This is where the Braintree Credit Card Component will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'braintreeacceleratedcheckout',
-    braintreeacceleratedcheckout: {
-        onInit: (renderPayPalComponentMethod) => renderPayPalComponentMethod('#container-id');
-    },
-});
-```
-
-## Table of contents
-
-### Methods
-
-- [onInit](BraintreeAcceleratedCheckoutPaymentInitializeOptions.md#oninit)
-
-## Methods
-
-### onInit
-
-▸ `Optional` **onInit**(`renderPayPalComponentMethod`): `void`
-
-The CSS selector of a container where the payment widget should be inserted into.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `renderPayPalComponentMethod` | (`container`: `string`) => `void` |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeError.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeError
-
-# Interface: BraintreeError
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`BraintreeError`**
-
-## Table of contents
-
-### Properties
-
-- [code](BraintreeError.md#code)
-- [details](BraintreeError.md#details)
-- [type](BraintreeError.md#type)
-
-## Properties
-
-### code
-
-• **code**: `string`
-
-___
-
-### details
-
-• `Optional` **details**: `unknown`
-
-___
-
-### type
-
-• **type**: ``"CUSTOMER"`` \| ``"MERCHANT"`` \| ``"NETWORK"`` \| ``"INTERNAL"`` \| ``"UNKNOWN"``

package/docs/interfaces/BraintreeFormFieldCardTypeChangeEventData.md

@@ -1,15 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldCardTypeChangeEventData
-
-# Interface: BraintreeFormFieldCardTypeChangeEventData
-
-## Table of contents
-
-### Properties
-
-- [cardType](BraintreeFormFieldCardTypeChangeEventData.md#cardtype)
-
-## Properties
-
-### cardType
-
-• `Optional` **cardType**: `string`

package/docs/interfaces/BraintreeFormFieldKeyboardEventData.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldKeyboardEventData
-
-# Interface: BraintreeFormFieldKeyboardEventData
-
-## Table of contents
-
-### Properties
-
-- [errors](BraintreeFormFieldKeyboardEventData.md#errors)
-- [fieldType](BraintreeFormFieldKeyboardEventData.md#fieldtype)
-
-## Properties
-
-### errors
-
-• `Optional` **errors**: `Partial`<`Record`<[`BraintreeFormErrorDataKeys`](../README.md#braintreeformerrordatakeys), `Pick`<[`BraintreeFormFieldState`](BraintreeFormFieldState.md), ``"isEmpty"`` \| ``"isPotentiallyValid"`` \| ``"isValid"``\>\>\>
-
-___
-
-### fieldType
-
-• **fieldType**: `string`

package/docs/interfaces/BraintreeFormFieldOptions.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldOptions
-
-# Interface: BraintreeFormFieldOptions
-
-## Hierarchy
-
-- **`BraintreeFormFieldOptions`**
-
-  ↳ [`BraintreeStoredCardFieldOptions`](BraintreeStoredCardFieldOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [accessibilityLabel](BraintreeFormFieldOptions.md#accessibilitylabel)
-- [containerId](BraintreeFormFieldOptions.md#containerid)
-- [placeholder](BraintreeFormFieldOptions.md#placeholder)
-
-## Properties
-
-### accessibilityLabel
-
-• `Optional` **accessibilityLabel**: `string`
-
-___
-
-### containerId
-
-• **containerId**: `string`
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`

package/docs/interfaces/BraintreeFormFieldState.md

@@ -1,36 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldState
-
-# Interface: BraintreeFormFieldState
-
-## Table of contents
-
-### Properties
-
-- [isEmpty](BraintreeFormFieldState.md#isempty)
-- [isFocused](BraintreeFormFieldState.md#isfocused)
-- [isPotentiallyValid](BraintreeFormFieldState.md#ispotentiallyvalid)
-- [isValid](BraintreeFormFieldState.md#isvalid)
-
-## Properties
-
-### isEmpty
-
-• **isEmpty**: `boolean`
-
-___
-
-### isFocused
-
-• **isFocused**: `boolean`
-
-___
-
-### isPotentiallyValid
-
-• **isPotentiallyValid**: `boolean`
-
-___
-
-### isValid
-
-• **isValid**: `boolean`

package/docs/interfaces/BraintreeFormFieldStylesMap.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldStylesMap
-
-# Interface: BraintreeFormFieldStylesMap
-
-## Table of contents
-
-### Properties
-
-- [default](BraintreeFormFieldStylesMap.md#default)
-- [error](BraintreeFormFieldStylesMap.md#error)
-- [focus](BraintreeFormFieldStylesMap.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/BraintreeFormFieldValidateErrorData.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldValidateErrorData
-
-# Interface: BraintreeFormFieldValidateErrorData
-
-## Table of contents
-
-### Properties
-
-- [fieldType](BraintreeFormFieldValidateErrorData.md#fieldtype)
-- [message](BraintreeFormFieldValidateErrorData.md#message)
-- [type](BraintreeFormFieldValidateErrorData.md#type)
-
-## Properties
-
-### fieldType
-
-• **fieldType**: `string`
-
-___
-
-### message
-
-• **message**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/BraintreeFormFieldValidateEventData.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldValidateEventData
-
-# Interface: BraintreeFormFieldValidateEventData
-
-## Table of contents
-
-### Properties
-
-- [errors](BraintreeFormFieldValidateEventData.md#errors)
-- [isValid](BraintreeFormFieldValidateEventData.md#isvalid)
-
-## Properties
-
-### errors
-
-• **errors**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `cardCode?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-| `cardCodeVerification?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-| `cardExpiry?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-| `cardName?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-| `cardNumber?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-| `cardNumberVerification?` | [`BraintreeFormFieldValidateErrorData`](BraintreeFormFieldValidateErrorData.md)[] |
-
-___
-
-### isValid
-
-• **isValid**: `boolean`

package/docs/interfaces/BraintreeFormFieldsMap.md

@@ -1,36 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormFieldsMap
-
-# Interface: BraintreeFormFieldsMap
-
-## Table of contents
-
-### Properties
-
-- [cardCode](BraintreeFormFieldsMap.md#cardcode)
-- [cardExpiry](BraintreeFormFieldsMap.md#cardexpiry)
-- [cardName](BraintreeFormFieldsMap.md#cardname)
-- [cardNumber](BraintreeFormFieldsMap.md#cardnumber)
-
-## Properties
-
-### cardCode
-
-• `Optional` **cardCode**: [`BraintreeFormFieldOptions`](BraintreeFormFieldOptions.md)
-
-___
-
-### cardExpiry
-
-• **cardExpiry**: [`BraintreeFormFieldOptions`](BraintreeFormFieldOptions.md)
-
-___
-
-### cardName
-
-• **cardName**: [`BraintreeFormFieldOptions`](BraintreeFormFieldOptions.md)
-
-___
-
-### cardNumber
-
-• **cardNumber**: [`BraintreeFormFieldOptions`](BraintreeFormFieldOptions.md)

package/docs/interfaces/BraintreeFormOptions.md

@@ -1,110 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeFormOptions
-
-# Interface: BraintreeFormOptions
-
-## Table of contents
-
-### Properties
-
-- [fields](BraintreeFormOptions.md#fields)
-- [styles](BraintreeFormOptions.md#styles)
-
-### Methods
-
-- [onBlur](BraintreeFormOptions.md#onblur)
-- [onCardTypeChange](BraintreeFormOptions.md#oncardtypechange)
-- [onEnter](BraintreeFormOptions.md#onenter)
-- [onFocus](BraintreeFormOptions.md#onfocus)
-- [onValidate](BraintreeFormOptions.md#onvalidate)
-
-## Properties
-
-### fields
-
-• **fields**: [`BraintreeFormFieldsMap`](BraintreeFormFieldsMap.md) \| [`BraintreeStoredCardFieldsMap`](BraintreeStoredCardFieldsMap.md)
-
-___
-
-### styles
-
-• `Optional` **styles**: [`BraintreeFormFieldStylesMap`](BraintreeFormFieldStylesMap.md)
-
-## Methods
-
-### onBlur
-
-▸ `Optional` **onBlur**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`BraintreeFormFieldKeyboardEventData`](BraintreeFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onCardTypeChange
-
-▸ `Optional` **onCardTypeChange**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`BraintreeFormFieldCardTypeChangeEventData`](BraintreeFormFieldCardTypeChangeEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onEnter
-
-▸ `Optional` **onEnter**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`BraintreeFormFieldKeyboardEventData`](BraintreeFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFocus
-
-▸ `Optional` **onFocus**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`BraintreeFormFieldKeyboardEventData`](BraintreeFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onValidate
-
-▸ `Optional` **onValidate**(`data`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`BraintreeFormFieldValidateEventData`](BraintreeFormFieldValidateEventData.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeLocalMethods.md

@@ -1,76 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeLocalMethods
-
-# Interface: BraintreeLocalMethods
-
-## Table of contents
-
-### Properties
-
-- [buttonText](BraintreeLocalMethods.md#buttontext)
-- [container](BraintreeLocalMethods.md#container)
-
-### Methods
-
-- [onError](BraintreeLocalMethods.md#onerror)
-- [onRenderButton](BraintreeLocalMethods.md#onrenderbutton)
-- [submitForm](BraintreeLocalMethods.md#submitform)
-
-## Properties
-
-### buttonText
-
-• **buttonText**: `string`
-
-Text that will be displayed on lpm button
-
-___
-
-### container
-
-• **container**: `string`
-
-The CSS selector of a container where the payment widget should be inserted into.
-
-## Methods
-
-### onError
-
-▸ **onError**(`error`): `void`
-
-A callback for displaying error popup. This callback requires error object as parameter.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error` | `unknown` |
-
-#### Returns
-
-`void`
-
-___
-
-### onRenderButton
-
-▸ `Optional` **onRenderButton**(): `void`
-
-A callback right before render Smart Payment Button that gets called when
-This callback can be used to hide the standard submit button.
-
-#### Returns
-
-`void`
-
-___
-
-### submitForm
-
-▸ `Optional` **submitForm**(): `void`
-
-A callback for submitting payment form that gets called
-when buyer approved PayPal account.
-
-#### Returns
-
-`void`