@bigcommerce/checkout-sdk 1.431.0 → 1.432.0

package/docs/README.md

@@ -22,6 +22,7 @@
 - [EmbeddedCheckoutEventType](enums/EmbeddedCheckoutEventType.md)
 - [ExtensionCommandType](enums/ExtensionCommandType.md)
 - [ExtensionRegion](enums/ExtensionRegion.md)
+- [GooglePayKey](enums/GooglePayKey.md)
 - [HostedFieldType](enums/HostedFieldType.md)
 - [HostedInputEventType](enums/HostedInputEventType.md)
 - [IconStyle](enums/IconStyle.md)
@@ -240,6 +241,7 @@
 - [GooglePayBuyNowInitializeOptions](interfaces/GooglePayBuyNowInitializeOptions.md)
 - [GooglePayCustomerInitializeOptions](interfaces/GooglePayCustomerInitializeOptions.md)
 - [GooglePayPaymentInitializeOptions](interfaces/GooglePayPaymentInitializeOptions.md)
+- [GooglePayPaymentInitializeOptions_2](interfaces/GooglePayPaymentInitializeOptions_2.md)
 - [HostedCardFieldOptions](interfaces/HostedCardFieldOptions.md)
 - [HostedCardFieldOptionsMap](interfaces/HostedCardFieldOptionsMap.md)
 - [HostedFieldStylesMap](interfaces/HostedFieldStylesMap.md)
@@ -469,6 +471,7 @@
 - [PaymentProviderCustomer](README.md#paymentprovidercustomer)
 - [StripeElementOptions](README.md#stripeelementoptions)
 - [StripeEventType](README.md#stripeeventtype)
+- [WithGooglePayPaymentInitializeOptions](README.md#withgooglepaypaymentinitializeoptions)
 
 ### Functions
 
@@ -740,7 +743,7 @@ ___
 
 ### PaymentInitializeOptions
 
-Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeAcceleratedCheckoutPaymentInitializeOptions`](interfaces/WithBraintreeAcceleratedCheckoutPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
+Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithBraintreeAcceleratedCheckoutPaymentInitializeOptions`](interfaces/WithBraintreeAcceleratedCheckoutPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithGooglePayPaymentInitializeOptions`](README.md#withgooglepaypaymentinitializeoptions) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
 
 ___
 
@@ -766,6 +769,15 @@ ___
 
 Ƭ **StripeEventType**: [`StripeShippingEvent`](interfaces/StripeShippingEvent.md) \| [`StripeCustomerEvent`](interfaces/StripeCustomerEvent.md)
 
+___
+
+### WithGooglePayPaymentInitializeOptions
+
+Ƭ **WithGooglePayPaymentInitializeOptions**: { [k in GooglePayKey]?: GooglePayPaymentInitializeOptions\_2 }
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
 ## Functions
 
 ### createBodlService

package/docs/enums/GooglePayKey.md

@@ -0,0 +1,87 @@
+[@bigcommerce/checkout-sdk](../README.md) / GooglePayKey
+
+# Enumeration: GooglePayKey
+
+The recognized keys to pass the initialization options for Google Pay.
+
+## Table of contents
+
+### Enumeration Members
+
+- [ADYEN_V2](GooglePayKey.md#adyen_v2)
+- [ADYEN_V3](GooglePayKey.md#adyen_v3)
+- [AUTHORIZE_NET](GooglePayKey.md#authorize_net)
+- [BNZ](GooglePayKey.md#bnz)
+- [BRAINTREE](GooglePayKey.md#braintree)
+- [CHECKOUT_COM](GooglePayKey.md#checkout_com)
+- [CYBERSOURCE_V2](GooglePayKey.md#cybersource_v2)
+- [ORBITAL](GooglePayKey.md#orbital)
+- [STRIPE](GooglePayKey.md#stripe)
+- [STRIPE_UPE](GooglePayKey.md#stripe_upe)
+- [WORLDPAY_ACCESS](GooglePayKey.md#worldpay_access)
+
+## Enumeration Members
+
+### ADYEN\_V2
+
+• **ADYEN\_V2**
+
+___
+
+### ADYEN\_V3
+
+• **ADYEN\_V3**
+
+___
+
+### AUTHORIZE\_NET
+
+• **AUTHORIZE\_NET**
+
+___
+
+### BNZ
+
+• **BNZ**
+
+___
+
+### BRAINTREE
+
+• **BRAINTREE**
+
+___
+
+### CHECKOUT\_COM
+
+• **CHECKOUT\_COM**
+
+___
+
+### CYBERSOURCE\_V2
+
+• **CYBERSOURCE\_V2**
+
+___
+
+### ORBITAL
+
+• **ORBITAL**
+
+___
+
+### STRIPE
+
+• **STRIPE**
+
+___
+
+### STRIPE\_UPE
+
+• **STRIPE\_UPE**
+
+___
+
+### WORLDPAY\_ACCESS
+
+• **WORLDPAY\_ACCESS**

package/docs/interfaces/GooglePayPaymentInitializeOptions_2.md

@@ -0,0 +1,93 @@
+[@bigcommerce/checkout-sdk](../README.md) / GooglePayPaymentInitializeOptions_2
+
+# Interface: GooglePayPaymentInitializeOptions\_2
+
+A set of options that are required to initialize the GooglePay payment method
+
+If the customer chooses to pay with GooglePay, they will be asked to
+enter their payment details via a modal. You can hook into events emitted by
+the modal by providing the callbacks listed below.
+
+```html
+<!-- This is where the GooglePay button will be inserted -->
+<div id="wallet-button"></div>
+```
+
+```js
+service.initializePayment({
+    // Using GooglePay provided by Braintree as an example
+    methodId: 'googlepaybraintree',
+    googlepaybraintree: {
+        walletButton: 'wallet-button'
+    },
+});
+```
+
+Additional event callbacks can be registered.
+
+```js
+service.initializePayment({
+    methodId: 'googlepaybraintree',
+    googlepaybraintree: {
+        walletButton: 'wallet-button',
+        onError(error) {
+            console.log(error);
+        },
+        onPaymentSelect() {
+            console.log('Selected');
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [walletButton](GooglePayPaymentInitializeOptions_2.md#walletbutton)
+
+### Methods
+
+- [onError](GooglePayPaymentInitializeOptions_2.md#onerror)
+- [onPaymentSelect](GooglePayPaymentInitializeOptions_2.md#onpaymentselect)
+
+## Properties
+
+### walletButton
+
+• `Optional` **walletButton**: `string`
+
+This walletButton is used to set an event listener, provide an element ID if you want
+users to be able to launch the GooglePay wallet modal by clicking on a button.
+It should be an HTML element.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called when GooglePay fails to initialize or
+selects a payment option.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `Error` | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(): `void`
+
+A callback that gets called when the customer selects a payment option.
+
+#### Returns
+
+`void`

package/package.json

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