@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/BraintreePaypalButtonInitializeOptions.md

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

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

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

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

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

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

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

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

package/docs/interfaces/BraintreeVisaCheckoutPaymentInitializeOptions.md

@@ -0,0 +1,70 @@
+[@bigcommerce/checkout-sdk](../README.md) / BraintreeVisaCheckoutPaymentInitializeOptions
+
+# Interface: 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](BraintreeVisaCheckoutPaymentInitializeOptions.md#onerror)
+- [onPaymentSelect](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/BrowserInfo.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / BrowserInfo
+
+# Interface: BrowserInfo
+
+## Table of contents
+
+### Properties
+
+- [color_depth](BrowserInfo.md#color_depth)
+- [java_enabled](BrowserInfo.md#java_enabled)
+- [language](BrowserInfo.md#language)
+- [screen_height](BrowserInfo.md#screen_height)
+- [screen_width](BrowserInfo.md#screen_width)
+- [time_zone_offset](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/ButtonResponse.md

@@ -0,0 +1,19 @@
+[@bigcommerce/checkout-sdk](../README.md) / ButtonResponse
+
+# Interface: ButtonResponse
+
+## Table of contents
+
+### Properties
+
+- [type](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"

package/docs/interfaces/ButtonStyles.md

@@ -0,0 +1,141 @@
+[@bigcommerce/checkout-sdk](../README.md) / ButtonStyles
+
+# Interface: ButtonStyles
+
+## Hierarchy
+
+- [`BlockElementStyles`](BlockElementStyles.md)
+
+  ↳ **`ButtonStyles`**
+
+## Table of contents
+
+### Properties
+
+- [active](ButtonStyles.md#active)
+- [backgroundColor](ButtonStyles.md#backgroundcolor)
+- [borderColor](ButtonStyles.md#bordercolor)
+- [borderWidth](ButtonStyles.md#borderwidth)
+- [boxShadow](ButtonStyles.md#boxshadow)
+- [color](ButtonStyles.md#color)
+- [disabled](ButtonStyles.md#disabled)
+- [focus](ButtonStyles.md#focus)
+- [fontFamily](ButtonStyles.md#fontfamily)
+- [fontWeight](ButtonStyles.md#fontweight)
+- [hover](ButtonStyles.md#hover)
+- [letterSpacing](ButtonStyles.md#letterspacing)
+- [lineHeight](ButtonStyles.md#lineheight)
+
+## Properties
+
+### active
+
+• `Optional` **active**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
+
+___
+
+### borderColor
+
+• `Optional` **borderColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
+
+___
+
+### borderWidth
+
+• `Optional` **borderWidth**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
+
+___
+
+### boxShadow
+
+• `Optional` **boxShadow**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### focus
+
+• `Optional` **focus**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
+
+___
+
+### hover
+
+• `Optional` **hover**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)