@bigcommerce/checkout-sdk 1.271.1 → 1.272.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.
Files changed (37) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/checkout-button.d.ts +3 -62
  3. package/dist/checkout-button.js +1 -1
  4. package/dist/checkout-button.js.map +1 -1
  5. package/dist/checkout-button.umd.js +1 -1
  6. package/dist/checkout-button.umd.js.map +1 -1
  7. package/dist/checkout-sdk.d.ts +17 -180
  8. package/dist/checkout-sdk.js +1 -1
  9. package/dist/checkout-sdk.js.map +1 -1
  10. package/dist/checkout-sdk.umd.js +1 -1
  11. package/dist/checkout-sdk.umd.js.map +1 -1
  12. package/docs/README.md +3 -58
  13. package/docs/classes/CheckoutButtonInitializer.md +2 -2
  14. package/docs/classes/CheckoutService.md +6 -6
  15. package/docs/interfaces/{CheckoutButtonInitializeOptions_4.md → CheckoutButtonInitializeOptions.md} +30 -30
  16. package/docs/interfaces/CheckoutButtonOptions.md +5 -5
  17. package/docs/interfaces/{CustomerInitializeOptions_4.md → CustomerInitializeOptions.md} +27 -27
  18. package/docs/interfaces/CustomerRequestOptions.md +39 -2
  19. package/docs/interfaces/ExecutePaymentMethodCheckoutOptions.md +4 -4
  20. package/docs/interfaces/{PaymentInitializeOptions_4.md → PaymentInitializeOptions.md} +46 -46
  21. package/docs/interfaces/PaymentRequestOptions.md +4 -4
  22. package/docs/interfaces/RequestOptions.md +3 -3
  23. package/docs/interfaces/SpamProtectionOptions.md +1 -1
  24. package/package.json +1 -1
  25. package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +0 -38
  26. package/docs/interfaces/ApplePayCustomerInitializeOptions_2.md +0 -77
  27. package/docs/interfaces/ApplePayPaymentInitializeOptions_2.md +0 -40
  28. package/docs/interfaces/CheckoutButtonInitializeOptions_3.md +0 -68
  29. package/docs/interfaces/CheckoutButtonOptions_2.md +0 -55
  30. package/docs/interfaces/CustomerInitializeOptions_3.md +0 -29
  31. package/docs/interfaces/CustomerRequestOptions_2.md +0 -60
  32. package/docs/interfaces/PaymentInitializeOptions_3.md +0 -74
  33. package/docs/interfaces/PaymentRequestOptions_2.md +0 -67
  34. package/docs/interfaces/RequestOptions_2.md +0 -44
  35. package/docs/interfaces/WithApplePayButtonInitializeOptions.md +0 -15
  36. package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +0 -15
  37. package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +0 -15
package/docs/interfaces/PaymentRequestOptions_2.md DELETED
@@ -1,67 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / PaymentRequestOptions_2
2
-
3
- # Interface: PaymentRequestOptions\_2
4
-
5
- The set of options for configuring any requests related to the payment step of
6
- the current checkout flow.
7
-
8
- ## Hierarchy
9
-
10
- - [`RequestOptions`](RequestOptions.md)
11
-
12
- ↳ **`PaymentRequestOptions_2`**
13
-
14
- ↳↳ [`PaymentInitializeOptions_4`](PaymentInitializeOptions_4.md)
15
-
16
- ## Table of contents
17
-
18
- ### Properties
19
-
20
- - [gatewayId](PaymentRequestOptions_2.md#gatewayid)
21
- - [methodId](PaymentRequestOptions_2.md#methodid)
22
- - [params](PaymentRequestOptions_2.md#params)
23
- - [timeout](PaymentRequestOptions_2.md#timeout)
24
-
25
- ## Properties
26
-
27
- ### gatewayId
28
-
29
- • `Optional` **gatewayId**: `string`
30
-
31
- The identifier of the payment provider providing the payment method. This
32
- option is only required if the provider offers multiple payment options.
33
- i.e.: Adyen and Klarna.
34
-
35
- ___
36
-
37
- ### methodId
38
-
39
- • **methodId**: `string`
40
-
41
- The identifier of the payment method.
42
-
43
- ___
44
-
45
- ### params
46
-
47
- • `Optional` **params**: `Object`
48
-
49
- The parameters of the request, if required.
50
-
51
- #### Inherited from
52
-
53
- [RequestOptions](RequestOptions.md).[params](RequestOptions.md#params)
54
-
55
- ___
56
-
57
- ### timeout
58
-
59
- • `Optional` **timeout**: `default`
60
-
61
- Provide this option if you want to cancel or time out the request. If the
62
- timeout object completes before the request, the request will be
63
- cancelled.
64
-
65
- #### Inherited from
66
-
67
- [RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)
package/docs/interfaces/RequestOptions_2.md DELETED
@@ -1,44 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / RequestOptions_2
2
-
3
- # Interface: RequestOptions\_2<TParams\>
4
-
5
- A set of options for configuring an asynchronous request.
6
-
7
- ## Type parameters
8
-
9
- | Name | Type |
10
- | :------ | :------ |
11
- | `TParams` | {} |
12
-
13
- ## Hierarchy
14
-
15
- - **`RequestOptions_2`**
16
-
17
- ↳ [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
18
-
19
- ↳ [`PaymentRequestOptions`](PaymentRequestOptions.md)
20
-
21
- ## Table of contents
22
-
23
- ### Properties
24
-
25
- - [params](RequestOptions_2.md#params)
26
- - [timeout](RequestOptions_2.md#timeout)
27
-
28
- ## Properties
29
-
30
- ### params
31
-
32
- • `Optional` **params**: `TParams`
33
-
34
- The parameters of the request, if required.
35
-
36
- ___
37
-
38
- ### timeout
39
-
40
- • `Optional` **timeout**: `default`
41
-
42
- Provide this option if you want to cancel or time out the request. If the
43
- timeout object completes before the request, the request will be
44
- cancelled.
package/docs/interfaces/WithApplePayButtonInitializeOptions.md DELETED
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / WithApplePayButtonInitializeOptions
2
-
3
- # Interface: WithApplePayButtonInitializeOptions
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [applepay](WithApplePayButtonInitializeOptions.md#applepay)
10
-
11
- ## Properties
12
-
13
- ### applepay
14
-
15
- • `Optional` **applepay**: [`ApplePayButtonInitializeOptions`](ApplePayButtonInitializeOptions.md)
package/docs/interfaces/WithApplePayCustomerInitializeOptions.md DELETED
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / WithApplePayCustomerInitializeOptions
2
-
3
- # Interface: WithApplePayCustomerInitializeOptions
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [applepay](WithApplePayCustomerInitializeOptions.md#applepay)
10
-
11
- ## Properties
12
-
13
- ### applepay
14
-
15
- • `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
package/docs/interfaces/WithApplePayPaymentInitializeOptions.md DELETED
@@ -1,15 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) / WithApplePayPaymentInitializeOptions
2
-
3
- # Interface: WithApplePayPaymentInitializeOptions
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [applepay](WithApplePayPaymentInitializeOptions.md#applepay)
10
-
11
- ## Properties
12
-
13
- ### applepay
14
-
15
- • `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)