@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

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/BraintreePaymentInitializeOptions.md

@@ -1,101 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreePaymentInitializeOptions
-
-# Interface: BraintreePaymentInitializeOptions
-
-A set of options that are required to initialize the Braintree payment
-method. You need to provide the options if you want to support 3D Secure
-authentication flow.
-
-```html
-<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
-<div id="card-number"></div>
-<div id="card-name"></div>
-<div id="card-expiry"></div>
-<div id="card-code"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'braintree',
-    braintree: {
-        form: {
-            fields: {
-                cardNumber: { containerId: 'card-number' },
-                cardName: { containerId: 'card-name' },
-                cardExpiry: { containerId: 'card-expiry' },
-                cardCode: { containerId: 'card-code' },
-            },
-        },
-    },
-});
-```
-
-Additional options can be passed in to customize the fields and register
-event callbacks.
-
-```js
-service.initializePayment({
-    methodId: 'braintree',
-    creditCard: {
-        form: {
-            fields: {
-                cardNumber: { containerId: 'card-number' },
-                cardName: { containerId: 'card-name' },
-                cardExpiry: { containerId: 'card-expiry' },
-                cardCode: { containerId: 'card-code' },
-            },
-            styles: {
-                default: {
-                    color: '#000',
-                },
-                error: {
-                    color: '#f00',
-                },
-                focus: {
-                    color: '#0f0',
-                },
-            },
-            onBlur({ fieldType }) {
-                console.log(fieldType);
-            },
-            onFocus({ fieldType }) {
-                console.log(fieldType);
-            },
-            onEnter({ fieldType }) {
-                console.log(fieldType);
-            },
-            onCardTypeChange({ cardType }) {
-                console.log(cardType);
-            },
-            onValidate({ errors, isValid }) {
-                console.log(errors);
-                console.log(isValid);
-            },
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [form](BraintreePaymentInitializeOptions.md#form)
-- [threeDSecure](BraintreePaymentInitializeOptions.md#threedsecure)
-
-## Properties
-
-### form
-
-• `Optional` **form**: [`BraintreeFormOptions`](BraintreeFormOptions.md)
-
-**`alpha`**
-Please note that this option is currently in an early stage of
-development. Therefore the API is unstable and not ready for public
-consumption.
-
-___
-
-### threeDSecure
-
-• `Optional` **threeDSecure**: [`BraintreeThreeDSecureOptions`](BraintreeThreeDSecureOptions.md)

package/docs/interfaces/BraintreePaypalButtonInitializeOptions.md

@@ -1,96 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreePaypalButtonInitializeOptions
-
-# Interface: BraintreePaypalButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [messagingContainerId](BraintreePaypalButtonInitializeOptions.md#messagingcontainerid)
-- [shippingAddress](BraintreePaypalButtonInitializeOptions.md#shippingaddress)
-- [style](BraintreePaypalButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onAuthorizeError](BraintreePaypalButtonInitializeOptions.md#onauthorizeerror)
-- [onError](BraintreePaypalButtonInitializeOptions.md#onerror)
-- [onPaymentError](BraintreePaypalButtonInitializeOptions.md#onpaymenterror)
-
-## Properties
-
-### messagingContainerId
-
-• `Optional` **messagingContainerId**: `string`
-
-The ID of a container which the messaging should be inserted.
-
-___
-
-### shippingAddress
-
-• `Optional` **shippingAddress**: ``null`` \| [`Address`](Address.md)
-
-Address to be used for shipping.
-If not provided, it will use the first saved address from the active customer.
-
-___
-
-### style
-
-• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](PaypalButtonStyleOptions.md), ``"color"`` \| ``"layout"`` \| ``"size"`` \| ``"label"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"`` \| ``"height"``\>
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### onAuthorizeError
-
-▸ `Optional` **onAuthorizeError**(`error`): `void`
-
-A callback that gets called if unable to authorize and tokenize payment.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called on any error instead of submit payment or authorization errors.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentError
-
-▸ `Optional` **onPaymentError**(`error`): `void`
-
-A callback that gets called if unable to submit payment.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreePaypalCreditButtonInitializeOptions.md

@@ -1,87 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreePaypalCreditButtonInitializeOptions
-
-# Interface: BraintreePaypalCreditButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [shippingAddress](BraintreePaypalCreditButtonInitializeOptions.md#shippingaddress)
-- [style](BraintreePaypalCreditButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onAuthorizeError](BraintreePaypalCreditButtonInitializeOptions.md#onauthorizeerror)
-- [onError](BraintreePaypalCreditButtonInitializeOptions.md#onerror)
-- [onPaymentError](BraintreePaypalCreditButtonInitializeOptions.md#onpaymenterror)
-
-## Properties
-
-### shippingAddress
-
-• `Optional` **shippingAddress**: ``null`` \| [`Address`](Address.md)
-
-Address to be used for shipping.
-If not provided, it will use the first saved address from the active customer.
-
-___
-
-### style
-
-• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](PaypalButtonStyleOptions.md), ``"color"`` \| ``"layout"`` \| ``"size"`` \| ``"label"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"`` \| ``"height"``\>
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### onAuthorizeError
-
-▸ `Optional` **onAuthorizeError**(`error`): `void`
-
-A callback that gets called if unable to authorize and tokenize payment.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called on any error instead of submit payment or authorization errors.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentError
-
-▸ `Optional` **onPaymentError**(`error`): `void`
-
-A callback that gets called if unable to submit payment.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeStoredCardFieldOptions.md

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

package/docs/interfaces/BraintreeStoredCardFieldsMap.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeStoredCardFieldsMap
-
-# Interface: BraintreeStoredCardFieldsMap
-
-## Table of contents
-
-### Properties
-
-- [cardCodeVerification](BraintreeStoredCardFieldsMap.md#cardcodeverification)
-- [cardNumberVerification](BraintreeStoredCardFieldsMap.md#cardnumberverification)
-
-## Properties
-
-### cardCodeVerification
-
-• `Optional` **cardCodeVerification**: [`BraintreeStoredCardFieldOptions`](BraintreeStoredCardFieldOptions.md)
-
-___
-
-### cardNumberVerification
-
-• `Optional` **cardNumberVerification**: [`BraintreeStoredCardFieldOptions`](BraintreeStoredCardFieldOptions.md)

package/docs/interfaces/BraintreeThreeDSecureOptions.md

@@ -1,51 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeThreeDSecureOptions
-
-# Interface: BraintreeThreeDSecureOptions
-
-A set of options that are required to support 3D Secure authentication flow.
-
-If the customer uses a credit card that has 3D Secure enabled, they will be
-asked to verify their identity when they pay. The verification is done
-through a web page via an iframe provided by the card issuer.
-
-## Table of contents
-
-### Methods
-
-- [addFrame](BraintreeThreeDSecureOptions.md#addframe)
-- [removeFrame](BraintreeThreeDSecureOptions.md#removeframe)
-
-## Methods
-
-### addFrame
-
-▸ **addFrame**(`error`, `iframe`, `cancel`): `void`
-
-A callback that gets called when the iframe is ready to be added to the
-current page. It is responsible for determining where the iframe should
-be inserted in the DOM.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | `undefined` \| `Error` | Any error raised during the verification process; undefined if there is none. |
-| `iframe` | `HTMLIFrameElement` | The iframe element containing the verification web page provided by the card issuer. |
-| `cancel` | () => `undefined` \| `Promise`<[`BraintreeVerifyPayload`](BraintreeVerifyPayload.md)\> | A function, when called, will cancel the verification process and remove the iframe. |
-
-#### Returns
-
-`void`
-
-___
-
-### removeFrame
-
-▸ **removeFrame**(): `void`
-
-A callback that gets called when the iframe is about to be removed from
-the current page.
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeVenmoButtonInitializeOptions.md

@@ -1,27 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeVenmoButtonInitializeOptions
-
-# Interface: BraintreeVenmoButtonInitializeOptions
-
-## Table of contents
-
-### Methods
-
-- [onError](BraintreeVenmoButtonInitializeOptions.md#onerror)
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called on any error.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/BraintreeVerifyPayload.md

@@ -1,51 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeVerifyPayload
-
-# Interface: BraintreeVerifyPayload
-
-## Table of contents
-
-### Properties
-
-- [description](BraintreeVerifyPayload.md#description)
-- [details](BraintreeVerifyPayload.md#details)
-- [liabilityShiftPossible](BraintreeVerifyPayload.md#liabilityshiftpossible)
-- [liabilityShifted](BraintreeVerifyPayload.md#liabilityshifted)
-- [nonce](BraintreeVerifyPayload.md#nonce)
-
-## Properties
-
-### description
-
-• **description**: `string`
-
-___
-
-### details
-
-• **details**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `cardType` | `string` |
-| `lastFour` | `string` |
-| `lastTwo` | `string` |
-
-___
-
-### liabilityShiftPossible
-
-• **liabilityShiftPossible**: `boolean`
-
-___
-
-### liabilityShifted
-
-• **liabilityShifted**: `boolean`
-
-___
-
-### nonce
-
-• **nonce**: `string`

package/docs/interfaces/BraintreeVisaCheckoutCustomerInitializeOptions.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BraintreeVisaCheckoutCustomerInitializeOptions
-
-# Interface: BraintreeVisaCheckoutCustomerInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [container](BraintreeVisaCheckoutCustomerInitializeOptions.md#container)
-
-### Methods
-
-- [onError](BraintreeVisaCheckoutCustomerInitializeOptions.md#onerror)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error` | `Error` |
-
-#### Returns
-
-`void`