@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/BillingAddressRequestBody.md

@@ -1,153 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BillingAddressRequestBody
-
-# Interface: BillingAddressRequestBody
-
-## Hierarchy
-
-- [`AddressRequestBody`](AddressRequestBody.md)
-
-  ↳ **`BillingAddressRequestBody`**
-
-## Table of contents
-
-### Properties
-
-- [address1](BillingAddressRequestBody.md#address1)
-- [address2](BillingAddressRequestBody.md#address2)
-- [city](BillingAddressRequestBody.md#city)
-- [company](BillingAddressRequestBody.md#company)
-- [countryCode](BillingAddressRequestBody.md#countrycode)
-- [customFields](BillingAddressRequestBody.md#customfields)
-- [email](BillingAddressRequestBody.md#email)
-- [firstName](BillingAddressRequestBody.md#firstname)
-- [lastName](BillingAddressRequestBody.md#lastname)
-- [phone](BillingAddressRequestBody.md#phone)
-- [postalCode](BillingAddressRequestBody.md#postalcode)
-- [stateOrProvince](BillingAddressRequestBody.md#stateorprovince)
-- [stateOrProvinceCode](BillingAddressRequestBody.md#stateorprovincecode)
-
-## Properties
-
-### address1
-
-• **address1**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[address1](AddressRequestBody.md#address1)
-
-___
-
-### address2
-
-• **address2**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[address2](AddressRequestBody.md#address2)
-
-___
-
-### city
-
-• **city**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[city](AddressRequestBody.md#city)
-
-___
-
-### company
-
-• **company**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[company](AddressRequestBody.md#company)
-
-___
-
-### countryCode
-
-• **countryCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[countryCode](AddressRequestBody.md#countrycode)
-
-___
-
-### customFields
-
-• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[customFields](AddressRequestBody.md#customfields)
-
-___
-
-### email
-
-• `Optional` **email**: `string`
-
-___
-
-### firstName
-
-• **firstName**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[firstName](AddressRequestBody.md#firstname)
-
-___
-
-### lastName
-
-• **lastName**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[lastName](AddressRequestBody.md#lastname)
-
-___
-
-### phone
-
-• **phone**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[phone](AddressRequestBody.md#phone)
-
-___
-
-### postalCode
-
-• **postalCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[postalCode](AddressRequestBody.md#postalcode)
-
-___
-
-### stateOrProvince
-
-• **stateOrProvince**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[stateOrProvince](AddressRequestBody.md#stateorprovince)
-
-___
-
-### stateOrProvinceCode
-
-• **stateOrProvinceCode**: `string`
-
-#### Inherited from
-
-[AddressRequestBody](AddressRequestBody.md).[stateOrProvinceCode](AddressRequestBody.md#stateorprovincecode)

package/docs/interfaces/BlockElementStyles.md

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

package/docs/interfaces/BlueSnapV2PaymentInitializeOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BlueSnapV2PaymentInitializeOptions
-
-# Interface: BlueSnapV2PaymentInitializeOptions
-
-A set of options that are required to initialize the BlueSnap V2 payment
-method.
-
-The payment step is done through a web page via an iframe provided by the
-strategy.
-
-```html
-<!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
-<div id="container"></div>
-
-<!-- This is a cancellation button -->
-<button type="button" id="cancel-button"></button>
-```
-
-```js
-service.initializePayment({
-    methodId: 'bluesnapv2',
-    bluesnapv2: {
-        onLoad: (iframe) => {
-            document.getElementById('container')
-                .appendChild(iframe);
-
-            document.getElementById('cancel-button')
-                .addEventListener('click', () => {
-                    document.getElementById('container').innerHTML = '';
-                });
-        },
-    },
-});
-
-## Table of contents
-
-### Properties
-
-- [style](BlueSnapV2PaymentInitializeOptions.md#style)
-
-### Methods
-
-- [onLoad](BlueSnapV2PaymentInitializeOptions.md#onload)
-
-## Properties
-
-### style
-
-• `Optional` **style**: [`BlueSnapV2StyleProps`](BlueSnapV2StyleProps.md)
-
-A set of CSS properties to apply to the iframe.
-
-## Methods
-
-### onLoad
-
-▸ **onLoad**(`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 |
-| :------ | :------ | :------ |
-| `iframe` | `HTMLIFrameElement` | The iframe element containing the payment web page provided by the strategy. |
-| `cancel` | () => `void` | A function, when called, will cancel the payment process and remove the iframe. |
-
-#### Returns
-
-`void`

package/docs/interfaces/BlueSnapV2StyleProps.md

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

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

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

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

@@ -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/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`