@bigcommerce/checkout-sdk 1.250.0 → 1.253.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 +29 -0
- package/dist/checkout-button.d.ts +51 -0
- 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 +51 -0
- 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 +1 -1
- package/dist/hosted-form.js.map +1 -1
- package/dist/hosted-form.umd.js +1 -1
- package/dist/hosted-form.umd.js.map +1 -1
- package/docs/README.md +2 -0
- package/docs/enums/checkoutbuttonmethodtype.md +14 -0
- package/docs/interfaces/braintreepaypalcreditbuttoninitializeoptions.md +85 -0
- package/docs/interfaces/braintreevenmobuttoninitializeoptions.md +29 -0
- package/docs/interfaces/checkoutbuttoninitializeoptions.md +20 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -106,10 +106,12 @@
|
|
|
106
106
|
* [BraintreeFormFieldsMap](interfaces/braintreeformfieldsmap.md)
|
|
107
107
|
* [BraintreeFormOptions](interfaces/braintreeformoptions.md)
|
|
108
108
|
* [BraintreePaymentInitializeOptions](interfaces/braintreepaymentinitializeoptions.md)
|
|
109
|
+
* [BraintreePaypalCreditButtonInitializeOptions](interfaces/braintreepaypalcreditbuttoninitializeoptions.md)
|
|
109
110
|
* [BraintreePaypalV1ButtonInitializeOptions](interfaces/braintreepaypalv1buttoninitializeoptions.md)
|
|
110
111
|
* [BraintreeStoredCardFieldOptions](interfaces/braintreestoredcardfieldoptions.md)
|
|
111
112
|
* [BraintreeStoredCardFieldsMap](interfaces/braintreestoredcardfieldsmap.md)
|
|
112
113
|
* [BraintreeThreeDSecureOptions](interfaces/braintreethreedsecureoptions.md)
|
|
114
|
+
* [BraintreeVenmoButtonInitializeOptions](interfaces/braintreevenmobuttoninitializeoptions.md)
|
|
113
115
|
* [BraintreeVerifyPayload](interfaces/braintreeverifypayload.md)
|
|
114
116
|
* [BraintreeVisaCheckoutCustomerInitializeOptions](interfaces/braintreevisacheckoutcustomerinitializeoptions.md)
|
|
115
117
|
* [BraintreeVisaCheckoutPaymentInitializeOptions](interfaces/braintreevisacheckoutpaymentinitializeoptions.md)
|
|
@@ -9,7 +9,9 @@
|
|
|
9
9
|
* [AMAZON_PAY_V2](checkoutbuttonmethodtype.md#amazon_pay_v2)
|
|
10
10
|
* [APPLEPAY](checkoutbuttonmethodtype.md#applepay)
|
|
11
11
|
* [BRAINTREE_PAYPAL](checkoutbuttonmethodtype.md#braintree_paypal)
|
|
12
|
+
* [BRAINTREE_PAYPALV2](checkoutbuttonmethodtype.md#braintree_paypalv2)
|
|
12
13
|
* [BRAINTREE_PAYPAL_CREDIT](checkoutbuttonmethodtype.md#braintree_paypal_credit)
|
|
14
|
+
* [BRAINTREE_PAYPAL_CREDITV2](checkoutbuttonmethodtype.md#braintree_paypal_creditv2)
|
|
13
15
|
* [BRAINTREE_VENMO](checkoutbuttonmethodtype.md#braintree_venmo)
|
|
14
16
|
* [GOOGLEPAY_ADYENV2](checkoutbuttonmethodtype.md#googlepay_adyenv2)
|
|
15
17
|
* [GOOGLEPAY_ADYENV3](checkoutbuttonmethodtype.md#googlepay_adyenv3)
|
|
@@ -44,12 +46,24 @@ ___
|
|
|
44
46
|
|
|
45
47
|
___
|
|
46
48
|
|
|
49
|
+
### BRAINTREE_PAYPALV2
|
|
50
|
+
|
|
51
|
+
• **BRAINTREE_PAYPALV2**: = "braintreepaypalv2"
|
|
52
|
+
|
|
53
|
+
___
|
|
54
|
+
|
|
47
55
|
### BRAINTREE_PAYPAL_CREDIT
|
|
48
56
|
|
|
49
57
|
• **BRAINTREE_PAYPAL_CREDIT**: = "braintreepaypalcredit"
|
|
50
58
|
|
|
51
59
|
___
|
|
52
60
|
|
|
61
|
+
### BRAINTREE_PAYPAL_CREDITV2
|
|
62
|
+
|
|
63
|
+
• **BRAINTREE_PAYPAL_CREDITV2**: = "braintreepaypalcreditv2"
|
|
64
|
+
|
|
65
|
+
___
|
|
66
|
+
|
|
53
67
|
### BRAINTREE_VENMO
|
|
54
68
|
|
|
55
69
|
• **BRAINTREE_VENMO**: = "braintreevenmo"
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)
|
|
2
|
+
|
|
3
|
+
# Interface: BraintreePaypalCreditButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
* **BraintreePaypalCreditButtonInitializeOptions**
|
|
8
|
+
|
|
9
|
+
## Index
|
|
10
|
+
|
|
11
|
+
### Properties
|
|
12
|
+
|
|
13
|
+
* [shippingAddress](braintreepaypalcreditbuttoninitializeoptions.md#optional-shippingaddress)
|
|
14
|
+
* [style](braintreepaypalcreditbuttoninitializeoptions.md#optional-style)
|
|
15
|
+
|
|
16
|
+
### Methods
|
|
17
|
+
|
|
18
|
+
* [onAuthorizeError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onauthorizeerror)
|
|
19
|
+
* [onError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onerror)
|
|
20
|
+
* [onPaymentError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onpaymenterror)
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
### `Optional` shippingAddress
|
|
25
|
+
|
|
26
|
+
• **shippingAddress**? : *[Address](address.md) | null*
|
|
27
|
+
|
|
28
|
+
Address to be used for shipping.
|
|
29
|
+
If not provided, it will use the first saved address from the active customer.
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### `Optional` style
|
|
34
|
+
|
|
35
|
+
• **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons" | "height"›*
|
|
36
|
+
|
|
37
|
+
A set of styling options for the checkout button.
|
|
38
|
+
|
|
39
|
+
## Methods
|
|
40
|
+
|
|
41
|
+
### `Optional` onAuthorizeError
|
|
42
|
+
|
|
43
|
+
▸ **onAuthorizeError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
|
|
44
|
+
|
|
45
|
+
A callback that gets called if unable to authorize and tokenize payment.
|
|
46
|
+
|
|
47
|
+
**Parameters:**
|
|
48
|
+
|
|
49
|
+
Name | Type | Description |
|
|
50
|
+
------ | ------ | ------ |
|
|
51
|
+
`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
|
|
52
|
+
|
|
53
|
+
**Returns:** *void*
|
|
54
|
+
|
|
55
|
+
___
|
|
56
|
+
|
|
57
|
+
### `Optional` onError
|
|
58
|
+
|
|
59
|
+
▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
|
|
60
|
+
|
|
61
|
+
A callback that gets called on any error instead of submit payment or authorization errors.
|
|
62
|
+
|
|
63
|
+
**Parameters:**
|
|
64
|
+
|
|
65
|
+
Name | Type | Description |
|
|
66
|
+
------ | ------ | ------ |
|
|
67
|
+
`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
|
|
68
|
+
|
|
69
|
+
**Returns:** *void*
|
|
70
|
+
|
|
71
|
+
___
|
|
72
|
+
|
|
73
|
+
### `Optional` onPaymentError
|
|
74
|
+
|
|
75
|
+
▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
|
|
76
|
+
|
|
77
|
+
A callback that gets called if unable to submit payment.
|
|
78
|
+
|
|
79
|
+
**Parameters:**
|
|
80
|
+
|
|
81
|
+
Name | Type | Description |
|
|
82
|
+
------ | ------ | ------ |
|
|
83
|
+
`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
|
|
84
|
+
|
|
85
|
+
**Returns:** *void*
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) › [BraintreeVenmoButtonInitializeOptions](braintreevenmobuttoninitializeoptions.md)
|
|
2
|
+
|
|
3
|
+
# Interface: BraintreeVenmoButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
* **BraintreeVenmoButtonInitializeOptions**
|
|
8
|
+
|
|
9
|
+
## Index
|
|
10
|
+
|
|
11
|
+
### Methods
|
|
12
|
+
|
|
13
|
+
* [onError](braintreevenmobuttoninitializeoptions.md#optional-onerror)
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
### `Optional` onError
|
|
18
|
+
|
|
19
|
+
▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
|
|
20
|
+
|
|
21
|
+
A callback that gets called on any error.
|
|
22
|
+
|
|
23
|
+
**Parameters:**
|
|
24
|
+
|
|
25
|
+
Name | Type | Description |
|
|
26
|
+
------ | ------ | ------ |
|
|
27
|
+
`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
|
|
28
|
+
|
|
29
|
+
**Returns:** *void*
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
* [applepay](checkoutbuttoninitializeoptions.md#optional-applepay)
|
|
21
21
|
* [braintreepaypal](checkoutbuttoninitializeoptions.md#optional-braintreepaypal)
|
|
22
22
|
* [braintreepaypalcredit](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcredit)
|
|
23
|
+
* [braintreepaypalcreditv2](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcreditv2)
|
|
24
|
+
* [braintreevenmo](checkoutbuttoninitializeoptions.md#optional-braintreevenmo)
|
|
23
25
|
* [containerId](checkoutbuttoninitializeoptions.md#containerid)
|
|
24
26
|
* [googlepayadyenv2](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv2)
|
|
25
27
|
* [googlepayadyenv3](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv3)
|
|
@@ -74,6 +76,24 @@ omitted unless you need to support Braintree Credit.
|
|
|
74
76
|
|
|
75
77
|
___
|
|
76
78
|
|
|
79
|
+
### `Optional` braintreepaypalcreditv2
|
|
80
|
+
|
|
81
|
+
• **braintreepaypalcreditv2**? : *[BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)*
|
|
82
|
+
|
|
83
|
+
The options that are required to facilitate Braintree Credit. They can be
|
|
84
|
+
omitted unless you need to support Braintree Credit.
|
|
85
|
+
|
|
86
|
+
___
|
|
87
|
+
|
|
88
|
+
### `Optional` braintreevenmo
|
|
89
|
+
|
|
90
|
+
• **braintreevenmo**? : *[BraintreeVenmoButtonInitializeOptions](braintreevenmobuttoninitializeoptions.md)*
|
|
91
|
+
|
|
92
|
+
The options that are required to facilitate Braintree Venmo. They can be
|
|
93
|
+
omitted unless you need to support Braintree Venmo.
|
|
94
|
+
|
|
95
|
+
___
|
|
96
|
+
|
|
77
97
|
### containerId
|
|
78
98
|
|
|
79
99
|
• **containerId**: *string*
|