@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/classes/CartChangedError.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / CartChangedError
+
+# Class: CartChangedError
+
+## Hierarchy
+
+- [`StandardError`](StandardError.md)
+
+  ↳ **`CartChangedError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CartChangedError.md#constructor)
+
+### Properties
+
+- [data](CartChangedError.md#data)
+- [name](CartChangedError.md#name)
+- [type](CartChangedError.md#type)
+
+## Constructors
+
+### constructor
+
+• **new CartChangedError**(`previous`, `updated`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `previous` | [`ComparableCheckout`](../README.md#comparablecheckout) |
+| `updated` | [`ComparableCheckout`](../README.md#comparablecheckout) |
+
+#### Overrides
+
+[StandardError](StandardError.md).[constructor](StandardError.md#constructor)
+
+## Properties
+
+### data
+
+• **data**: `Object`
+
+**`alpha`**
+Please note that this option is currently in an early stage of
+development. Therefore the API is unstable and not ready for public
+consumption.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `previous` | [`ComparableCheckout`](../README.md#comparablecheckout) |
+| `updated` | [`ComparableCheckout`](../README.md#comparablecheckout) |
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StandardError](StandardError.md).[name](StandardError.md#name)
+
+___
+
+### type
+
+• **type**: `string`
+
+#### Inherited from
+
+[StandardError](StandardError.md).[type](StandardError.md#type)

package/docs/classes/CheckoutButtonErrorSelector.md

@@ -0,0 +1,52 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonErrorSelector
+
+# Class: CheckoutButtonErrorSelector
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CheckoutButtonErrorSelector.md#constructor)
+
+### Methods
+
+- [getDeinitializeButtonError](CheckoutButtonErrorSelector.md#getdeinitializebuttonerror)
+- [getInitializeButtonError](CheckoutButtonErrorSelector.md#getinitializebuttonerror)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonErrorSelector**()
+
+## Methods
+
+### getDeinitializeButtonError
+
+▸ **getDeinitializeButtonError**(`methodId?`): `undefined` \| `Error`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`APPLEPAY`](../enums/CheckoutButtonMethodType.md#applepay) \| [`AMAZON_PAY_V2`](../enums/CheckoutButtonMethodType.md#amazon_pay_v2) \| [`BRAINTREE_PAYPAL`](../enums/CheckoutButtonMethodType.md#braintree_paypal) \| [`BRAINTREE_VENMO`](../enums/CheckoutButtonMethodType.md#braintree_venmo) \| [`BRAINTREE_PAYPAL_CREDIT`](../enums/CheckoutButtonMethodType.md#braintree_paypal_credit) \| [`GOOGLEPAY_ADYENV2`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv2) \| [`GOOGLEPAY_ADYENV3`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv3) \| [`GOOGLEPAY_AUTHORIZENET`](../enums/CheckoutButtonMethodType.md#googlepay_authorizenet) \| [`GOOGLEPAY_BRAINTREE`](../enums/CheckoutButtonMethodType.md#googlepay_braintree) \| [`GOOGLEPAY_CHECKOUTCOM`](../enums/CheckoutButtonMethodType.md#googlepay_checkoutcom) \| [`GOOGLEPAY_CYBERSOURCEV2`](../enums/CheckoutButtonMethodType.md#googlepay_cybersourcev2) \| [`GOOGLEPAY_ORBITAL`](../enums/CheckoutButtonMethodType.md#googlepay_orbital) \| [`GOOGLEPAY_STRIPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripe) \| [`GOOGLEPAY_STRIPEUPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripeupe) \| [`MASTERPASS`](../enums/CheckoutButtonMethodType.md#masterpass) \| [`PAYPALEXPRESS`](../enums/CheckoutButtonMethodType.md#paypalexpress) \| [`PAYPALCOMMERCE`](../enums/CheckoutButtonMethodType.md#paypalcommerce) \| [`PAYPALCOMMERCE_APMS`](../enums/CheckoutButtonMethodType.md#paypalcommerce_apms) \| [`PAYPALCOMMERCE_VENMO`](../enums/CheckoutButtonMethodType.md#paypalcommerce_venmo) |
+
+#### Returns
+
+`undefined` \| `Error`
+
+___
+
+### getInitializeButtonError
+
+▸ **getInitializeButtonError**(`methodId?`): `undefined` \| `Error`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`APPLEPAY`](../enums/CheckoutButtonMethodType.md#applepay) \| [`AMAZON_PAY_V2`](../enums/CheckoutButtonMethodType.md#amazon_pay_v2) \| [`BRAINTREE_PAYPAL`](../enums/CheckoutButtonMethodType.md#braintree_paypal) \| [`BRAINTREE_VENMO`](../enums/CheckoutButtonMethodType.md#braintree_venmo) \| [`BRAINTREE_PAYPAL_CREDIT`](../enums/CheckoutButtonMethodType.md#braintree_paypal_credit) \| [`GOOGLEPAY_ADYENV2`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv2) \| [`GOOGLEPAY_ADYENV3`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv3) \| [`GOOGLEPAY_AUTHORIZENET`](../enums/CheckoutButtonMethodType.md#googlepay_authorizenet) \| [`GOOGLEPAY_BRAINTREE`](../enums/CheckoutButtonMethodType.md#googlepay_braintree) \| [`GOOGLEPAY_CHECKOUTCOM`](../enums/CheckoutButtonMethodType.md#googlepay_checkoutcom) \| [`GOOGLEPAY_CYBERSOURCEV2`](../enums/CheckoutButtonMethodType.md#googlepay_cybersourcev2) \| [`GOOGLEPAY_ORBITAL`](../enums/CheckoutButtonMethodType.md#googlepay_orbital) \| [`GOOGLEPAY_STRIPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripe) \| [`GOOGLEPAY_STRIPEUPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripeupe) \| [`MASTERPASS`](../enums/CheckoutButtonMethodType.md#masterpass) \| [`PAYPALEXPRESS`](../enums/CheckoutButtonMethodType.md#paypalexpress) \| [`PAYPALCOMMERCE`](../enums/CheckoutButtonMethodType.md#paypalcommerce) \| [`PAYPALCOMMERCE_APMS`](../enums/CheckoutButtonMethodType.md#paypalcommerce_apms) \| [`PAYPALCOMMERCE_VENMO`](../enums/CheckoutButtonMethodType.md#paypalcommerce_venmo) |
+
+#### Returns
+
+`undefined` \| `Error`

package/docs/classes/CheckoutButtonInitializer.md

@@ -0,0 +1,177 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializer
+
+# Class: CheckoutButtonInitializer
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CheckoutButtonInitializer.md#constructor)
+
+### Methods
+
+- [deinitializeButton](CheckoutButtonInitializer.md#deinitializebutton)
+- [getState](CheckoutButtonInitializer.md#getstate)
+- [initializeButton](CheckoutButtonInitializer.md#initializebutton)
+- [subscribe](CheckoutButtonInitializer.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonInitializer**()
+
+## Methods
+
+### deinitializeButton
+
+▸ **deinitializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/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/CheckoutButtonOptions.md) | Options for deinitializing the checkout button. |
+
+#### Returns
+
+`Promise`<[`CheckoutButtonSelectors`](../interfaces/CheckoutButtonSelectors.md)\>
+
+A promise that resolves to the current state.
+
+___
+
+### getState
+
+▸ **getState**(): [`CheckoutButtonSelectors`](../interfaces/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/CheckoutButtonSelectors.md)
+
+The current customer's checkout state
+
+___
+
+### initializeButton
+
+▸ **initializeButton**(`options`): `Promise`<[`CheckoutButtonSelectors`](../interfaces/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`](../interfaces/CheckoutButtonInitializeOptions.md) | Options for initializing the checkout button. |
+
+#### Returns
+
+`Promise`<[`CheckoutButtonSelectors`](../interfaces/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/CheckoutButtonSelectors.md)) => `void` | The function to subscribe to state changes. |
+| `...filters` | (`state`: [`CheckoutButtonSelectors`](../interfaces/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/CheckoutButtonStatusSelector.md

@@ -0,0 +1,52 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonStatusSelector
+
+# Class: CheckoutButtonStatusSelector
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CheckoutButtonStatusSelector.md#constructor)
+
+### Methods
+
+- [isDeinitializingButton](CheckoutButtonStatusSelector.md#isdeinitializingbutton)
+- [isInitializingButton](CheckoutButtonStatusSelector.md#isinitializingbutton)
+
+## Constructors
+
+### constructor
+
+• **new CheckoutButtonStatusSelector**()
+
+## Methods
+
+### isDeinitializingButton
+
+▸ **isDeinitializingButton**(`methodId?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`APPLEPAY`](../enums/CheckoutButtonMethodType.md#applepay) \| [`AMAZON_PAY_V2`](../enums/CheckoutButtonMethodType.md#amazon_pay_v2) \| [`BRAINTREE_PAYPAL`](../enums/CheckoutButtonMethodType.md#braintree_paypal) \| [`BRAINTREE_VENMO`](../enums/CheckoutButtonMethodType.md#braintree_venmo) \| [`BRAINTREE_PAYPAL_CREDIT`](../enums/CheckoutButtonMethodType.md#braintree_paypal_credit) \| [`GOOGLEPAY_ADYENV2`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv2) \| [`GOOGLEPAY_ADYENV3`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv3) \| [`GOOGLEPAY_AUTHORIZENET`](../enums/CheckoutButtonMethodType.md#googlepay_authorizenet) \| [`GOOGLEPAY_BRAINTREE`](../enums/CheckoutButtonMethodType.md#googlepay_braintree) \| [`GOOGLEPAY_CHECKOUTCOM`](../enums/CheckoutButtonMethodType.md#googlepay_checkoutcom) \| [`GOOGLEPAY_CYBERSOURCEV2`](../enums/CheckoutButtonMethodType.md#googlepay_cybersourcev2) \| [`GOOGLEPAY_ORBITAL`](../enums/CheckoutButtonMethodType.md#googlepay_orbital) \| [`GOOGLEPAY_STRIPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripe) \| [`GOOGLEPAY_STRIPEUPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripeupe) \| [`MASTERPASS`](../enums/CheckoutButtonMethodType.md#masterpass) \| [`PAYPALEXPRESS`](../enums/CheckoutButtonMethodType.md#paypalexpress) \| [`PAYPALCOMMERCE`](../enums/CheckoutButtonMethodType.md#paypalcommerce) \| [`PAYPALCOMMERCE_APMS`](../enums/CheckoutButtonMethodType.md#paypalcommerce_apms) \| [`PAYPALCOMMERCE_VENMO`](../enums/CheckoutButtonMethodType.md#paypalcommerce_venmo) |
+
+#### Returns
+
+`boolean`
+
+___
+
+### isInitializingButton
+
+▸ **isInitializingButton**(`methodId?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `methodId?` | [`APPLEPAY`](../enums/CheckoutButtonMethodType.md#applepay) \| [`AMAZON_PAY_V2`](../enums/CheckoutButtonMethodType.md#amazon_pay_v2) \| [`BRAINTREE_PAYPAL`](../enums/CheckoutButtonMethodType.md#braintree_paypal) \| [`BRAINTREE_VENMO`](../enums/CheckoutButtonMethodType.md#braintree_venmo) \| [`BRAINTREE_PAYPAL_CREDIT`](../enums/CheckoutButtonMethodType.md#braintree_paypal_credit) \| [`GOOGLEPAY_ADYENV2`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv2) \| [`GOOGLEPAY_ADYENV3`](../enums/CheckoutButtonMethodType.md#googlepay_adyenv3) \| [`GOOGLEPAY_AUTHORIZENET`](../enums/CheckoutButtonMethodType.md#googlepay_authorizenet) \| [`GOOGLEPAY_BRAINTREE`](../enums/CheckoutButtonMethodType.md#googlepay_braintree) \| [`GOOGLEPAY_CHECKOUTCOM`](../enums/CheckoutButtonMethodType.md#googlepay_checkoutcom) \| [`GOOGLEPAY_CYBERSOURCEV2`](../enums/CheckoutButtonMethodType.md#googlepay_cybersourcev2) \| [`GOOGLEPAY_ORBITAL`](../enums/CheckoutButtonMethodType.md#googlepay_orbital) \| [`GOOGLEPAY_STRIPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripe) \| [`GOOGLEPAY_STRIPEUPE`](../enums/CheckoutButtonMethodType.md#googlepay_stripeupe) \| [`MASTERPASS`](../enums/CheckoutButtonMethodType.md#masterpass) \| [`PAYPALEXPRESS`](../enums/CheckoutButtonMethodType.md#paypalexpress) \| [`PAYPALCOMMERCE`](../enums/CheckoutButtonMethodType.md#paypalcommerce) \| [`PAYPALCOMMERCE_APMS`](../enums/CheckoutButtonMethodType.md#paypalcommerce_apms) \| [`PAYPALCOMMERCE_VENMO`](../enums/CheckoutButtonMethodType.md#paypalcommerce_venmo) |
+
+#### Returns
+
+`boolean`