@bigcommerce/checkout-sdk 1.342.0 → 1.344.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/README.md CHANGED
@@ -284,6 +284,7 @@
284
284
  - [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
285
285
  - [PayPalCommerceInlineButtonInitializeOptions](interfaces/PayPalCommerceInlineButtonInitializeOptions.md)
286
286
  - [PayPalCommerceVenmoButtonInitializeOptions](interfaces/PayPalCommerceVenmoButtonInitializeOptions.md)
287
+ - [PayPalCommerceVenmoCustomerInitializeOptions](interfaces/PayPalCommerceVenmoCustomerInitializeOptions.md)
287
288
  - [PayPalInstrument](interfaces/PayPalInstrument.md)
288
289
  - [PaymentMethod](interfaces/PaymentMethod.md)
289
290
  - [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
@@ -380,6 +381,7 @@
380
381
  - [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
381
382
  - [WithPayPalCommerceInlineButtonInitializeOptions](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md)
382
383
  - [WithPayPalCommerceVenmoButtonInitializeOptions](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
384
+ - [WithPayPalCommerceVenmoCustomerInitializeOptions](interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md)
383
385
  - [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
384
386
  - [WorldpayAccessPaymentInitializeOptions](interfaces/WorldpayAccessPaymentInitializeOptions.md)
385
387
  - [ZipCodeElementOptions](interfaces/ZipCodeElementOptions.md)
@@ -432,6 +434,7 @@
432
434
  - [StripeElementOptions](README.md#stripeelementoptions)
433
435
  - [StripeEventType](README.md#stripeeventtype)
434
436
  - [UserExperienceSettingNames](README.md#userexperiencesettingnames)
437
+ - [UserExperienceSettings](README.md#userexperiencesettings)
435
438
 
436
439
  ### Functions
437
440
 
@@ -552,7 +555,7 @@ ___
552
555
 
553
556
  ### CustomerInitializeOptions
554
557
 
555
- Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md) & [`WithPayPalCommerceCustomerInitializeOptions`](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
558
+ Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md) & [`WithPayPalCommerceCustomerInitializeOptions`](interfaces/WithPayPalCommerceCustomerInitializeOptions.md) & [`WithPayPalCommerceVenmoCustomerInitializeOptions`](interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md)
556
559
 
557
560
  ___
558
561
 
@@ -732,6 +735,12 @@ ___
732
735
 
733
736
  Ƭ **UserExperienceSettingNames**: ``"walletButtonsOnTop"``
734
737
 
738
+ ___
739
+
740
+ ### UserExperienceSettings
741
+
742
+ Ƭ **UserExperienceSettings**: { [key in UserExperienceSettingNames]: boolean }
743
+
735
744
  ## Functions
736
745
 
737
746
  ### createBodlService
@@ -45,13 +45,7 @@ ___
45
45
 
46
46
  ### checkoutUserExperienceSettings
47
47
 
48
- • **checkoutUserExperienceSettings**: `Object`
49
-
50
- #### Type declaration
51
-
52
- | Name | Type |
53
- | :------ | :------ |
54
- | `walletButtonsOnTop` | `boolean` |
48
+ • **checkoutUserExperienceSettings**: [`UserExperienceSettings`](../README.md#userexperiencesettings)
55
49
 
56
50
  ___
57
51
 
@@ -35,6 +35,7 @@ checkout information, such as shipping and billing details.
35
35
  - [getShippingCountries](CheckoutStoreSelector.md#getshippingcountries)
36
36
  - [getShippingOptions](CheckoutStoreSelector.md#getshippingoptions)
37
37
  - [getSignInEmail](CheckoutStoreSelector.md#getsigninemail)
38
+ - [getUserExperienceSettings](CheckoutStoreSelector.md#getuserexperiencesettings)
38
39
  - [isPaymentDataRequired](CheckoutStoreSelector.md#ispaymentdatarequired)
39
40
  - [isPaymentDataSubmitted](CheckoutStoreSelector.md#ispaymentdatasubmitted)
40
41
 
@@ -447,6 +448,20 @@ The sign-in email object if sent, otherwise undefined
447
448
 
448
449
  ___
449
450
 
451
+ ### getUserExperienceSettings
452
+
453
+ ▸ **getUserExperienceSettings**(): `undefined` \| [`UserExperienceSettings`](../README.md#userexperiencesettings)
454
+
455
+ Gets user experience settings.
456
+
457
+ #### Returns
458
+
459
+ `undefined` \| [`UserExperienceSettings`](../README.md#userexperiencesettings)
460
+
461
+ The object of user experience settings if it is loaded, otherwise undefined.
462
+
463
+ ___
464
+
450
465
  ### isPaymentDataRequired
451
466
 
452
467
  ▸ **isPaymentDataRequired**(`useStoreCredit?`): `boolean`
@@ -0,0 +1,40 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceVenmoCustomerInitializeOptions
2
+
3
+ # Interface: PayPalCommerceVenmoCustomerInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [container](PayPalCommerceVenmoCustomerInitializeOptions.md#container)
10
+
11
+ ### Methods
12
+
13
+ - [onError](PayPalCommerceVenmoCustomerInitializeOptions.md#onerror)
14
+
15
+ ## Properties
16
+
17
+ ### container
18
+
19
+ • **container**: `string`
20
+
21
+ The ID of a container which the checkout button should be inserted into.
22
+
23
+ ## Methods
24
+
25
+ ### onError
26
+
27
+ ▸ `Optional` **onError**(`error?`): `void`
28
+
29
+ A callback that gets called if unable to initialize the widget or select
30
+ one of the address options provided by the widget.
31
+
32
+ #### Parameters
33
+
34
+ | Name | Type | Description |
35
+ | :------ | :------ | :------ |
36
+ | `error?` | `Error` | The error object describing the failure. |
37
+
38
+ #### Returns
39
+
40
+ `void`
@@ -0,0 +1,15 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceVenmoCustomerInitializeOptions
2
+
3
+ # Interface: WithPayPalCommerceVenmoCustomerInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [paypalcommercevenmo](WithPayPalCommerceVenmoCustomerInitializeOptions.md#paypalcommercevenmo)
10
+
11
+ ## Properties
12
+
13
+ ### paypalcommercevenmo
14
+
15
+ • `Optional` **paypalcommercevenmo**: [`PayPalCommerceVenmoCustomerInitializeOptions`](PayPalCommerceVenmoCustomerInitializeOptions.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.342.0",
3
+ "version": "1.344.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",