@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/BlueSnapV2StyleProps.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / BlueSnapV2StyleProps
+
+# Interface: BlueSnapV2StyleProps
+
+## Table of contents
+
+### Properties
+
+- [border](BlueSnapV2StyleProps.md#border)
+- [height](BlueSnapV2StyleProps.md#height)
+- [width](BlueSnapV2StyleProps.md#width)
+
+## Properties
+
+### border
+
+• `Optional` **border**: `string`
+
+___
+
+### height
+
+• `Optional` **height**: `string`
+
+___
+
+### width
+
+• `Optional` **width**: `string`

package/docs/interfaces/BodyStyles.md

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

package/docs/interfaces/BoltCustomerInitializeOptions.md

@@ -0,0 +1,30 @@
+[@bigcommerce/checkout-sdk](../README.md) / BoltCustomerInitializeOptions
+
+# Interface: BoltCustomerInitializeOptions
+
+A set of options that are required to initialize the customer step of
+checkout to support Bolt.
+
+## Table of contents
+
+### Methods
+
+- [onInit](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/BoltPaymentInitializeOptions.md

@@ -0,0 +1,94 @@
+[@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/BraintreeError.md

@@ -0,0 +1,35 @@
+[@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

@@ -0,0 +1,15 @@
+[@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

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

package/docs/interfaces/BraintreeFormFieldOptions.md

@@ -0,0 +1,35 @@
+[@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/BraintreeFormFieldStylesMap.md

@@ -0,0 +1,29 @@
+[@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

@@ -0,0 +1,29 @@
+[@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

@@ -0,0 +1,33 @@
+[@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

@@ -0,0 +1,36 @@
+[@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

@@ -0,0 +1,110 @@
+[@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

@@ -0,0 +1,101 @@
+[@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)