@bigcommerce/checkout-sdk 1.248.2 → 1.251.0

package/docs/README.md

@@ -19,6 +19,11 @@
 * [HostedFieldType](enums/hostedfieldtype.md)
 * [HostedInputEventType](enums/hostedinputeventtype.md)
 * [IconStyle](enums/iconstyle.md)
+* [PaypalButtonStyleColorOption](enums/paypalbuttonstylecoloroption.md)
+* [PaypalButtonStyleLabelOption](enums/paypalbuttonstylelabeloption.md)
+* [PaypalButtonStyleLayoutOption](enums/paypalbuttonstylelayoutoption.md)
+* [PaypalButtonStyleShapeOption](enums/paypalbuttonstyleshapeoption.md)
+* [PaypalButtonStyleSizeOption](enums/paypalbuttonstylesizeoption.md)
 * [PaypalCommerceFormFieldType](enums/paypalcommerceformfieldtype.md)
 * [RadiusUnit](enums/radiusunit.md)
 * [StyleButtonColor](enums/stylebuttoncolor.md)
@@ -101,7 +106,8 @@
 * [BraintreeFormFieldsMap](interfaces/braintreeformfieldsmap.md)
 * [BraintreeFormOptions](interfaces/braintreeformoptions.md)
 * [BraintreePaymentInitializeOptions](interfaces/braintreepaymentinitializeoptions.md)
-* [BraintreePaypalButtonInitializeOptions](interfaces/braintreepaypalbuttoninitializeoptions.md)
+* [BraintreePaypalCreditButtonInitializeOptions](interfaces/braintreepaypalcreditbuttoninitializeoptions.md)
+* [BraintreePaypalV1ButtonInitializeOptions](interfaces/braintreepaypalv1buttoninitializeoptions.md)
 * [BraintreeStoredCardFieldOptions](interfaces/braintreestoredcardfieldoptions.md)
 * [BraintreeStoredCardFieldsMap](interfaces/braintreestoredcardfieldsmap.md)
 * [BraintreeThreeDSecureOptions](interfaces/braintreethreedsecureoptions.md)
