@bigcommerce/checkout-sdk 1.314.2 → 1.316.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
@@ -292,6 +292,7 @@
292
292
  - [PaypalCommerceButtonInitializeOptions](interfaces/PaypalCommerceButtonInitializeOptions.md)
293
293
  - [PaypalCommerceCreditButtonInitializeOptions](interfaces/PaypalCommerceCreditButtonInitializeOptions.md)
294
294
  - [PaypalCommerceCreditCardPaymentInitializeOptions](interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md)
295
+ - [PaypalCommerceCustomerInitializeOptions](interfaces/PaypalCommerceCustomerInitializeOptions.md)
295
296
  - [PaypalCommerceFormFieldCardTypeChangeEventData](interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md)
296
297
  - [PaypalCommerceFormFieldKeyboardEventData](interfaces/PaypalCommerceFormFieldKeyboardEventData.md)
297
298
  - [PaypalCommerceFormFieldOptions](interfaces/PaypalCommerceFormFieldOptions.md)
@@ -42,6 +42,7 @@ information in order to initialize the customer step of checkout.
42
42
  - [masterpass](BaseCustomerInitializeOptions.md#masterpass)
43
43
  - [methodId](BaseCustomerInitializeOptions.md#methodid)
44
44
  - [params](BaseCustomerInitializeOptions.md#params)
45
+ - [paypalcommerce](BaseCustomerInitializeOptions.md#paypalcommerce)
45
46
  - [stripeupe](BaseCustomerInitializeOptions.md#stripeupe)
46
47
  - [timeout](BaseCustomerInitializeOptions.md#timeout)
47
48
 
@@ -213,6 +214,15 @@ The parameters of the request, if required.
213
214
 
214
215
  ___
215
216
 
217
+ ### paypalcommerce
218
+
219
+ • `Optional` **paypalcommerce**: [`PaypalCommerceCustomerInitializeOptions`](PaypalCommerceCustomerInitializeOptions.md)
220
+
221
+ The options that are required to initialize the PayPalCommerce payment method.
222
+ They can be omitted unless you need to support PayPalCommerce.
223
+
224
+ ___
225
+
216
226
  ### stripeupe
217
227
 
218
228
  • `Optional` **stripeupe**: [`StripeUPECustomerInitializeOptions`](StripeUPECustomerInitializeOptions.md)
@@ -0,0 +1,56 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceCustomerInitializeOptions
2
+
3
+ # Interface: PaypalCommerceCustomerInitializeOptions
4
+
5
+ A set of options that are required to initialize the customer step of
6
+ checkout to support PayPalCommerce.
7
+
8
+ ## Table of contents
9
+
10
+ ### Properties
11
+
12
+ - [container](PaypalCommerceCustomerInitializeOptions.md#container)
13
+
14
+ ### Methods
15
+
16
+ - [onComplete](PaypalCommerceCustomerInitializeOptions.md#oncomplete)
17
+ - [onError](PaypalCommerceCustomerInitializeOptions.md#onerror)
18
+
19
+ ## Properties
20
+
21
+ ### container
22
+
23
+ • **container**: `string`
24
+
25
+ The ID of a container which the checkout button should be inserted into.
26
+
27
+ ## Methods
28
+
29
+ ### onComplete
30
+
31
+ ▸ `Optional` **onComplete**(): `void`
32
+
33
+ A callback that gets called when payment complete on paypal side.
34
+
35
+ #### Returns
36
+
37
+ `void`
38
+
39
+ ___
40
+
41
+ ### onError
42
+
43
+ ▸ `Optional` **onError**(`error?`): `void`
44
+
45
+ A callback that gets called if unable to initialize the widget or select
46
+ one of the address options provided by the widget.
47
+
48
+ #### Parameters
49
+
50
+ | Name | Type | Description |
51
+ | :------ | :------ | :------ |
52
+ | `error?` | `Error` | The error object describing the failure. |
53
+
54
+ #### Returns
55
+
56
+ `void`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.314.2",
3
+ "version": "1.316.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",