@bigcommerce/checkout-sdk 1.326.1 → 1.326.2

package/docs/README.md

@@ -78,10 +78,6 @@
 - [AdyenV3CreditCardComponentOptions](interfaces/AdyenV3CreditCardComponentOptions.md)
 - [AdyenV3PaymentInitializeOptions](interfaces/AdyenV3PaymentInitializeOptions.md)
 - [AdyenV3ValidationState](interfaces/AdyenV3ValidationState.md)
-- [AmazonPayCustomerInitializeOptions](interfaces/AmazonPayCustomerInitializeOptions.md)
-- [AmazonPayOrderReference](interfaces/AmazonPayOrderReference.md)
-- [AmazonPayPaymentInitializeOptions](interfaces/AmazonPayPaymentInitializeOptions.md)
-- [AmazonPayShippingInitializeOptions](interfaces/AmazonPayShippingInitializeOptions.md)
 - [AmazonPayV2ButtonConfig](interfaces/AmazonPayV2ButtonConfig.md)
 - [AmazonPayV2ButtonParams](interfaces/AmazonPayV2ButtonParams.md)
 - [AmazonPayV2CheckoutSession](interfaces/AmazonPayV2CheckoutSession.md)
@@ -91,7 +87,6 @@
 - [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
 - [AmazonPayV2Price](interfaces/AmazonPayV2Price.md)
 - [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
-- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
 - [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
 - [ApplePayButtonInitializeOptions_2](interfaces/ApplePayButtonInitializeOptions_2.md)
 - [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)

package/docs/classes/CheckoutService.md

@@ -371,7 +371,7 @@ initialization.
 
 ```js
 await service.deinitializeCustomer({
-    methodId: 'amazon',
+    methodId: 'amazonpay',
 });
 ```
 
@@ -402,7 +402,7 @@ result of payment initialization.
 
 ```js
 await service.deinitializePayment({
-    methodId: 'amazon',
+    methodId: 'amazonpay',
 });
 ```
 
@@ -433,7 +433,7 @@ initialization.
 
 ```js
 await service.deinitializeShipping({
-    methodId: 'amazon',
+    methodId: 'amazonpay',
 });
 ```
 
@@ -645,13 +645,13 @@ ___
 
 Initializes the sign-in step of a checkout process.
 
-Some payment methods, such as Amazon, have their own sign-in flow. In
+Some payment methods, such as Amazon Pay, have their own sign-in flow. In
 order to support them, this method must be called.
 
 ```js
 await service.initializeCustomer({
-    methodId: 'amazon',
-    amazon: {
+    methodId: 'amazonpay',
+    amazonpay: {
         container: 'signInButton',
     },
 });
@@ -679,14 +679,15 @@ Initializes the payment step of a checkout process.
 
 Before a payment method can accept payment details, it must first be
 initialized. Some payment methods require you to provide additional
-initialization options. For example, Amazon requires a container ID in
-order to initialize their payment widget.
+initialization options. For example, you can provide an element ID for
+Amazon Pay if you want users to be able to select a different payment
+method by clicking on the element.
 
 ```js
 await service.initializePayment({
-    methodId: 'amazon',
-    amazon: {
-        container: 'walletWidget',
+    methodId: 'amazonpay',
+    amazonpay: {
+        editButtonId: 'edit-button',
     },
 });
 ```
@@ -711,15 +712,15 @@ ___
 
 Initializes the shipping step of a checkout process.
 
-Some payment methods, such as Amazon, can provide shipping information to
-be used for checkout. In order to support them, this method must be
-called.
+Some payment methods, such as Amazon Pay, can provide shipping
+information to be used for checkout. In order to support them, this
+method must be called.
 
 ```js
 await service.initializeShipping({
-    methodId: 'amazon',
-    amazon: {
-        container: 'addressBook',
+    methodId: 'amazonpay',
+    amazonpay: {
+        editAddressButtonId: 'changeAddressButton',
     },
 });
 ```

package/docs/interfaces/AmazonPayV2CustomerInitializeOptions.md

@@ -9,6 +9,20 @@ 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.
 
+```html
+<!-- This is where the Amazon Pay button will be inserted -->
+<div id="signInButton"></div>
+```
+
+```js
+service.initializeCustomer({
+    methodId: 'amazonpay',
+    amazonpay: {
+        container: 'signInButton',
+    },
+});
+```
+
 ## Table of contents
 
 ### Properties

package/docs/interfaces/AmazonPayV2PaymentInitializeOptions.md

@@ -10,8 +10,8 @@ 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>
+<!-- This is the change payment button that will be bound -->
+<button id="edit-button">Change card</button>
 ```
 
 ```js

package/docs/interfaces/AmazonPayV2ShippingInitializeOptions.md

@@ -9,6 +9,20 @@ 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.
 
+```html
+<!-- This is the change shipping button that will be bound -->
+<button id="edit-button">Change shipping</button>
+```
+
+```js
+service.initializeShipping({
+    methodId: 'amazonpay',
+    amazonpay: {
+        editAddressButtonId: 'edit-button',
+    },
+});
+```
+
 ## Table of contents
 
 ### Properties

package/docs/interfaces/BaseCustomerInitializeOptions.md

@@ -24,7 +24,6 @@ information in order to initialize the customer step of checkout.
 
 ### Properties
 
-- [amazon](BaseCustomerInitializeOptions.md#amazon)
 - [amazonpay](BaseCustomerInitializeOptions.md#amazonpay)
 - [bolt](BaseCustomerInitializeOptions.md#bolt)
 - [braintreepaypal](BaseCustomerInitializeOptions.md#braintreepaypal)
@@ -48,15 +47,6 @@ information in order to initialize the customer step of checkout.
 
 ## Properties
 
-### amazon
-
-• `Optional` **amazon**: [`AmazonPayCustomerInitializeOptions`](AmazonPayCustomerInitializeOptions.md)
-
-The options that are required to initialize the customer step of checkout
-when using Amazon Pay.
-
-___
-
 ### amazonpay
 
 • `Optional` **amazonpay**: [`AmazonPayV2CustomerInitializeOptions`](AmazonPayV2CustomerInitializeOptions.md)

package/docs/interfaces/BasePaymentInitializeOptions.md

@@ -15,7 +15,6 @@ current checkout flow.
 
 ### Properties
 
-- [amazon](BasePaymentInitializeOptions.md#amazon)
 - [amazonpay](BasePaymentInitializeOptions.md#amazonpay)
 - [bluesnapv2](BasePaymentInitializeOptions.md#bluesnapv2)
 - [bolt](BasePaymentInitializeOptions.md#bolt)
@@ -53,15 +52,6 @@ current checkout flow.
 
 ## Properties
 
-### amazon
-
-• `Optional` **amazon**: [`AmazonPayPaymentInitializeOptions`](AmazonPayPaymentInitializeOptions.md)
-
-The options that are required to initialize the Amazon Pay payment
-method. They can be omitted unless you need to support AmazonPay.
-
-___
-
 ### amazonpay
 
 • `Optional` **amazonpay**: [`AmazonPayV2PaymentInitializeOptions`](AmazonPayV2PaymentInitializeOptions.md)

package/docs/interfaces/BraintreePaypalButtonInitializeOptions.md

@@ -77,7 +77,7 @@ A callback that gets called if unable to authorize and tokenize payment.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 
@@ -95,7 +95,7 @@ A callback that gets called on any error instead of submit payment or authorizat
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 
@@ -113,7 +113,7 @@ A callback that gets called if unable to submit payment.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 

package/docs/interfaces/BraintreePaypalCreditButtonInitializeOptions.md

@@ -68,7 +68,7 @@ A callback that gets called if unable to authorize and tokenize payment.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 
@@ -86,7 +86,7 @@ A callback that gets called on any error instead of submit payment or authorizat
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 
@@ -104,7 +104,7 @@ A callback that gets called if unable to submit payment.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 

package/docs/interfaces/BraintreePaypalCustomerInitializeOptions.md

@@ -32,7 +32,7 @@ A callback that gets called on any error instead of submit payment or authorizat
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 

package/docs/interfaces/BraintreeVenmoButtonInitializeOptions.md

@@ -47,7 +47,7 @@ A callback that gets called on any error.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `error` | [`StandardError`](../classes/StandardError.md) \| [`BraintreeError`](BraintreeError.md) | The error object describing the failure. |
+| `error` | [`BraintreeError`](BraintreeError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
 
 #### Returns
 

package/docs/interfaces/ShippingInitializeOptions.md

@@ -27,7 +27,6 @@ step of checkout.
 
 ### Properties
 
-- [amazon](ShippingInitializeOptions.md#amazon)
 - [amazonpay](ShippingInitializeOptions.md#amazonpay)
 - [methodId](ShippingInitializeOptions.md#methodid)
 - [params](ShippingInitializeOptions.md#params)
@@ -36,15 +35,6 @@ step of checkout.
 
 ## Properties
 
-### amazon
-
-• `Optional` **amazon**: [`AmazonPayShippingInitializeOptions`](AmazonPayShippingInitializeOptions.md)
-
-The options that are required to initialize the shipping step of checkout
-when using Amazon Pay.
-
-___
-
 ### amazonpay
 
 • `Optional` **amazonpay**: [`AmazonPayV2ShippingInitializeOptions`](AmazonPayV2ShippingInitializeOptions.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.326.1",
+  "version": "1.326.2",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",

package/docs/interfaces/AmazonPayCustomerInitializeOptions.md

@@ -1,65 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayCustomerInitializeOptions
-
-# Interface: AmazonPayCustomerInitializeOptions
-
-A set of options that are required to initialize the customer step of
-checkout to support Amazon Pay.
-
-When AmazonPay 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
-
-- [color](AmazonPayCustomerInitializeOptions.md#color)
-- [container](AmazonPayCustomerInitializeOptions.md#container)
-- [size](AmazonPayCustomerInitializeOptions.md#size)
-
-### Methods
-
-- [onError](AmazonPayCustomerInitializeOptions.md#onerror)
-
-## Properties
-
-### color
-
-• `Optional` **color**: ``"Gold"`` \| ``"LightGray"`` \| ``"DarkGray"``
-
-The colour of the sign-in button.
-
-___
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the sign-in button should insert into.
-
-___
-
-### size
-
-• `Optional` **size**: ``"small"`` \| ``"medium"`` \| ``"large"`` \| ``"x-large"``
-
-The size of the sign-in button.
-
-## 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` | [`AmazonPayWidgetError`](AmazonPayWidgetError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`

package/docs/interfaces/AmazonPayOrderReference.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayOrderReference
-
-# Interface: AmazonPayOrderReference
-
-## Table of contents
-
-### Methods
-
-- [getAmazonBillingAgreementId](AmazonPayOrderReference.md#getamazonbillingagreementid)
-- [getAmazonOrderReferenceId](AmazonPayOrderReference.md#getamazonorderreferenceid)
-
-## Methods
-
-### getAmazonBillingAgreementId
-
-▸ **getAmazonBillingAgreementId**(): `string`
-
-#### Returns
-
-`string`
-
-___
-
-### getAmazonOrderReferenceId
-
-▸ **getAmazonOrderReferenceId**(): `string`
-
-#### Returns
-
-`string`

package/docs/interfaces/AmazonPayPaymentInitializeOptions.md

@@ -1,100 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayPaymentInitializeOptions
-
-# Interface: AmazonPayPaymentInitializeOptions
-
-A set of options that are required to initialize the Amazon Pay payment
-method.
-
-When AmazonPay is initialized, a widget will be inserted into the DOM. The
-widget has a list of payment options for the customer to choose from.
-
-```html
-<!-- This is where the widget will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'amazon',
-    amazon: {
-        container: 'container',
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [container](AmazonPayPaymentInitializeOptions.md#container)
-
-### Methods
-
-- [onError](AmazonPayPaymentInitializeOptions.md#onerror)
-- [onPaymentSelect](AmazonPayPaymentInitializeOptions.md#onpaymentselect)
-- [onReady](AmazonPayPaymentInitializeOptions.md#onready)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the payment widget should insert into.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback that gets called if unable to initialize the widget or select
-one of the payment options.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | [`AmazonPayWidgetError`](AmazonPayWidgetError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
-
-#### Returns
-
-`void`
-
-___
-
-### onPaymentSelect
-
-▸ `Optional` **onPaymentSelect**(`reference`): `void`
-
-A callback that gets called when the customer selects one of the payment
-options provided by the widget.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `reference` | [`AmazonPayOrderReference`](AmazonPayOrderReference.md) | The order reference provided by Amazon. |
-
-#### 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/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/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`