@bigcommerce/checkout-sdk 1.396.1 → 1.398.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/dist/checkout-button.js +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-sdk.d.ts +65 -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 +4 -1
- package/docs/interfaces/BlueSnapDirectAPMInitializeOptions.md +73 -0
- package/docs/interfaces/BlueSnapDirectStyleProps.md +29 -0
- package/docs/interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md +18 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -103,6 +103,8 @@
|
|
|
103
103
|
- [BillingAddress](interfaces/BillingAddress.md)
|
|
104
104
|
- [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
|
|
105
105
|
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
106
|
+
- [BlueSnapDirectAPMInitializeOptions](interfaces/BlueSnapDirectAPMInitializeOptions.md)
|
|
107
|
+
- [BlueSnapDirectStyleProps](interfaces/BlueSnapDirectStyleProps.md)
|
|
106
108
|
- [BlueSnapV2PaymentInitializeOptions](interfaces/BlueSnapV2PaymentInitializeOptions.md)
|
|
107
109
|
- [BlueSnapV2StyleProps](interfaces/BlueSnapV2StyleProps.md)
|
|
108
110
|
- [BodlEventsPayload](interfaces/BodlEventsPayload.md)
|
|
@@ -379,6 +381,7 @@
|
|
|
379
381
|
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
380
382
|
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
381
383
|
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
384
|
+
- [WithBlueSnapDirectAPMPaymentInitializeOptions](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md)
|
|
382
385
|
- [WithBoltButtonInitializeOptions](interfaces/WithBoltButtonInitializeOptions.md)
|
|
383
386
|
- [WithBoltCustomerInitializeOptions](interfaces/WithBoltCustomerInitializeOptions.md)
|
|
384
387
|
- [WithBoltPaymentInitializeOptions](interfaces/WithBoltPaymentInitializeOptions.md)
|
|
@@ -726,7 +729,7 @@ ___
|
|
|
726
729
|
|
|
727
730
|
### PaymentInitializeOptions
|
|
728
731
|
|
|
729
|
-
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
|
|
732
|
+
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBlueSnapDirectAPMPaymentInitializeOptions`](interfaces/WithBlueSnapDirectAPMPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithBraintreePaypalAchPaymentInitializeOptions`](interfaces/WithBraintreePaypalAchPaymentInitializeOptions.md) & [`WithBraintreeLocalMethodsPaymentInitializeOptions`](interfaces/WithBraintreeLocalMethodsPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceVenmoPaymentInitializeOptions`](interfaces/WithPayPalCommerceVenmoPaymentInitializeOptions.md) & [`WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions`](interfaces/WithPayPalCommerceAlternativeMethodsPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
|
|
730
733
|
|
|
731
734
|
___
|
|
732
735
|
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BlueSnapDirectAPMInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: BlueSnapDirectAPMInitializeOptions
|
|
4
|
+
|
|
5
|
+
A set of options that are required to initialize the BlueSnap V2 payment
|
|
6
|
+
method.
|
|
7
|
+
|
|
8
|
+
The payment step is done through a web page via an iframe provided by the
|
|
9
|
+
strategy.
|
|
10
|
+
|
|
11
|
+
```html
|
|
12
|
+
<!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
|
|
13
|
+
<div id="container"></div>
|
|
14
|
+
|
|
15
|
+
<!-- This is a cancellation button -->
|
|
16
|
+
<button type="button" id="cancel-button"></button>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
```js
|
|
20
|
+
service.initializePayment({
|
|
21
|
+
methodId: 'bluesnapDirect',
|
|
22
|
+
bluesnapDirect: {
|
|
23
|
+
onLoad: (iframe) => {
|
|
24
|
+
document.getElementById('container')
|
|
25
|
+
.appendChild(iframe);
|
|
26
|
+
|
|
27
|
+
document.getElementById('cancel-button')
|
|
28
|
+
.addEventListener('click', () => {
|
|
29
|
+
document.getElementById('container').innerHTML = '';
|
|
30
|
+
});
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Table of contents
|
|
37
|
+
|
|
38
|
+
### Properties
|
|
39
|
+
|
|
40
|
+
- [style](BlueSnapDirectAPMInitializeOptions.md#style)
|
|
41
|
+
|
|
42
|
+
### Methods
|
|
43
|
+
|
|
44
|
+
- [onLoad](BlueSnapDirectAPMInitializeOptions.md#onload)
|
|
45
|
+
|
|
46
|
+
## Properties
|
|
47
|
+
|
|
48
|
+
### style
|
|
49
|
+
|
|
50
|
+
• `Optional` **style**: [`BlueSnapDirectStyleProps`](BlueSnapDirectStyleProps.md)
|
|
51
|
+
|
|
52
|
+
A set of CSS properties to apply to the iframe.
|
|
53
|
+
|
|
54
|
+
## Methods
|
|
55
|
+
|
|
56
|
+
### onLoad
|
|
57
|
+
|
|
58
|
+
▸ **onLoad**(`iframe`, `cancel`): `void`
|
|
59
|
+
|
|
60
|
+
A callback that gets called when the iframe is ready to be added to the
|
|
61
|
+
current page. It is responsible for determining where the iframe should
|
|
62
|
+
be inserted in the DOM.
|
|
63
|
+
|
|
64
|
+
#### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description |
|
|
67
|
+
| :------ | :------ | :------ |
|
|
68
|
+
| `iframe` | `HTMLIFrameElement` | The iframe element containing the payment web page provided by the strategy. |
|
|
69
|
+
| `cancel` | () => `void` | A function, when called, will cancel the payment process and remove the iframe. |
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`void`
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BlueSnapDirectStyleProps
|
|
2
|
+
|
|
3
|
+
# Interface: BlueSnapDirectStyleProps
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [border](BlueSnapDirectStyleProps.md#border)
|
|
10
|
+
- [height](BlueSnapDirectStyleProps.md#height)
|
|
11
|
+
- [width](BlueSnapDirectStyleProps.md#width)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### border
|
|
16
|
+
|
|
17
|
+
• `Optional` **border**: `string`
|
|
18
|
+
|
|
19
|
+
___
|
|
20
|
+
|
|
21
|
+
### height
|
|
22
|
+
|
|
23
|
+
• `Optional` **height**: `string`
|
|
24
|
+
|
|
25
|
+
___
|
|
26
|
+
|
|
27
|
+
### width
|
|
28
|
+
|
|
29
|
+
• `Optional` **width**: `string`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithBlueSnapDirectAPMPaymentInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithBlueSnapDirectAPMPaymentInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [bluesnapdirect](WithBlueSnapDirectAPMPaymentInitializeOptions.md#bluesnapdirect)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### bluesnapdirect
|
|
14
|
+
|
|
15
|
+
• `Optional` **bluesnapdirect**: [`BlueSnapDirectAPMInitializeOptions`](BlueSnapDirectAPMInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the Apple Pay payment
|
|
18
|
+
method. They can be omitted unless you need to support Apple Pay.
|