@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.BodlService.md

@@ -1,172 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BodlService
-
-# Interface: BodlService
-
-[<internal>](../modules/internal_.md).BodlService
-
-## Table of contents
-
-### Methods
-
-- [checkoutBegin](internal_.BodlService.md#checkoutbegin)
-- [clickPayButton](internal_.BodlService.md#clickpaybutton)
-- [customerEmailEntry](internal_.BodlService.md#customeremailentry)
-- [customerPaymentMethodExecuted](internal_.BodlService.md#customerpaymentmethodexecuted)
-- [customerSuggestionExecute](internal_.BodlService.md#customersuggestionexecute)
-- [exitCheckout](internal_.BodlService.md#exitcheckout)
-- [orderPurchased](internal_.BodlService.md#orderpurchased)
-- [paymentComplete](internal_.BodlService.md#paymentcomplete)
-- [paymentRejected](internal_.BodlService.md#paymentrejected)
-- [selectedPaymentMethod](internal_.BodlService.md#selectedpaymentmethod)
-- [showShippingMethods](internal_.BodlService.md#showshippingmethods)
-- [stepCompleted](internal_.BodlService.md#stepcompleted)
-
-## Methods
-
-### checkoutBegin
-
-▸ **checkoutBegin**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### clickPayButton
-
-▸ **clickPayButton**(`payload?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `payload?` | [`BodlEventsPayload`](internal_.BodlEventsPayload.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### customerEmailEntry
-
-▸ **customerEmailEntry**(`email?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `email?` | `string` |
-
-#### Returns
-
-`void`
-
-___
-
-### customerPaymentMethodExecuted
-
-▸ **customerPaymentMethodExecuted**(`payload?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `payload?` | [`BodlEventsPayload`](internal_.BodlEventsPayload.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### customerSuggestionExecute
-
-▸ **customerSuggestionExecute**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### exitCheckout
-
-▸ **exitCheckout**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### orderPurchased
-
-▸ **orderPurchased**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### paymentComplete
-
-▸ **paymentComplete**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### paymentRejected
-
-▸ **paymentRejected**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### selectedPaymentMethod
-
-▸ **selectedPaymentMethod**(`methodName?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `methodName?` | `string` |
-
-#### Returns
-
-`void`
-
-___
-
-### showShippingMethods
-
-▸ **showShippingMethods**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### stepCompleted
-
-▸ **stepCompleted**(`step?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `step?` | `string` |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.BodyStyles.md

@@ -1,17 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BodyStyles
-
-# Interface: BodyStyles
-
-[<internal>](../modules/internal_.md).BodyStyles
-
-## Table of contents
-
-### Properties
-
-- [backgroundColor](internal_.BodyStyles.md#backgroundcolor)
-
-## Properties
-
-### backgroundColor
-
-• `Optional` **backgroundColor**: `string`

package/docs/interfaces/internal_.BoltCustomerInitializeOptions.md

@@ -1,32 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BoltCustomerInitializeOptions
-
-# Interface: BoltCustomerInitializeOptions
-
-[<internal>](../modules/internal_.md).BoltCustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout to support Bolt.
-
-## Table of contents
-
-### Methods
-
-- [onInit](internal_.BoltCustomerInitializeOptions.md#oninit)
-
-## Methods
-
-### onInit
-
-▸ `Optional` **onInit**(`hasBoltAccount`): `void`
-
-A callback that gets called on initialize the strategy
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `hasBoltAccount` | `boolean` | The hasBoltAccount variable handle the result of checking user account availability on Bolt. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.BoltPaymentInitializeOptions.md

@@ -1,96 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BoltPaymentInitializeOptions
-
-# Interface: BoltPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).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](internal_.BoltPaymentInitializeOptions.md#containerid)
-- [useBigCommerceCheckout](internal_.BoltPaymentInitializeOptions.md#usebigcommercecheckout)
-
-### Methods
-
-- [onPaymentSelect](internal_.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/internal_.BraintreePaymentInitializeOptions.md

@@ -1,91 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreePaymentInitializeOptions
-
-# Interface: BraintreePaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).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
-
-- [threeDSecure](internal_.BraintreePaymentInitializeOptions.md#threedsecure)
-
-## Properties
-
-### threeDSecure
-
-• `Optional` **threeDSecure**: [`BraintreeThreeDSecureOptions`](internal_.BraintreeThreeDSecureOptions.md)

package/docs/interfaces/internal_.BraintreeThreeDSecureOptions.md

@@ -1,53 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeThreeDSecureOptions
-
-# Interface: BraintreeThreeDSecureOptions
-
-[<internal>](../modules/internal_.md).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](internal_.BraintreeThreeDSecureOptions.md#addframe)
-- [removeFrame](internal_.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`](internal_.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/internal_.BraintreeVerifyPayload.md

@@ -1,53 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeVerifyPayload
-
-# Interface: BraintreeVerifyPayload
-
-[<internal>](../modules/internal_.md).BraintreeVerifyPayload
-
-## Table of contents
-
-### Properties
-
-- [description](internal_.BraintreeVerifyPayload.md#description)
-- [details](internal_.BraintreeVerifyPayload.md#details)
-- [liabilityShiftPossible](internal_.BraintreeVerifyPayload.md#liabilityshiftpossible)
-- [liabilityShifted](internal_.BraintreeVerifyPayload.md#liabilityshifted)
-- [nonce](internal_.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/internal_.BraintreeVisaCheckoutCustomerInitializeOptions.md

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

package/docs/interfaces/internal_.BraintreeVisaCheckoutPaymentInitializeOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeVisaCheckoutPaymentInitializeOptions
-
-# Interface: BraintreeVisaCheckoutPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).BraintreeVisaCheckoutPaymentInitializeOptions
-
-A set of options that are required to initialize the Visa Checkout payment
-method provided by Braintree.
-
-If the customer chooses to pay with Visa Checkout, 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.
-
-```js
-service.initializePayment({
-    methodId: 'braintreevisacheckout',
-});
-```
-
-Additional event callbacks can be registered.
-
-```js
-service.initializePayment({
-    methodId: 'braintreevisacheckout',
-    braintreevisacheckout: {
-        onError(error) {
-            console.log(error);
-        },
-        onPaymentSelect() {
-            console.log('Selected');
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Methods
-
-- [onError](internal_.BraintreeVisaCheckoutPaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](internal_.BraintreeVisaCheckoutPaymentInitializeOptions.md#onpaymentselect)
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called when Visa Checkout 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_.BrowserInfo.md

@@ -1,52 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BrowserInfo
-
-# Interface: BrowserInfo
-
-[<internal>](../modules/internal_.md).BrowserInfo
-
-## Table of contents
-
-### Properties
-
-- [color\_depth](internal_.BrowserInfo.md#color_depth)
-- [java\_enabled](internal_.BrowserInfo.md#java_enabled)
-- [language](internal_.BrowserInfo.md#language)
-- [screen\_height](internal_.BrowserInfo.md#screen_height)
-- [screen\_width](internal_.BrowserInfo.md#screen_width)
-- [time\_zone\_offset](internal_.BrowserInfo.md#time_zone_offset)
-
-## Properties
-
-### color\_depth
-
-• **color\_depth**: `number`
-
-___
-
-### java\_enabled
-
-• **java\_enabled**: `boolean`
-
-___
-
-### language
-
-• **language**: `string`
-
-___
-
-### screen\_height
-
-• **screen\_height**: `number`
-
-___
-
-### screen\_width
-
-• **screen\_width**: `number`
-
-___
-
-### time\_zone\_offset
-
-• **time\_zone\_offset**: `string`

package/docs/interfaces/internal_.ButtonResponse.md

@@ -1,21 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ButtonResponse
-
-# Interface: ButtonResponse
-
-[<internal>](../modules/internal_.md).ButtonResponse
-
-## Table of contents
-
-### Properties
-
-- [type](internal_.ButtonResponse.md#type)
-
-## Properties
-
-### type
-
-• **type**: `string`
-
-https://docs.digitalriver.com/digital-river-api/payment-integrations-1/drop-in/drop-in-integration-guide#customizing-the-text-of-the-drop-in-button
-The text of the Drop-in button is customizable. You can either display pre-configured text or you can specify a unique text
-Examples type: "payNow" || type: "buyNow" || type: "completeOrder" || type: "submitOrder"