@bigcommerce/checkout-sdk 1.283.1 → 1.284.2
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 -14
- 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 +24 -14
- 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 +30 -1
- package/docs/interfaces/BaseCheckoutButtonInitializeOptions.md +1 -1
- package/docs/interfaces/BodlService.md +30 -0
- package/docs/interfaces/PaypalCommerceButtonInitializeOptions.md +4 -4
- package/package.json +1 -1
- package/docs/interfaces/PaypalCommerceV2ButtonInitializeOptions.md +0 -26
package/docs/README.md
CHANGED
|
@@ -106,6 +106,7 @@
|
|
|
106
106
|
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
107
107
|
- [BlueSnapV2PaymentInitializeOptions](interfaces/BlueSnapV2PaymentInitializeOptions.md)
|
|
108
108
|
- [BlueSnapV2StyleProps](interfaces/BlueSnapV2StyleProps.md)
|
|
109
|
+
- [BodlService](interfaces/BodlService.md)
|
|
109
110
|
- [BodyStyles](interfaces/BodyStyles.md)
|
|
110
111
|
- [BoltCustomerInitializeOptions](interfaces/BoltCustomerInitializeOptions.md)
|
|
111
112
|
- [BoltPaymentInitializeOptions](interfaces/BoltPaymentInitializeOptions.md)
|
|
@@ -299,7 +300,6 @@
|
|
|
299
300
|
- [PaypalCommercePaymentInitializeOptions](interfaces/PaypalCommercePaymentInitializeOptions.md)
|
|
300
301
|
- [PaypalCommerceStoredCardFieldOptions](interfaces/PaypalCommerceStoredCardFieldOptions.md)
|
|
301
302
|
- [PaypalCommerceStoredCardFieldsMap](interfaces/PaypalCommerceStoredCardFieldsMap.md)
|
|
302
|
-
- [PaypalCommerceV2ButtonInitializeOptions](interfaces/PaypalCommerceV2ButtonInitializeOptions.md)
|
|
303
303
|
- [PaypalCommerceVenmoButtonInitializeOptions](interfaces/PaypalCommerceVenmoButtonInitializeOptions.md)
|
|
304
304
|
- [PaypalExpressPaymentInitializeOptions](interfaces/PaypalExpressPaymentInitializeOptions.md)
|
|
305
305
|
- [PaypalFieldsStyleOptions](interfaces/PaypalFieldsStyleOptions.md)
|
|
@@ -421,6 +421,7 @@
|
|
|
421
421
|
|
|
422
422
|
### Functions
|
|
423
423
|
|
|
424
|
+
- [createBodlService](README.md#createbodlservice)
|
|
424
425
|
- [createCheckoutButtonInitializer](README.md#createcheckoutbuttoninitializer)
|
|
425
426
|
- [createCheckoutService](README.md#createcheckoutservice)
|
|
426
427
|
- [createCurrencyService](README.md#createcurrencyservice)
|
|
@@ -713,6 +714,34 @@ ___
|
|
|
713
714
|
|
|
714
715
|
## Functions
|
|
715
716
|
|
|
717
|
+
### createBodlService
|
|
718
|
+
|
|
719
|
+
▸ **createBodlService**(`subscribe`): [`BodlService`](interfaces/BodlService.md)
|
|
720
|
+
|
|
721
|
+
Creates an instance of `BodlService`.
|
|
722
|
+
|
|
723
|
+
**`remarks`**
|
|
724
|
+
|
|
725
|
+
```js
|
|
726
|
+
const bodlService = BodlService();
|
|
727
|
+
bodlService.checkoutBegin();
|
|
728
|
+
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
#### Parameters
|
|
732
|
+
|
|
733
|
+
| Name | Type |
|
|
734
|
+
| :------ | :------ |
|
|
735
|
+
| `subscribe` | (`subscriber`: (`state`: [`CheckoutSelectors`](interfaces/CheckoutSelectors.md)) => `void`) => `void` |
|
|
736
|
+
|
|
737
|
+
#### Returns
|
|
738
|
+
|
|
739
|
+
[`BodlService`](interfaces/BodlService.md)
|
|
740
|
+
|
|
741
|
+
an instance of `BodlService`.
|
|
742
|
+
|
|
743
|
+
___
|
|
744
|
+
|
|
716
745
|
### createCheckoutButtonInitializer
|
|
717
746
|
|
|
718
747
|
▸ **createCheckoutButtonInitializer**(`options?`): [`CheckoutButtonInitializer`](classes/CheckoutButtonInitializer.md)
|
|
@@ -222,7 +222,7 @@ ___
|
|
|
222
222
|
|
|
223
223
|
### paypalcommerce
|
|
224
224
|
|
|
225
|
-
• `Optional` **paypalcommerce**: [`
|
|
225
|
+
• `Optional` **paypalcommerce**: [`PaypalCommerceButtonInitializeOptions`](PaypalCommerceButtonInitializeOptions.md)
|
|
226
226
|
|
|
227
227
|
The options that are required to facilitate PayPal Commerce V2. They can be omitted
|
|
228
228
|
unless you need to support Paypal Commerce.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BodlService
|
|
2
|
+
|
|
3
|
+
# Interface: BodlService
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Methods
|
|
8
|
+
|
|
9
|
+
- [checkoutBegin](BodlService.md#checkoutbegin)
|
|
10
|
+
- [orderPurchased](BodlService.md#orderpurchased)
|
|
11
|
+
|
|
12
|
+
## Methods
|
|
13
|
+
|
|
14
|
+
### checkoutBegin
|
|
15
|
+
|
|
16
|
+
▸ **checkoutBegin**(): `void`
|
|
17
|
+
|
|
18
|
+
#### Returns
|
|
19
|
+
|
|
20
|
+
`void`
|
|
21
|
+
|
|
22
|
+
___
|
|
23
|
+
|
|
24
|
+
### orderPurchased
|
|
25
|
+
|
|
26
|
+
▸ **orderPurchased**(): `void`
|
|
27
|
+
|
|
28
|
+
#### Returns
|
|
29
|
+
|
|
30
|
+
`void`
|
|
@@ -6,16 +6,16 @@
|
|
|
6
6
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
|
-
- [
|
|
9
|
+
- [initializesOnCheckoutPage](PaypalCommerceButtonInitializeOptions.md#initializesoncheckoutpage)
|
|
10
10
|
- [style](PaypalCommerceButtonInitializeOptions.md#style)
|
|
11
11
|
|
|
12
12
|
## Properties
|
|
13
13
|
|
|
14
|
-
###
|
|
14
|
+
### initializesOnCheckoutPage
|
|
15
15
|
|
|
16
|
-
• `Optional` **
|
|
16
|
+
• `Optional` **initializesOnCheckoutPage**: `boolean`
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Flag which helps to detect that the strategy initializes on Checkout page
|
|
19
19
|
|
|
20
20
|
___
|
|
21
21
|
|
package/package.json
CHANGED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceV2ButtonInitializeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: PaypalCommerceV2ButtonInitializeOptions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [initializesOnCheckoutPage](PaypalCommerceV2ButtonInitializeOptions.md#initializesoncheckoutpage)
|
|
10
|
-
- [style](PaypalCommerceV2ButtonInitializeOptions.md#style)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### initializesOnCheckoutPage
|
|
15
|
-
|
|
16
|
-
• `Optional` **initializesOnCheckoutPage**: `boolean`
|
|
17
|
-
|
|
18
|
-
Flag which helps to detect that the strategy initializes on Checkout page
|
|
19
|
-
|
|
20
|
-
___
|
|
21
|
-
|
|
22
|
-
### style
|
|
23
|
-
|
|
24
|
-
• `Optional` **style**: [`PaypalButtonStyleOptions_2`](PaypalButtonStyleOptions_2.md)
|
|
25
|
-
|
|
26
|
-
A set of styling options for the checkout button.
|