@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.BraintreeVenmoButtonInitializeOptions.md

@@ -1,56 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeVenmoButtonInitializeOptions
-
-# Interface: BraintreeVenmoButtonInitializeOptions
-
-[<internal>](../modules/internal_.md).BraintreeVenmoButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [buyNowInitializeOptions](internal_.BraintreeVenmoButtonInitializeOptions.md#buynowinitializeoptions)
-- [currencyCode](internal_.BraintreeVenmoButtonInitializeOptions.md#currencycode)
-
-### Methods
-
-- [onError](internal_.BraintreeVenmoButtonInitializeOptions.md#onerror)
-
-## Properties
-
-### buyNowInitializeOptions
-
-• `Optional` **buyNowInitializeOptions**: `Object`
-
-The options that are required to initialize Buy Now functionality.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
-
-___
-
-### currencyCode
-
-• `Optional` **currencyCode**: `string`
-
-The option that used to initialize a PayPal script with provided currency code.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called on any error.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`BraintreeError`](internal_.BraintreeError.md) \| [`StandardError`](../classes/internal_.StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.BuyNowCartRequestBody.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BuyNowCartRequestBody
-
-# Interface: BuyNowCartRequestBody
-
-[<internal>](../modules/internal_.md).BuyNowCartRequestBody
-
-An object that contains the information required for creating 'Buy now' cart.
-
-## Table of contents
-
-### Properties
-
-- [lineItems](internal_.BuyNowCartRequestBody.md#lineitems)
-- [source](internal_.BuyNowCartRequestBody.md#source)
-
-## Properties
-
-### lineItems
-
-• **lineItems**: [`LineItem`](internal_.LineItem.md)[]
-
-___
-
-### source
-
-• **source**: ``"BUY_NOW"``

package/docs/interfaces/internal_.CheckoutButtonInitializerOptions.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonInitializerOptions
-
-# Interface: CheckoutButtonInitializerOptions
-
-[<internal>](../modules/internal_.md).CheckoutButtonInitializerOptions
-
-## Table of contents
-
-### Properties
-
-- [host](internal_.CheckoutButtonInitializerOptions.md#host)
-- [locale](internal_.CheckoutButtonInitializerOptions.md#locale)
-
-## Properties
-
-### host
-
-• `Optional` **host**: `string`
-
-___
-
-### locale
-
-• `Optional` **locale**: `string`

package/docs/interfaces/internal_.CheckoutButtonOptions.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonOptions
-
-# Interface: CheckoutButtonOptions
-
-[<internal>](../modules/internal_.md).CheckoutButtonOptions
-
-The set of options for configuring the checkout button.
-
-## Hierarchy
-
-- [`RequestOptions`](internal_.RequestOptions.md)
-
-  ↳ **`CheckoutButtonOptions`**
-
-  ↳↳ [`BaseCheckoutButtonInitializeOptions`](internal_.BaseCheckoutButtonInitializeOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [methodId](internal_.CheckoutButtonOptions.md#methodid)
-- [params](internal_.CheckoutButtonOptions.md#params)
-- [timeout](internal_.CheckoutButtonOptions.md#timeout)
-
-## Properties
-
-### methodId
-
-• **methodId**: [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md)
-
-The identifier of the payment method.
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions](internal_.RequestOptions.md).[params](internal_.RequestOptions.md#params)
-
-___
-
-### timeout
-
-• `Optional` **timeout**: `default`
-
-Provide this option if you want to cancel or time out the request. If the
-timeout object completes before the request, the request will be
-cancelled.
-
-#### Inherited from
-
-[RequestOptions](internal_.RequestOptions.md).[timeout](internal_.RequestOptions.md#timeout)

package/docs/interfaces/internal_.CheckoutButtonSelectors.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonSelectors
-
-# Interface: CheckoutButtonSelectors
-
-[<internal>](../modules/internal_.md).CheckoutButtonSelectors
-
-## Table of contents
-
-### Properties
-
-- [errors](internal_.CheckoutButtonSelectors.md#errors)
-- [statuses](internal_.CheckoutButtonSelectors.md#statuses)
-
-## Properties
-
-### errors
-
-• **errors**: [`CheckoutButtonErrorSelector`](../classes/internal_.CheckoutButtonErrorSelector.md)
-
-___
-
-### statuses
-
-• **statuses**: [`CheckoutButtonStatusSelector`](../classes/internal_.CheckoutButtonStatusSelector.md)

package/docs/interfaces/internal_.PaypalButtonInitializeOptions.md

@@ -1,78 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonInitializeOptions
-
-# Interface: PaypalButtonInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [allowCredit](internal_.PaypalButtonInitializeOptions.md#allowcredit)
-- [clientId](internal_.PaypalButtonInitializeOptions.md#clientid)
-- [style](internal_.PaypalButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onAuthorizeError](internal_.PaypalButtonInitializeOptions.md#onauthorizeerror)
-- [onPaymentError](internal_.PaypalButtonInitializeOptions.md#onpaymenterror)
-
-## Properties
-
-### allowCredit
-
-• `Optional` **allowCredit**: `boolean`
-
-Whether or not to show a credit button.
-
-___
-
-### clientId
-
-• **clientId**: `string`
-
-The Client ID of the Paypal App
-
-___
-
-### style
-
-• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](internal_.PaypalButtonStyleOptions.md), ``"label"`` \| ``"size"`` \| ``"color"`` \| ``"layout"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"``\>
-
-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/internal_.StandardError.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/internal_.StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.PaypalButtonStyleOptions.md

@@ -1,66 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleOptions
-
-# Interface: PaypalButtonStyleOptions
-
-[<internal>](../modules/internal_.md).PaypalButtonStyleOptions
-
-## Table of contents
-
-### Properties
-
-- [color](internal_.PaypalButtonStyleOptions.md#color)
-- [fundingicons](internal_.PaypalButtonStyleOptions.md#fundingicons)
-- [height](internal_.PaypalButtonStyleOptions.md#height)
-- [label](internal_.PaypalButtonStyleOptions.md#label)
-- [layout](internal_.PaypalButtonStyleOptions.md#layout)
-- [shape](internal_.PaypalButtonStyleOptions.md#shape)
-- [size](internal_.PaypalButtonStyleOptions.md#size)
-- [tagline](internal_.PaypalButtonStyleOptions.md#tagline)
-
-## Properties
-
-### color
-
-• `Optional` **color**: [`PaypalButtonStyleColorOption`](../enums/internal_.PaypalButtonStyleColorOption.md)
-
-___
-
-### fundingicons
-
-• `Optional` **fundingicons**: `boolean`
-
-___
-
-### height
-
-• `Optional` **height**: `number`
-
-___
-
-### label
-
-• `Optional` **label**: [`PaypalButtonStyleLabelOption`](../enums/internal_.PaypalButtonStyleLabelOption.md)
-
-___
-
-### layout
-
-• `Optional` **layout**: [`PaypalButtonStyleLayoutOption`](../enums/internal_.PaypalButtonStyleLayoutOption.md)
-
-___
-
-### shape
-
-• `Optional` **shape**: [`PaypalButtonStyleShapeOption`](../enums/internal_.PaypalButtonStyleShapeOption.md)
-
-___
-
-### size
-
-• `Optional` **size**: [`PaypalButtonStyleSizeOption`](../enums/internal_.PaypalButtonStyleSizeOption.md)
-
-___
-
-### tagline
-
-• `Optional` **tagline**: `boolean`

package/docs/interfaces/internal_.PaypalButtonStyleOptions_2.md

@@ -1,69 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleOptions\_2
-
-# Interface: PaypalButtonStyleOptions\_2
-
-[<internal>](../modules/internal_.md).PaypalButtonStyleOptions_2
-
-## Table of contents
-
-### Properties
-
-- [color](internal_.PaypalButtonStyleOptions_2.md#color)
-- [custom](internal_.PaypalButtonStyleOptions_2.md#custom)
-- [height](internal_.PaypalButtonStyleOptions_2.md#height)
-- [label](internal_.PaypalButtonStyleOptions_2.md#label)
-- [layout](internal_.PaypalButtonStyleOptions_2.md#layout)
-- [shape](internal_.PaypalButtonStyleOptions_2.md#shape)
-- [tagline](internal_.PaypalButtonStyleOptions_2.md#tagline)
-
-## Properties
-
-### color
-
-• `Optional` **color**: [`StyleButtonColor`](../enums/internal_.StyleButtonColor.md)
-
-___
-
-### custom
-
-• `Optional` **custom**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `css?` | { `background?`: `string` ; `color?`: `string` ; `width?`: `string`  } |
-| `css.background?` | `string` |
-| `css.color?` | `string` |
-| `css.width?` | `string` |
-| `label?` | `string` |
-
-___
-
-### height
-
-• `Optional` **height**: `number`
-
-___
-
-### label
-
-• `Optional` **label**: [`StyleButtonLabel`](../enums/internal_.StyleButtonLabel.md)
-
-___
-
-### layout
-
-• `Optional` **layout**: [`StyleButtonLayout`](../enums/internal_.StyleButtonLayout.md)
-
-___
-
-### shape
-
-• `Optional` **shape**: [`StyleButtonShape`](../enums/internal_.StyleButtonShape.md)
-
-___
-
-### tagline
-
-• `Optional` **tagline**: `boolean`

package/docs/interfaces/internal_.PaypalCommerceAlternativeMethodsButtonOptions.md

@@ -1,61 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceAlternativeMethodsButtonOptions
-
-# Interface: PaypalCommerceAlternativeMethodsButtonOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceAlternativeMethodsButtonOptions
-
-## Table of contents
-
-### Properties
-
-- [apm](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#apm)
-- [buyNowInitializeOptions](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#buynowinitializeoptions)
-- [currencyCode](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#currencycode)
-- [initializesOnCheckoutPage](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#initializesoncheckoutpage)
-- [style](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md#style)
-
-## Properties
-
-### apm
-
-• **apm**: `string`
-
-Alternative payment method id what used for initialization PayPal button as funding source.
-
-___
-
-### buyNowInitializeOptions
-
-• `Optional` **buyNowInitializeOptions**: `Object`
-
-The options that are required to initialize Buy Now functionality.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
-
-___
-
-### currencyCode
-
-• `Optional` **currencyCode**: `string`
-
-The option that used to initialize a PayPal script with provided currency code.
-
-___
-
-### initializesOnCheckoutPage
-
-• `Optional` **initializesOnCheckoutPage**: `boolean`
-
-Flag which helps to detect that the strategy initializes on Checkout page.
-
-___
-
-### style
-
-• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
-
-A set of styling options for the checkout button.

package/docs/interfaces/internal_.PaypalCommerceButtonInitializeOptions.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceButtonInitializeOptions
-
-# Interface: PaypalCommerceButtonInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [buyNowInitializeOptions](internal_.PaypalCommerceButtonInitializeOptions.md#buynowinitializeoptions)
-- [currencyCode](internal_.PaypalCommerceButtonInitializeOptions.md#currencycode)
-- [initializesOnCheckoutPage](internal_.PaypalCommerceButtonInitializeOptions.md#initializesoncheckoutpage)
-- [style](internal_.PaypalCommerceButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onComplete](internal_.PaypalCommerceButtonInitializeOptions.md#oncomplete)
-
-## Properties
-
-### buyNowInitializeOptions
-
-• `Optional` **buyNowInitializeOptions**: `Object`
-
-The options that are required to initialize Buy Now functionality.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
-
-___
-
-### currencyCode
-
-• `Optional` **currencyCode**: `string`
-
-The option that used to initialize a PayPal script with provided currency code.
-
-___
-
-### initializesOnCheckoutPage
-
-• `Optional` **initializesOnCheckoutPage**: `boolean`
-
-Flag which helps to detect that the strategy initializes on Checkout page.
-
-___
-
-### style
-
-• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### onComplete
-
-▸ `Optional` **onComplete**(): `void`
-
-A callback that gets called when payment complete on paypal side.
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.PaypalCommerceCreditButtonInitializeOptions.md

@@ -1,77 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceCreditButtonInitializeOptions
-
-# Interface: PaypalCommerceCreditButtonInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceCreditButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [buyNowInitializeOptions](internal_.PaypalCommerceCreditButtonInitializeOptions.md#buynowinitializeoptions)
-- [currencyCode](internal_.PaypalCommerceCreditButtonInitializeOptions.md#currencycode)
-- [initializesOnCheckoutPage](internal_.PaypalCommerceCreditButtonInitializeOptions.md#initializesoncheckoutpage)
-- [messagingContainerId](internal_.PaypalCommerceCreditButtonInitializeOptions.md#messagingcontainerid)
-- [style](internal_.PaypalCommerceCreditButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onComplete](internal_.PaypalCommerceCreditButtonInitializeOptions.md#oncomplete)
-
-## Properties
-
-### buyNowInitializeOptions
-
-• `Optional` **buyNowInitializeOptions**: `Object`
-
-The options that are required to initialize Buy Now functionality.
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](internal_.BuyNowCartRequestBody.md) |
-
-___
-
-### currencyCode
-
-• `Optional` **currencyCode**: `string`
-
-The option that used to initialize a PayPal script with provided currency code.
-
-___
-
-### initializesOnCheckoutPage
-
-• `Optional` **initializesOnCheckoutPage**: `boolean`
-
-Flag which helps to detect that the strategy initializes on Checkout page
-
-___
-
-### messagingContainerId
-
-• `Optional` **messagingContainerId**: `string`
-
-The ID of a container which the messaging should be inserted.
-
-___
-
-### style
-
-• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### onComplete
-
-▸ `Optional` **onComplete**(): `void`
-
-A callback that gets called when payment complete on paypal side.
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md

@@ -1,58 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceInlineCheckoutButtonInitializeOptions
-
-# Interface: PaypalCommerceInlineCheckoutButtonInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceInlineCheckoutButtonInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [buttonContainerClassName](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#buttoncontainerclassname)
-- [style](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#style)
-
-### Methods
-
-- [onComplete](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#oncomplete)
-- [onError](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md#onerror)
-
-## Properties
-
-### buttonContainerClassName
-
-• `Optional` **buttonContainerClassName**: `string`
-
-A class name used to add special class for container where the button will be generated in
-Default: 'PaypalCommerceInlineButton'
-
-___
-
-### style
-
-• `Optional` **style**: [`PaypalButtonStyleOptions_2`](internal_.PaypalButtonStyleOptions_2.md)
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### onComplete
-
-▸ **onComplete**(): `void`
-
-A callback that gets called when payment complete on paypal side.
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(): `void`
-
-A callback that gets called on any error
-
-#### Returns
-
-`void`