@bigcommerce/checkout-sdk 1.281.2 → 1.282.0

package/docs/README.md

@@ -330,11 +330,16 @@
 - [StoreCurrency](interfaces/StoreCurrency.md)
 - [StoreLinks](interfaces/StoreLinks.md)
 - [StoreProfile](interfaces/StoreProfile.md)
+- [StripeCustomerEvent](interfaces/StripeCustomerEvent.md)
 - [StripeElementCSSProperties](interfaces/StripeElementCSSProperties.md)
 - [StripeElementClasses](interfaces/StripeElementClasses.md)
 - [StripeElementStyle](interfaces/StripeElementStyle.md)
 - [StripeElementStyleVariant](interfaces/StripeElementStyleVariant.md)
+- [StripeEvent](interfaces/StripeEvent.md)
+- [StripeShippingEvent](interfaces/StripeShippingEvent.md)
+- [StripeUPECustomerInitializeOptions](interfaces/StripeUPECustomerInitializeOptions.md)
 - [StripeUPEPaymentInitializeOptions](interfaces/StripeUPEPaymentInitializeOptions.md)
+- [StripeUPEShippingInitializeOptions](interfaces/StripeUPEShippingInitializeOptions.md)
 - [StripeV3PaymentInitializeOptions](interfaces/StripeV3PaymentInitializeOptions.md)
 - [StyleOptions](interfaces/StyleOptions.md)
 - [StyleOptions_2](interfaces/StyleOptions_2.md)
