@bigcommerce/checkout-sdk 1.325.0 → 1.326.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 +74 -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 +74 -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/README.md +8 -1
- package/docs/enums/StyleButtonColor_2.md +43 -0
- package/docs/enums/StyleButtonLabel_2.md +43 -0
- package/docs/enums/StyleButtonLayout_2.md +22 -0
- package/docs/enums/StyleButtonShape_2.md +22 -0
- package/docs/interfaces/PayPalButtonStyleOptions.md +67 -0
- package/docs/interfaces/PayPalCommerceInlineButtonInitializeOptions.md +61 -0
- package/docs/interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md +15 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -30,9 +30,13 @@
|
|
|
30
30
|
- [PaypalCommerceFormFieldType](enums/PaypalCommerceFormFieldType.md)
|
|
31
31
|
- [RadiusUnit](enums/RadiusUnit.md)
|
|
32
32
|
- [StyleButtonColor](enums/StyleButtonColor.md)
|
|
33
|
+
- [StyleButtonColor_2](enums/StyleButtonColor_2.md)
|
|
33
34
|
- [StyleButtonLabel](enums/StyleButtonLabel.md)
|
|
35
|
+
- [StyleButtonLabel_2](enums/StyleButtonLabel_2.md)
|
|
34
36
|
- [StyleButtonLayout](enums/StyleButtonLayout.md)
|
|
37
|
+
- [StyleButtonLayout_2](enums/StyleButtonLayout_2.md)
|
|
35
38
|
- [StyleButtonShape](enums/StyleButtonShape.md)
|
|
39
|
+
- [StyleButtonShape_2](enums/StyleButtonShape_2.md)
|
|
36
40
|
|
|
37
41
|
### Classes
|
|
38
42
|
|
|
@@ -282,7 +286,9 @@
|
|
|
282
286
|
- [OrderRequestBody](interfaces/OrderRequestBody.md)
|
|
283
287
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
284
288
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
289
|
+
- [PayPalButtonStyleOptions](interfaces/PayPalButtonStyleOptions.md)
|
|
285
290
|
- [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
|
|
291
|
+
- [PayPalCommerceInlineButtonInitializeOptions](interfaces/PayPalCommerceInlineButtonInitializeOptions.md)
|
|
286
292
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
287
293
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
288
294
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
@@ -380,6 +386,7 @@
|
|
|
380
386
|
- [WithDocumentInstrument](interfaces/WithDocumentInstrument.md)
|
|
381
387
|
- [WithMollieIssuerInstrument](interfaces/WithMollieIssuerInstrument.md)
|
|
382
388
|
- [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
|
|
389
|
+
- [WithPayPalCommerceInlineButtonInitializeOptions](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md)
|
|
383
390
|
- [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
|
|
384
391
|
- [WorldpayAccessPaymentInitializeOptions](interfaces/WorldpayAccessPaymentInitializeOptions.md)
|
|
385
392
|
- [ZipCodeElementOptions](interfaces/ZipCodeElementOptions.md)
|
|
@@ -515,7 +522,7 @@ ___
|
|
|
515
522
|
|
|
516
523
|
### CheckoutButtonInitializeOptions
|
|
517
524
|
|
|
518
|
-
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
525
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md) & [`WithPayPalCommerceInlineButtonInitializeOptions`](interfaces/WithPayPalCommerceInlineButtonInitializeOptions.md)
|
|
519
526
|
|
|
520
527
|
___
|
|
521
528
|
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / StyleButtonColor_2
|
|
2
|
+
|
|
3
|
+
# Enumeration: StyleButtonColor\_2
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration Members
|
|
8
|
+
|
|
9
|
+
- [BLACK](StyleButtonColor_2.md#black)
|
|
10
|
+
- [BLUE](StyleButtonColor_2.md#blue)
|
|
11
|
+
- [GOLD](StyleButtonColor_2.md#gold)
|
|
12
|
+
- [SILVER](StyleButtonColor_2.md#silver)
|
|
13
|
+
- [WHITE](StyleButtonColor_2.md#white)
|
|
14
|
+
|
|
15
|
+
## Enumeration Members
|
|
16
|
+
|
|
17
|
+
### BLACK
|
|
18
|
+
|
|
19
|
+
• **BLACK**
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### BLUE
|
|
24
|
+
|
|
25
|
+
• **BLUE**
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### GOLD
|
|
30
|
+
|
|
31
|
+
• **GOLD**
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### SILVER
|
|
36
|
+
|
|
37
|
+
• **SILVER**
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### WHITE
|
|
42
|
+
|
|
43
|
+
• **WHITE**
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / StyleButtonLabel_2
|
|
2
|
+
|
|
3
|
+
# Enumeration: StyleButtonLabel\_2
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration Members
|
|
8
|
+
|
|
9
|
+
- [BUYNOW](StyleButtonLabel_2.md#buynow)
|
|
10
|
+
- [CHECKOUT](StyleButtonLabel_2.md#checkout)
|
|
11
|
+
- [INSTALLMENT](StyleButtonLabel_2.md#installment)
|
|
12
|
+
- [PAY](StyleButtonLabel_2.md#pay)
|
|
13
|
+
- [PAYPAL](StyleButtonLabel_2.md#paypal)
|
|
14
|
+
|
|
15
|
+
## Enumeration Members
|
|
16
|
+
|
|
17
|
+
### BUYNOW
|
|
18
|
+
|
|
19
|
+
• **BUYNOW**
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### CHECKOUT
|
|
24
|
+
|
|
25
|
+
• **CHECKOUT**
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### INSTALLMENT
|
|
30
|
+
|
|
31
|
+
• **INSTALLMENT**
|
|
32
|
+
|
|
33
|
+
___
|
|
34
|
+
|
|
35
|
+
### PAY
|
|
36
|
+
|
|
37
|
+
• **PAY**
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### PAYPAL
|
|
42
|
+
|
|
43
|
+
• **PAYPAL**
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / StyleButtonLayout_2
|
|
2
|
+
|
|
3
|
+
# Enumeration: StyleButtonLayout\_2
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration Members
|
|
8
|
+
|
|
9
|
+
- [HORIZONTAL](StyleButtonLayout_2.md#horizontal)
|
|
10
|
+
- [VERTICAL](StyleButtonLayout_2.md#vertical)
|
|
11
|
+
|
|
12
|
+
## Enumeration Members
|
|
13
|
+
|
|
14
|
+
### HORIZONTAL
|
|
15
|
+
|
|
16
|
+
• **HORIZONTAL**
|
|
17
|
+
|
|
18
|
+
___
|
|
19
|
+
|
|
20
|
+
### VERTICAL
|
|
21
|
+
|
|
22
|
+
• **VERTICAL**
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / StyleButtonShape_2
|
|
2
|
+
|
|
3
|
+
# Enumeration: StyleButtonShape\_2
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Enumeration Members
|
|
8
|
+
|
|
9
|
+
- [PILL](StyleButtonShape_2.md#pill)
|
|
10
|
+
- [RECT](StyleButtonShape_2.md#rect)
|
|
11
|
+
|
|
12
|
+
## Enumeration Members
|
|
13
|
+
|
|
14
|
+
### PILL
|
|
15
|
+
|
|
16
|
+
• **PILL**
|
|
17
|
+
|
|
18
|
+
___
|
|
19
|
+
|
|
20
|
+
### RECT
|
|
21
|
+
|
|
22
|
+
• **RECT**
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / PayPalButtonStyleOptions
|
|
2
|
+
|
|
3
|
+
# Interface: PayPalButtonStyleOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [color](PayPalButtonStyleOptions.md#color)
|
|
10
|
+
- [custom](PayPalButtonStyleOptions.md#custom)
|
|
11
|
+
- [height](PayPalButtonStyleOptions.md#height)
|
|
12
|
+
- [label](PayPalButtonStyleOptions.md#label)
|
|
13
|
+
- [layout](PayPalButtonStyleOptions.md#layout)
|
|
14
|
+
- [shape](PayPalButtonStyleOptions.md#shape)
|
|
15
|
+
- [tagline](PayPalButtonStyleOptions.md#tagline)
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### color
|
|
20
|
+
|
|
21
|
+
• `Optional` **color**: [`GOLD`](../enums/StyleButtonColor_2.md#gold) \| [`BLUE`](../enums/StyleButtonColor_2.md#blue) \| [`SILVER`](../enums/StyleButtonColor_2.md#silver) \| [`BLACK`](../enums/StyleButtonColor_2.md#black) \| [`WHITE`](../enums/StyleButtonColor_2.md#white)
|
|
22
|
+
|
|
23
|
+
___
|
|
24
|
+
|
|
25
|
+
### custom
|
|
26
|
+
|
|
27
|
+
• `Optional` **custom**: `Object`
|
|
28
|
+
|
|
29
|
+
#### Type declaration
|
|
30
|
+
|
|
31
|
+
| Name | Type |
|
|
32
|
+
| :------ | :------ |
|
|
33
|
+
| `css?` | `Object` |
|
|
34
|
+
| `css.background?` | `string` |
|
|
35
|
+
| `css.color?` | `string` |
|
|
36
|
+
| `css.width?` | `string` |
|
|
37
|
+
| `label?` | `string` |
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### height
|
|
42
|
+
|
|
43
|
+
• `Optional` **height**: `number`
|
|
44
|
+
|
|
45
|
+
___
|
|
46
|
+
|
|
47
|
+
### label
|
|
48
|
+
|
|
49
|
+
• `Optional` **label**: [`PAYPAL`](../enums/StyleButtonLabel_2.md#paypal) \| [`CHECKOUT`](../enums/StyleButtonLabel_2.md#checkout) \| [`BUYNOW`](../enums/StyleButtonLabel_2.md#buynow) \| [`PAY`](../enums/StyleButtonLabel_2.md#pay) \| [`INSTALLMENT`](../enums/StyleButtonLabel_2.md#installment)
|
|
50
|
+
|
|
51
|
+
___
|
|
52
|
+
|
|
53
|
+
### layout
|
|
54
|
+
|
|
55
|
+
• `Optional` **layout**: [`VERTICAL`](../enums/StyleButtonLayout_2.md#vertical) \| [`HORIZONTAL`](../enums/StyleButtonLayout_2.md#horizontal)
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### shape
|
|
60
|
+
|
|
61
|
+
• `Optional` **shape**: [`PILL`](../enums/StyleButtonShape_2.md#pill) \| [`RECT`](../enums/StyleButtonShape_2.md#rect)
|
|
62
|
+
|
|
63
|
+
___
|
|
64
|
+
|
|
65
|
+
### tagline
|
|
66
|
+
|
|
67
|
+
• `Optional` **tagline**: `boolean`
|
|
@@ -0,0 +1,61 @@
|
|
|
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`
|
|
@@ -0,0 +1,15 @@
|
|
|
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)
|