@bigcommerce/checkout-sdk 1.249.0 → 1.252.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/docs/README.md CHANGED
@@ -106,6 +106,7 @@
106
106
  * [BraintreeFormFieldsMap](interfaces/braintreeformfieldsmap.md)
107
107
  * [BraintreeFormOptions](interfaces/braintreeformoptions.md)
108
108
  * [BraintreePaymentInitializeOptions](interfaces/braintreepaymentinitializeoptions.md)
109
+ * [BraintreePaypalCreditButtonInitializeOptions](interfaces/braintreepaypalcreditbuttoninitializeoptions.md)
109
110
  * [BraintreePaypalV1ButtonInitializeOptions](interfaces/braintreepaypalv1buttoninitializeoptions.md)
110
111
  * [BraintreeStoredCardFieldOptions](interfaces/braintreestoredcardfieldoptions.md)
111
112
  * [BraintreeStoredCardFieldsMap](interfaces/braintreestoredcardfieldsmap.md)
@@ -378,6 +379,7 @@
378
379
  * [HostedVaultedInstrument](README.md#hostedvaultedinstrument)
379
380
  * [Instrument](README.md#instrument)
380
381
  * [Omit](README.md#omit)
382
+ * [OrderPaymentInstrument](README.md#orderpaymentinstrument)
381
383
  * [OrderPayments](README.md#orderpayments)
382
384
  * [PaymentInstrument](README.md#paymentinstrument)
383
385
  * [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
@@ -589,6 +591,12 @@ ___
589
591
 
590
592
  ___
591
593
 
594
+ ### OrderPaymentInstrument
595
+
596
+ Ƭ **OrderPaymentInstrument**: *[CreditCardInstrument](interfaces/creditcardinstrument.md) | [HostedInstrument](interfaces/hostedinstrument.md) | object | [VaultedInstrument](interfaces/vaultedinstrument.md) | object | [NonceInstrument](interfaces/nonceinstrument.md) | [CreditCardInstrument](interfaces/creditcardinstrument.md) & [WithDocumentInstrument](interfaces/withdocumentinstrument.md) | [CreditCardInstrument](interfaces/creditcardinstrument.md) & [WithCheckoutcomFawryInstrument](interfaces/withcheckoutcomfawryinstrument.md) | [CreditCardInstrument](interfaces/creditcardinstrument.md) & [WithCheckoutcomSEPAInstrument](interfaces/withcheckoutcomsepainstrument.md) | [CreditCardInstrument](interfaces/creditcardinstrument.md) & [WithCheckoutcomiDealInstrument](interfaces/withcheckoutcomidealinstrument.md) | [HostedInstrument](interfaces/hostedinstrument.md) & [WithMollieIssuerInstrument](interfaces/withmollieissuerinstrument.md) | [WithAccountCreation](interfaces/withaccountcreation.md)*
597
+
598
+ ___
599
+
592
600
  ### OrderPayments
593
601
 
594
602
  Ƭ **OrderPayments**: *Array‹[GatewayOrderPayment](interfaces/gatewayorderpayment.md) | [GiftCertificateOrderPayment](interfaces/giftcertificateorderpayment.md)›*
@@ -9,7 +9,9 @@
9
9
  * [AMAZON_PAY_V2](checkoutbuttonmethodtype.md#amazon_pay_v2)
10
10
  * [APPLEPAY](checkoutbuttonmethodtype.md#applepay)
11
11
  * [BRAINTREE_PAYPAL](checkoutbuttonmethodtype.md#braintree_paypal)
12
+ * [BRAINTREE_PAYPALV2](checkoutbuttonmethodtype.md#braintree_paypalv2)
12
13
  * [BRAINTREE_PAYPAL_CREDIT](checkoutbuttonmethodtype.md#braintree_paypal_credit)
14
+ * [BRAINTREE_PAYPAL_CREDITV2](checkoutbuttonmethodtype.md#braintree_paypal_creditv2)
13
15
  * [BRAINTREE_VENMO](checkoutbuttonmethodtype.md#braintree_venmo)
14
16
  * [GOOGLEPAY_ADYENV2](checkoutbuttonmethodtype.md#googlepay_adyenv2)
15
17
  * [GOOGLEPAY_ADYENV3](checkoutbuttonmethodtype.md#googlepay_adyenv3)
@@ -44,12 +46,24 @@ ___
44
46
 
45
47
  ___
46
48
 
49
+ ### BRAINTREE_PAYPALV2
50
+
51
+ • **BRAINTREE_PAYPALV2**: = "braintreepaypalv2"
52
+
53
+ ___
54
+
47
55
  ### BRAINTREE_PAYPAL_CREDIT
48
56
 
49
57
  • **BRAINTREE_PAYPAL_CREDIT**: = "braintreepaypalcredit"
50
58
 
51
59
  ___
52
60
 
61
+ ### BRAINTREE_PAYPAL_CREDITV2
62
+
63
+ • **BRAINTREE_PAYPAL_CREDITV2**: = "braintreepaypalcreditv2"
64
+
65
+ ___
66
+
53
67
  ### BRAINTREE_VENMO
54
68
 
55
69
  • **BRAINTREE_VENMO**: = "braintreevenmo"
@@ -0,0 +1,85 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)
2
+
3
+ # Interface: BraintreePaypalCreditButtonInitializeOptions
4
+
5
+ ## Hierarchy
6
+
7
+ * **BraintreePaypalCreditButtonInitializeOptions**
8
+
9
+ ## Index
10
+
11
+ ### Properties
12
+
13
+ * [shippingAddress](braintreepaypalcreditbuttoninitializeoptions.md#optional-shippingaddress)
14
+ * [style](braintreepaypalcreditbuttoninitializeoptions.md#optional-style)
15
+
16
+ ### Methods
17
+
18
+ * [onAuthorizeError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onauthorizeerror)
19
+ * [onError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onerror)
20
+ * [onPaymentError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onpaymenterror)
21
+
22
+ ## Properties
23
+
24
+ ### `Optional` shippingAddress
25
+
26
+ • **shippingAddress**? : *[Address](address.md) | null*
27
+
28
+ Address to be used for shipping.
29
+ If not provided, it will use the first saved address from the active customer.
30
+
31
+ ___
32
+
33
+ ### `Optional` style
34
+
35
+ • **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons" | "height"›*
36
+
37
+ A set of styling options for the checkout button.
38
+
39
+ ## Methods
40
+
41
+ ### `Optional` onAuthorizeError
42
+
43
+ ▸ **onAuthorizeError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
44
+
45
+ A callback that gets called if unable to authorize and tokenize payment.
46
+
47
+ **Parameters:**
48
+
49
+ Name | Type | Description |
50
+ ------ | ------ | ------ |
51
+ `error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
52
+
53
+ **Returns:** *void*
54
+
55
+ ___
56
+
57
+ ### `Optional` onError
58
+
59
+ ▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
60
+
61
+ A callback that gets called on any error instead of submit payment or authorization errors.
62
+
63
+ **Parameters:**
64
+
65
+ Name | Type | Description |
66
+ ------ | ------ | ------ |
67
+ `error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
68
+
69
+ **Returns:** *void*
70
+
71
+ ___
72
+
73
+ ### `Optional` onPaymentError
74
+
75
+ ▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
76
+
77
+ A callback that gets called if unable to submit payment.
78
+
79
+ **Parameters:**
80
+
81
+ Name | Type | Description |
82
+ ------ | ------ | ------ |
83
+ `error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure. |
84
+
85
+ **Returns:** *void*
@@ -20,6 +20,7 @@
20
20
  * [applepay](checkoutbuttoninitializeoptions.md#optional-applepay)
21
21
  * [braintreepaypal](checkoutbuttoninitializeoptions.md#optional-braintreepaypal)
22
22
  * [braintreepaypalcredit](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcredit)
23
+ * [braintreepaypalcreditv2](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcreditv2)
23
24
  * [containerId](checkoutbuttoninitializeoptions.md#containerid)
24
25
  * [googlepayadyenv2](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv2)
25
26
  * [googlepayadyenv3](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv3)
@@ -74,6 +75,15 @@ omitted unless you need to support Braintree Credit.
74
75
 
75
76
  ___
76
77
 
78
+ ### `Optional` braintreepaypalcreditv2
79
+
80
+ • **braintreepaypalcreditv2**? : *[BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)*
81
+
82
+ The options that are required to facilitate Braintree Credit. They can be
83
+ omitted unless you need to support Braintree Credit.
84
+
85
+ ___
86
+
77
87
  ### containerId
78
88
 
79
89
  • **containerId**: *string*
@@ -37,7 +37,7 @@ ___
37
37
 
38
38
  ### `Optional` paymentData
39
39
 
40
- • **paymentData**? : *[CreditCardInstrument](creditcardinstrument.md) | [HostedInstrument](hostedinstrument.md) | [HostedCreditCardInstrument](../README.md#hostedcreditcardinstrument) | [HostedVaultedInstrument](../README.md#hostedvaultedinstrument) | [NonceInstrument](nonceinstrument.md) | [VaultedInstrument](vaultedinstrument.md) | [CreditCardInstrument](creditcardinstrument.md) & [WithDocumentInstrument](withdocumentinstrument.md) | [CreditCardInstrument](creditcardinstrument.md) & [WithCheckoutcomFawryInstrument](withcheckoutcomfawryinstrument.md) | [CreditCardInstrument](creditcardinstrument.md) & [WithCheckoutcomSEPAInstrument](withcheckoutcomsepainstrument.md) | [CreditCardInstrument](creditcardinstrument.md) & [WithCheckoutcomiDealInstrument](withcheckoutcomidealinstrument.md) | [HostedInstrument](hostedinstrument.md) & [WithMollieIssuerInstrument](withmollieissuerinstrument.md) | [WithAccountCreation](withaccountcreation.md)*
40
+ • **paymentData**? : *[OrderPaymentInstrument](../README.md#orderpaymentinstrument)*
41
41
 
42
42
  An object that contains the details of a credit card, vaulted payment
43
43
  instrument or nonce instrument.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.249.0",
3
+ "version": "1.252.0",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",