@bigcommerce/checkout-sdk 1.370.0 → 1.371.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.
- package/CHANGELOG.md +14 -0
- package/dist/checkout-button.d.ts +2 -40
- 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 +2 -40
- 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 +1 -3
- package/docs/interfaces/AmazonPayV2ButtonConfig.md +2 -0
- package/docs/interfaces/PayPalButtonStyleOptions.md +0 -17
- package/docs/interfaces/WithBuyNowFeature.md +98 -0
- package/package.json +1 -1
- package/docs/interfaces/PayPalCommerceInlineButtonInitializeOptions.md +0 -61
- package/docs/interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md +0 -15
package/docs/README.md
CHANGED
|
@@ -290,7 +290,6 @@
|
|
|
290
290
|
- [PayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/PayPalCommerceCreditCardsPaymentInitializeOptions.md)
|
|
291
291
|
- [PayPalCommerceCreditCustomerInitializeOptions](interfaces/PayPalCommerceCreditCustomerInitializeOptions.md)
|
|
292
292
|
- [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
|
|
293
|
-
- [PayPalCommerceInlineButtonInitializeOptions](interfaces/PayPalCommerceInlineButtonInitializeOptions.md)
|
|
294
293
|
- [PayPalCommerceVenmoButtonInitializeOptions](interfaces/PayPalCommerceVenmoButtonInitializeOptions.md)
|
|
295
294
|
- [PayPalCommerceVenmoCustomerInitializeOptions](interfaces/PayPalCommerceVenmoCustomerInitializeOptions.md)
|
|
296
295
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
@@ -381,7 +380,6 @@
|
|
|
381
380
|
- [WithPayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md)
|
|
382
381
|
- [WithPayPalCommerceCreditCustomerInitializeOptions](interfaces/WithPayPalCommerceCreditCustomerInitializeOptions.md)
|
|
383
382
|
- [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
|
|
384
|
-
- [WithPayPalCommerceInlineButtonInitializeOptions](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md)
|
|
385
383
|
- [WithPayPalCommerceVenmoButtonInitializeOptions](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
386
384
|
- [WithPayPalCommerceVenmoCustomerInitializeOptions](interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md)
|
|
387
385
|
- [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
|
|
@@ -537,7 +535,7 @@ ___
|
|
|
537
535
|
|
|
538
536
|
### CheckoutButtonInitializeOptions
|
|
539
537
|
|
|
540
|
-
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithBoltButtonInitializeOptions`](interfaces/WithBoltButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`
|
|
538
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithBoltButtonInitializeOptions`](interfaces/WithBoltButtonInitializeOptions.md) & [`WithPayPalCommerceButtonInitializeOptions`](interfaces/WithPayPalCommerceButtonInitializeOptions.md) & [`WithPayPalCommerceCreditButtonInitializeOptions`](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md) & [`WithPayPalCommerceVenmoButtonInitializeOptions`](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
|
|
541
539
|
|
|
542
540
|
___
|
|
543
541
|
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
9
|
- [color](PayPalButtonStyleOptions.md#color)
|
|
10
|
-
- [custom](PayPalButtonStyleOptions.md#custom)
|
|
11
10
|
- [height](PayPalButtonStyleOptions.md#height)
|
|
12
11
|
- [label](PayPalButtonStyleOptions.md#label)
|
|
13
12
|
- [shape](PayPalButtonStyleOptions.md#shape)
|
|
@@ -20,22 +19,6 @@
|
|
|
20
19
|
|
|
21
20
|
___
|
|
22
21
|
|
|
23
|
-
### custom
|
|
24
|
-
|
|
25
|
-
• `Optional` **custom**: `Object`
|
|
26
|
-
|
|
27
|
-
#### Type declaration
|
|
28
|
-
|
|
29
|
-
| Name | Type |
|
|
30
|
-
| :------ | :------ |
|
|
31
|
-
| `css?` | `Object` |
|
|
32
|
-
| `css.background?` | `string` |
|
|
33
|
-
| `css.color?` | `string` |
|
|
34
|
-
| `css.width?` | `string` |
|
|
35
|
-
| `label?` | `string` |
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
22
|
### height
|
|
40
23
|
|
|
41
24
|
• `Optional` **height**: `number`
|
|
@@ -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)
|
package/package.json
CHANGED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceInlineButtonInitializeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: PayPalCommerceInlineButtonInitializeOptions
|
|
4
|
-
|
|
5
|
-
A set of options that are required to initialize ApplePay in cart.
|
|
6
|
-
|
|
7
|
-
When ApplePay is initialized, an ApplePay button will be inserted into the
|
|
8
|
-
DOM. When a customer clicks on it, it will trigger Apple sheet.
|
|
9
|
-
|
|
10
|
-
## Table of contents
|
|
11
|
-
|
|
12
|
-
### Properties
|
|
13
|
-
|
|
14
|
-
- [buttonContainerClassName](PayPalCommerceInlineButtonInitializeOptions.md#buttoncontainerclassname)
|
|
15
|
-
- [style](PayPalCommerceInlineButtonInitializeOptions.md#style)
|
|
16
|
-
|
|
17
|
-
### Methods
|
|
18
|
-
|
|
19
|
-
- [onComplete](PayPalCommerceInlineButtonInitializeOptions.md#oncomplete)
|
|
20
|
-
- [onError](PayPalCommerceInlineButtonInitializeOptions.md#onerror)
|
|
21
|
-
|
|
22
|
-
## Properties
|
|
23
|
-
|
|
24
|
-
### buttonContainerClassName
|
|
25
|
-
|
|
26
|
-
• `Optional` **buttonContainerClassName**: `string`
|
|
27
|
-
|
|
28
|
-
A class name used to add special class for container where the button will be generated in
|
|
29
|
-
Default: 'PaypalCommerceInlineButton'
|
|
30
|
-
|
|
31
|
-
___
|
|
32
|
-
|
|
33
|
-
### style
|
|
34
|
-
|
|
35
|
-
• `Optional` **style**: `Pick`<[`PayPalButtonStyleOptions`](PayPalButtonStyleOptions.md), ``"custom"``\>
|
|
36
|
-
|
|
37
|
-
A set of styling options for the checkout button.
|
|
38
|
-
|
|
39
|
-
## Methods
|
|
40
|
-
|
|
41
|
-
### onComplete
|
|
42
|
-
|
|
43
|
-
▸ **onComplete**(): `void`
|
|
44
|
-
|
|
45
|
-
A callback that gets called when payment complete on paypal side.
|
|
46
|
-
|
|
47
|
-
#### Returns
|
|
48
|
-
|
|
49
|
-
`void`
|
|
50
|
-
|
|
51
|
-
___
|
|
52
|
-
|
|
53
|
-
### onError
|
|
54
|
-
|
|
55
|
-
▸ `Optional` **onError**(): `void`
|
|
56
|
-
|
|
57
|
-
A callback that gets called on any error
|
|
58
|
-
|
|
59
|
-
#### Returns
|
|
60
|
-
|
|
61
|
-
`void`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceInlineButtonInitializeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: WithPayPalCommerceInlineButtonInitializeOptions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [paypalcommerceinline](WithPayPalCommerceInlineButtonInitializeOptions.md#paypalcommerceinline)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### paypalcommerceinline
|
|
14
|
-
|
|
15
|
-
• `Optional` **paypalcommerceinline**: [`PayPalCommerceInlineButtonInitializeOptions`](PayPalCommerceInlineButtonInitializeOptions.md)
|