@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.
- package/CHANGELOG.md +21 -0
- package/dist/checkout-button.d.ts +168 -101
- 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 +525 -447
- 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/dist/hosted-form.js.map +1 -1
- package/dist/hosted-form.umd.js.map +1 -1
- package/docs/README.md +40 -4
- package/docs/classes/CheckoutButtonInitializer.md +1 -1
- package/docs/classes/CheckoutService.md +2 -2
- package/docs/enums/AmazonPayV2ButtonColor.md +29 -0
- package/docs/interfaces/AmazonPayV2ButtonConfig.md +80 -0
- package/docs/interfaces/AmazonPayV2ButtonParams.md +45 -1
- package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md +36 -0
- package/docs/interfaces/AmazonPayV2NewButtonParams.md +125 -0
- package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +38 -0
- package/docs/interfaces/{CheckoutButtonInitializeOptions.md → BaseCheckoutButtonInitializeOptions.md} +26 -26
- package/docs/interfaces/{CustomerInitializeOptions.md → BaseCustomerInitializeOptions.md} +25 -31
- package/docs/interfaces/{PaymentInitializeOptions.md → BasePaymentInitializeOptions.md} +39 -49
- package/docs/interfaces/CheckoutButtonOptions.md +1 -1
- package/docs/interfaces/CustomerRequestOptions.md +1 -1
- package/docs/interfaces/PaymentRequestOptions.md +1 -1
- package/docs/interfaces/WithApplePayButtonInitializeOptions.md +15 -0
- package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +18 -0
- package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +18 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
- [AdyenV2CardFields](enums/AdyenV2CardFields.md)
|
|
10
10
|
- [AdyenV3CardFields](enums/AdyenV3CardFields.md)
|
|
11
|
+
- [AmazonPayV2ButtonColor](enums/AmazonPayV2ButtonColor.md)
|
|
11
12
|
- [AmazonPayV2CheckoutLanguage](enums/AmazonPayV2CheckoutLanguage.md)
|
|
12
13
|
- [AmazonPayV2LedgerCurrency](enums/AmazonPayV2LedgerCurrency.md)
|
|
13
14
|
- [AmazonPayV2PayOptions](enums/AmazonPayV2PayOptions.md)
|
|
@@ -76,22 +77,29 @@
|
|
|
76
77
|
- [AmazonPayOrderReference](interfaces/AmazonPayOrderReference.md)
|
|
77
78
|
- [AmazonPayPaymentInitializeOptions](interfaces/AmazonPayPaymentInitializeOptions.md)
|
|
78
79
|
- [AmazonPayShippingInitializeOptions](interfaces/AmazonPayShippingInitializeOptions.md)
|
|
80
|
+
- [AmazonPayV2ButtonConfig](interfaces/AmazonPayV2ButtonConfig.md)
|
|
79
81
|
- [AmazonPayV2ButtonParams](interfaces/AmazonPayV2ButtonParams.md)
|
|
80
82
|
- [AmazonPayV2CheckoutSession](interfaces/AmazonPayV2CheckoutSession.md)
|
|
83
|
+
- [AmazonPayV2CheckoutSessionConfig](interfaces/AmazonPayV2CheckoutSessionConfig.md)
|
|
81
84
|
- [AmazonPayV2CustomerInitializeOptions](interfaces/AmazonPayV2CustomerInitializeOptions.md)
|
|
85
|
+
- [AmazonPayV2NewButtonParams](interfaces/AmazonPayV2NewButtonParams.md)
|
|
82
86
|
- [AmazonPayV2PaymentInitializeOptions](interfaces/AmazonPayV2PaymentInitializeOptions.md)
|
|
83
87
|
- [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
|
|
84
88
|
- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
|
|
85
89
|
- [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
|
|
90
|
+
- [ApplePayButtonInitializeOptions_2](interfaces/ApplePayButtonInitializeOptions_2.md)
|
|
86
91
|
- [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)
|
|
87
92
|
- [ApplePayPaymentInitializeOptions](interfaces/ApplePayPaymentInitializeOptions.md)
|
|
88
93
|
- [BankInstrument](interfaces/BankInstrument.md)
|
|
89
94
|
- [Banner](interfaces/Banner.md)
|
|
90
95
|
- [BaseAccountInstrument](interfaces/BaseAccountInstrument.md)
|
|
96
|
+
- [BaseCheckoutButtonInitializeOptions](interfaces/BaseCheckoutButtonInitializeOptions.md)
|
|
97
|
+
- [BaseCustomerInitializeOptions](interfaces/BaseCustomerInitializeOptions.md)
|
|
91
98
|
- [BaseElementOptions](interfaces/BaseElementOptions.md)
|
|
92
99
|
- [BaseElementOptions_2](interfaces/BaseElementOptions_2.md)
|
|
93
100
|
- [BaseIndividualElementOptions](interfaces/BaseIndividualElementOptions.md)
|
|
94
101
|
- [BaseInstrument](interfaces/BaseInstrument.md)
|
|
102
|
+
- [BasePaymentInitializeOptions](interfaces/BasePaymentInitializeOptions.md)
|
|
95
103
|
- [BillingAddress](interfaces/BillingAddress.md)
|
|
96
104
|
- [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
|
|
97
105
|
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
@@ -141,7 +149,6 @@
|
|
|
141
149
|
- [CheckableInputStyles](interfaces/CheckableInputStyles.md)
|
|
142
150
|
- [ChecklistStyles](interfaces/ChecklistStyles.md)
|
|
143
151
|
- [Checkout](interfaces/Checkout.md)
|
|
144
|
-
- [CheckoutButtonInitializeOptions](interfaces/CheckoutButtonInitializeOptions.md)
|
|
145
152
|
- [CheckoutButtonInitializerOptions](interfaces/CheckoutButtonInitializerOptions.md)
|
|
146
153
|
- [CheckoutButtonOptions](interfaces/CheckoutButtonOptions.md)
|
|
147
154
|
- [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
|
|
@@ -178,7 +185,6 @@
|
|
|
178
185
|
- [CustomerAddress](interfaces/CustomerAddress.md)
|
|
179
186
|
- [CustomerCredentials](interfaces/CustomerCredentials.md)
|
|
180
187
|
- [CustomerGroup](interfaces/CustomerGroup.md)
|
|
181
|
-
- [CustomerInitializeOptions](interfaces/CustomerInitializeOptions.md)
|
|
182
188
|
- [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
|
|
183
189
|
- [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
|
|
184
190
|
- [DigitalItem](interfaces/DigitalItem.md)
|
|
@@ -268,7 +274,6 @@
|
|
|
268
274
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
269
275
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
270
276
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
271
|
-
- [PaymentInitializeOptions](interfaces/PaymentInitializeOptions.md)
|
|
272
277
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
273
278
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
274
279
|
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
@@ -345,6 +350,9 @@
|
|
|
345
350
|
- [WechatState](interfaces/WechatState.md)
|
|
346
351
|
- [WechatState_2](interfaces/WechatState_2.md)
|
|
347
352
|
- [WithAccountCreation](interfaces/WithAccountCreation.md)
|
|
353
|
+
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
354
|
+
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
355
|
+
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
348
356
|
- [WithCheckoutcomFawryInstrument](interfaces/WithCheckoutcomFawryInstrument.md)
|
|
349
357
|
- [WithCheckoutcomSEPAInstrument](interfaces/WithCheckoutcomSEPAInstrument.md)
|
|
350
358
|
- [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
|
|
@@ -360,16 +368,19 @@
|
|
|
360
368
|
- [AdyenComponentState](README.md#adyencomponentstate)
|
|
361
369
|
- [AdyenV3ComponentState](README.md#adyenv3componentstate)
|
|
362
370
|
- [AmazonPayV2ButtonInitializeOptions](README.md#amazonpayv2buttoninitializeoptions)
|
|
371
|
+
- [AmazonPayV2ButtonParameters](README.md#amazonpayv2buttonparameters)
|
|
363
372
|
- [AnalyticStepType](README.md#analyticsteptype)
|
|
364
373
|
- [BraintreeFormFieldBlurEventData](README.md#braintreeformfieldblureventdata)
|
|
365
374
|
- [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
|
|
366
375
|
- [BraintreeFormFieldFocusEventData](README.md#braintreeformfieldfocuseventdata)
|
|
367
376
|
- [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
|
|
377
|
+
- [CheckoutButtonInitializeOptions](README.md#checkoutbuttoninitializeoptions)
|
|
368
378
|
- [CheckoutIncludeParam](README.md#checkoutincludeparam)
|
|
369
379
|
- [ComparableCheckout](README.md#comparablecheckout)
|
|
370
380
|
- [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
|
|
371
381
|
- [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
|
|
372
382
|
- [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
|
|
383
|
+
- [CustomerInitializeOptions](README.md#customerinitializeoptions)
|
|
373
384
|
- [FlashMessageType](README.md#flashmessagetype)
|
|
374
385
|
- [FormFieldFieldType](README.md#formfieldfieldtype)
|
|
375
386
|
- [FormFieldType](README.md#formfieldtype)
|
|
@@ -388,6 +399,7 @@
|
|
|
388
399
|
- [Omit](README.md#omit)
|
|
389
400
|
- [OrderPaymentInstrument](README.md#orderpaymentinstrument)
|
|
390
401
|
- [OrderPayments](README.md#orderpayments)
|
|
402
|
+
- [PaymentInitializeOptions](README.md#paymentinitializeoptions)
|
|
391
403
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
392
404
|
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
393
405
|
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
@@ -434,12 +446,18 @@ ___
|
|
|
434
446
|
|
|
435
447
|
### AmazonPayV2ButtonInitializeOptions
|
|
436
448
|
|
|
437
|
-
Ƭ **AmazonPayV2ButtonInitializeOptions**: [`
|
|
449
|
+
Ƭ **AmazonPayV2ButtonInitializeOptions**: [`AmazonPayV2ButtonParameters`](README.md#amazonpayv2buttonparameters)
|
|
438
450
|
|
|
439
451
|
The required config to render the AmazonPayV2 buttton.
|
|
440
452
|
|
|
441
453
|
___
|
|
442
454
|
|
|
455
|
+
### AmazonPayV2ButtonParameters
|
|
456
|
+
|
|
457
|
+
Ƭ **AmazonPayV2ButtonParameters**: [`AmazonPayV2ButtonParams`](interfaces/AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](interfaces/AmazonPayV2NewButtonParams.md)
|
|
458
|
+
|
|
459
|
+
___
|
|
460
|
+
|
|
443
461
|
### AnalyticStepType
|
|
444
462
|
|
|
445
463
|
Ƭ **AnalyticStepType**: ``"customer"`` \| ``"shipping"`` \| ``"billing"`` \| ``"payment"``
|
|
@@ -470,6 +488,12 @@ ___
|
|
|
470
488
|
|
|
471
489
|
___
|
|
472
490
|
|
|
491
|
+
### CheckoutButtonInitializeOptions
|
|
492
|
+
|
|
493
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
494
|
+
|
|
495
|
+
___
|
|
496
|
+
|
|
473
497
|
### CheckoutIncludeParam
|
|
474
498
|
|
|
475
499
|
Ƭ **CheckoutIncludeParam**: { [key in CheckoutIncludes]?: boolean }
|
|
@@ -500,6 +524,12 @@ ___
|
|
|
500
524
|
|
|
501
525
|
___
|
|
502
526
|
|
|
527
|
+
### CustomerInitializeOptions
|
|
528
|
+
|
|
529
|
+
Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
530
|
+
|
|
531
|
+
___
|
|
532
|
+
|
|
503
533
|
### FlashMessageType
|
|
504
534
|
|
|
505
535
|
Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``
|
|
@@ -615,6 +645,12 @@ ___
|
|
|
615
645
|
|
|
616
646
|
___
|
|
617
647
|
|
|
648
|
+
### PaymentInitializeOptions
|
|
649
|
+
|
|
650
|
+
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
651
|
+
|
|
652
|
+
___
|
|
653
|
+
|
|
618
654
|
### PaymentInstrument
|
|
619
655
|
|
|
620
656
|
Ƭ **PaymentInstrument**: [`CardInstrument`](interfaces/CardInstrument.md) \| [`AccountInstrument`](README.md#accountinstrument)
|
|
@@ -95,7 +95,7 @@ initializer.initializeButton({
|
|
|
95
95
|
|
|
96
96
|
| Name | Type | Description |
|
|
97
97
|
| :------ | :------ | :------ |
|
|
98
|
-
| `options` | [`CheckoutButtonInitializeOptions`](../
|
|
98
|
+
| `options` | [`CheckoutButtonInitializeOptions`](../README.md#checkoutbuttoninitializeoptions) | Options for initializing the checkout button. |
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -661,7 +661,7 @@ await service.initializeCustomer({
|
|
|
661
661
|
|
|
662
662
|
| Name | Type | Description |
|
|
663
663
|
| :------ | :------ | :------ |
|
|
664
|
-
| `options?` | [`CustomerInitializeOptions`](../
|
|
664
|
+
| `options?` | [`CustomerInitializeOptions`](../README.md#customerinitializeoptions) | Options for initializing the customer step of checkout. |
|
|
665
665
|
|
|
666
666
|
#### Returns
|
|
667
667
|
|
|
@@ -695,7 +695,7 @@ await service.initializePayment({
|
|
|
695
695
|
|
|
696
696
|
| Name | Type | Description |
|
|
697
697
|
| :------ | :------ | :------ |
|
|
698
|
-
| `options` | [`PaymentInitializeOptions`](../
|
|
698
|
+
| `options` | [`PaymentInitializeOptions`](../README.md#paymentinitializeoptions) | Options for initializing the payment step of checkout. |
|
|
699
699
|
|
|
700
700
|
#### Returns
|
|
701
701
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonColor
|
|
2
|
+
|
|
3
|
+
# Enumeration: AmazonPayV2ButtonColor
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration members
|
|
8
|
+
|
|
9
|
+
- [DarkGray](AmazonPayV2ButtonColor.md#darkgray)
|
|
10
|
+
- [Gold](AmazonPayV2ButtonColor.md#gold)
|
|
11
|
+
- [LightGray](AmazonPayV2ButtonColor.md#lightgray)
|
|
12
|
+
|
|
13
|
+
## Enumeration members
|
|
14
|
+
|
|
15
|
+
### DarkGray
|
|
16
|
+
|
|
17
|
+
• **DarkGray** = `"DarkGray"`
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### Gold
|
|
22
|
+
|
|
23
|
+
• **Gold** = `"Gold"`
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### LightGray
|
|
28
|
+
|
|
29
|
+
• **LightGray** = `"LightGray"`
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonConfig
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2ButtonConfig
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- **`AmazonPayV2ButtonConfig`**
|
|
8
|
+
|
|
9
|
+
↳ [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
|
|
10
|
+
|
|
11
|
+
↳ [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
|
|
12
|
+
|
|
13
|
+
## Table of contents
|
|
14
|
+
|
|
15
|
+
### Properties
|
|
16
|
+
|
|
17
|
+
- [buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
18
|
+
- [checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
19
|
+
- [ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
20
|
+
- [merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
21
|
+
- [placement](AmazonPayV2ButtonConfig.md#placement)
|
|
22
|
+
- [productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
23
|
+
- [sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
### buttonColor
|
|
28
|
+
|
|
29
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
30
|
+
|
|
31
|
+
Color of the Amazon Pay button.
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### checkoutLanguage
|
|
36
|
+
|
|
37
|
+
• `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)
|
|
38
|
+
|
|
39
|
+
Language used to render the button and text on Amazon Pay hosted pages.
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### ledgerCurrency
|
|
44
|
+
|
|
45
|
+
• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
|
|
46
|
+
|
|
47
|
+
Ledger currency provided during registration for the given merchant identifier.
|
|
48
|
+
|
|
49
|
+
___
|
|
50
|
+
|
|
51
|
+
### merchantId
|
|
52
|
+
|
|
53
|
+
• **merchantId**: `string`
|
|
54
|
+
|
|
55
|
+
Amazon Pay merchant account identifier.
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### placement
|
|
60
|
+
|
|
61
|
+
• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
|
|
62
|
+
|
|
63
|
+
Placement of the Amazon Pay button on your website.
|
|
64
|
+
|
|
65
|
+
___
|
|
66
|
+
|
|
67
|
+
### productType
|
|
68
|
+
|
|
69
|
+
• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
|
|
70
|
+
|
|
71
|
+
Product type selected for checkout. Default is 'PayAndShip'.
|
|
72
|
+
|
|
73
|
+
___
|
|
74
|
+
|
|
75
|
+
### sandbox
|
|
76
|
+
|
|
77
|
+
• `Optional` **sandbox**: `boolean`
|
|
78
|
+
|
|
79
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
80
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
@@ -2,10 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: AmazonPayV2ButtonParams
|
|
4
4
|
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
|
|
8
|
+
|
|
9
|
+
↳ **`AmazonPayV2ButtonParams`**
|
|
10
|
+
|
|
5
11
|
## Table of contents
|
|
6
12
|
|
|
7
13
|
### Properties
|
|
8
14
|
|
|
15
|
+
- [buttonColor](AmazonPayV2ButtonParams.md#buttoncolor)
|
|
9
16
|
- [checkoutLanguage](AmazonPayV2ButtonParams.md#checkoutlanguage)
|
|
10
17
|
- [createCheckoutSession](AmazonPayV2ButtonParams.md#createcheckoutsession)
|
|
11
18
|
- [ledgerCurrency](AmazonPayV2ButtonParams.md#ledgercurrency)
|
|
@@ -16,12 +23,28 @@
|
|
|
16
23
|
|
|
17
24
|
## Properties
|
|
18
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
|
+
|
|
19
38
|
### checkoutLanguage
|
|
20
39
|
|
|
21
40
|
• `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)
|
|
22
41
|
|
|
23
42
|
Language used to render the button and text on Amazon Pay hosted pages.
|
|
24
43
|
|
|
44
|
+
#### Inherited from
|
|
45
|
+
|
|
46
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
47
|
+
|
|
25
48
|
___
|
|
26
49
|
|
|
27
50
|
### createCheckoutSession
|
|
@@ -38,6 +61,10 @@ ___
|
|
|
38
61
|
|
|
39
62
|
Ledger currency provided during registration for the given merchant identifier.
|
|
40
63
|
|
|
64
|
+
#### Inherited from
|
|
65
|
+
|
|
66
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
67
|
+
|
|
41
68
|
___
|
|
42
69
|
|
|
43
70
|
### merchantId
|
|
@@ -46,6 +73,10 @@ ___
|
|
|
46
73
|
|
|
47
74
|
Amazon Pay merchant account identifier.
|
|
48
75
|
|
|
76
|
+
#### Inherited from
|
|
77
|
+
|
|
78
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
79
|
+
|
|
49
80
|
___
|
|
50
81
|
|
|
51
82
|
### placement
|
|
@@ -54,6 +85,10 @@ ___
|
|
|
54
85
|
|
|
55
86
|
Placement of the Amazon Pay button on your website.
|
|
56
87
|
|
|
88
|
+
#### Inherited from
|
|
89
|
+
|
|
90
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
|
|
91
|
+
|
|
57
92
|
___
|
|
58
93
|
|
|
59
94
|
### productType
|
|
@@ -62,10 +97,19 @@ ___
|
|
|
62
97
|
|
|
63
98
|
Product type selected for checkout. Default is 'PayAndShip'.
|
|
64
99
|
|
|
100
|
+
#### Inherited from
|
|
101
|
+
|
|
102
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
103
|
+
|
|
65
104
|
___
|
|
66
105
|
|
|
67
106
|
### sandbox
|
|
68
107
|
|
|
69
108
|
• `Optional` **sandbox**: `boolean`
|
|
70
109
|
|
|
71
|
-
Sets button to Sandbox environment.
|
|
110
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
111
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
112
|
+
|
|
113
|
+
#### Inherited from
|
|
114
|
+
|
|
115
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSessionConfig
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2CheckoutSessionConfig
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [payloadJSON](AmazonPayV2CheckoutSessionConfig.md#payloadjson)
|
|
10
|
+
- [publicKeyId](AmazonPayV2CheckoutSessionConfig.md#publickeyid)
|
|
11
|
+
- [signature](AmazonPayV2CheckoutSessionConfig.md#signature)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### payloadJSON
|
|
16
|
+
|
|
17
|
+
• **payloadJSON**: `string`
|
|
18
|
+
|
|
19
|
+
A payload that Amazon Pay will use to create a Checkout Session object.
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### publicKeyId
|
|
24
|
+
|
|
25
|
+
• `Optional` **publicKeyId**: `string`
|
|
26
|
+
|
|
27
|
+
Credential provided by Amazon Pay. You do not have to set this parameter
|
|
28
|
+
if your `publicKeyId` has an environment prefix.
|
|
29
|
+
|
|
30
|
+
___
|
|
31
|
+
|
|
32
|
+
### signature
|
|
33
|
+
|
|
34
|
+
• **signature**: `string`
|
|
35
|
+
|
|
36
|
+
Payload's signature.
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2NewButtonParams
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2NewButtonParams
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
|
|
8
|
+
|
|
9
|
+
↳ **`AmazonPayV2NewButtonParams`**
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
- [buttonColor](AmazonPayV2NewButtonParams.md#buttoncolor)
|
|
16
|
+
- [checkoutLanguage](AmazonPayV2NewButtonParams.md#checkoutlanguage)
|
|
17
|
+
- [createCheckoutSessionConfig](AmazonPayV2NewButtonParams.md#createcheckoutsessionconfig)
|
|
18
|
+
- [ledgerCurrency](AmazonPayV2NewButtonParams.md#ledgercurrency)
|
|
19
|
+
- [merchantId](AmazonPayV2NewButtonParams.md#merchantid)
|
|
20
|
+
- [placement](AmazonPayV2NewButtonParams.md#placement)
|
|
21
|
+
- [productType](AmazonPayV2NewButtonParams.md#producttype)
|
|
22
|
+
- [publicKeyId](AmazonPayV2NewButtonParams.md#publickeyid)
|
|
23
|
+
- [sandbox](AmazonPayV2NewButtonParams.md#sandbox)
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
### buttonColor
|
|
28
|
+
|
|
29
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
30
|
+
|
|
31
|
+
Color of the Amazon Pay button.
|
|
32
|
+
|
|
33
|
+
#### Inherited from
|
|
34
|
+
|
|
35
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
36
|
+
|
|
37
|
+
___
|
|
38
|
+
|
|
39
|
+
### checkoutLanguage
|
|
40
|
+
|
|
41
|
+
• `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)
|
|
42
|
+
|
|
43
|
+
Language used to render the button and text on Amazon Pay hosted pages.
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
48
|
+
|
|
49
|
+
___
|
|
50
|
+
|
|
51
|
+
### createCheckoutSessionConfig
|
|
52
|
+
|
|
53
|
+
• **createCheckoutSessionConfig**: [`AmazonPayV2CheckoutSessionConfig`](AmazonPayV2CheckoutSessionConfig.md)
|
|
54
|
+
|
|
55
|
+
Create Checkout Session configuration.
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### ledgerCurrency
|
|
60
|
+
|
|
61
|
+
• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
|
|
62
|
+
|
|
63
|
+
Ledger currency provided during registration for the given merchant identifier.
|
|
64
|
+
|
|
65
|
+
#### Inherited from
|
|
66
|
+
|
|
67
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
68
|
+
|
|
69
|
+
___
|
|
70
|
+
|
|
71
|
+
### merchantId
|
|
72
|
+
|
|
73
|
+
• **merchantId**: `string`
|
|
74
|
+
|
|
75
|
+
Amazon Pay merchant account identifier.
|
|
76
|
+
|
|
77
|
+
#### Inherited from
|
|
78
|
+
|
|
79
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
80
|
+
|
|
81
|
+
___
|
|
82
|
+
|
|
83
|
+
### placement
|
|
84
|
+
|
|
85
|
+
• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
|
|
86
|
+
|
|
87
|
+
Placement of the Amazon Pay button on your website.
|
|
88
|
+
|
|
89
|
+
#### Inherited from
|
|
90
|
+
|
|
91
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
|
|
92
|
+
|
|
93
|
+
___
|
|
94
|
+
|
|
95
|
+
### productType
|
|
96
|
+
|
|
97
|
+
• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
|
|
98
|
+
|
|
99
|
+
Product type selected for checkout. Default is 'PayAndShip'.
|
|
100
|
+
|
|
101
|
+
#### Inherited from
|
|
102
|
+
|
|
103
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
104
|
+
|
|
105
|
+
___
|
|
106
|
+
|
|
107
|
+
### publicKeyId
|
|
108
|
+
|
|
109
|
+
• `Optional` **publicKeyId**: `string`
|
|
110
|
+
|
|
111
|
+
Credential provided by Amazon Pay. You must also set the `sandbox`
|
|
112
|
+
parameter if your `publicKeyId` does not have an environment prefix.
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### sandbox
|
|
117
|
+
|
|
118
|
+
• `Optional` **sandbox**: `boolean`
|
|
119
|
+
|
|
120
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
121
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
122
|
+
|
|
123
|
+
#### Inherited from
|
|
124
|
+
|
|
125
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / ApplePayButtonInitializeOptions_2
|
|
2
|
+
|
|
3
|
+
# Interface: ApplePayButtonInitializeOptions\_2
|
|
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
|
+
- [buttonClassName](ApplePayButtonInitializeOptions_2.md#buttonclassname)
|
|
15
|
+
|
|
16
|
+
### Methods
|
|
17
|
+
|
|
18
|
+
- [onPaymentAuthorize](ApplePayButtonInitializeOptions_2.md#onpaymentauthorize)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### buttonClassName
|
|
23
|
+
|
|
24
|
+
• `Optional` **buttonClassName**: `string`
|
|
25
|
+
|
|
26
|
+
The class name of the ApplePay button style.
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
### onPaymentAuthorize
|
|
31
|
+
|
|
32
|
+
▸ **onPaymentAuthorize**(): `void`
|
|
33
|
+
|
|
34
|
+
A callback that gets called when a payment is successfully completed.
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`void`
|
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BaseCheckoutButtonInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface:
|
|
3
|
+
# Interface: BaseCheckoutButtonInitializeOptions
|
|
4
4
|
|
|
5
5
|
## Hierarchy
|
|
6
6
|
|
|
7
7
|
- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
|
|
8
8
|
|
|
9
|
-
↳ **`
|
|
9
|
+
↳ **`BaseCheckoutButtonInitializeOptions`**
|
|
10
10
|
|
|
11
11
|
## Table of contents
|
|
12
12
|
|
|
13
13
|
### Properties
|
|
14
14
|
|
|
15
|
-
- [amazonpay](
|
|
16
|
-
- [applepay](
|
|
17
|
-
- [braintreepaypal](
|
|
18
|
-
- [braintreepaypalcredit](
|
|
19
|
-
- [braintreevenmo](
|
|
20
|
-
- [containerId](
|
|
21
|
-
- [googlepayadyenv2](
|
|
22
|
-
- [googlepayadyenv3](
|
|
23
|
-
- [googlepayauthorizenet](
|
|
24
|
-
- [googlepaybraintree](
|
|
25
|
-
- [googlepaycheckoutcom](
|
|
26
|
-
- [googlepaycybersourcev2](
|
|
27
|
-
- [googlepayorbital](
|
|
28
|
-
- [googlepaystripe](
|
|
29
|
-
- [googlepaystripeupe](
|
|
30
|
-
- [methodId](
|
|
31
|
-
- [params](
|
|
32
|
-
- [paypal](
|
|
33
|
-
- [paypalCommerce](
|
|
34
|
-
- [paypalcommercealternativemethods](
|
|
35
|
-
- [paypalcommercevenmo](
|
|
36
|
-
- [timeout](
|
|
15
|
+
- [amazonpay](BaseCheckoutButtonInitializeOptions.md#amazonpay)
|
|
16
|
+
- [applepay](BaseCheckoutButtonInitializeOptions.md#applepay)
|
|
17
|
+
- [braintreepaypal](BaseCheckoutButtonInitializeOptions.md#braintreepaypal)
|
|
18
|
+
- [braintreepaypalcredit](BaseCheckoutButtonInitializeOptions.md#braintreepaypalcredit)
|
|
19
|
+
- [braintreevenmo](BaseCheckoutButtonInitializeOptions.md#braintreevenmo)
|
|
20
|
+
- [containerId](BaseCheckoutButtonInitializeOptions.md#containerid)
|
|
21
|
+
- [googlepayadyenv2](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv2)
|
|
22
|
+
- [googlepayadyenv3](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv3)
|
|
23
|
+
- [googlepayauthorizenet](BaseCheckoutButtonInitializeOptions.md#googlepayauthorizenet)
|
|
24
|
+
- [googlepaybraintree](BaseCheckoutButtonInitializeOptions.md#googlepaybraintree)
|
|
25
|
+
- [googlepaycheckoutcom](BaseCheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
|
|
26
|
+
- [googlepaycybersourcev2](BaseCheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
|
|
27
|
+
- [googlepayorbital](BaseCheckoutButtonInitializeOptions.md#googlepayorbital)
|
|
28
|
+
- [googlepaystripe](BaseCheckoutButtonInitializeOptions.md#googlepaystripe)
|
|
29
|
+
- [googlepaystripeupe](BaseCheckoutButtonInitializeOptions.md#googlepaystripeupe)
|
|
30
|
+
- [methodId](BaseCheckoutButtonInitializeOptions.md#methodid)
|
|
31
|
+
- [params](BaseCheckoutButtonInitializeOptions.md#params)
|
|
32
|
+
- [paypal](BaseCheckoutButtonInitializeOptions.md#paypal)
|
|
33
|
+
- [paypalCommerce](BaseCheckoutButtonInitializeOptions.md#paypalcommerce)
|
|
34
|
+
- [paypalcommercealternativemethods](BaseCheckoutButtonInitializeOptions.md#paypalcommercealternativemethods)
|
|
35
|
+
- [paypalcommercevenmo](BaseCheckoutButtonInitializeOptions.md#paypalcommercevenmo)
|
|
36
|
+
- [timeout](BaseCheckoutButtonInitializeOptions.md#timeout)
|
|
37
37
|
|
|
38
38
|
## Properties
|
|
39
39
|
|
|
40
40
|
### amazonpay
|
|
41
41
|
|
|
42
|
-
• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
|
|
42
|
+
• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
|
|
43
43
|
|
|
44
44
|
The options that are required to facilitate AmazonPayV2. They can be
|
|
45
45
|
omitted unless you need to support AmazonPayV2.
|