@@ -373,6 +379,7 @@
 * [HostedVaultedInstrument](README.md#hostedvaultedinstrument)
 * [Instrument](README.md#instrument)
 * [Omit](README.md#omit)
+* [OrderPaymentInstrument](README.md#orderpaymentinstrument)
 * [OrderPayments](README.md#orderpayments)
 * [PaymentInstrument](README.md#paymentinstrument)
 * [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
@@ -584,6 +591,12 @@ ___
 
 ___
 
+###  OrderPaymentInstrument
+
+Ƭ **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)*
+
+___
+
 ###  OrderPayments
 
 Ƭ **OrderPayments**: *Array‹[GatewayOrderPayment](interfaces/gatewayorderpayment.md) | [GiftCertificateOrderPayment](interfaces/giftcertificateorderpayment.md)›*

package/docs/enums/checkoutbuttonmethodtype.md

@@ -10,6 +10,7 @@
 * [APPLEPAY](checkoutbuttonmethodtype.md#applepay)
 * [BRAINTREE_PAYPAL](checkoutbuttonmethodtype.md#braintree_paypal)
 * [BRAINTREE_PAYPAL_CREDIT](checkoutbuttonmethodtype.md#braintree_paypal_credit)
+* [BRAINTREE_PAYPAL_CREDITV2](checkoutbuttonmethodtype.md#braintree_paypal_creditv2)
 * [BRAINTREE_VENMO](checkoutbuttonmethodtype.md#braintree_venmo)
 * [GOOGLEPAY_ADYENV2](checkoutbuttonmethodtype.md#googlepay_adyenv2)
 * [GOOGLEPAY_ADYENV3](checkoutbuttonmethodtype.md#googlepay_adyenv3)
@@ -50,6 +51,12 @@ ___
 
 ___
 
+###  BRAINTREE_PAYPAL_CREDITV2
+
+• **BRAINTREE_PAYPAL_CREDITV2**: = "braintreepaypalcreditv2"
+
+___
+
 ###  BRAINTREE_VENMO
 
 • **BRAINTREE_VENMO**: = "braintreevenmo"

package/docs/enums/paypalbuttonstylecoloroption.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleColorOption](paypalbuttonstylecoloroption.md)
+
+# Enumeration: PaypalButtonStyleColorOption
+
+## Index
+
+### Enumeration members
+
+* [BLACK](paypalbuttonstylecoloroption.md#black)
+* [BLUE](paypalbuttonstylecoloroption.md#blue)
+* [GOLD](paypalbuttonstylecoloroption.md#gold)
+* [SIlVER](paypalbuttonstylecoloroption.md#silver)
+
+## Enumeration members
+
+###  BLACK
+
+• **BLACK**: = "black"
+
+___
+
+###  BLUE
+
+• **BLUE**: = "blue"
+
+___
+
+###  GOLD
+
+• **GOLD**: = "gold"
+
+___
+
+###  SIlVER
+
+• **SIlVER**: = "silver"

package/docs/enums/paypalbuttonstylelabeloption.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleLabelOption](paypalbuttonstylelabeloption.md)
+
+# Enumeration: PaypalButtonStyleLabelOption
+
+## Index
+
+### Enumeration members
+
+* [BUYNOW](paypalbuttonstylelabeloption.md#buynow)
+* [CHECKOUT](paypalbuttonstylelabeloption.md#checkout)
+* [CREDIT](paypalbuttonstylelabeloption.md#credit)
+* [PAY](paypalbuttonstylelabeloption.md#pay)
+* [PAYPAL](paypalbuttonstylelabeloption.md#paypal)
+
+## Enumeration members
+
+###  BUYNOW
+
+• **BUYNOW**: = "buynow"
+
+___
+
+###  CHECKOUT
+
+• **CHECKOUT**: = "checkout"
+
+___
+
+###  CREDIT
+
+• **CREDIT**: = "credit"
+
+___
+
+###  PAY
+
+• **PAY**: = "pay"
+
+___
+
+###  PAYPAL
+
+• **PAYPAL**: = "paypal"

package/docs/enums/paypalbuttonstylelayoutoption.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleLayoutOption](paypalbuttonstylelayoutoption.md)
+
+# Enumeration: PaypalButtonStyleLayoutOption
+
+## Index
+
+### Enumeration members
+
+* [HORIZONTAL](paypalbuttonstylelayoutoption.md#horizontal)
+* [VERTICAL](paypalbuttonstylelayoutoption.md#vertical)
+
+## Enumeration members
+
+###  HORIZONTAL
+
+• **HORIZONTAL**: = "horizontal"
+
+___
+
+###  VERTICAL
+
+• **VERTICAL**: = "vertical"

package/docs/enums/paypalbuttonstyleshapeoption.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleShapeOption](paypalbuttonstyleshapeoption.md)
+
+# Enumeration: PaypalButtonStyleShapeOption
+
+## Index
+
+### Enumeration members
+
+* [PILL](paypalbuttonstyleshapeoption.md#pill)
+* [RECT](paypalbuttonstyleshapeoption.md#rect)
+
+## Enumeration members
+
+###  PILL
+
+• **PILL**: = "pill"
+
+___
+
+###  RECT
+
+• **RECT**: = "rect"

package/docs/enums/paypalbuttonstylesizeoption.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleSizeOption](paypalbuttonstylesizeoption.md)
+
+# Enumeration: PaypalButtonStyleSizeOption
+
+## Index
+
+### Enumeration members
+
+* [LARGE](paypalbuttonstylesizeoption.md#large)
+* [MEDIUM](paypalbuttonstylesizeoption.md#medium)
+* [RESPONSIVE](paypalbuttonstylesizeoption.md#responsive)
+* [SMALL](paypalbuttonstylesizeoption.md#small)
+
+## Enumeration members
+
+###  LARGE
+
+• **LARGE**: = "large"
+
+___
+
+###  MEDIUM
+
+• **MEDIUM**: = "medium"
+
+___
+
+###  RESPONSIVE
+
+• **RESPONSIVE**: = "responsive"
+
+___
+
+###  SMALL
+
+• **SMALL**: = "small"

package/docs/interfaces/braintreeerror.md

@@ -14,6 +14,7 @@
 
 * [Error](braintreeerror.md#error)
 * [code](braintreeerror.md#code)
+* [details](braintreeerror.md#optional-details)
 * [message](braintreeerror.md#message)
 * [name](braintreeerror.md#name)
 * [stack](braintreeerror.md#optional-stack)
@@ -33,11 +34,17 @@ ___
 
 ___
 
+### `Optional` details
+
+• **details**? : *unknown*
+
+___
+
 ###  message
 
 • **message**: *string*
 
-*Overrides [AmazonPayWidgetError](amazonpaywidgeterror.md).[message](amazonpaywidgeterror.md#message)*
+*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[message](amazonpaywidgeterror.md#message)*
 
 ___
 

package/docs/interfaces/braintreepaypalcreditbuttoninitializeoptions.md

@@ -0,0 +1,85 @@
+[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)
+
+# Interface: BraintreePaypalCreditButtonInitializeOptions
+
+## Hierarchy
+
+* **BraintreePaypalCreditButtonInitializeOptions**
+
+## Index
+
+### Properties
+
+* [shippingAddress](braintreepaypalcreditbuttoninitializeoptions.md#optional-shippingaddress)
+* [style](braintreepaypalcreditbuttoninitializeoptions.md#optional-style)
+
+### Methods
+
+* [onAuthorizeError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onauthorizeerror)
+* [onError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onerror)
+* [onPaymentError](braintreepaypalcreditbuttoninitializeoptions.md#optional-onpaymenterror)
+
+## Properties
+
+### `Optional` shippingAddress
+
+• **shippingAddress**? : *[Address](address.md) | null*
+
+Address to be used for shipping.
+If not provided, it will use the first saved address from the active customer.
+
+___
+
+### `Optional` style
+
+• **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons" | "height"›*
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### `Optional` onAuthorizeError
+
+▸ **onAuthorizeError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
+
+A callback that gets called if unable to authorize and tokenize payment.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
+
+**Returns:** *void*
+
+___
+
+### `Optional` onError
+
+▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
+
+A callback that gets called on any error instead of submit payment or authorization errors.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
+
+**Returns:** *void*
+
+___
+
+### `Optional` onPaymentError
+
+▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
+
+A callback that gets called if unable to submit payment.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
+
+**Returns:** *void*

package/docs/interfaces/{braintreepaypalbuttoninitializeoptions.md → braintreepaypalv1buttoninitializeoptions.md}

@@ -1,24 +1,25 @@
-[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalButtonInitializeOptions](braintreepaypalbuttoninitializeoptions.md)
+[@bigcommerce/checkout-sdk](../README.md) › [BraintreePaypalV1ButtonInitializeOptions](braintreepaypalv1buttoninitializeoptions.md)
 
-# Interface: BraintreePaypalButtonInitializeOptions
+# Interface: BraintreePaypalV1ButtonInitializeOptions
 
 ## Hierarchy
 
-* **BraintreePaypalButtonInitializeOptions**
+* **BraintreePaypalV1ButtonInitializeOptions**
 
 ## Index
 
 ### Properties
 
-* [allowCredit](braintreepaypalbuttoninitializeoptions.md#optional-allowcredit)
-* [messagingContainerId](braintreepaypalbuttoninitializeoptions.md#optional-messagingcontainerid)
-* [shippingAddress](braintreepaypalbuttoninitializeoptions.md#optional-shippingaddress)
-* [style](braintreepaypalbuttoninitializeoptions.md#optional-style)
+* [allowCredit](braintreepaypalv1buttoninitializeoptions.md#optional-allowcredit)
+* [messagingContainerId](braintreepaypalv1buttoninitializeoptions.md#optional-messagingcontainerid)
+* [shippingAddress](braintreepaypalv1buttoninitializeoptions.md#optional-shippingaddress)
+* [style](braintreepaypalv1buttoninitializeoptions.md#optional-style)
 
 ### Methods
 
-* [onAuthorizeError](braintreepaypalbuttoninitializeoptions.md#optional-onauthorizeerror)
-* [onPaymentError](braintreepaypalbuttoninitializeoptions.md#optional-onpaymenterror)
+* [onAuthorizeError](braintreepaypalv1buttoninitializeoptions.md#optional-onauthorizeerror)
+* [onError](braintreepaypalv1buttoninitializeoptions.md#optional-onerror)
+* [onPaymentError](braintreepaypalv1buttoninitializeoptions.md#optional-onpaymenterror)
 
 ## Properties
 
@@ -71,6 +72,22 @@ Name | Type | Description |
 
 ___
 
+### `Optional` onError
+
+▸ **onError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*
+
+A callback that gets called on any error instead of submit payment or authorization errors.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`error` | [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
+
+**Returns:** *void*
+
+___
+
 ### `Optional` onPaymentError
 
 ▸ **onPaymentError**(`error`: [BraintreeError](braintreeerror.md) | [StandardError](../classes/standarderror.md)): *void*

package/docs/interfaces/checkoutbuttoninitializeoptions.md

@@ -20,6 +20,7 @@
 * [applepay](checkoutbuttoninitializeoptions.md#optional-applepay)
 * [braintreepaypal](checkoutbuttoninitializeoptions.md#optional-braintreepaypal)
 * [braintreepaypalcredit](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcredit)
+* [braintreepaypalcreditv2](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcreditv2)
 * [containerId](checkoutbuttoninitializeoptions.md#containerid)
 * [googlepayadyenv2](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv2)
 * [googlepayadyenv3](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv3)
@@ -58,7 +59,7 @@ ___
 
 ### `Optional` braintreepaypal
 
-• **braintreepaypal**? : *[BraintreePaypalButtonInitializeOptions](braintreepaypalbuttoninitializeoptions.md)*
+• **braintreepaypal**? : *[BraintreePaypalV1ButtonInitializeOptions](braintreepaypalv1buttoninitializeoptions.md)*
 
 The options that are required to facilitate Braintree PayPal. They can be
 omitted unless you need to support Braintree PayPal.
@@ -67,7 +68,16 @@ ___
 
 ### `Optional` braintreepaypalcredit
 
-• **braintreepaypalcredit**? : *[BraintreePaypalButtonInitializeOptions](braintreepaypalbuttoninitializeoptions.md)*
+• **braintreepaypalcredit**? : *[BraintreePaypalV1ButtonInitializeOptions](braintreepaypalv1buttoninitializeoptions.md)*
+
+The options that are required to facilitate Braintree Credit. They can be
+omitted unless you need to support Braintree Credit.
+
+___
+
+### `Optional` braintreepaypalcreditv2
+
+• **braintreepaypalcreditv2**? : *[BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)*
 
 The options that are required to facilitate Braintree Credit. They can be
 omitted unless you need to support Braintree Credit.

package/docs/interfaces/orderpaymentrequestbody.md

@@ -37,7 +37,7 @@ ___
 
 ### `Optional` paymentData
 
-• **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)*
+• **paymentData**? : *[OrderPaymentInstrument](../README.md#orderpaymentinstrument)*
 
 An object that contains the details of a credit card, vaulted payment
 instrument or nonce instrument.

package/docs/interfaces/paypalbuttonstyleoptions.md

@@ -23,7 +23,7 @@
 
 ### `Optional` color
 
-• **color**? : *"gold" | "blue" | "silver" | "black"*
+• **color**? : *[PaypalButtonStyleColorOption](../enums/paypalbuttonstylecoloroption.md)*
 
 ___
 
@@ -41,25 +41,25 @@ ___
 
 ### `Optional` label
 
-• **label**? : *"checkout" | "pay" | "buynow" | "paypal" | "credit"*
+• **label**? : *[PaypalButtonStyleLabelOption](../enums/paypalbuttonstylelabeloption.md)*
 
 ___
 
 ### `Optional` layout
 
-• **layout**? : *"horizontal" | "vertical"*
+• **layout**? : *[PaypalButtonStyleLayoutOption](../enums/paypalbuttonstylelayoutoption.md)*
 
 ___
 
 ### `Optional` shape
 
-• **shape**? : *"pill" | "rect"*
+• **shape**? : *[PaypalButtonStyleShapeOption](../enums/paypalbuttonstyleshapeoption.md)*
 
 ___
 
 ### `Optional` size
 
-• **size**? : *"small" | "medium" | "large" | "responsive"*
+• **size**? : *[PaypalButtonStyleSizeOption](../enums/paypalbuttonstylesizeoption.md)*
 
 ___
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.248.2",
+  "version": "1.251.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",