@bigcommerce/checkout-sdk 1.273.0 → 1.275.1

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.
Files changed (32) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/checkout-button.d.ts +168 -101
  3. package/dist/checkout-button.js +1 -1
  4. package/dist/checkout-button.js.map +1 -1
  5. package/dist/checkout-button.umd.js +1 -1
  6. package/dist/checkout-button.umd.js.map +1 -1
  7. package/dist/checkout-sdk.d.ts +525 -447
  8. package/dist/checkout-sdk.js +1 -1
  9. package/dist/checkout-sdk.js.map +1 -1
  10. package/dist/checkout-sdk.umd.js +1 -1
  11. package/dist/checkout-sdk.umd.js.map +1 -1
  12. package/dist/hosted-form.js.map +1 -1
  13. package/dist/hosted-form.umd.js.map +1 -1
  14. package/docs/README.md +40 -4
  15. package/docs/classes/CheckoutButtonInitializer.md +1 -1
  16. package/docs/classes/CheckoutService.md +2 -2
  17. package/docs/enums/AmazonPayV2ButtonColor.md +29 -0
  18. package/docs/interfaces/AmazonPayV2ButtonConfig.md +80 -0
  19. package/docs/interfaces/AmazonPayV2ButtonParams.md +45 -1
  20. package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md +36 -0
  21. package/docs/interfaces/AmazonPayV2NewButtonParams.md +125 -0
  22. package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +38 -0
  23. package/docs/interfaces/{CheckoutButtonInitializeOptions.md → BaseCheckoutButtonInitializeOptions.md} +26 -26
  24. package/docs/interfaces/{CustomerInitializeOptions.md → BaseCustomerInitializeOptions.md} +25 -31
  25. package/docs/interfaces/{PaymentInitializeOptions.md → BasePaymentInitializeOptions.md} +39 -49
  26. package/docs/interfaces/CheckoutButtonOptions.md +1 -1
  27. package/docs/interfaces/CustomerRequestOptions.md +1 -1
  28. package/docs/interfaces/PaymentRequestOptions.md +1 -1
  29. package/docs/interfaces/WithApplePayButtonInitializeOptions.md +15 -0
  30. package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +18 -0
  31. package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +18 -0
  32. package/package.json +1 -1
package/docs/interfaces/{CustomerInitializeOptions.md → BaseCustomerInitializeOptions.md} RENAMED
@@ -1,6 +1,6 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / CustomerInitializeOptions
1
+ [@bigcommerce/checkout-sdk](../README.md) / BaseCustomerInitializeOptions
2
2
 
3
- # Interface: CustomerInitializeOptions
3
+ # Interface: BaseCustomerInitializeOptions
4
4
 
5
5
  A set of options that are required to initialize the customer step of the
6
6
  current checkout flow.
@@ -14,31 +14,34 @@ information in order to initialize the customer step of checkout.
14
14
 
15
15
  - [`CustomerRequestOptions`](CustomerRequestOptions.md)
16
16
 
17
- ↳ **`CustomerInitializeOptions`**
17
+ ↳ **`BaseCustomerInitializeOptions`**
18
+
19
+ ## Indexable
20
+
21
+ ▪ [key: `string`]: `unknown`
18
22
 
19
23
  ## Table of contents
20
24
 
21
25
  ### Properties
22
26
 
