@bigcommerce/checkout-sdk 1.304.0 → 1.305.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/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
+ - [BodlEventsPayload](interfaces/BodlEventsPayload.md)
109
110
  - [BodlService](interfaces/BodlService.md)
110
111
  - [BodyStyles](interfaces/BodyStyles.md)
111
112
  - [BoltCustomerInitializeOptions](interfaces/BoltCustomerInitializeOptions.md)
@@ -157,6 +158,7 @@
157
158
  - [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
158
159
  - [CheckoutParams](interfaces/CheckoutParams.md)
159
160
  - [CheckoutPayment](interfaces/CheckoutPayment.md)
161
+ - [CheckoutPaymentMethodExecutedOptions](interfaces/CheckoutPaymentMethodExecutedOptions.md)
160
162
  - [CheckoutRequestBody](interfaces/CheckoutRequestBody.md)
161
163
  - [CheckoutSelectors](interfaces/CheckoutSelectors.md)
162
164
  - [CheckoutServiceOptions](interfaces/CheckoutServiceOptions.md)
@@ -0,0 +1,7 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / BodlEventsPayload
2
+
3
+ # Interface: BodlEventsPayload
4
+
5
+ ## Indexable
6
+
7
+ ▪ [key: `string`]: `unknown`
@@ -7,7 +7,17 @@
7
7
  ### Methods
8
8
 
9
9
  - [checkoutBegin](BodlService.md#checkoutbegin)
10
+ - [clickPayButton](BodlService.md#clickpaybutton)
11
+ - [customerEmailEntry](BodlService.md#customeremailentry)
12
+ - [customerPaymentMethodExecuted](BodlService.md#customerpaymentmethodexecuted)
13
+ - [customerSuggestionExecute](BodlService.md#customersuggestionexecute)
14
+ - [exitCheckout](BodlService.md#exitcheckout)
10
15
  - [orderPurchased](BodlService.md#orderpurchased)
16
+ - [paymentComplete](BodlService.md#paymentcomplete)
17
+ - [paymentRejected](BodlService.md#paymentrejected)
18
+ - [selectedPaymentMethod](BodlService.md#selectedpaymentmethod)
19
+ - [showShippingMethods](BodlService.md#showshippingmethods)
20
+ - [stepCompleted](BodlService.md#stepcompleted)
11
21
 
12
22
  ## Methods
13
23
 
@@ -21,6 +31,74 @@
21
31
 
22
32
  ___
23
33
 
34
+ ### clickPayButton
35
+
36
+ ▸ **clickPayButton**(`payload?`): `void`
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type |
41
+ | :------ | :------ |
42
+ | `payload?` | [`BodlEventsPayload`](BodlEventsPayload.md) |
43
+
44
+ #### Returns
45
+
46
+ `void`
47
+
48
+ ___
49
+
50
+ ### customerEmailEntry
51
+
52
+ ▸ **customerEmailEntry**(`email?`): `void`
53
+
54
+ #### Parameters
55
+
56
+ | Name | Type |
57
+ | :------ | :------ |
58
+ | `email?` | `string` |
59
+
60
+ #### Returns
61
+
62
+ `void`
63
+
64
+ ___
65
+
66
+ ### customerPaymentMethodExecuted
67
+
68
+ ▸ **customerPaymentMethodExecuted**(`payload?`): `void`
69
+
70
+ #### Parameters
71
+
72
+ | Name | Type |
73
+ | :------ | :------ |
74
+ | `payload?` | [`BodlEventsPayload`](BodlEventsPayload.md) |
75
+
76
+ #### Returns
77
+
78
+ `void`
79
+
80
+ ___
81
+
82
+ ### customerSuggestionExecute
83
+
84
+ ▸ **customerSuggestionExecute**(): `void`
85
+
86
+ #### Returns
87
+
88
+ `void`
89
+
90
+ ___
91
+
92
+ ### exitCheckout
93
+
94
+ ▸ **exitCheckout**(): `void`
95
+
96
+ #### Returns
97
+
98
+ `void`
99
+
100
+ ___
101
+
24
102
  ### orderPurchased
25
103
 
26
104
  ▸ **orderPurchased**(): `void`
@@ -28,3 +106,65 @@ ___
28
106
  #### Returns
29
107
 
30
108
  `void`
109
+
110
+ ___
111
+
112
+ ### paymentComplete
113
+
114
+ ▸ **paymentComplete**(): `void`
115
+
116
+ #### Returns
117
+
118
+ `void`
119
+
120
+ ___
121
+
122
+ ### paymentRejected
123
+
124
+ ▸ **paymentRejected**(): `void`
125
+
126
+ #### Returns
127
+
128
+ `void`
129
+
130
+ ___
131
+
132
+ ### selectedPaymentMethod
133
+
134
+ ▸ **selectedPaymentMethod**(`methodName?`): `void`
135
+
136
+ #### Parameters
137
+
138
+ | Name | Type |
139
+ | :------ | :------ |
140
+ | `methodName?` | `string` |
141
+
142
+ #### Returns
143
+
144
+ `void`
145
+
146
+ ___
147
+
148
+ ### showShippingMethods
149
+
150
+ ▸ **showShippingMethods**(): `void`
151
+
152
+ #### Returns
153
+
154
+ `void`
155
+
156
+ ___
157
+
158
+ ### stepCompleted
159
+
160
+ ▸ **stepCompleted**(`step?`): `void`
161
+
162
+ #### Parameters
163
+
164
+ | Name | Type |
165
+ | :------ | :------ |
166
+ | `step?` | `string` |
167
+
168
+ #### Returns
169
+
170
+ `void`
@@ -0,0 +1,15 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) / CheckoutPaymentMethodExecutedOptions
2
+
3
+ # Interface: CheckoutPaymentMethodExecutedOptions
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [hasBoltAccount](CheckoutPaymentMethodExecutedOptions.md#hasboltaccount)
10
+
11
+ ## Properties
12
+
13
+ ### hasBoltAccount
14
+
15
+ • `Optional` **hasBoltAccount**: `boolean`
@@ -27,6 +27,7 @@ to execution method.
27
27
 
28
28
  ### Methods
29
29
 
30
+ - [checkoutPaymentMethodExecuted](ExecutePaymentMethodCheckoutOptions.md#checkoutpaymentmethodexecuted)
30
31
  - [continueWithCheckoutCallback](ExecutePaymentMethodCheckoutOptions.md#continuewithcheckoutcallback)
31
32
 
32
33
  ## Properties
@@ -67,6 +68,22 @@ cancelled.
67
68
 
68
69
  ## Methods
69
70
 
71
+ ### checkoutPaymentMethodExecuted
72
+
73
+ ▸ `Optional` **checkoutPaymentMethodExecuted**(`data?`): `void`
74
+
75
+ #### Parameters
76
+
77
+ | Name | Type |
78
+ | :------ | :------ |
79
+ | `data?` | [`CheckoutPaymentMethodExecutedOptions`](CheckoutPaymentMethodExecutedOptions.md) |
80
+
81
+ #### Returns
82
+
83
+ `void`
84
+
85
+ ___
86
+
70
87
  ### continueWithCheckoutCallback
71
88
 
72
89
  ▸ `Optional` **continueWithCheckoutCallback**(): `void`
@@ -6,29 +6,16 @@
6
6
 
7
7
  ### Properties
8
8
 
9
- - [acceleratedCheckoutContainerDataId](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#acceleratedcheckoutcontainerdataid)
10
9
  - [buttonContainerClassName](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#buttoncontainerclassname)
11
- - [buttonContainerDataId](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#buttoncontainerdataid)
12
- - [nativeCheckoutButtonDataId](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#nativecheckoutbuttondataid)
13
10
  - [style](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#style)
14
11
 
15
12
  ### Methods
16
13
 
17
14
  - [onComplete](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#oncomplete)
15
+ - [onError](PaypalCommerceInlineCheckoutButtonInitializeOptions.md#onerror)
18
16
 
19
17
  ## Properties
20
18
 
21
- ### acceleratedCheckoutContainerDataId
22
-
23
- • **acceleratedCheckoutContainerDataId**: `string`
24
-
25
- Accelerated Checkout Buttons container - is a generic container for all AC buttons
26
- Used as a container where the button will be rendered with its own container
27
- Example: 'data-cart-accelerated-checkout-buttons'
28
- Info: we are using data attributes as an identifier because the buttons can be rendered in several places on the page
29
-
30
- ___
31
-
32
19
  ### buttonContainerClassName
33
20
 
34
21
  • `Optional` **buttonContainerClassName**: `string`
@@ -38,26 +25,6 @@ Default: 'PaypalCommerceInlineButton'
38
25
 
39
26
  ___
40
27
 
41
- ### buttonContainerDataId
42
-
43
- • **buttonContainerDataId**: `string`
44
-
45
- A container identifier what used to add special class for container where the button will be generated in
46
- Example: 'data-paypal-commerce-inline-button'
47
- Info: we are using data attributes as an identifier because the buttons can be rendered in several places on the page
48
-
49
- ___
50
-
51
- ### nativeCheckoutButtonDataId
52
-
53
- • **nativeCheckoutButtonDataId**: `string`
54
-
55
- Used by Accelerated Checkout strategy to hide native action button before rendering PayPal inline checkout button
56
- Example: 'data-checkout-now-button'
57
- Info: we are using data attributes as an identifier because the buttons can be rendered in several places on the page
58
-
59
- ___
60
-
61
28
  ### style
62
29
 
63
30
  • `Optional` **style**: [`PaypalButtonStyleOptions_2`](PaypalButtonStyleOptions_2.md)
@@ -75,3 +42,15 @@ A callback that gets called when payment complete on paypal side.
75
42
  #### Returns
76
43
 
77
44
  `void`
45
+
46
+ ___
47
+
48
+ ### onError
49
+
50
+ ▸ `Optional` **onError**(): `void`
51
+
52
+ A callback that gets called on any error
53
+
54
+ #### Returns
55
+
56
+ `void`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.304.0",
3
+ "version": "1.305.1",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",