@bigcommerce/checkout-sdk 1.370.0 → 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 +7 -0
- package/dist/checkout-button.d.ts +1 -1
- 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 +1 -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/interfaces/AmazonPayV2ButtonConfig.md +2 -0
- package/docs/interfaces/WithBuyNowFeature.md +98 -0
- package/package.json +1 -1
|
@@ -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)
|