@@ -411,6 +416,7 @@
 - [PaypalCommerceFormFieldStyles](README.md#paypalcommerceformfieldstyles)
 - [PaypalCommerceInitializeOptions](README.md#paypalcommerceinitializeoptions)
 - [StripeElementOptions](README.md#stripeelementoptions)
+- [StripeEventType](README.md#stripeeventtype)
 
 ### Functions
 
@@ -698,6 +704,12 @@ ___
 
 Ƭ **StripeElementOptions**: [`CardElementOptions`](interfaces/CardElementOptions.md) \| [`CardExpiryElementOptions`](interfaces/CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](interfaces/CardNumberElementOptions.md) \| [`CardCvcElementOptions`](interfaces/CardCvcElementOptions.md) \| [`IdealElementOptions`](interfaces/IdealElementOptions.md) \| [`IbanElementOptions`](interfaces/IbanElementOptions.md) \| [`ZipCodeElementOptions`](interfaces/ZipCodeElementOptions.md)
 
+___
+
+### StripeEventType
+
+Ƭ **StripeEventType**: [`StripeShippingEvent`](interfaces/StripeShippingEvent.md) \| [`StripeCustomerEvent`](interfaces/StripeCustomerEvent.md)
+
 ## Functions
 
 ### createCheckoutButtonInitializer

package/docs/interfaces/BaseCustomerInitializeOptions.md

@@ -41,6 +41,7 @@ information in order to initialize the customer step of checkout.
 - [masterpass](BaseCustomerInitializeOptions.md#masterpass)
 - [methodId](BaseCustomerInitializeOptions.md#methodid)
 - [params](BaseCustomerInitializeOptions.md#params)
+- [stripeupe](BaseCustomerInitializeOptions.md#stripeupe)
 - [timeout](BaseCustomerInitializeOptions.md#timeout)
 
 ## Properties
@@ -202,6 +203,15 @@ The parameters of the request, if required.
 
 ___
 
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPECustomerInitializeOptions`](StripeUPECustomerInitializeOptions.md)
+
+The options that are required to initialize the Customer Stripe Upe payment method.
+They can be omitted unless you need to support Customer Stripe Upe.
+
+___
+
 ### timeout
 
 • `Optional` **timeout**: `default`

package/docs/interfaces/ShippingInitializeOptions.md

@@ -31,6 +31,7 @@ step of checkout.
 - [amazonpay](ShippingInitializeOptions.md#amazonpay)
 - [methodId](ShippingInitializeOptions.md#methodid)
 - [params](ShippingInitializeOptions.md#params)
+- [stripeupe](ShippingInitializeOptions.md#stripeupe)
 - [timeout](ShippingInitializeOptions.md#timeout)
 
 ## Properties
@@ -75,6 +76,15 @@ The parameters of the request, if required.
 
 ___
 
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPEShippingInitializeOptions`](StripeUPEShippingInitializeOptions.md)
+
+The options that are required to initialize the shipping step of checkout
+when using Stripe Upe Link.
+
+___
+
 ### timeout
 
 • `Optional` **timeout**: `default`

package/docs/interfaces/StripeCustomerEvent.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeCustomerEvent
+
+# Interface: StripeCustomerEvent
+
+## Hierarchy
+
+- [`StripeEvent`](StripeEvent.md)
+
+  ↳ **`StripeCustomerEvent`**
+
+## Table of contents
+
+### Properties
+
+- [authenticated](StripeCustomerEvent.md#authenticated)
+- [collapsed](StripeCustomerEvent.md#collapsed)
+- [complete](StripeCustomerEvent.md#complete)
+- [elementType](StripeCustomerEvent.md#elementtype)
+- [empty](StripeCustomerEvent.md#empty)
+- [value](StripeCustomerEvent.md#value)
+
+## Properties
+
+### authenticated
+
+• **authenticated**: `boolean`
+
+___
+
+### collapsed
+
+• `Optional` **collapsed**: `boolean`
+
+___
+
+### complete
+
+• **complete**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[complete](StripeEvent.md#complete)
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[elementType](StripeEvent.md#elementtype)
+
+___
+
+### empty
+
+• **empty**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[empty](StripeEvent.md#empty)
+
+___
+
+### value
+
+• **value**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |

package/docs/interfaces/StripeEvent.md

@@ -0,0 +1,37 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeEvent
+
+# Interface: StripeEvent
+
+## Hierarchy
+
+- **`StripeEvent`**
+
+  ↳ [`StripeCustomerEvent`](StripeCustomerEvent.md)
+
+  ↳ [`StripeShippingEvent`](StripeShippingEvent.md)
+
+## Table of contents
+
+### Properties
+
+- [complete](StripeEvent.md#complete)
+- [elementType](StripeEvent.md#elementtype)
+- [empty](StripeEvent.md#empty)
+
+## Properties
+
+### complete
+
+• **complete**: `boolean`
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+___
+
+### empty
+
+• **empty**: `boolean`

package/docs/interfaces/StripeShippingEvent.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeShippingEvent
+
+# Interface: StripeShippingEvent
+
+## Hierarchy
+
+- [`StripeEvent`](StripeEvent.md)
+
+  ↳ **`StripeShippingEvent`**
+
+## Table of contents
+
+### Properties
+
+- [complete](StripeShippingEvent.md#complete)
+- [elementType](StripeShippingEvent.md#elementtype)
+- [empty](StripeShippingEvent.md#empty)
+- [isNewAddress](StripeShippingEvent.md#isnewaddress)
+- [value](StripeShippingEvent.md#value)
+
+## Properties
+
+### complete
+
+• **complete**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[complete](StripeEvent.md#complete)
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[elementType](StripeEvent.md#elementtype)
+
+___
+
+### empty
+
+• **empty**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](StripeEvent.md).[empty](StripeEvent.md#empty)
+
+___
+
+### isNewAddress
+
+• `Optional` **isNewAddress**: `boolean`
+
+___
+
+### value
+
+• **value**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `Object` |
+| `address.city` | `string` |
+| `address.country` | `string` |
+| `address.line1` | `string` |
+| `address.line2?` | `string` |
+| `address.postal_code` | `string` |
+| `address.state` | `string` |
+| `name` | `string` |

package/docs/interfaces/StripeUPECustomerInitializeOptions.md

@@ -0,0 +1,92 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeUPECustomerInitializeOptions
+
+# Interface: StripeUPECustomerInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [container](StripeUPECustomerInitializeOptions.md#container)
+- [gatewayId](StripeUPECustomerInitializeOptions.md#gatewayid)
+- [methodId](StripeUPECustomerInitializeOptions.md#methodid)
+
+### Methods
+
+- [getStyles](StripeUPECustomerInitializeOptions.md#getstyles)
+- [isLoading](StripeUPECustomerInitializeOptions.md#isloading)
+- [onEmailChange](StripeUPECustomerInitializeOptions.md#onemailchange)
+
+## Properties
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the stripe iframe should be inserted.
+
+___
+
+### gatewayId
+
+• **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.: Stripeupe and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+## Methods
+
+### getStyles
+
+▸ `Optional` **getStyles**(): `Object`
+
+get styles from store theme
+
+#### Returns
+
+`Object`
+
+___
+
+### isLoading
+
+▸ **isLoading**(`mounted`): `void`
+
+A callback that gets called when Stripe Link Authentication Element is Loaded.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mounted` | `boolean` |
+
+#### Returns
+
+`void`
+
+___
+
+### onEmailChange
+
+▸ **onEmailChange**(`authenticated`, `email`): `void`
+
+A callback that gets called whenever the Stripe Link Authentication Element's value changes.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `authenticated` | `boolean` | if the email is authenticated on Stripe. |
+| `email` | `string` | The new value of the email. |
+
+#### Returns
+
+`void`

package/docs/interfaces/StripeUPEShippingInitializeOptions.md

@@ -0,0 +1,87 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeUPEShippingInitializeOptions
+
+# Interface: StripeUPEShippingInitializeOptions
+
+A set of options that are required to initialize the shipping step of
+checkout in order to support StripeUpe.
+
+When StripeUpe is initialized, an iframe will be inserted into the DOM. The
+iframe has a list of shipping addresses for the customer to choose from.
+
+## Table of contents
+
+### Properties
+
+- [availableCountries](StripeUPEShippingInitializeOptions.md#availablecountries)
+- [container](StripeUPEShippingInitializeOptions.md#container)
+- [gatewayId](StripeUPEShippingInitializeOptions.md#gatewayid)
+- [methodId](StripeUPEShippingInitializeOptions.md#methodid)
+
+### Methods
+
+- [getStyles](StripeUPEShippingInitializeOptions.md#getstyles)
+- [onChangeShipping](StripeUPEShippingInitializeOptions.md#onchangeshipping)
+
+## Properties
+
+### availableCountries
+
+• **availableCountries**: `string`
+
+Available countries configured on BC shipping setup.
+
+___
+
+### container
+
+• `Optional` **container**: `string`
+
+The ID of a container which the stripe iframe should be inserted.
+
+___
+
+### gatewayId
+
+• **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.: Stripeupe and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+## Methods
+
+### getStyles
+
+▸ `Optional` **getStyles**(): `Object`
+
+get styles from store theme
+
+#### Returns
+
+`Object`
+
+___
+
+### onChangeShipping
+
+▸ **onChangeShipping**(`shipping`): `void`
+
+A callback that gets called whenever the Stripe Link Shipping Element's object is completed.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shipping` | [`StripeEventType`](../README.md#stripeeventtype) |
+
+#### Returns
+
+`void`

package/package.json

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