@bigcommerce/checkout-sdk 1.271.1 → 1.272.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 +21 -0
- package/dist/checkout-button.d.ts +3 -62
- 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 +17 -180
- 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 +3 -58
- package/docs/classes/CheckoutButtonInitializer.md +2 -2
- package/docs/classes/CheckoutService.md +6 -6
- package/docs/interfaces/{CheckoutButtonInitializeOptions_4.md → CheckoutButtonInitializeOptions.md} +30 -30
- package/docs/interfaces/CheckoutButtonOptions.md +5 -5
- package/docs/interfaces/{CustomerInitializeOptions_4.md → CustomerInitializeOptions.md} +27 -27
- package/docs/interfaces/CustomerRequestOptions.md +39 -2
- package/docs/interfaces/ExecutePaymentMethodCheckoutOptions.md +4 -4
- package/docs/interfaces/{PaymentInitializeOptions_4.md → PaymentInitializeOptions.md} +46 -46
- package/docs/interfaces/PaymentRequestOptions.md +4 -4
- package/docs/interfaces/RequestOptions.md +3 -3
- package/docs/interfaces/SpamProtectionOptions.md +1 -1
- package/package.json +1 -1
- package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +0 -38
- package/docs/interfaces/ApplePayCustomerInitializeOptions_2.md +0 -77
- package/docs/interfaces/ApplePayPaymentInitializeOptions_2.md +0 -40
- package/docs/interfaces/CheckoutButtonInitializeOptions_3.md +0 -68
- package/docs/interfaces/CheckoutButtonOptions_2.md +0 -55
- package/docs/interfaces/CustomerInitializeOptions_3.md +0 -29
- package/docs/interfaces/CustomerRequestOptions_2.md +0 -60
- package/docs/interfaces/PaymentInitializeOptions_3.md +0 -74
- package/docs/interfaces/PaymentRequestOptions_2.md +0 -67
- package/docs/interfaces/RequestOptions_2.md +0 -44
- package/docs/interfaces/WithApplePayButtonInitializeOptions.md +0 -15
- package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +0 -15
- package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +0 -15
package/docs/README.md
CHANGED
|
@@ -79,11 +79,8 @@
|
|
|
79
79
|
- [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
|
|
80
80
|
- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
|
|
81
81
|
- [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
|
|
82
|
-
- [ApplePayButtonInitializeOptions_2](interfaces/ApplePayButtonInitializeOptions_2.md)
|
|
83
82
|
- [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)
|
|
84
|
-
- [ApplePayCustomerInitializeOptions_2](interfaces/ApplePayCustomerInitializeOptions_2.md)
|
|
85
83
|
- [ApplePayPaymentInitializeOptions](interfaces/ApplePayPaymentInitializeOptions.md)
|
|
86
|
-
- [ApplePayPaymentInitializeOptions_2](interfaces/ApplePayPaymentInitializeOptions_2.md)
|
|
87
84
|
- [BankInstrument](interfaces/BankInstrument.md)
|
|
88
85
|
- [Banner](interfaces/Banner.md)
|
|
89
86
|
- [BaseAccountInstrument](interfaces/BaseAccountInstrument.md)
|
|
@@ -140,11 +137,9 @@
|
|
|
140
137
|
- [CheckableInputStyles](interfaces/CheckableInputStyles.md)
|
|
141
138
|
- [ChecklistStyles](interfaces/ChecklistStyles.md)
|
|
142
139
|
- [Checkout](interfaces/Checkout.md)
|
|
143
|
-
- [
|
|
144
|
-
- [CheckoutButtonInitializeOptions_4](interfaces/CheckoutButtonInitializeOptions_4.md)
|
|
140
|
+
- [CheckoutButtonInitializeOptions](interfaces/CheckoutButtonInitializeOptions.md)
|
|
145
141
|
- [CheckoutButtonInitializerOptions](interfaces/CheckoutButtonInitializerOptions.md)
|
|
146
142
|
- [CheckoutButtonOptions](interfaces/CheckoutButtonOptions.md)
|
|
147
|
-
- [CheckoutButtonOptions_2](interfaces/CheckoutButtonOptions_2.md)
|
|
148
143
|
- [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
|
|
149
144
|
- [CheckoutParams](interfaces/CheckoutParams.md)
|
|
150
145
|
- [CheckoutPayment](interfaces/CheckoutPayment.md)
|
|
@@ -179,11 +174,9 @@
|
|
|
179
174
|
- [CustomerAddress](interfaces/CustomerAddress.md)
|
|
180
175
|
- [CustomerCredentials](interfaces/CustomerCredentials.md)
|
|
181
176
|
- [CustomerGroup](interfaces/CustomerGroup.md)
|
|
182
|
-
- [
|
|
183
|
-
- [CustomerInitializeOptions_4](interfaces/CustomerInitializeOptions_4.md)
|
|
177
|
+
- [CustomerInitializeOptions](interfaces/CustomerInitializeOptions.md)
|
|
184
178
|
- [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
|
|
185
179
|
- [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
|
|
186
|
-
- [CustomerRequestOptions_2](interfaces/CustomerRequestOptions_2.md)
|
|
187
180
|
- [DigitalItem](interfaces/DigitalItem.md)
|
|
188
181
|
- [DigitalRiverElementClasses](interfaces/DigitalRiverElementClasses.md)
|
|
189
182
|
- [DigitalRiverPaymentInitializeOptions](interfaces/DigitalRiverPaymentInitializeOptions.md)
|
|
@@ -271,12 +264,10 @@
|
|
|
271
264
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
272
265
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
273
266
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
274
|
-
- [
|
|
275
|
-
- [PaymentInitializeOptions_4](interfaces/PaymentInitializeOptions_4.md)
|
|
267
|
+
- [PaymentInitializeOptions](interfaces/PaymentInitializeOptions.md)
|
|
276
268
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
277
269
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
278
270
|
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
279
|
-
- [PaymentRequestOptions_2](interfaces/PaymentRequestOptions_2.md)
|
|
280
271
|
- [PaymentSettings](interfaces/PaymentSettings.md)
|
|
281
272
|
- [PaypalButtonInitializeOptions](interfaces/PaypalButtonInitializeOptions.md)
|
|
282
273
|
- [PaypalButtonStyleOptions](interfaces/PaypalButtonStyleOptions.md)
|
|
@@ -306,7 +297,6 @@
|
|
|
306
297
|
- [Radius](interfaces/Radius.md)
|
|
307
298
|
- [Region](interfaces/Region.md)
|
|
308
299
|
- [RequestOptions](interfaces/RequestOptions.md)
|
|
309
|
-
- [RequestOptions_2](interfaces/RequestOptions_2.md)
|
|
310
300
|
- [SearchArea](interfaces/SearchArea.md)
|
|
311
301
|
- [SepaPlaceHolder](interfaces/SepaPlaceHolder.md)
|
|
312
302
|
- [SepaPlaceHolder_2](interfaces/SepaPlaceHolder_2.md)
|
|
@@ -351,9 +341,6 @@
|
|
|
351
341
|
- [WechatState](interfaces/WechatState.md)
|
|
352
342
|
- [WechatState_2](interfaces/WechatState_2.md)
|
|
353
343
|
- [WithAccountCreation](interfaces/WithAccountCreation.md)
|
|
354
|
-
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
355
|
-
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
356
|
-
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
357
344
|
- [WithCheckoutcomFawryInstrument](interfaces/WithCheckoutcomFawryInstrument.md)
|
|
358
345
|
- [WithCheckoutcomSEPAInstrument](interfaces/WithCheckoutcomSEPAInstrument.md)
|
|
359
346
|
- [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
|
|
@@ -374,15 +361,11 @@
|
|
|
374
361
|
- [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
|
|
375
362
|
- [BraintreeFormFieldFocusEventData](README.md#braintreeformfieldfocuseventdata)
|
|
376
363
|
- [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
|
|
377
|
-
- [CheckoutButtonInitializeOptions](README.md#checkoutbuttoninitializeoptions)
|
|
378
|
-
- [CheckoutButtonInitializeOptions_2](README.md#checkoutbuttoninitializeoptions_2)
|
|
379
364
|
- [CheckoutIncludeParam](README.md#checkoutincludeparam)
|
|
380
365
|
- [ComparableCheckout](README.md#comparablecheckout)
|
|
381
366
|
- [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
|
|
382
367
|
- [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
|
|
383
368
|
- [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
|
|
384
|
-
- [CustomerInitializeOptions](README.md#customerinitializeoptions)
|
|
385
|
-
- [CustomerInitializeOptions_2](README.md#customerinitializeoptions_2)
|
|
386
369
|
- [FlashMessageType](README.md#flashmessagetype)
|
|
387
370
|
- [FormFieldFieldType](README.md#formfieldfieldtype)
|
|
388
371
|
- [FormFieldType](README.md#formfieldtype)
|
|
@@ -401,8 +384,6 @@
|
|
|
401
384
|
- [Omit](README.md#omit)
|
|
402
385
|
- [OrderPaymentInstrument](README.md#orderpaymentinstrument)
|
|
403
386
|
- [OrderPayments](README.md#orderpayments)
|
|
404
|
-
- [PaymentInitializeOptions](README.md#paymentinitializeoptions)
|
|
405
|
-
- [PaymentInitializeOptions_2](README.md#paymentinitializeoptions_2)
|
|
406
387
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
407
388
|
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
408
389
|
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
@@ -485,18 +466,6 @@ ___
|
|
|
485
466
|
|
|
486
467
|
___
|
|
487
468
|
|
|
488
|
-
### CheckoutButtonInitializeOptions
|
|
489
|
-
|
|
490
|
-
Ƭ **CheckoutButtonInitializeOptions**: [`CheckoutButtonInitializeOptions_2`](README.md#checkoutbuttoninitializeoptions_2) & [`CheckoutButtonInitializeOptions_4`](interfaces/CheckoutButtonInitializeOptions_4.md)
|
|
491
|
-
|
|
492
|
-
___
|
|
493
|
-
|
|
494
|
-
### CheckoutButtonInitializeOptions\_2
|
|
495
|
-
|
|
496
|
-
Ƭ **CheckoutButtonInitializeOptions\_2**: [`CheckoutButtonInitializeOptions_3`](interfaces/CheckoutButtonInitializeOptions_3.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
497
|
-
|
|
498
|
-
___
|
|
499
|
-
|
|
500
469
|
### CheckoutIncludeParam
|
|
501
470
|
|
|
502
471
|
Ƭ **CheckoutIncludeParam**: { [key in CheckoutIncludes]?: boolean }
|
|
@@ -527,18 +496,6 @@ ___
|
|
|
527
496
|
|
|
528
497
|
___
|
|
529
498
|
|
|
530
|
-
### CustomerInitializeOptions
|
|
531
|
-
|
|
532
|
-
Ƭ **CustomerInitializeOptions**: [`CustomerInitializeOptions_2`](README.md#customerinitializeoptions_2) & [`CustomerInitializeOptions_4`](interfaces/CustomerInitializeOptions_4.md)
|
|
533
|
-
|
|
534
|
-
___
|
|
535
|
-
|
|
536
|
-
### CustomerInitializeOptions\_2
|
|
537
|
-
|
|
538
|
-
Ƭ **CustomerInitializeOptions\_2**: [`CustomerInitializeOptions_3`](interfaces/CustomerInitializeOptions_3.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
539
|
-
|
|
540
|
-
___
|
|
541
|
-
|
|
542
499
|
### FlashMessageType
|
|
543
500
|
|
|
544
501
|
Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``
|
|
@@ -654,18 +611,6 @@ ___
|
|
|
654
611
|
|
|
655
612
|
___
|
|
656
613
|
|
|
657
|
-
### PaymentInitializeOptions
|
|
658
|
-
|
|
659
|
-
Ƭ **PaymentInitializeOptions**: [`PaymentInitializeOptions_2`](README.md#paymentinitializeoptions_2) & [`PaymentInitializeOptions_4`](interfaces/PaymentInitializeOptions_4.md)
|
|
660
|
-
|
|
661
|
-
___
|
|
662
|
-
|
|
663
|
-
### PaymentInitializeOptions\_2
|
|
664
|
-
|
|
665
|
-
Ƭ **PaymentInitializeOptions\_2**: [`PaymentInitializeOptions_3`](interfaces/PaymentInitializeOptions_3.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
666
|
-
|
|
667
|
-
___
|
|
668
|
-
|
|
669
614
|
### PaymentInstrument
|
|
670
615
|
|
|
671
616
|
Ƭ **PaymentInstrument**: [`CardInstrument`](interfaces/CardInstrument.md) \| [`AccountInstrument`](README.md#accountinstrument)
|
|
@@ -39,7 +39,7 @@ await service.deinitializeButton({
|
|
|
39
39
|
|
|
40
40
|
| Name | Type | Description |
|
|
41
41
|
| :------ | :------ | :------ |
|
|
42
|
-
| `options` | [`
|
|
42
|
+
| `options` | [`CheckoutButtonOptions`](../interfaces/CheckoutButtonOptions.md) | Options for deinitializing the checkout button. |
|
|
43
43
|
|
|
44
44
|
#### Returns
|
|
45
45
|
|
|
@@ -95,7 +95,7 @@ initializer.initializeButton({
|
|
|
95
95
|
|
|
96
96
|
| Name | Type | Description |
|
|
97
97
|
| :------ | :------ | :------ |
|
|
98
|
-
| `options` | [`CheckoutButtonInitializeOptions`](../
|
|
98
|
+
| `options` | [`CheckoutButtonInitializeOptions`](../interfaces/CheckoutButtonInitializeOptions.md) | Options for initializing the checkout button. |
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -379,7 +379,7 @@ await service.deinitializeCustomer({
|
|
|
379
379
|
|
|
380
380
|
| Name | Type | Description |
|
|
381
381
|
| :------ | :------ | :------ |
|
|
382
|
-
| `options?` | [`
|
|
382
|
+
| `options?` | [`CustomerRequestOptions`](../interfaces/CustomerRequestOptions.md) | Options for deinitializing the customer step of checkout. |
|
|
383
383
|
|
|
384
384
|
#### Returns
|
|
385
385
|
|
|
@@ -410,7 +410,7 @@ await service.deinitializePayment({
|
|
|
410
410
|
|
|
411
411
|
| Name | Type | Description |
|
|
412
412
|
| :------ | :------ | :------ |
|
|
413
|
-
| `options` | [`
|
|
413
|
+
| `options` | [`PaymentRequestOptions`](../interfaces/PaymentRequestOptions.md) | Options for deinitializing the payment step of checkout. |
|
|
414
414
|
|
|
415
415
|
#### Returns
|
|
416
416
|
|
|
@@ -661,7 +661,7 @@ await service.initializeCustomer({
|
|
|
661
661
|
|
|
662
662
|
| Name | Type | Description |
|
|
663
663
|
| :------ | :------ | :------ |
|
|
664
|
-
| `options?` | [`CustomerInitializeOptions`](../
|
|
664
|
+
| `options?` | [`CustomerInitializeOptions`](../interfaces/CustomerInitializeOptions.md) | 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`](../interfaces/PaymentInitializeOptions.md) | Options for initializing the payment step of checkout. |
|
|
699
699
|
|
|
700
700
|
#### Returns
|
|
701
701
|
|
|
@@ -1274,7 +1274,7 @@ console.log(state.data.getCustomer());
|
|
|
1274
1274
|
| Name | Type | Description |
|
|
1275
1275
|
| :------ | :------ | :------ |
|
|
1276
1276
|
| `credentials` | [`CustomerCredentials`](../interfaces/CustomerCredentials.md) | The credentials to be used for signing in the customer. |
|
|
1277
|
-
| `options?` | [`
|
|
1277
|
+
| `options?` | [`CustomerRequestOptions`](../interfaces/CustomerRequestOptions.md) | Options for signing in the customer. |
|
|
1278
1278
|
|
|
1279
1279
|
#### Returns
|
|
1280
1280
|
|
|
@@ -1317,7 +1317,7 @@ try {
|
|
|
1317
1317
|
|
|
1318
1318
|
| Name | Type | Description |
|
|
1319
1319
|
| :------ | :------ | :------ |
|
|
1320
|
-
| `options?` | [`
|
|
1320
|
+
| `options?` | [`CustomerRequestOptions`](../interfaces/CustomerRequestOptions.md) | Options for signing out the customer. |
|
|
1321
1321
|
|
|
1322
1322
|
#### Returns
|
|
1323
1323
|
|
package/docs/interfaces/{CheckoutButtonInitializeOptions_4.md → CheckoutButtonInitializeOptions.md}
RENAMED
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface: CheckoutButtonInitializeOptions
|
|
3
|
+
# Interface: CheckoutButtonInitializeOptions
|
|
4
4
|
|
|
5
5
|
## Hierarchy
|
|
6
6
|
|
|
7
|
-
- [`
|
|
7
|
+
- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
|
|
8
8
|
|
|
9
|
-
↳ **`
|
|
9
|
+
↳ **`CheckoutButtonInitializeOptions`**
|
|
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](CheckoutButtonInitializeOptions.md#amazonpay)
|
|
16
|
+
- [applepay](CheckoutButtonInitializeOptions.md#applepay)
|
|
17
|
+
- [braintreepaypal](CheckoutButtonInitializeOptions.md#braintreepaypal)
|
|
18
|
+
- [braintreepaypalcredit](CheckoutButtonInitializeOptions.md#braintreepaypalcredit)
|
|
19
|
+
- [braintreevenmo](CheckoutButtonInitializeOptions.md#braintreevenmo)
|
|
20
|
+
- [containerId](CheckoutButtonInitializeOptions.md#containerid)
|
|
21
|
+
- [googlepayadyenv2](CheckoutButtonInitializeOptions.md#googlepayadyenv2)
|
|
22
|
+
- [googlepayadyenv3](CheckoutButtonInitializeOptions.md#googlepayadyenv3)
|
|
23
|
+
- [googlepayauthorizenet](CheckoutButtonInitializeOptions.md#googlepayauthorizenet)
|
|
24
|
+
- [googlepaybraintree](CheckoutButtonInitializeOptions.md#googlepaybraintree)
|
|
25
|
+
- [googlepaycheckoutcom](CheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
|
|
26
|
+
- [googlepaycybersourcev2](CheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
|
|
27
|
+
- [googlepayorbital](CheckoutButtonInitializeOptions.md#googlepayorbital)
|
|
28
|
+
- [googlepaystripe](CheckoutButtonInitializeOptions.md#googlepaystripe)
|
|
29
|
+
- [googlepaystripeupe](CheckoutButtonInitializeOptions.md#googlepaystripeupe)
|
|
30
|
+
- [methodId](CheckoutButtonInitializeOptions.md#methodid)
|
|
31
|
+
- [params](CheckoutButtonInitializeOptions.md#params)
|
|
32
|
+
- [paypal](CheckoutButtonInitializeOptions.md#paypal)
|
|
33
|
+
- [paypalCommerce](CheckoutButtonInitializeOptions.md#paypalcommerce)
|
|
34
|
+
- [paypalcommercealternativemethods](CheckoutButtonInitializeOptions.md#paypalcommercealternativemethods)
|
|
35
|
+
- [paypalcommercevenmo](CheckoutButtonInitializeOptions.md#paypalcommercevenmo)
|
|
36
|
+
- [timeout](CheckoutButtonInitializeOptions.md#timeout)
|
|
37
37
|
|
|
38
38
|
## Properties
|
|
39
39
|
|
|
@@ -48,7 +48,7 @@ ___
|
|
|
48
48
|
|
|
49
49
|
### applepay
|
|
50
50
|
|
|
51
|
-
• `Optional` **applepay**: [`
|
|
51
|
+
• `Optional` **applepay**: [`ApplePayButtonInitializeOptions`](ApplePayButtonInitializeOptions.md)
|
|
52
52
|
|
|
53
53
|
The options that are required to initialize the ApplePay payment method.
|
|
54
54
|
They can be omitted unless you need to support ApplePay in cart.
|
|
@@ -179,7 +179,7 @@ The identifier of the payment method.
|
|
|
179
179
|
|
|
180
180
|
#### Inherited from
|
|
181
181
|
|
|
182
|
-
[
|
|
182
|
+
[CheckoutButtonOptions](CheckoutButtonOptions.md).[methodId](CheckoutButtonOptions.md#methodid)
|
|
183
183
|
|
|
184
184
|
___
|
|
185
185
|
|
|
@@ -191,7 +191,7 @@ The parameters of the request, if required.
|
|
|
191
191
|
|
|
192
192
|
#### Inherited from
|
|
193
193
|
|
|
194
|
-
[
|
|
194
|
+
[CheckoutButtonOptions](CheckoutButtonOptions.md).[params](CheckoutButtonOptions.md#params)
|
|
195
195
|
|
|
196
196
|
___
|
|
197
197
|
|
|
@@ -241,4 +241,4 @@ cancelled.
|
|
|
241
241
|
|
|
242
242
|
#### Inherited from
|
|
243
243
|
|
|
244
|
-
[
|
|
244
|
+
[CheckoutButtonOptions](CheckoutButtonOptions.md).[timeout](CheckoutButtonOptions.md#timeout)
|
|
@@ -6,11 +6,11 @@ The set of options for configuring the checkout button.
|
|
|
6
6
|
|
|
7
7
|
## Hierarchy
|
|
8
8
|
|
|
9
|
-
- [`
|
|
9
|
+
- [`RequestOptions`](RequestOptions.md)
|
|
10
10
|
|
|
11
11
|
↳ **`CheckoutButtonOptions`**
|
|
12
12
|
|
|
13
|
-
↳↳ [`
|
|
13
|
+
↳↳ [`CheckoutButtonInitializeOptions`](CheckoutButtonInitializeOptions.md)
|
|
14
14
|
|
|
15
15
|
## Table of contents
|
|
16
16
|
|
|
@@ -24,7 +24,7 @@ The set of options for configuring the checkout button.
|
|
|
24
24
|
|
|
25
25
|
### methodId
|
|
26
26
|
|
|
27
|
-
• **methodId**: `
|
|
27
|
+
• **methodId**: [`CheckoutButtonMethodType`](../enums/CheckoutButtonMethodType.md)
|
|
28
28
|
|
|
29
29
|
The identifier of the payment method.
|
|
30
30
|
|
|
@@ -38,7 +38,7 @@ The parameters of the request, if required.
|
|
|
38
38
|
|
|
39
39
|
#### Inherited from
|
|
40
40
|
|
|
41
|
-
[
|
|
41
|
+
[RequestOptions](RequestOptions.md).[params](RequestOptions.md#params)
|
|
42
42
|
|
|
43
43
|
___
|
|
44
44
|
|
|
@@ -52,4 +52,4 @@ cancelled.
|
|
|
52
52
|
|
|
53
53
|
#### Inherited from
|
|
54
54
|
|
|
55
|
-
[
|
|
55
|
+
[RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / CustomerInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface: CustomerInitializeOptions
|
|
3
|
+
# Interface: CustomerInitializeOptions
|
|
4
4
|
|
|
5
5
|
A set of options that are required to initialize the customer step of the
|
|
6
6
|
current checkout flow.
|
|
@@ -12,33 +12,33 @@ information in order to initialize the customer step of checkout.
|
|
|
12
12
|
|
|
13
13
|
## Hierarchy
|
|
14
14
|
|
|
15
|
-
- [`
|
|
15
|
+
- [`CustomerRequestOptions`](CustomerRequestOptions.md)
|
|
16
16
|
|
|
17
|
-
↳ **`
|
|
17
|
+
↳ **`CustomerInitializeOptions`**
|
|
18
18
|
|
|
19
19
|
## Table of contents
|
|
20
20
|
|
|
21
21
|
### Properties
|
|
22
22
|
|
|
23
|
-
- [amazon](
|
|
24
|
-
- [amazonpay](
|
|
25
|
-
- [applepay](
|
|
26
|
-
- [bolt](
|
|
27
|
-
- [braintreevisacheckout](
|
|
28
|
-
- [chasepay](
|
|
29
|
-
- [googlepayadyenv2](
|
|
30
|
-
- [googlepayadyenv3](
|
|
31
|
-
- [googlepayauthorizenet](
|
|
32
|
-
- [googlepaybraintree](
|
|
33
|
-
- [googlepaycheckoutcom](
|
|
34
|
-
- [googlepaycybersourcev2](
|
|
35
|
-
- [googlepayorbital](
|
|
36
|
-
- [googlepaystripe](
|
|
37
|
-
- [googlepaystripeupe](
|
|
38
|
-
- [masterpass](
|
|
39
|
-
- [methodId](
|
|
40
|
-
- [params](
|
|
41
|
-
- [timeout](
|
|
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)
|
|
42
42
|
|
|
43
43
|
## Properties
|
|
44
44
|
|
|
@@ -62,7 +62,7 @@ ___
|
|
|
62
62
|
|
|
63
63
|
### applepay
|
|
64
64
|
|
|
65
|
-
• `Optional` **applepay**: [`
|
|
65
|
+
• `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
|
|
66
66
|
|
|
67
67
|
The options that are required to initialize the customer step of checkout
|
|
68
68
|
when using ApplePay.
|
|
@@ -192,7 +192,7 @@ ___
|
|
|
192
192
|
|
|
193
193
|
#### Inherited from
|
|
194
194
|
|
|
195
|
-
[
|
|
195
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)
|
|
196
196
|
|
|
197
197
|
___
|
|
198
198
|
|
|
@@ -204,7 +204,7 @@ The parameters of the request, if required.
|
|
|
204
204
|
|
|
205
205
|
#### Inherited from
|
|
206
206
|
|
|
207
|
-
[
|
|
207
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[params](CustomerRequestOptions.md#params)
|
|
208
208
|
|
|
209
209
|
___
|
|
210
210
|
|
|
@@ -218,4 +218,4 @@ cancelled.
|
|
|
218
218
|
|
|
219
219
|
#### Inherited from
|
|
220
220
|
|
|
221
|
-
[
|
|
221
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[timeout](CustomerRequestOptions.md#timeout)
|
|
@@ -2,22 +2,59 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: CustomerRequestOptions
|
|
4
4
|
|
|
5
|
+
A set of options for configuring any requests related to the customer step of
|
|
6
|
+
the current checkout flow.
|
|
7
|
+
|
|
8
|
+
Some payment methods have their own sign-in or sign-out flow. Therefore, you
|
|
9
|
+
need to indicate the method you want to use if you need to trigger a specific
|
|
10
|
+
flow for signing in or out a customer. Otherwise, these options are not required.
|
|
11
|
+
|
|
5
12
|
## Hierarchy
|
|
6
13
|
|
|
7
|
-
- `
|
|
14
|
+
- [`RequestOptions`](RequestOptions.md)
|
|
8
15
|
|
|
9
16
|
↳ **`CustomerRequestOptions`**
|
|
10
17
|
|
|
11
|
-
↳↳ [`
|
|
18
|
+
↳↳ [`CustomerInitializeOptions`](CustomerInitializeOptions.md)
|
|
19
|
+
|
|
20
|
+
↳↳ [`ExecutePaymentMethodCheckoutOptions`](ExecutePaymentMethodCheckoutOptions.md)
|
|
12
21
|
|
|
13
22
|
## Table of contents
|
|
14
23
|
|
|
15
24
|
### Properties
|
|
16
25
|
|
|
17
26
|
- [methodId](CustomerRequestOptions.md#methodid)
|
|
27
|
+
- [params](CustomerRequestOptions.md#params)
|
|
28
|
+
- [timeout](CustomerRequestOptions.md#timeout)
|
|
18
29
|
|
|
19
30
|
## Properties
|
|
20
31
|
|
|
21
32
|
### methodId
|
|
22
33
|
|
|
23
34
|
• `Optional` **methodId**: `string`
|
|
35
|
+
|
|
36
|
+
___
|
|
37
|
+
|
|
38
|
+
### params
|
|
39
|
+
|
|
40
|
+
• `Optional` **params**: `Object`
|
|
41
|
+
|
|
42
|
+
The parameters of the request, if required.
|
|
43
|
+
|
|
44
|
+
#### Inherited from
|
|
45
|
+
|
|
46
|
+
[RequestOptions](RequestOptions.md).[params](RequestOptions.md#params)
|
|
47
|
+
|
|
48
|
+
___
|
|
49
|
+
|
|
50
|
+
### timeout
|
|
51
|
+
|
|
52
|
+
• `Optional` **timeout**: `default`
|
|
53
|
+
|
|
54
|
+
Provide this option if you want to cancel or time out the request. If the
|
|
55
|
+
timeout object completes before the request, the request will be
|
|
56
|
+
cancelled.
|
|
57
|
+
|
|
58
|
+
#### Inherited from
|
|
59
|
+
|
|
60
|
+
[RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)
|
|
@@ -13,7 +13,7 @@ to execution method.
|
|
|
13
13
|
|
|
14
14
|
## Hierarchy
|
|
15
15
|
|
|
16
|
-
- [`
|
|
16
|
+
- [`CustomerRequestOptions`](CustomerRequestOptions.md)
|
|
17
17
|
|
|
18
18
|
↳ **`ExecutePaymentMethodCheckoutOptions`**
|
|
19
19
|
|
|
@@ -37,7 +37,7 @@ to execution method.
|
|
|
37
37
|
|
|
38
38
|
#### Inherited from
|
|
39
39
|
|
|
40
|
-
[
|
|
40
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[methodId](CustomerRequestOptions.md#methodid)
|
|
41
41
|
|
|
42
42
|
___
|
|
43
43
|
|
|
@@ -49,7 +49,7 @@ The parameters of the request, if required.
|
|
|
49
49
|
|
|
50
50
|
#### Inherited from
|
|
51
51
|
|
|
52
|
-
[
|
|
52
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[params](CustomerRequestOptions.md#params)
|
|
53
53
|
|
|
54
54
|
___
|
|
55
55
|
|
|
@@ -63,7 +63,7 @@ cancelled.
|
|
|
63
63
|
|
|
64
64
|
#### Inherited from
|
|
65
65
|
|
|
66
|
-
[
|
|
66
|
+
[CustomerRequestOptions](CustomerRequestOptions.md).[timeout](CustomerRequestOptions.md#timeout)
|
|
67
67
|
|
|
68
68
|
## Methods
|
|
69
69
|
|