@bigcommerce/checkout-sdk 1.435.0 → 1.436.1

package/docs/interfaces/BirthDate.md

@@ -1,41 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BirthDate
-
-# Interface: BirthDate
-
-## Table of contents
-
-### Methods
-
-- [getDate](BirthDate.md#getdate)
-- [getFullYear](BirthDate.md#getfullyear)
-- [getMonth](BirthDate.md#getmonth)
-
-## Methods
-
-### getDate
-
-▸ **getDate**(): `number`
-
-#### Returns
-
-`number`
-
-___
-
-### getFullYear
-
-▸ **getFullYear**(): `number`
-
-#### Returns
-
-`number`
-
-___
-
-### getMonth
-
-▸ **getMonth**(): `number`
-
-#### Returns
-
-`number`

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

@@ -1,73 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BlueSnapDirectAPMInitializeOptions
-
-# Interface: BlueSnapDirectAPMInitializeOptions
-
-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: 'bluesnapDirect',
-    bluesnapDirect: {
-        onLoad: (iframe) => {
-            document.getElementById('container')
-                .appendChild(iframe);
-
-            document.getElementById('cancel-button')
-                .addEventListener('click', () => {
-                    document.getElementById('container').innerHTML = '';
-                });
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [style](BlueSnapDirectAPMInitializeOptions.md#style)
-
-### Methods
-
-- [onLoad](BlueSnapDirectAPMInitializeOptions.md#onload)
-
-## Properties
-
-### style
-
-• `Optional` **style**: [`BlueSnapDirectStyleProps`](BlueSnapDirectStyleProps.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/BlueSnapDirectStyleProps.md

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

package/docs/interfaces/BlueSnapV2PaymentInitializeOptions.md

@@ -1,73 +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/BodlEventsPayload.md

@@ -1,7 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BodlEventsPayload
-
-# Interface: BodlEventsPayload
-
-## Indexable
-
-▪ [key: `string`]: `unknown`

package/docs/interfaces/BodlService.md

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

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BoltButtonInitializeOptions
-
-# Interface: BoltButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [buyNowInitializeOptions](BoltButtonInitializeOptions.md#buynowinitializeoptions)
-- [style](BoltButtonInitializeOptions.md#style)
-
-## Properties
-
-### buyNowInitializeOptions
-
-• `Optional` **buyNowInitializeOptions**: [`BoltBuyNowInitializeOptions`](BoltBuyNowInitializeOptions.md)
-
-The options that are required to initialize Buy Now functionality.
-
-___
-
-### style
-
-• `Optional` **style**: [`BoltButtonStyleOptions`](BoltButtonStyleOptions.md)

package/docs/interfaces/BoltButtonStyleOptions.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BoltButtonStyleOptions
-
-# Interface: BoltButtonStyleOptions
-
-## Table of contents
-
-### Properties
-
-- [shape](BoltButtonStyleOptions.md#shape)
-- [size](BoltButtonStyleOptions.md#size)
-
-## Properties
-
-### shape
-
-• `Optional` **shape**: [`Pill`](../enums/StyleButtonShape.md#pill) \| [`Rect`](../enums/StyleButtonShape.md#rect)
-
-___
-
-### size
-
-• `Optional` **size**: [`Small`](../enums/StyleButtonSize.md#small) \| [`Medium`](../enums/StyleButtonSize.md#medium) \| [`Large`](../enums/StyleButtonSize.md#large)

package/docs/interfaces/BoltBuyNowInitializeOptions.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / BoltBuyNowInitializeOptions
-
-# Interface: BoltBuyNowInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [storefrontApiToken](BoltBuyNowInitializeOptions.md#storefrontapitoken)
-
-### Methods
-
-- [getBuyNowCartRequestBody](BoltBuyNowInitializeOptions.md#getbuynowcartrequestbody)
-
-## Properties
-
-### storefrontApiToken
-
-• `Optional` **storefrontApiToken**: `string`
-
-## Methods
-
-### getBuyNowCartRequestBody
-
-▸ **getBuyNowCartRequestBody**(): `default`
-
-#### Returns
-
-`default`

package/docs/interfaces/BoltCustomerInitializeOptions.md

@@ -1,31 +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`, `email?`): `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. |
-| `email?` | `string` | Email address which was used for checking user account availability on Bolt. |
-
-#### Returns
-
-`void`