@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/AmazonPayShippingInitializeOptions.md

@@ -1,85 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayShippingInitializeOptions
-
-# Interface: AmazonPayShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of
-checkout in order to support Amazon Pay.
-
-When Amazon Pay is initialized, a widget will be inserted into the DOM. The
-widget has a list of shipping addresses for the customer to choose from.
-
-## Table of contents
-
-### Properties
-
-- [container](AmazonPayShippingInitializeOptions.md#container)
-
-### Methods
-
-- [onAddressSelect](AmazonPayShippingInitializeOptions.md#onaddressselect)
-- [onError](AmazonPayShippingInitializeOptions.md#onerror)
-- [onReady](AmazonPayShippingInitializeOptions.md#onready)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the address widget should insert into.
-
-## Methods
-
-### onAddressSelect
-
-▸ `Optional` **onAddressSelect**(`reference`): `void`
-
-A callback that gets called when the customer selects an address option.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the address options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`AmazonPayWidgetError`](AmazonPayWidgetError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure of the initialization. |
-
-#### Returns
-
-`void`
-
-___
-
-### onReady
-
-▸ `Optional` **onReady**(`reference`): `void`
-
-A callback that gets called when the widget is loaded and ready to be
-interacted with.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### Returns
-
-`void`

package/docs/interfaces/AmazonPayV2ButtonParams.md

@@ -1,71 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonParams
-
-# Interface: AmazonPayV2ButtonParams
-
-## Table of contents
-
-### Properties
-
-- [checkoutLanguage](AmazonPayV2ButtonParams.md#checkoutlanguage)
-- [createCheckoutSession](AmazonPayV2ButtonParams.md#createcheckoutsession)
-- [ledgerCurrency](AmazonPayV2ButtonParams.md#ledgercurrency)
-- [merchantId](AmazonPayV2ButtonParams.md#merchantid)
-- [placement](AmazonPayV2ButtonParams.md#placement)
-- [productType](AmazonPayV2ButtonParams.md#producttype)
-- [sandbox](AmazonPayV2ButtonParams.md#sandbox)
-
-## Properties
-
-### checkoutLanguage
-
-• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
-
-Language used to render the button and text on Amazon Pay hosted pages.
-
-___
-
-### createCheckoutSession
-
-• **createCheckoutSession**: [`AmazonPayV2CheckoutSession`](AmazonPayV2CheckoutSession.md)
-
-Configuration for calling the endpoint to Create Checkout Session.
-
-___
-
-### ledgerCurrency
-
-• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
-
-Ledger currency provided during registration for the given merchant identifier.
-
-___
-
-### merchantId
-
-• **merchantId**: `string`
-
-Amazon Pay merchant account identifier.
-
-___
-
-### placement
-
-• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
-
-Placement of the Amazon Pay button on your website.
-
-___
-
-### productType
-
-• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
-
-Product type selected for checkout. Default is 'PayAndShip'.
-
-___
-
-### sandbox
-
-• `Optional` **sandbox**: `boolean`
-
-Sets button to Sandbox environment. Default is false.

package/docs/interfaces/AmazonPayV2CheckoutSession.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSession
-
-# Interface: AmazonPayV2CheckoutSession
-
-## Table of contents
-
-### Properties
-
-- [extractAmazonCheckoutSessionId](AmazonPayV2CheckoutSession.md#extractamazoncheckoutsessionid)
-- [method](AmazonPayV2CheckoutSession.md#method)
-- [url](AmazonPayV2CheckoutSession.md#url)
-
-## Properties
-
-### extractAmazonCheckoutSessionId
-
-• `Optional` **extractAmazonCheckoutSessionId**: `string`
-
-Checkout Session ID parameter in the response. Default is 'checkoutSessionId'.
-
-___
-
-### method
-
-• `Optional` **method**: ``"GET"`` \| ``"POST"``
-
-HTTP request method. Default is 'POST'.
-
-___
-
-### url
-
-• **url**: `string`
-
-Endpoint URL to Create Checkout Session.

package/docs/interfaces/AmazonPayV2CustomerInitializeOptions.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CustomerInitializeOptions
-
-# Interface: AmazonPayV2CustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout in order to support AmazonPayV2.
-
-When AmazonPayV2 is initialized, a sign-in button will be inserted into the
-DOM. When the customer clicks on it, they will be redirected to Amazon to
-sign in.
-
-## Table of contents
-
-### Properties
-
-- [container](AmazonPayV2CustomerInitializeOptions.md#container)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.

package/docs/interfaces/AmazonPayV2PaymentInitializeOptions.md

@@ -1,39 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2PaymentInitializeOptions
-
-# Interface: AmazonPayV2PaymentInitializeOptions
-
-A set of options that are required to initialize the payment step of
-checkout in order to support AmazonPayV2.
-
-When AmazonPayV2 is initialized, a change payment button will be bound.
-When the customer clicks on it, they will be redirected to Amazon to
-select a different payment method.
-
-```html
-<!-- This is where the Amazon button will be inserted -->
-<div id="edit-button"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'amazonpay',
-    amazonpay: {
-        editButtonId: 'edit-button',
-    },
-});
-
-## Table of contents
-
-### Properties
-
-- [editButtonId](AmazonPayV2PaymentInitializeOptions.md#editbuttonid)
-
-## Properties
-
-### editButtonId
-
-• `Optional` **editButtonId**: `string`
-
-This editButtonId is used to set an event listener, provide an element ID
-if you want users to be able to select a different payment method by
-clicking on a button. It should be an HTML element.

package/docs/interfaces/AmazonPayV2ShippingInitializeOptions.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ShippingInitializeOptions
-
-# Interface: AmazonPayV2ShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of
-checkout in order to support AmazonPayV2.
-
-When AmazonPayV2 is initialized, a change shipping button will be bound.
-When the customer clicks on it, they will be redirected to Amazon to
-select a different shipping address.
-
-## Table of contents
-
-### Properties
-
-- [editAddressButtonId](AmazonPayV2ShippingInitializeOptions.md#editaddressbuttonid)
-
-## Properties
-
-### editAddressButtonId
-
-• `Optional` **editAddressButtonId**: `string`
-
-This editAddressButtonId is used to set an event listener, provide an
-element ID if you want users to be able to select a different shipping
-address by clicking on a button. It should be an HTML element.

package/docs/interfaces/AmazonPayWidgetError.md

@@ -1,25 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayWidgetError
-
-# Interface: AmazonPayWidgetError
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`AmazonPayWidgetError`**
-
-## Table of contents
-
-### Methods
-
-- [getErrorCode](AmazonPayWidgetError.md#geterrorcode)
-
-## Methods
-
-### getErrorCode
-
-▸ **getErrorCode**(): `string`
-
-#### Returns
-
-`string`

package/docs/interfaces/ApplePayButtonInitializeOptions.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayButtonInitializeOptions
-
-# Interface: ApplePayButtonInitializeOptions
-
-A set of options that are required to initialize ApplePay in cart.
-
-When ApplePay is initialized, an ApplePay button will be inserted into the
-DOM. When a customer clicks on it, it will trigger Apple sheet.
-
-## Table of contents
-
-### Properties
-
-- [buttonClassName](ApplePayButtonInitializeOptions.md#buttonclassname)
-
-### Methods
-
-- [onPaymentAuthorize](ApplePayButtonInitializeOptions.md#onpaymentauthorize)
-
-## Properties
-
-### buttonClassName
-
-• `Optional` **buttonClassName**: `string`
-
-The class name of the ApplePay button style.
-
-## Methods
-
-### onPaymentAuthorize
-
-▸ **onPaymentAuthorize**(): `void`
-
-A callback that gets called when a payment is successfully completed.
-
-#### Returns
-
-`void`

package/docs/interfaces/ApplePayButtonInitializeOptions_2.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayButtonInitializeOptions_2
-
-# Interface: ApplePayButtonInitializeOptions\_2
-
-A set of options that are required to initialize ApplePay in cart.
-
-When ApplePay is initialized, an ApplePay button will be inserted into the
-DOM. When a customer clicks on it, it will trigger Apple sheet.
-
-## Table of contents
-
-### Properties
-
-- [buttonClassName](ApplePayButtonInitializeOptions_2.md#buttonclassname)
-
-### Methods
-
-- [onPaymentAuthorize](ApplePayButtonInitializeOptions_2.md#onpaymentauthorize)
-
-## Properties
-
-### buttonClassName
-
-• `Optional` **buttonClassName**: `string`
-
-The class name of the ApplePay button style.
-
-## Methods
-
-### onPaymentAuthorize
-
-▸ **onPaymentAuthorize**(): `void`
-
-A callback that gets called when a payment is successfully completed.
-
-#### Returns
-
-`void`

package/docs/interfaces/ApplePayCustomerInitializeOptions.md

@@ -1,77 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayCustomerInitializeOptions
-
-# Interface: ApplePayCustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout in order to support ApplePay.
-
-When ApplePay is initialized, a sign-in button will be inserted into the
-DOM. When the customer clicks on it, it will trigger apple sheet
-
-## Table of contents
-
-### Properties
-
-- [container](ApplePayCustomerInitializeOptions.md#container)
-- [shippingLabel](ApplePayCustomerInitializeOptions.md#shippinglabel)
-- [subtotalLabel](ApplePayCustomerInitializeOptions.md#subtotallabel)
-
-### Methods
-
-- [onError](ApplePayCustomerInitializeOptions.md#onerror)
-- [onPaymentAuthorize](ApplePayCustomerInitializeOptions.md#onpaymentauthorize)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.
-
-___
-
-### shippingLabel
-
-• `Optional` **shippingLabel**: `string`
-
-Shipping label to be passed to apple sheet.
-
-___
-
-### subtotalLabel
-
-• `Optional` **subtotalLabel**: `string`
-
-Sub total label to be passed to apple sheet.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error?`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the address options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error?` | `Error` | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentAuthorize
-
-▸ **onPaymentAuthorize**(): `void`
-
-A callback that gets called when a payment is successfully completed.
-
-#### Returns
-
-`void`

package/docs/interfaces/ApplePayCustomerInitializeOptions_2.md

@@ -1,77 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayCustomerInitializeOptions_2
-
-# Interface: ApplePayCustomerInitializeOptions\_2
-
-A set of options that are required to initialize the customer step of
-checkout in order to support ApplePay.
-
-When ApplePay is initialized, a sign-in button will be inserted into the
-DOM. When the customer clicks on it, it will trigger apple sheet
-
-## Table of contents
-
-### Properties
-
-- [container](ApplePayCustomerInitializeOptions_2.md#container)
-- [shippingLabel](ApplePayCustomerInitializeOptions_2.md#shippinglabel)
-- [subtotalLabel](ApplePayCustomerInitializeOptions_2.md#subtotallabel)
-
-### Methods
-
-- [onError](ApplePayCustomerInitializeOptions_2.md#onerror)
-- [onPaymentAuthorize](ApplePayCustomerInitializeOptions_2.md#onpaymentauthorize)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.
-
-___
-
-### shippingLabel
-
-• `Optional` **shippingLabel**: `string`
-
-Shipping label to be passed to apple sheet.
-
-___
-
-### subtotalLabel
-
-• `Optional` **subtotalLabel**: `string`
-
-Sub total label to be passed to apple sheet.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error?`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the address options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error?` | `Error` | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentAuthorize
-
-▸ **onPaymentAuthorize**(): `void`
-
-A callback that gets called when a payment is successfully completed.
-
-#### Returns
-
-`void`

package/docs/interfaces/ApplePayPaymentInitializeOptions.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayPaymentInitializeOptions
-
-# Interface: ApplePayPaymentInitializeOptions
-
-A set of options that are required to initialize the Applepay payment method with:
-
-1) ApplePay:
-
-```js
-service.initializePayment({
-    methodId: 'applepay',
-    applepay: {
-        shippingLabel: 'Shipping',
-        subtotalLabel: 'Sub total',
-    }
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [shippingLabel](ApplePayPaymentInitializeOptions.md#shippinglabel)
-- [subtotalLabel](ApplePayPaymentInitializeOptions.md#subtotallabel)
-
-## Properties
-
-### shippingLabel
-
-• `Optional` **shippingLabel**: `string`
-
-Shipping label to be passed to apple sheet.
-
-___
-
-### subtotalLabel
-
-• `Optional` **subtotalLabel**: `string`
-
-Sub total label to be passed to apple sheet.

package/docs/interfaces/ApplePayPaymentInitializeOptions_2.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ApplePayPaymentInitializeOptions_2
-
-# Interface: ApplePayPaymentInitializeOptions\_2
-
-A set of options that are required to initialize the Applepay payment method with:
-
-1) ApplePay:
-
-```js
-service.initializePayment({
-    methodId: 'applepay',
-    applepay: {
-        shippingLabel: 'Shipping',
-        subtotalLabel: 'Sub total',
-    }
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [shippingLabel](ApplePayPaymentInitializeOptions_2.md#shippinglabel)
-- [subtotalLabel](ApplePayPaymentInitializeOptions_2.md#subtotallabel)
-
-## Properties
-
-### shippingLabel
-
-• `Optional` **shippingLabel**: `string`
-
-Shipping label to be passed to apple sheet.
-
-___
-
-### subtotalLabel
-
-• `Optional` **subtotalLabel**: `string`
-
-Sub total label to be passed to apple sheet.