@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/classes/internal_.CheckoutButtonErrorSelector.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonErrorSelector
-
-# Class: CheckoutButtonErrorSelector
-
-[<internal>](../modules/internal_.md).CheckoutButtonErrorSelector
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.CheckoutButtonErrorSelector.md#constructor)
-
-### Methods
-
-- [getDeinitializeButtonError](internal_.CheckoutButtonErrorSelector.md#getdeinitializebuttonerror)
-- [getInitializeButtonError](internal_.CheckoutButtonErrorSelector.md#getinitializebuttonerror)
-
-## Constructors
-
-### constructor
-
-• **new CheckoutButtonErrorSelector**()
-
-## Methods
-
-### getDeinitializeButtonError
-
-▸ **getDeinitializeButtonError**(`methodId?`): `undefined` \| `Error`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
-
-#### Returns
-
-`undefined` \| `Error`
-
-___
-
-### getInitializeButtonError
-
-▸ **getInitializeButtonError**(`methodId?`): `undefined` \| `Error`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
-
-#### Returns
-
-`undefined` \| `Error`

package/docs/classes/internal_.CheckoutButtonInitializer.md

@@ -1,179 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonInitializer
-
-# Class: CheckoutButtonInitializer
-
-[<internal>](../modules/internal_.md).CheckoutButtonInitializer
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.CheckoutButtonInitializer.md#constructor)
-
-### Methods
-
-- [deinitializeButton](internal_.CheckoutButtonInitializer.md#deinitializebutton)
-- [getState](internal_.CheckoutButtonInitializer.md#getstate)
-- [initializeButton](internal_.CheckoutButtonInitializer.md#initializebutton)
-- [subscribe](internal_.CheckoutButtonInitializer.md#subscribe)
-
-## Constructors
-
-### constructor
-
-• **new CheckoutButtonInitializer**()
-
-## Methods
-
-### deinitializeButton
-
-▸ **deinitializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
-
-De-initializes the checkout button by performing any necessary clean-ups.
-
-```js
-await service.deinitializeButton({
-    methodId: 'braintreepaypal',
-});
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`CheckoutButtonOptions`](../interfaces/internal_.CheckoutButtonOptions.md) | Options for deinitializing the checkout button. |
-
-#### Returns
-
-`Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
-
-A promise that resolves to the current state.
-
-___
-
-### getState
-
-▸ **getState**(): [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)
-
-Returns a snapshot of the current state.
-
-The method returns a new instance every time there is a change in the
-state. You can query the state by calling any of its getter methods.
-
-```js
-const state = service.getState();
-
-console.log(state.errors.getInitializeButtonError());
-console.log(state.statuses.isInitializingButton());
-```
-
-#### Returns
-
-[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)
-
-The current customer's checkout state
-
-___
-
-### initializeButton
-
-▸ **initializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
-
-Initializes the checkout button of a payment method.
-
-When the checkout button is initialized, it will be inserted into the DOM,
-ready to be interacted with by the customer.
-
-```js
-initializer.initializeButton({
-    methodId: 'braintreepaypal',
-    containerId: 'checkoutButton',
-    braintreepaypal: {
-    },
-});
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`CheckoutButtonInitializeOptions`](../modules/internal_.md#checkoutbuttoninitializeoptions) | Options for initializing the checkout button. |
-
-#### Returns
-
-`Promise`<[`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)\>
-
-A promise that resolves to the current state.
-
-___
-
-### subscribe
-
-▸ **subscribe**(`subscriber`, ...`filters`): () => `void`
-
-Subscribes to any changes to the current state.
-
-The method registers a callback function and executes it every time there
-is a change in the current state.
-
-```js
-service.subscribe(state => {
-    console.log(state.statuses.isInitializingButton());
-});
-```
-
-The method can be configured to notify subscribers only regarding
-relevant changes, by providing a filter function.
-
-```js
-const filter = state => state.errors.getInitializeButtonError();
-
-// Only trigger the subscriber when the cart changes.
-service.subscribe(state => {
-    console.log(state.errors.getInitializeButtonError())
-}, filter);
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `subscriber` | (`state`: [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)) => `void` | The function to subscribe to state changes. |
-| `...filters` | (`state`: [`CheckoutButtonSelectors`](../interfaces/internal_.CheckoutButtonSelectors.md)) => `any`[] | One or more functions to filter out irrelevant state changes. If more than one function is provided, the subscriber will only be triggered if all conditions are met. |
-
-#### Returns
-
-`fn`
-
-A function, if called, will unsubscribe the subscriber.
-
-▸ (): `void`
-
-Subscribes to any changes to the current state.
-
-The method registers a callback function and executes it every time there
-is a change in the current state.
-
-```js
-service.subscribe(state => {
-    console.log(state.statuses.isInitializingButton());
-});
-```
-
-The method can be configured to notify subscribers only regarding
-relevant changes, by providing a filter function.
-
-```js
-const filter = state => state.errors.getInitializeButtonError();
-
-// Only trigger the subscriber when the cart changes.
-service.subscribe(state => {
-    console.log(state.errors.getInitializeButtonError())
-}, filter);
-```
-
-##### Returns
-
-`void`
-
-A function, if called, will unsubscribe the subscriber.

package/docs/classes/internal_.CheckoutButtonStatusSelector.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonStatusSelector
-
-# Class: CheckoutButtonStatusSelector
-
-[<internal>](../modules/internal_.md).CheckoutButtonStatusSelector
-
-## Table of contents
-
-### Constructors
-
-- [constructor](internal_.CheckoutButtonStatusSelector.md#constructor)
-
-### Methods
-
-- [isDeinitializingButton](internal_.CheckoutButtonStatusSelector.md#isdeinitializingbutton)
-- [isInitializingButton](internal_.CheckoutButtonStatusSelector.md#isinitializingbutton)
-
-## Constructors
-
-### constructor
-
-• **new CheckoutButtonStatusSelector**()
-
-## Methods
-
-### isDeinitializingButton
-
-▸ **isDeinitializingButton**(`methodId?`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
-
-#### Returns
-
-`boolean`
-
-___
-
-### isInitializingButton
-
-▸ **isInitializingButton**(`methodId?`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `methodId?` | [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md) |
-
-#### Returns
-
-`boolean`

package/docs/enums/internal_.AmazonPayV2ButtonColor.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2ButtonColor
-
-# Enumeration: AmazonPayV2ButtonColor
-
-[<internal>](../modules/internal_.md).AmazonPayV2ButtonColor
-
-## Table of contents
-
-### Enumeration Members
-
-- [DarkGray](internal_.AmazonPayV2ButtonColor.md#darkgray)
-- [Gold](internal_.AmazonPayV2ButtonColor.md#gold)
-- [LightGray](internal_.AmazonPayV2ButtonColor.md#lightgray)
-
-## Enumeration Members
-
-### DarkGray
-
-• **DarkGray**
-
-___
-
-### Gold
-
-• **Gold**
-
-___
-
-### LightGray
-
-• **LightGray**

package/docs/enums/internal_.AmazonPayV2CheckoutLanguage.md

@@ -1,59 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2CheckoutLanguage
-
-# Enumeration: AmazonPayV2CheckoutLanguage
-
-[<internal>](../modules/internal_.md).AmazonPayV2CheckoutLanguage
-
-## Table of contents
-
-### Enumeration Members
-
-- [de\_DE](internal_.AmazonPayV2CheckoutLanguage.md#de_de)
-- [en\_GB](internal_.AmazonPayV2CheckoutLanguage.md#en_gb)
-- [en\_US](internal_.AmazonPayV2CheckoutLanguage.md#en_us)
-- [es\_ES](internal_.AmazonPayV2CheckoutLanguage.md#es_es)
-- [fr\_FR](internal_.AmazonPayV2CheckoutLanguage.md#fr_fr)
-- [it\_IT](internal_.AmazonPayV2CheckoutLanguage.md#it_it)
-- [ja\_JP](internal_.AmazonPayV2CheckoutLanguage.md#ja_jp)
-
-## Enumeration Members
-
-### de\_DE
-
-• **de\_DE**
-
-___
-
-### en\_GB
-
-• **en\_GB**
-
-___
-
-### en\_US
-
-• **en\_US**
-
-___
-
-### es\_ES
-
-• **es\_ES**
-
-___
-
-### fr\_FR
-
-• **fr\_FR**
-
-___
-
-### it\_IT
-
-• **it\_IT**
-
-___
-
-### ja\_JP
-
-• **ja\_JP**

package/docs/enums/internal_.AmazonPayV2LedgerCurrency.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2LedgerCurrency
-
-# Enumeration: AmazonPayV2LedgerCurrency
-
-[<internal>](../modules/internal_.md).AmazonPayV2LedgerCurrency
-
-## Table of contents
-
-### Enumeration Members
-
-- [EUR](internal_.AmazonPayV2LedgerCurrency.md#eur)
-- [GBP](internal_.AmazonPayV2LedgerCurrency.md#gbp)
-- [JPY](internal_.AmazonPayV2LedgerCurrency.md#jpy)
-- [USD](internal_.AmazonPayV2LedgerCurrency.md#usd)
-
-## Enumeration Members
-
-### EUR
-
-• **EUR**
-
-___
-
-### GBP
-
-• **GBP**
-
-___
-
-### JPY
-
-• **JPY**
-
-___
-
-### USD
-
-• **USD**

package/docs/enums/internal_.AmazonPayV2PayOptions.md

@@ -1,28 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2PayOptions
-
-# Enumeration: AmazonPayV2PayOptions
-
-[<internal>](../modules/internal_.md).AmazonPayV2PayOptions
-
-## Table of contents
-
-### Enumeration Members
-
-- [PayAndShip](internal_.AmazonPayV2PayOptions.md#payandship)
-- [PayOnly](internal_.AmazonPayV2PayOptions.md#payonly)
-
-## Enumeration Members
-
-### PayAndShip
-
-• **PayAndShip**
-
-Select this product type if you need the buyer's shipping details.
-
-___
-
-### PayOnly
-
-• **PayOnly**
-
-Select this product type if you do not need the buyer's shipping details.

package/docs/enums/internal_.AmazonPayV2Placement.md

@@ -1,55 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2Placement
-
-# Enumeration: AmazonPayV2Placement
-
-[<internal>](../modules/internal_.md).AmazonPayV2Placement
-
-## Table of contents
-
-### Enumeration Members
-
-- [Cart](internal_.AmazonPayV2Placement.md#cart)
-- [Checkout](internal_.AmazonPayV2Placement.md#checkout)
-- [Home](internal_.AmazonPayV2Placement.md#home)
-- [Other](internal_.AmazonPayV2Placement.md#other)
-- [Product](internal_.AmazonPayV2Placement.md#product)
-
-## Enumeration Members
-
-### Cart
-
-• **Cart**
-
-Cart review page before buyer starts checkout.
-
-___
-
-### Checkout
-
-• **Checkout**
-
-Any page after buyer starts checkout.
-
-___
-
-### Home
-
-• **Home**
-
-Initial or main page.
-
-___
-
-### Other
-
-• **Other**
-
-Any page that doesn't fit the previous descriptions.
-
-___
-
-### Product
-
-• **Product**
-
-Product details page.

package/docs/enums/internal_.CheckoutButtonMethodType.md

@@ -1,164 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonMethodType
-
-# Enumeration: CheckoutButtonMethodType
-
-[<internal>](../modules/internal_.md).CheckoutButtonMethodType
-
-## Table of contents
-
-### Enumeration Members
-
-- [AMAZON\_PAY\_V2](internal_.CheckoutButtonMethodType.md#amazon_pay_v2)
-- [APPLEPAY](internal_.CheckoutButtonMethodType.md#applepay)
-- [BRAINTREE\_PAYPAL](internal_.CheckoutButtonMethodType.md#braintree_paypal)
-- [BRAINTREE\_PAYPAL\_CREDIT](internal_.CheckoutButtonMethodType.md#braintree_paypal_credit)
-- [BRAINTREE\_VENMO](internal_.CheckoutButtonMethodType.md#braintree_venmo)
-- [GOOGLEPAY\_ADYENV2](internal_.CheckoutButtonMethodType.md#googlepay_adyenv2)
-- [GOOGLEPAY\_ADYENV3](internal_.CheckoutButtonMethodType.md#googlepay_adyenv3)
-- [GOOGLEPAY\_AUTHORIZENET](internal_.CheckoutButtonMethodType.md#googlepay_authorizenet)
-- [GOOGLEPAY\_BNZ](internal_.CheckoutButtonMethodType.md#googlepay_bnz)
-- [GOOGLEPAY\_BRAINTREE](internal_.CheckoutButtonMethodType.md#googlepay_braintree)
-- [GOOGLEPAY\_CHECKOUTCOM](internal_.CheckoutButtonMethodType.md#googlepay_checkoutcom)
-- [GOOGLEPAY\_CYBERSOURCEV2](internal_.CheckoutButtonMethodType.md#googlepay_cybersourcev2)
-- [GOOGLEPAY\_ORBITAL](internal_.CheckoutButtonMethodType.md#googlepay_orbital)
-- [GOOGLEPAY\_STRIPE](internal_.CheckoutButtonMethodType.md#googlepay_stripe)
-- [GOOGLEPAY\_STRIPEUPE](internal_.CheckoutButtonMethodType.md#googlepay_stripeupe)
-- [MASTERPASS](internal_.CheckoutButtonMethodType.md#masterpass)
-- [PAYPALCOMMERCE](internal_.CheckoutButtonMethodType.md#paypalcommerce)
-- [PAYPALCOMMERCE\_APMS](internal_.CheckoutButtonMethodType.md#paypalcommerce_apms)
-- [PAYPALCOMMERCE\_CREDIT](internal_.CheckoutButtonMethodType.md#paypalcommerce_credit)
-- [PAYPALCOMMERCE\_INLINE](internal_.CheckoutButtonMethodType.md#paypalcommerce_inline)
-- [PAYPALCOMMERCE\_VENMO](internal_.CheckoutButtonMethodType.md#paypalcommerce_venmo)
-- [PAYPALEXPRESS](internal_.CheckoutButtonMethodType.md#paypalexpress)
-
-## Enumeration Members
-
-### AMAZON\_PAY\_V2
-
-• **AMAZON\_PAY\_V2**
-
-___
-
-### APPLEPAY
-
-• **APPLEPAY**
-
-___
-
-### BRAINTREE\_PAYPAL
-
-• **BRAINTREE\_PAYPAL**
-
-___
-
-### BRAINTREE\_PAYPAL\_CREDIT
-
-• **BRAINTREE\_PAYPAL\_CREDIT**
-
-___
-
-### BRAINTREE\_VENMO
-
-• **BRAINTREE\_VENMO**
-
-___
-
-### GOOGLEPAY\_ADYENV2
-
-• **GOOGLEPAY\_ADYENV2**
-
-___
-
-### GOOGLEPAY\_ADYENV3
-
-• **GOOGLEPAY\_ADYENV3**
-
-___
-
-### GOOGLEPAY\_AUTHORIZENET
-
-• **GOOGLEPAY\_AUTHORIZENET**
-
-___
-
-### GOOGLEPAY\_BNZ
-
-• **GOOGLEPAY\_BNZ**
-
-___
-
-### GOOGLEPAY\_BRAINTREE
-
-• **GOOGLEPAY\_BRAINTREE**
-
-___
-
-### GOOGLEPAY\_CHECKOUTCOM
-
-• **GOOGLEPAY\_CHECKOUTCOM**
-
-___
-
-### GOOGLEPAY\_CYBERSOURCEV2
-
-• **GOOGLEPAY\_CYBERSOURCEV2**
-
-___
-
-### GOOGLEPAY\_ORBITAL
-
-• **GOOGLEPAY\_ORBITAL**
-
-___
-
-### GOOGLEPAY\_STRIPE
-
-• **GOOGLEPAY\_STRIPE**
-
-___
-
-### GOOGLEPAY\_STRIPEUPE
-
-• **GOOGLEPAY\_STRIPEUPE**
-
-___
-
-### MASTERPASS
-
-• **MASTERPASS**
-
-___
-
-### PAYPALCOMMERCE
-
-• **PAYPALCOMMERCE**
-
-___
-
-### PAYPALCOMMERCE\_APMS
-
-• **PAYPALCOMMERCE\_APMS**
-
-___
-
-### PAYPALCOMMERCE\_CREDIT
-
-• **PAYPALCOMMERCE\_CREDIT**
-
-___
-
-### PAYPALCOMMERCE\_INLINE
-
-• **PAYPALCOMMERCE\_INLINE**
-
-___
-
-### PAYPALCOMMERCE\_VENMO
-
-• **PAYPALCOMMERCE\_VENMO**
-
-___
-
-### PAYPALEXPRESS
-
-• **PAYPALEXPRESS**

package/docs/enums/internal_.PaypalButtonStyleColorOption.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleColorOption
-
-# Enumeration: PaypalButtonStyleColorOption
-
-[<internal>](../modules/internal_.md).PaypalButtonStyleColorOption
-
-## Table of contents
-
-### Enumeration Members
-
-- [BLACK](internal_.PaypalButtonStyleColorOption.md#black)
-- [BLUE](internal_.PaypalButtonStyleColorOption.md#blue)
-- [GOLD](internal_.PaypalButtonStyleColorOption.md#gold)
-- [SIlVER](internal_.PaypalButtonStyleColorOption.md#silver)
-
-## Enumeration Members
-
-### BLACK
-
-• **BLACK**
-
-___
-
-### BLUE
-
-• **BLUE**
-
-___
-
-### GOLD
-
-• **GOLD**
-
-___
-
-### SIlVER
-
-• **SIlVER**