@bigcommerce/checkout-sdk 1.264.0 → 1.265.0

package/docs/enums/CheckoutButtonMethodType.md

@@ -0,0 +1,134 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonMethodType
+
+# Enumeration: CheckoutButtonMethodType
+
+## Table of contents
+
+### Enumeration members
+
+- [AMAZON_PAY_V2](CheckoutButtonMethodType.md#amazon_pay_v2)
+- [APPLEPAY](CheckoutButtonMethodType.md#applepay)
+- [BRAINTREE_PAYPAL](CheckoutButtonMethodType.md#braintree_paypal)
+- [BRAINTREE_PAYPAL_CREDIT](CheckoutButtonMethodType.md#braintree_paypal_credit)
+- [BRAINTREE_VENMO](CheckoutButtonMethodType.md#braintree_venmo)
+- [GOOGLEPAY_ADYENV2](CheckoutButtonMethodType.md#googlepay_adyenv2)
+- [GOOGLEPAY_ADYENV3](CheckoutButtonMethodType.md#googlepay_adyenv3)
+- [GOOGLEPAY_AUTHORIZENET](CheckoutButtonMethodType.md#googlepay_authorizenet)
+- [GOOGLEPAY_BRAINTREE](CheckoutButtonMethodType.md#googlepay_braintree)
+- [GOOGLEPAY_CHECKOUTCOM](CheckoutButtonMethodType.md#googlepay_checkoutcom)
+- [GOOGLEPAY_CYBERSOURCEV2](CheckoutButtonMethodType.md#googlepay_cybersourcev2)
+- [GOOGLEPAY_ORBITAL](CheckoutButtonMethodType.md#googlepay_orbital)
+- [GOOGLEPAY_STRIPE](CheckoutButtonMethodType.md#googlepay_stripe)
+- [GOOGLEPAY_STRIPEUPE](CheckoutButtonMethodType.md#googlepay_stripeupe)
+- [MASTERPASS](CheckoutButtonMethodType.md#masterpass)
+- [PAYPALCOMMERCE](CheckoutButtonMethodType.md#paypalcommerce)
+- [PAYPALCOMMERCE_VENMO](CheckoutButtonMethodType.md#paypalcommerce_venmo)
+- [PAYPALEXPRESS](CheckoutButtonMethodType.md#paypalexpress)
+
+## Enumeration members
+
+### AMAZON\_PAY\_V2
+
+• **AMAZON\_PAY\_V2** = `"amazonpay"`
+
+___
+
+### APPLEPAY
+
+• **APPLEPAY** = `"applepay"`
+
+___
+
+### BRAINTREE\_PAYPAL
+
+• **BRAINTREE\_PAYPAL** = `"braintreepaypal"`
+
+___
+
+### BRAINTREE\_PAYPAL\_CREDIT
+
+• **BRAINTREE\_PAYPAL\_CREDIT** = `"braintreepaypalcredit"`
+
+___
+
+### BRAINTREE\_VENMO
+
+• **BRAINTREE\_VENMO** = `"braintreevenmo"`
+
+___
+
+### GOOGLEPAY\_ADYENV2
+
+• **GOOGLEPAY\_ADYENV2** = `"googlepayadyenv2"`
+
+___
+
+### GOOGLEPAY\_ADYENV3
+
+• **GOOGLEPAY\_ADYENV3** = `"googlepayadyenv3"`
+
+___
+
+### GOOGLEPAY\_AUTHORIZENET
+
+• **GOOGLEPAY\_AUTHORIZENET** = `"googlepayauthorizenet"`
+
+___
+
+### GOOGLEPAY\_BRAINTREE
+
+• **GOOGLEPAY\_BRAINTREE** = `"googlepaybraintree"`
+
+___
+
+### GOOGLEPAY\_CHECKOUTCOM
+
+• **GOOGLEPAY\_CHECKOUTCOM** = `"googlepaycheckoutcom"`
+
+___
+
+### GOOGLEPAY\_CYBERSOURCEV2
+
+• **GOOGLEPAY\_CYBERSOURCEV2** = `"googlepaycybersourcev2"`
+
+___
+
+### GOOGLEPAY\_ORBITAL
+
+• **GOOGLEPAY\_ORBITAL** = `"googlepayorbital"`
+
+___
+
+### GOOGLEPAY\_STRIPE
+
+• **GOOGLEPAY\_STRIPE** = `"googlepaystripe"`
+
+___
+
+### GOOGLEPAY\_STRIPEUPE
+
+• **GOOGLEPAY\_STRIPEUPE** = `"googlepaystripeupe"`
+
+___
+
+### MASTERPASS
+
+• **MASTERPASS** = `"masterpass"`
+
+___
+
+### PAYPALCOMMERCE
+
+• **PAYPALCOMMERCE** = `"paypalcommerce"`
+
+___
+
+### PAYPALCOMMERCE\_VENMO
+
+• **PAYPALCOMMERCE\_VENMO** = `"paypalcommercevenmo"`
+
+___
+
+### PAYPALEXPRESS
+
+• **PAYPALEXPRESS** = `"paypalexpress"`

package/docs/enums/CheckoutIncludes.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / CheckoutIncludes
+
+# Enumeration: CheckoutIncludes
+
+## Table of contents
+
+### Enumeration members
+
+- [AvailableShippingOptions](CheckoutIncludes.md#availableshippingoptions)
+- [DigitalItemsCategoryNames](CheckoutIncludes.md#digitalitemscategorynames)
+- [PhysicalItemsCategoryNames](CheckoutIncludes.md#physicalitemscategorynames)
+
+## Enumeration members
+
+### AvailableShippingOptions
+
+• **AvailableShippingOptions** = `"consignments.availableShippingOptions"`
+
+___
+
+### DigitalItemsCategoryNames
+
+• **DigitalItemsCategoryNames** = `"cart.lineItems.digitalItems.categoryNames"`
+
+___
+
+### PhysicalItemsCategoryNames
+
+• **PhysicalItemsCategoryNames** = `"cart.lineItems.physicalItems.categoryNames"`

package/docs/enums/EmbeddedCheckoutEventType.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / EmbeddedCheckoutEventType
+
+# Enumeration: EmbeddedCheckoutEventType
+
+## Table of contents
+
+### Enumeration members
+
+- [CheckoutComplete](EmbeddedCheckoutEventType.md#checkoutcomplete)
+- [CheckoutError](EmbeddedCheckoutEventType.md#checkouterror)
+- [CheckoutLoaded](EmbeddedCheckoutEventType.md#checkoutloaded)
+- [FrameError](EmbeddedCheckoutEventType.md#frameerror)
+- [FrameLoaded](EmbeddedCheckoutEventType.md#frameloaded)
+- [SignedOut](EmbeddedCheckoutEventType.md#signedout)
+
+## Enumeration members
+
+### CheckoutComplete
+
+• **CheckoutComplete** = `"CHECKOUT_COMPLETE"`
+
+___
+
+### CheckoutError
+
+• **CheckoutError** = `"CHECKOUT_ERROR"`
+
+___
+
+### CheckoutLoaded
+
+• **CheckoutLoaded** = `"CHECKOUT_LOADED"`
+
+___
+
+### FrameError
+
+• **FrameError** = `"FRAME_ERROR"`
+
+___
+
+### FrameLoaded
+
+• **FrameLoaded** = `"FRAME_LOADED"`
+
+___
+
+### SignedOut
+
+• **SignedOut** = `"SIGNED_OUT"`

package/docs/enums/HostedFieldType.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedFieldType
+
+# Enumeration: HostedFieldType
+
+## Table of contents
+
+### Enumeration members
+
+- [CardCode](HostedFieldType.md#cardcode)
+- [CardCodeVerification](HostedFieldType.md#cardcodeverification)
+- [CardExpiry](HostedFieldType.md#cardexpiry)
+- [CardName](HostedFieldType.md#cardname)
+- [CardNumber](HostedFieldType.md#cardnumber)
+- [CardNumberVerification](HostedFieldType.md#cardnumberverification)
+
+## Enumeration members
+
+### CardCode
+
+• **CardCode** = `"cardCode"`
+
+___
+
+### CardCodeVerification
+
+• **CardCodeVerification** = `"cardCodeVerification"`
+
+___
+
+### CardExpiry
+
+• **CardExpiry** = `"cardExpiry"`
+
+___
+
+### CardName
+
+• **CardName** = `"cardName"`
+
+___
+
+### CardNumber
+
+• **CardNumber** = `"cardNumber"`
+
+___
+
+### CardNumberVerification
+
+• **CardNumberVerification** = `"cardNumberVerification"`

package/docs/enums/HostedInputEventType.md

@@ -0,0 +1,85 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputEventType
+
+# Enumeration: HostedInputEventType
+
+## Table of contents
+
+### Enumeration members
+
+- [AttachFailed](HostedInputEventType.md#attachfailed)
+- [AttachSucceeded](HostedInputEventType.md#attachsucceeded)
+- [BinChanged](HostedInputEventType.md#binchanged)
+- [Blurred](HostedInputEventType.md#blurred)
+- [CardTypeChanged](HostedInputEventType.md#cardtypechanged)
+- [Changed](HostedInputEventType.md#changed)
+- [Entered](HostedInputEventType.md#entered)
+- [Focused](HostedInputEventType.md#focused)
+- [SubmitFailed](HostedInputEventType.md#submitfailed)
+- [SubmitSucceeded](HostedInputEventType.md#submitsucceeded)
+- [Validated](HostedInputEventType.md#validated)
+
+## Enumeration members
+
+### AttachFailed
+
+• **AttachFailed** = `"HOSTED_INPUT:ATTACH_FAILED"`
+
+___
+
+### AttachSucceeded
+
+• **AttachSucceeded** = `"HOSTED_INPUT:ATTACH_SUCCEEDED"`
+
+___
+
+### BinChanged
+
+• **BinChanged** = `"HOSTED_INPUT:BIN_CHANGED"`
+
+___
+
+### Blurred
+
+• **Blurred** = `"HOSTED_INPUT:BLURRED"`
+
+___
+
+### CardTypeChanged
+
+• **CardTypeChanged** = `"HOSTED_INPUT:CARD_TYPE_CHANGED"`
+
+___
+
+### Changed
+
+• **Changed** = `"HOSTED_INPUT:CHANGED"`
+
+___
+
+### Entered
+
+• **Entered** = `"HOSTED_INPUT:ENTERED"`
+
+___
+
+### Focused
+
+• **Focused** = `"HOSTED_INPUT:FOCUSED"`
+
+___
+
+### SubmitFailed
+
+• **SubmitFailed** = `"HOSTED_INPUT:SUBMIT_FAILED"`
+
+___
+
+### SubmitSucceeded
+
+• **SubmitSucceeded** = `"HOSTED_INPUT:SUBMIT_SUCCEEDED"`
+
+___
+
+### Validated
+
+• **Validated** = `"HOSTED_INPUT:VALIDATED"`

package/docs/enums/IconStyle.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / IconStyle
+
+# Enumeration: IconStyle
+
+## Table of contents
+
+### Enumeration members
+
+- [Default](IconStyle.md#default)
+- [Solid](IconStyle.md#solid)
+
+## Enumeration members
+
+### Default
+
+• **Default** = `"default"`
+
+___
+
+### Solid
+
+• **Solid** = `"solid"`

package/docs/enums/PaypalButtonStyleColorOption.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalButtonStyleColorOption
+
+# Enumeration: PaypalButtonStyleColorOption
+
+## Table of contents
+
+### 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
+
+# Enumeration: PaypalButtonStyleLabelOption
+
+## Table of contents
+
+### 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
+
+# Enumeration: PaypalButtonStyleLayoutOption
+
+## Table of contents
+
+### 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
+
+# Enumeration: PaypalButtonStyleShapeOption
+
+## Table of contents
+
+### 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
+
+# Enumeration: PaypalButtonStyleSizeOption
+
+## Table of contents
+
+### 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/enums/PaypalCommerceFormFieldType.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldType
+
+# Enumeration: PaypalCommerceFormFieldType
+
+## Table of contents
+
+### Enumeration members
+
+- [CardCode](PaypalCommerceFormFieldType.md#cardcode)
+- [CardCodeVerification](PaypalCommerceFormFieldType.md#cardcodeverification)
+- [CardExpiry](PaypalCommerceFormFieldType.md#cardexpiry)
+- [CardName](PaypalCommerceFormFieldType.md#cardname)
+- [CardNumber](PaypalCommerceFormFieldType.md#cardnumber)
+- [CardNumberVerification](PaypalCommerceFormFieldType.md#cardnumberverification)
+
+## Enumeration members
+
+### CardCode
+
+• **CardCode** = `"cardCode"`
+
+___
+
+### CardCodeVerification
+
+• **CardCodeVerification** = `"cardCodeVerification"`
+
+___
+
+### CardExpiry
+
+• **CardExpiry** = `"cardExpiry"`
+
+___
+
+### CardName
+
+• **CardName** = `"cardName"`
+
+___
+
+### CardNumber
+
+• **CardNumber** = `"cardNumber"`
+
+___
+
+### CardNumberVerification
+
+• **CardNumberVerification** = `"cardNumberVerification"`

package/docs/enums/RadiusUnit.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / RadiusUnit
+
+# Enumeration: RadiusUnit
+
+## Table of contents
+
+### Enumeration members
+
+- [KM](RadiusUnit.md#km)
+- [MI](RadiusUnit.md#mi)
+
+## Enumeration members
+
+### KM
+
+• **KM** = `"KM"`
+
+___
+
+### MI
+
+• **MI** = `"MI"`

package/docs/enums/StyleButtonColor.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / StyleButtonColor
+
+# Enumeration: StyleButtonColor
+
+## Table of contents
+
+### Enumeration members
+
+- [black](StyleButtonColor.md#black)
+- [blue](StyleButtonColor.md#blue)
+- [gold](StyleButtonColor.md#gold)
+- [silver](StyleButtonColor.md#silver)
+- [white](StyleButtonColor.md#white)
+
+## Enumeration members
+
+### black
+
+• **black** = `"black"`
+
+___
+
+### blue
+
+• **blue** = `"blue"`
+
+___
+
+### gold
+
+• **gold** = `"gold"`
+
+___
+
+### silver
+
+• **silver** = `"silver"`
+
+___
+
+### white
+
+• **white** = `"white"`

package/docs/enums/StyleButtonLabel.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / StyleButtonLabel
+
+# Enumeration: StyleButtonLabel
+
+## Table of contents
+
+### Enumeration members
+
+- [buynow](StyleButtonLabel.md#buynow)
+- [checkout](StyleButtonLabel.md#checkout)
+- [installment](StyleButtonLabel.md#installment)
+- [pay](StyleButtonLabel.md#pay)
+- [paypal](StyleButtonLabel.md#paypal)
+
+## Enumeration members
+
+### buynow
+
+• **buynow** = `"buynow"`
+
+___
+
+### checkout
+
+• **checkout** = `"checkout"`
+
+___
+
+### installment
+
+• **installment** = `"installment"`
+
+___
+
+### pay
+
+• **pay** = `"pay"`
+
+___
+
+### paypal
+
+• **paypal** = `"paypal"`