@bigcommerce/checkout-sdk 1.271.1 → 1.272.0

package/docs/interfaces/{PaymentInitializeOptions_4.md → PaymentInitializeOptions.md}

@@ -1,57 +1,57 @@
-[@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions_4
+[@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions
 
-# Interface: PaymentInitializeOptions\_4
+# Interface: PaymentInitializeOptions
 
 A set of options that are required to initialize the payment step of the
 current checkout flow.
 
 ## Hierarchy
 
-- [`PaymentRequestOptions_2`](PaymentRequestOptions_2.md)
+- [`PaymentRequestOptions`](PaymentRequestOptions.md)
 
-  ↳ **`PaymentInitializeOptions_4`**
+  ↳ **`PaymentInitializeOptions`**
 
 ## Table of contents
 
 ### Properties
 
-- [adyenv2](PaymentInitializeOptions_4.md#adyenv2)
-- [adyenv3](PaymentInitializeOptions_4.md#adyenv3)
-- [amazon](PaymentInitializeOptions_4.md#amazon)
-- [amazonpay](PaymentInitializeOptions_4.md#amazonpay)
-- [applepay](PaymentInitializeOptions_4.md#applepay)
-- [bluesnapv2](PaymentInitializeOptions_4.md#bluesnapv2)
-- [bolt](PaymentInitializeOptions_4.md#bolt)
-- [braintree](PaymentInitializeOptions_4.md#braintree)
-- [braintreevisacheckout](PaymentInitializeOptions_4.md#braintreevisacheckout)
-- [chasepay](PaymentInitializeOptions_4.md#chasepay)
-- [creditCard](PaymentInitializeOptions_4.md#creditcard)
-- [digitalriver](PaymentInitializeOptions_4.md#digitalriver)
-- [gatewayId](PaymentInitializeOptions_4.md#gatewayid)
-- [googlepayadyenv2](PaymentInitializeOptions_4.md#googlepayadyenv2)
-- [googlepayadyenv3](PaymentInitializeOptions_4.md#googlepayadyenv3)
-- [googlepayauthorizenet](PaymentInitializeOptions_4.md#googlepayauthorizenet)
-- [googlepaybraintree](PaymentInitializeOptions_4.md#googlepaybraintree)
-- [googlepaycheckoutcom](PaymentInitializeOptions_4.md#googlepaycheckoutcom)
-- [googlepaycybersourcev2](PaymentInitializeOptions_4.md#googlepaycybersourcev2)
-- [googlepayorbital](PaymentInitializeOptions_4.md#googlepayorbital)
-- [googlepaystripe](PaymentInitializeOptions_4.md#googlepaystripe)
-- [googlepaystripeupe](PaymentInitializeOptions_4.md#googlepaystripeupe)
-- [klarna](PaymentInitializeOptions_4.md#klarna)
-- [klarnav2](PaymentInitializeOptions_4.md#klarnav2)
-- [masterpass](PaymentInitializeOptions_4.md#masterpass)
-- [methodId](PaymentInitializeOptions_4.md#methodid)
-- [mollie](PaymentInitializeOptions_4.md#mollie)
-- [moneris](PaymentInitializeOptions_4.md#moneris)
-- [opy](PaymentInitializeOptions_4.md#opy)
-- [params](PaymentInitializeOptions_4.md#params)
-- [paypalcommerce](PaymentInitializeOptions_4.md#paypalcommerce)
-- [paypalexpress](PaymentInitializeOptions_4.md#paypalexpress)
-- [square](PaymentInitializeOptions_4.md#square)
-- [stripeupe](PaymentInitializeOptions_4.md#stripeupe)
-- [stripev3](PaymentInitializeOptions_4.md#stripev3)
-- [timeout](PaymentInitializeOptions_4.md#timeout)
-- [worldpay](PaymentInitializeOptions_4.md#worldpay)
+- [adyenv2](PaymentInitializeOptions.md#adyenv2)
+- [adyenv3](PaymentInitializeOptions.md#adyenv3)
+- [amazon](PaymentInitializeOptions.md#amazon)
+- [amazonpay](PaymentInitializeOptions.md#amazonpay)
+- [applepay](PaymentInitializeOptions.md#applepay)
+- [bluesnapv2](PaymentInitializeOptions.md#bluesnapv2)
+- [bolt](PaymentInitializeOptions.md#bolt)
+- [braintree](PaymentInitializeOptions.md#braintree)
+- [braintreevisacheckout](PaymentInitializeOptions.md#braintreevisacheckout)
+- [chasepay](PaymentInitializeOptions.md#chasepay)
+- [creditCard](PaymentInitializeOptions.md#creditcard)
+- [digitalriver](PaymentInitializeOptions.md#digitalriver)
+- [gatewayId](PaymentInitializeOptions.md#gatewayid)
+- [googlepayadyenv2](PaymentInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](PaymentInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](PaymentInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybraintree](PaymentInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](PaymentInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](PaymentInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](PaymentInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](PaymentInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](PaymentInitializeOptions.md#googlepaystripeupe)
+- [klarna](PaymentInitializeOptions.md#klarna)
+- [klarnav2](PaymentInitializeOptions.md#klarnav2)
+- [masterpass](PaymentInitializeOptions.md#masterpass)
+- [methodId](PaymentInitializeOptions.md#methodid)
+- [mollie](PaymentInitializeOptions.md#mollie)
+- [moneris](PaymentInitializeOptions.md#moneris)
+- [opy](PaymentInitializeOptions.md#opy)
+- [params](PaymentInitializeOptions.md#params)
+- [paypalcommerce](PaymentInitializeOptions.md#paypalcommerce)
+- [paypalexpress](PaymentInitializeOptions.md#paypalexpress)
+- [square](PaymentInitializeOptions.md#square)
+- [stripeupe](PaymentInitializeOptions.md#stripeupe)
+- [stripev3](PaymentInitializeOptions.md#stripev3)
+- [timeout](PaymentInitializeOptions.md#timeout)
+- [worldpay](PaymentInitializeOptions.md#worldpay)
 
 ## Properties
 
@@ -93,7 +93,7 @@ ___
 
 ### applepay
 
-• `Optional` **applepay**: [`ApplePayPaymentInitializeOptions_2`](ApplePayPaymentInitializeOptions_2.md)
+• `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
 
 The options that are required to initialize the Apple Pay payment
 method. They can be omitted unless you need to support AmazonPay.
@@ -176,7 +176,7 @@ i.e.: Adyen and Klarna.
 
 #### Inherited from
 
-[PaymentRequestOptions_2](PaymentRequestOptions_2.md).[gatewayId](PaymentRequestOptions_2.md#gatewayid)
+[PaymentRequestOptions](PaymentRequestOptions.md).[gatewayId](PaymentRequestOptions.md#gatewayid)
 
 ___
 
@@ -296,7 +296,7 @@ The identifier of the payment method.
 
 #### Inherited from
 
-[PaymentRequestOptions_2](PaymentRequestOptions_2.md).[methodId](PaymentRequestOptions_2.md#methodid)
+[PaymentRequestOptions](PaymentRequestOptions.md).[methodId](PaymentRequestOptions.md#methodid)
 
 ___
 
@@ -335,7 +335,7 @@ The parameters of the request, if required.
 
 #### Inherited from
 
-[PaymentRequestOptions_2](PaymentRequestOptions_2.md).[params](PaymentRequestOptions_2.md#params)
+[PaymentRequestOptions](PaymentRequestOptions.md).[params](PaymentRequestOptions.md#params)
 
 ___
 
@@ -394,7 +394,7 @@ cancelled.
 
 #### Inherited from
 
-[PaymentRequestOptions_2](PaymentRequestOptions_2.md).[timeout](PaymentRequestOptions_2.md#timeout)
+[PaymentRequestOptions](PaymentRequestOptions.md).[timeout](PaymentRequestOptions.md#timeout)
 
 ___
 

package/docs/interfaces/PaymentRequestOptions.md

@@ -7,11 +7,11 @@ the current checkout flow.
 
 ## Hierarchy
 
-- [`RequestOptions_2`](RequestOptions_2.md)
+- [`RequestOptions`](RequestOptions.md)
 
   ↳ **`PaymentRequestOptions`**
 
-  ↳↳ [`PaymentInitializeOptions_3`](PaymentInitializeOptions_3.md)
+  ↳↳ [`PaymentInitializeOptions`](PaymentInitializeOptions.md)
 
 ## Table of contents
 
@@ -50,7 +50,7 @@ The parameters of the request, if required.
 
 #### Inherited from
 
-[RequestOptions_2](RequestOptions_2.md).[params](RequestOptions_2.md#params)
+[RequestOptions](RequestOptions.md).[params](RequestOptions.md#params)
 
 ___
 
@@ -64,4 +64,4 @@ cancelled.
 
 #### Inherited from
 
-[RequestOptions_2](RequestOptions_2.md).[timeout](RequestOptions_2.md#timeout)
+[RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/RequestOptions.md

@@ -14,11 +14,11 @@ A set of options for configuring an asynchronous request.
 
 - **`RequestOptions`**
 
-  ↳ [`CheckoutButtonOptions_2`](CheckoutButtonOptions_2.md)
+  ↳ [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
 
-  ↳ [`CustomerRequestOptions_2`](CustomerRequestOptions_2.md)
+  ↳ [`CustomerRequestOptions`](CustomerRequestOptions.md)
 
-  ↳ [`PaymentRequestOptions_2`](PaymentRequestOptions_2.md)
+  ↳ [`PaymentRequestOptions`](PaymentRequestOptions.md)
 
   ↳ [`ShippingRequestOptions`](ShippingRequestOptions.md)
 

package/docs/interfaces/SpamProtectionOptions.md

@@ -6,7 +6,7 @@ The set of options for configuring any requests related to spam protection.
 
 ## Hierarchy
 
-- `RequestOptions_3`
+- `RequestOptions_2`
 
   ↳ **`SpamProtectionOptions`**
 

package/package.json

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

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_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_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.

package/docs/interfaces/CheckoutButtonInitializeOptions_3.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializeOptions_3
-
-# Interface: CheckoutButtonInitializeOptions\_3
-
-## Hierarchy
-
-- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
-
-  ↳ **`CheckoutButtonInitializeOptions_3`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [containerId](CheckoutButtonInitializeOptions_3.md#containerid)
-- [methodId](CheckoutButtonInitializeOptions_3.md#methodid)
-- [params](CheckoutButtonInitializeOptions_3.md#params)
-- [timeout](CheckoutButtonInitializeOptions_3.md#timeout)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the checkout button should be inserted.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[methodId](CheckoutButtonOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[params](CheckoutButtonOptions.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
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[timeout](CheckoutButtonOptions.md#timeout)

package/docs/interfaces/CheckoutButtonOptions_2.md

@@ -1,55 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonOptions_2
-
-# Interface: CheckoutButtonOptions\_2
-
-The set of options for configuring the checkout button.
-
-## Hierarchy
-
-- [`RequestOptions`](RequestOptions.md)
-
-  ↳ **`CheckoutButtonOptions_2`**
-
-  ↳↳ [`CheckoutButtonInitializeOptions_4`](CheckoutButtonInitializeOptions_4.md)
-
-## Table of contents
-
-### Properties
-
-- [methodId](CheckoutButtonOptions_2.md#methodid)
-- [params](CheckoutButtonOptions_2.md#params)
-- [timeout](CheckoutButtonOptions_2.md#timeout)
-
-## Properties
-
-### methodId
-
-• **methodId**: [`CheckoutButtonMethodType`](../enums/CheckoutButtonMethodType.md)
-
-The identifier of the payment method.
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions](RequestOptions.md).[params](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](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/CustomerInitializeOptions_3.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CustomerInitializeOptions_3
-
-# Interface: CustomerInitializeOptions\_3
-
-## Hierarchy
-
-- [`CustomerRequestOptions`](CustomerRequestOptions.md)
-
-  ↳ **`CustomerInitializeOptions_3`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [methodId](CustomerInitializeOptions_3.md#methodid)
-
-## Properties
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-#### Inherited from
-
-[CustomerRequestOptions](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)

package/docs/interfaces/CustomerRequestOptions_2.md

@@ -1,60 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CustomerRequestOptions_2
-
-# Interface: CustomerRequestOptions\_2
-
-A set of options for configuring any requests related to the customer step of
-the current checkout flow.
-
-Some payment methods have their own sign-in or sign-out flow. Therefore, you
-need to indicate the method you want to use if you need to trigger a specific
-flow for signing in or out a customer. Otherwise, these options are not required.
-
-## Hierarchy
-
-- [`RequestOptions`](RequestOptions.md)
-
-  ↳ **`CustomerRequestOptions_2`**
-
-  ↳↳ [`CustomerInitializeOptions_4`](CustomerInitializeOptions_4.md)
-
-  ↳↳ [`ExecutePaymentMethodCheckoutOptions`](ExecutePaymentMethodCheckoutOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [methodId](CustomerRequestOptions_2.md#methodid)
-- [params](CustomerRequestOptions_2.md#params)
-- [timeout](CustomerRequestOptions_2.md#timeout)
-
-## Properties
-
-### methodId
-
-• `Optional` **methodId**: `string`
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions](RequestOptions.md).[params](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](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/PaymentInitializeOptions_3.md

@@ -1,74 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions_3
-
-# Interface: PaymentInitializeOptions\_3
-
-## Hierarchy
-
-- [`PaymentRequestOptions`](PaymentRequestOptions.md)
-
-  ↳ **`PaymentInitializeOptions_3`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [gatewayId](PaymentInitializeOptions_3.md#gatewayid)
-- [methodId](PaymentInitializeOptions_3.md#methodid)
-- [params](PaymentInitializeOptions_3.md#params)
-- [timeout](PaymentInitializeOptions_3.md#timeout)
-
-## Properties
-
-### gatewayId
-
-• `Optional` **gatewayId**: `string`
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Adyen and Klarna.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[gatewayId](PaymentRequestOptions.md#gatewayid)
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[methodId](PaymentRequestOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[params](PaymentRequestOptions.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
-
-[PaymentRequestOptions](PaymentRequestOptions.md).[timeout](PaymentRequestOptions.md#timeout)