@bigcommerce/checkout-sdk 1.321.0 → 1.322.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/CHANGELOG.md +7 -0
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +31 -1
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/docs/README.md +3 -1
- package/docs/interfaces/PayPalCommerceCustomerInitializeOptions.md +56 -0
- package/docs/interfaces/WithPayPalCommerceCustomerInitializeOptions.md +18 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -281,6 +281,7 @@
|
|
|
281
281
|
- [OrderRequestBody](interfaces/OrderRequestBody.md)
|
|
282
282
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
283
283
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
284
|
+
- [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
|
|
284
285
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
285
286
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
286
287
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
@@ -378,6 +379,7 @@
|
|
|
378
379
|
- [WithCreditCardPaymentInitializeOptions](interfaces/WithCreditCardPaymentInitializeOptions.md)
|
|
379
380
|
- [WithDocumentInstrument](interfaces/WithDocumentInstrument.md)
|
|
380
381
|
- [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
|
|
382
|
+
- [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
|
|
381
383
|
- [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
|
|
382
384
|
- [WorldpayAccessPaymentInitializeOptions](interfaces/WorldpayAccessPaymentInitializeOptions.md)
|
|
383
385
|
- [ZipCodeElementOptions](interfaces/ZipCodeElementOptions.md)
|
|
@@ -549,7 +551,7 @@ ___
|
|
|
549
551
|
|
|
550
552
|
### CustomerInitializeOptions
|
|
551
553
|
|
|
552
|
-
Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
554
|
+
Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md) & [`WithPayPalCommerceCustomerInitializeOptions`](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
|
|
553
555
|
|
|
554
556
|
___
|
|
555
557
|
|
|
@@ -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`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceCustomerInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithPayPalCommerceCustomerInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [paypalcommerce](WithPayPalCommerceCustomerInitializeOptions.md#paypalcommerce)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### paypalcommerce
|
|
14
|
+
|
|
15
|
+
• `Optional` **paypalcommerce**: [`PayPalCommerceCustomerInitializeOptions`](PayPalCommerceCustomerInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the customer step of checkout
|
|
18
|
+
when using PayPalCommerce.
|