@bigcommerce/checkout-sdk 1.369.2 → 1.371.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 +14 -0
- package/dist/checkout-button.d.ts +22 -2
- 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 +22 -2
- 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 +4 -1
- package/docs/interfaces/AmazonPayV2ButtonConfig.md +2 -0
- package/docs/interfaces/BoltButtonInitializeOptions.md +17 -0
- package/docs/interfaces/BoltBuyNowInitializeOptions.md +29 -0
- package/docs/interfaces/WithBoltButtonInitializeOptions.md +18 -0
- package/docs/interfaces/WithBuyNowFeature.md +98 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -104,6 +104,8 @@
|
|
|
104
104
|
- [BodlEventsPayload](interfaces/BodlEventsPayload.md)
|
|
105
105
|
- [BodlService](interfaces/BodlService.md)
|
|
106
106
|
- [BodyStyles](interfaces/BodyStyles.md)
|
|
107
|
+
- [BoltButtonInitializeOptions](interfaces/BoltButtonInitializeOptions.md)
|
|
108
|
+
- [BoltBuyNowInitializeOptions](interfaces/BoltBuyNowInitializeOptions.md)
|
|
107
109
|
- [BoltCustomerInitializeOptions](interfaces/BoltCustomerInitializeOptions.md)
|
|
108
110
|
- [BoltPaymentInitializeOptions](interfaces/BoltPaymentInitializeOptions.md)
|
|
109
111
|
- [BraintreeError](interfaces/BraintreeError.md)
|
|
@@ -364,6 +366,7 @@
|
|
|
364
366
|
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
365
367
|
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
366
368
|
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
369
|
+
- [WithBoltButtonInitializeOptions](interfaces/WithBoltButtonInitializeOptions.md)
|
|
367
370
|
- [WithBoltPaymentInitializeOptions](interfaces/WithBoltPaymentInitializeOptions.md)
|
|
368
371
|
- [WithBraintreePaypalCustomerInitializeOptions](interfaces/WithBraintreePaypalCustomerInitializeOptions.md)
|
|
369
372
|
- [WithBuyNowFeature](interfaces/WithBuyNowFeature.md)
|
|
@@ -534,7 +537,7 @@ ___
|
|
|
534
537
|
|
|
535
538
|
### CheckoutButtonInitializeOptions
|
|
536
539
|
|
|
537
|
-
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`WithPayPalCommerceInlineButtonInitializeOptions`](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md) & [`WithPayPalCommerceVenmoButtonInitializeOptions`](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
540
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithBoltButtonInitializeOptions`](interfaces/WithBoltButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`WithPayPalCommerceInlineButtonInitializeOptions`](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md) & [`WithPayPalCommerceVenmoButtonInitializeOptions`](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
538
541
|
|
|
539
542
|
___
|
|
540
543
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BoltButtonInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BoltButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [buyNowInitializeOptions](BoltButtonInitializeOptions.md#buynowinitializeoptions)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### buyNowInitializeOptions
|
|
14
|
+
|
|
15
|
+
• `Optional` **buyNowInitializeOptions**: [`BoltBuyNowInitializeOptions`](BoltBuyNowInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize Buy Now functionality.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BoltBuyNowInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BoltBuyNowInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [storefrontApiToken](BoltBuyNowInitializeOptions.md#storefrontapitoken)
|
|
10
|
+
|
|
11
|
+
### Methods
|
|
12
|
+
|
|
13
|
+
- [getBuyNowCartRequestBody](BoltBuyNowInitializeOptions.md#getbuynowcartrequestbody)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### storefrontApiToken
|
|
18
|
+
|
|
19
|
+
• `Optional` **storefrontApiToken**: `string`
|
|
20
|
+
|
|
21
|
+
## Methods
|
|
22
|
+
|
|
23
|
+
### getBuyNowCartRequestBody
|
|
24
|
+
|
|
25
|
+
▸ **getBuyNowCartRequestBody**(): `default`
|
|
26
|
+
|
|
27
|
+
#### Returns
|
|
28
|
+
|
|
29
|
+
`default`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithBoltButtonInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithBoltButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [bolt](WithBoltButtonInitializeOptions.md#bolt)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### bolt
|
|
14
|
+
|
|
15
|
+
• `Optional` **bolt**: [`BoltButtonInitializeOptions`](BoltButtonInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the Bolt payment
|
|
18
|
+
method. They can be omitted unless you need to support Bolt.
|
|
@@ -2,14 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WithBuyNowFeature
|
|
4
4
|
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
|
|
8
|
+
|
|
9
|
+
↳ **`WithBuyNowFeature`**
|
|
10
|
+
|
|
5
11
|
## Table of contents
|
|
6
12
|
|
|
7
13
|
### Properties
|
|
8
14
|
|
|
15
|
+
- [buttonColor](WithBuyNowFeature.md#buttoncolor)
|
|
9
16
|
- [buyNowInitializeOptions](WithBuyNowFeature.md#buynowinitializeoptions)
|
|
17
|
+
- [checkoutLanguage](WithBuyNowFeature.md#checkoutlanguage)
|
|
18
|
+
- [ledgerCurrency](WithBuyNowFeature.md#ledgercurrency)
|
|
19
|
+
- [merchantId](WithBuyNowFeature.md#merchantid)
|
|
20
|
+
- [placement](WithBuyNowFeature.md#placement)
|
|
21
|
+
- [productType](WithBuyNowFeature.md#producttype)
|
|
22
|
+
- [sandbox](WithBuyNowFeature.md#sandbox)
|
|
10
23
|
|
|
11
24
|
## Properties
|
|
12
25
|
|
|
26
|
+
### buttonColor
|
|
27
|
+
|
|
28
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
29
|
+
|
|
30
|
+
Color of the Amazon Pay button.
|
|
31
|
+
|
|
32
|
+
#### Inherited from
|
|
33
|
+
|
|
34
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
35
|
+
|
|
36
|
+
___
|
|
37
|
+
|
|
13
38
|
### buyNowInitializeOptions
|
|
14
39
|
|
|
15
40
|
• `Optional` **buyNowInitializeOptions**: `Object`
|
|
@@ -21,3 +46,76 @@ The options that are required to initialize Buy Now functionality.
|
|
|
21
46
|
| Name | Type |
|
|
22
47
|
| :------ | :------ |
|
|
23
48
|
| `getBuyNowCartRequestBody?` | () => `void` \| [`BuyNowCartRequestBody`](BuyNowCartRequestBody.md) |
|
|
49
|
+
|
|
50
|
+
___
|
|
51
|
+
|
|
52
|
+
### checkoutLanguage
|
|
53
|
+
|
|
54
|
+
• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
|
|
55
|
+
|
|
56
|
+
Language used to render the button and text on Amazon Pay hosted pages.
|
|
57
|
+
|
|
58
|
+
#### Inherited from
|
|
59
|
+
|
|
60
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
61
|
+
|
|
62
|
+
___
|
|
63
|
+
|
|
64
|
+
### ledgerCurrency
|
|
65
|
+
|
|
66
|
+
• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
|
|
67
|
+
|
|
68
|
+
Ledger currency provided during registration for the given merchant identifier.
|
|
69
|
+
|
|
70
|
+
#### Inherited from
|
|
71
|
+
|
|
72
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
73
|
+
|
|
74
|
+
___
|
|
75
|
+
|
|
76
|
+
### merchantId
|
|
77
|
+
|
|
78
|
+
• **merchantId**: `string`
|
|
79
|
+
|
|
80
|
+
Amazon Pay merchant account identifier.
|
|
81
|
+
|
|
82
|
+
#### Inherited from
|
|
83
|
+
|
|
84
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
85
|
+
|
|
86
|
+
___
|
|
87
|
+
|
|
88
|
+
### placement
|
|
89
|
+
|
|
90
|
+
• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
|
|
91
|
+
|
|
92
|
+
Placement of the Amazon Pay button on your website.
|
|
93
|
+
|
|
94
|
+
#### Inherited from
|
|
95
|
+
|
|
96
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
|
|
97
|
+
|
|
98
|
+
___
|
|
99
|
+
|
|
100
|
+
### productType
|
|
101
|
+
|
|
102
|
+
• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
|
|
103
|
+
|
|
104
|
+
Product type selected for checkout. Default is 'PayAndShip'.
|
|
105
|
+
|
|
106
|
+
#### Inherited from
|
|
107
|
+
|
|
108
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
109
|
+
|
|
110
|
+
___
|
|
111
|
+
|
|
112
|
+
### sandbox
|
|
113
|
+
|
|
114
|
+
• `Optional` **sandbox**: `boolean`
|
|
115
|
+
|
|
116
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
117
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
118
|
+
|
|
119
|
+
#### Inherited from
|
|
120
|
+
|
|
121
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|