23
- - [amazon](CustomerInitializeOptions.md#amazon)
24
- - [amazonpay](CustomerInitializeOptions.md#amazonpay)
25
- - [applepay](CustomerInitializeOptions.md#applepay)
26
- - [bolt](CustomerInitializeOptions.md#bolt)
27
- - [braintreevisacheckout](CustomerInitializeOptions.md#braintreevisacheckout)
28
- - [chasepay](CustomerInitializeOptions.md#chasepay)
29
- - [googlepayadyenv2](CustomerInitializeOptions.md#googlepayadyenv2)
30
- - [googlepayadyenv3](CustomerInitializeOptions.md#googlepayadyenv3)
31
- - [googlepayauthorizenet](CustomerInitializeOptions.md#googlepayauthorizenet)
32
- - [googlepaybraintree](CustomerInitializeOptions.md#googlepaybraintree)
33
- - [googlepaycheckoutcom](CustomerInitializeOptions.md#googlepaycheckoutcom)
34
- - [googlepaycybersourcev2](CustomerInitializeOptions.md#googlepaycybersourcev2)
35
- - [googlepayorbital](CustomerInitializeOptions.md#googlepayorbital)
36
- - [googlepaystripe](CustomerInitializeOptions.md#googlepaystripe)
37
- - [googlepaystripeupe](CustomerInitializeOptions.md#googlepaystripeupe)
38
- - [masterpass](CustomerInitializeOptions.md#masterpass)
39
- - [methodId](CustomerInitializeOptions.md#methodid)
40
- - [params](CustomerInitializeOptions.md#params)
41
- - [timeout](CustomerInitializeOptions.md#timeout)
27
+ - [amazon](BaseCustomerInitializeOptions.md#amazon)
28
+ - [amazonpay](BaseCustomerInitializeOptions.md#amazonpay)
29
+ - [bolt](BaseCustomerInitializeOptions.md#bolt)
30
+ - [braintreevisacheckout](BaseCustomerInitializeOptions.md#braintreevisacheckout)
31
+ - [chasepay](BaseCustomerInitializeOptions.md#chasepay)
32
+ - [googlepayadyenv2](BaseCustomerInitializeOptions.md#googlepayadyenv2)
33
+ - [googlepayadyenv3](BaseCustomerInitializeOptions.md#googlepayadyenv3)
34
+ - [googlepayauthorizenet](BaseCustomerInitializeOptions.md#googlepayauthorizenet)
35
+ - [googlepaybraintree](BaseCustomerInitializeOptions.md#googlepaybraintree)
36
+ - [googlepaycheckoutcom](BaseCustomerInitializeOptions.md#googlepaycheckoutcom)
37
+ - [googlepaycybersourcev2](BaseCustomerInitializeOptions.md#googlepaycybersourcev2)
38
+ - [googlepayorbital](BaseCustomerInitializeOptions.md#googlepayorbital)
39
+ - [googlepaystripe](BaseCustomerInitializeOptions.md#googlepaystripe)
40
+ - [googlepaystripeupe](BaseCustomerInitializeOptions.md#googlepaystripeupe)
41
+ - [masterpass](BaseCustomerInitializeOptions.md#masterpass)
42
+ - [methodId](BaseCustomerInitializeOptions.md#methodid)
43
+ - [params](BaseCustomerInitializeOptions.md#params)
44
+ - [timeout](BaseCustomerInitializeOptions.md#timeout)
42
45
 
43
46
  ## Properties
44
47
 
@@ -60,15 +63,6 @@ when using AmazonPayV2.
60
63
 
61
64
  ___
62
65
 
63
- ### applepay
64
-
65
- • `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
66
-
67
- The options that are required to initialize the customer step of checkout
68
- when using ApplePay.
69
-
70
- ___
71
-
72
66
  ### bolt
73
67
 
74
68
  • `Optional` **bolt**: [`BoltCustomerInitializeOptions`](BoltCustomerInitializeOptions.md)
package/docs/interfaces/{PaymentInitializeOptions.md → BasePaymentInitializeOptions.md} RENAMED
@@ -1,6 +1,6 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions
1
+ [@bigcommerce/checkout-sdk](../README.md) / BasePaymentInitializeOptions
2
2
 
3
- # Interface: PaymentInitializeOptions
3
+ # Interface: BasePaymentInitializeOptions
4
4
 
5
5
  A set of options that are required to initialize the payment step of the
6
6
  current checkout flow.
@@ -9,49 +9,48 @@ current checkout flow.
9
9
 
10
10
  - [`PaymentRequestOptions`](PaymentRequestOptions.md)
11
11
 
12
- ↳ **`PaymentInitializeOptions`**
12
+ ↳ **`BasePaymentInitializeOptions`**
13
13
 
14
14
  ## Table of contents
15
15
 
16
16
  ### Properties
17
17
 
18
- - [adyenv2](PaymentInitializeOptions.md#adyenv2)
19
- - [adyenv3](PaymentInitializeOptions.md#adyenv3)
20
- - [amazon](PaymentInitializeOptions.md#amazon)
21
- - [amazonpay](PaymentInitializeOptions.md#amazonpay)
22
- - [applepay](PaymentInitializeOptions.md#applepay)
23
- - [bluesnapv2](PaymentInitializeOptions.md#bluesnapv2)
24
- - [bolt](PaymentInitializeOptions.md#bolt)
25
- - [braintree](PaymentInitializeOptions.md#braintree)
26
- - [braintreevisacheckout](PaymentInitializeOptions.md#braintreevisacheckout)
27
- - [chasepay](PaymentInitializeOptions.md#chasepay)
28
- - [creditCard](PaymentInitializeOptions.md#creditcard)
29
- - [digitalriver](PaymentInitializeOptions.md#digitalriver)
30
- - [gatewayId](PaymentInitializeOptions.md#gatewayid)
31
- - [googlepayadyenv2](PaymentInitializeOptions.md#googlepayadyenv2)
32
- - [googlepayadyenv3](PaymentInitializeOptions.md#googlepayadyenv3)
33
- - [googlepayauthorizenet](PaymentInitializeOptions.md#googlepayauthorizenet)
34
- - [googlepaybraintree](PaymentInitializeOptions.md#googlepaybraintree)
35
- - [googlepaycheckoutcom](PaymentInitializeOptions.md#googlepaycheckoutcom)
36
- - [googlepaycybersourcev2](PaymentInitializeOptions.md#googlepaycybersourcev2)
37
- - [googlepayorbital](PaymentInitializeOptions.md#googlepayorbital)
38
- - [googlepaystripe](PaymentInitializeOptions.md#googlepaystripe)
39
- - [googlepaystripeupe](PaymentInitializeOptions.md#googlepaystripeupe)
40
- - [klarna](PaymentInitializeOptions.md#klarna)
41
- - [klarnav2](PaymentInitializeOptions.md#klarnav2)
42
- - [masterpass](PaymentInitializeOptions.md#masterpass)
43
- - [methodId](PaymentInitializeOptions.md#methodid)
44
- - [mollie](PaymentInitializeOptions.md#mollie)
45
- - [moneris](PaymentInitializeOptions.md#moneris)
46
- - [opy](PaymentInitializeOptions.md#opy)
47
- - [params](PaymentInitializeOptions.md#params)
48
- - [paypalcommerce](PaymentInitializeOptions.md#paypalcommerce)
49
- - [paypalexpress](PaymentInitializeOptions.md#paypalexpress)
50
- - [square](PaymentInitializeOptions.md#square)
51
- - [stripeupe](PaymentInitializeOptions.md#stripeupe)
52
- - [stripev3](PaymentInitializeOptions.md#stripev3)
53
- - [timeout](PaymentInitializeOptions.md#timeout)
54
- - [worldpay](PaymentInitializeOptions.md#worldpay)
18
+ - [adyenv2](BasePaymentInitializeOptions.md#adyenv2)
19
+ - [adyenv3](BasePaymentInitializeOptions.md#adyenv3)
20
+ - [amazon](BasePaymentInitializeOptions.md#amazon)
21
+ - [amazonpay](BasePaymentInitializeOptions.md#amazonpay)
22
+ - [bluesnapv2](BasePaymentInitializeOptions.md#bluesnapv2)
23
+ - [bolt](BasePaymentInitializeOptions.md#bolt)
24
+ - [braintree](BasePaymentInitializeOptions.md#braintree)
25
+ - [braintreevisacheckout](BasePaymentInitializeOptions.md#braintreevisacheckout)
26
+ - [chasepay](BasePaymentInitializeOptions.md#chasepay)
27
+ - [creditCard](BasePaymentInitializeOptions.md#creditcard)
28
+ - [digitalriver](BasePaymentInitializeOptions.md#digitalriver)
29
+ - [gatewayId](BasePaymentInitializeOptions.md#gatewayid)
30
+ - [googlepayadyenv2](BasePaymentInitializeOptions.md#googlepayadyenv2)
31
+ - [googlepayadyenv3](BasePaymentInitializeOptions.md#googlepayadyenv3)
32
+ - [googlepayauthorizenet](BasePaymentInitializeOptions.md#googlepayauthorizenet)
33
+ - [googlepaybraintree](BasePaymentInitializeOptions.md#googlepaybraintree)
34
+ - [googlepaycheckoutcom](BasePaymentInitializeOptions.md#googlepaycheckoutcom)
35
+ - [googlepaycybersourcev2](BasePaymentInitializeOptions.md#googlepaycybersourcev2)
36
+ - [googlepayorbital](BasePaymentInitializeOptions.md#googlepayorbital)
37
+ - [googlepaystripe](BasePaymentInitializeOptions.md#googlepaystripe)
38
+ - [googlepaystripeupe](BasePaymentInitializeOptions.md#googlepaystripeupe)
39
+ - [klarna](BasePaymentInitializeOptions.md#klarna)
40
+ - [klarnav2](BasePaymentInitializeOptions.md#klarnav2)
41
+ - [masterpass](BasePaymentInitializeOptions.md#masterpass)
42
+ - [methodId](BasePaymentInitializeOptions.md#methodid)
43
+ - [mollie](BasePaymentInitializeOptions.md#mollie)
44
+ - [moneris](BasePaymentInitializeOptions.md#moneris)
45
+ - [opy](BasePaymentInitializeOptions.md#opy)
46
+ - [params](BasePaymentInitializeOptions.md#params)
47
+ - [paypalcommerce](BasePaymentInitializeOptions.md#paypalcommerce)
48
+ - [paypalexpress](BasePaymentInitializeOptions.md#paypalexpress)
49
+ - [square](BasePaymentInitializeOptions.md#square)
50
+ - [stripeupe](BasePaymentInitializeOptions.md#stripeupe)
51
+ - [stripev3](BasePaymentInitializeOptions.md#stripev3)
52
+ - [timeout](BasePaymentInitializeOptions.md#timeout)
53
+ - [worldpay](BasePaymentInitializeOptions.md#worldpay)
55
54
 
56
55
  ## Properties
57
56
 
@@ -91,15 +90,6 @@ method. They can be omitted unless you need to support AmazonPayV2.
91
90
 
92
91
  ___
93
92
 
94
- ### applepay
95
-
96
- • `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
97
-
98
- The options that are required to initialize the Apple Pay payment
99
- method. They can be omitted unless you need to support AmazonPay.
100
-
101
- ___
102
-
103
93
  ### bluesnapv2
104
94
 
105
95
  • `Optional` **bluesnapv2**: [`BlueSnapV2PaymentInitializeOptions`](BlueSnapV2PaymentInitializeOptions.md)
package/docs/interfaces/CheckoutButtonOptions.md CHANGED
@@ -10,7 +10,7 @@ The set of options for configuring the checkout button.
10
10
 
11
11
  ↳ **`CheckoutButtonOptions`**
12
12
 
13
- ↳↳ [`CheckoutButtonInitializeOptions`](CheckoutButtonInitializeOptions.md)
13
+ ↳↳ [`BaseCheckoutButtonInitializeOptions`](BaseCheckoutButtonInitializeOptions.md)
14
14
 
15
15
  ## Table of contents
16
16
 
package/docs/interfaces/CustomerRequestOptions.md CHANGED
@@ -15,7 +15,7 @@ flow for signing in or out a customer. Otherwise, these options are not required
15
15
 
16
16
  ↳ **`CustomerRequestOptions`**
17
17
 
18
- ↳↳ [`CustomerInitializeOptions`](CustomerInitializeOptions.md)
18
+ ↳↳ [`BaseCustomerInitializeOptions`](BaseCustomerInitializeOptions.md)
19
19
 
20
20
  ↳↳ [`ExecutePaymentMethodCheckoutOptions`](ExecutePaymentMethodCheckoutOptions.md)
21
21
 
package/docs/interfaces/PaymentRequestOptions.md CHANGED
@@ -11,7 +11,7 @@ the current checkout flow.
11
11
 
12
12
  ↳ **`PaymentRequestOptions`**
13
13
 
14
- ↳↳ [`PaymentInitializeOptions`](PaymentInitializeOptions.md)
14
+ ↳↳ [`BasePaymentInitializeOptions`](BasePaymentInitializeOptions.md)
15
15
 
16
16
  ## Table of contents
17
17
 
package/docs/interfaces/WithApplePayButtonInitializeOptions.md ADDED
@@ -0,0 +1,15 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithApplePayButtonInitializeOptions
2
+
3
+ # Interface: WithApplePayButtonInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [applepay](WithApplePayButtonInitializeOptions.md#applepay)
10
+
11
+ ## Properties
12
+
13
+ ### applepay
14
+
15
+ • `Optional` **applepay**: [`ApplePayButtonInitializeOptions_2`](ApplePayButtonInitializeOptions_2.md)
package/docs/interfaces/WithApplePayCustomerInitializeOptions.md ADDED
@@ -0,0 +1,18 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithApplePayCustomerInitializeOptions
2
+
3
+ # Interface: WithApplePayCustomerInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [applepay](WithApplePayCustomerInitializeOptions.md#applepay)
10
+
11
+ ## Properties
12
+
13
+ ### applepay
14
+
15
+ • `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
16
+
17
+ The options that are required to initialize the customer step of checkout
18
+ when using ApplePay.
package/docs/interfaces/WithApplePayPaymentInitializeOptions.md ADDED
@@ -0,0 +1,18 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / WithApplePayPaymentInitializeOptions
2
+
3
+ # Interface: WithApplePayPaymentInitializeOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [applepay](WithApplePayPaymentInitializeOptions.md#applepay)
10
+
11
+ ## Properties
12
+
13
+ ### applepay
14
+
15
+ • `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
16
+
17
+ The options that are required to initialize the Apple Pay payment
18
+ method. They can be omitted unless you need to support Apple Pay.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.273.0",
3
+ "version": "1.275.1",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",