@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/enums/internal_.CheckoutButtonMethodType.md

@@ -0,0 +1,164 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutButtonMethodType
+
+# Enumeration: CheckoutButtonMethodType
+
+[<internal>](../modules/internal_.md).CheckoutButtonMethodType
+
+## Table of contents
+
+### Enumeration Members
+
+- [AMAZON\_PAY\_V2](internal_.CheckoutButtonMethodType.md#amazon_pay_v2)
+- [APPLEPAY](internal_.CheckoutButtonMethodType.md#applepay)
+- [BRAINTREE\_PAYPAL](internal_.CheckoutButtonMethodType.md#braintree_paypal)
+- [BRAINTREE\_PAYPAL\_CREDIT](internal_.CheckoutButtonMethodType.md#braintree_paypal_credit)
+- [BRAINTREE\_VENMO](internal_.CheckoutButtonMethodType.md#braintree_venmo)
+- [GOOGLEPAY\_ADYENV2](internal_.CheckoutButtonMethodType.md#googlepay_adyenv2)
+- [GOOGLEPAY\_ADYENV3](internal_.CheckoutButtonMethodType.md#googlepay_adyenv3)
+- [GOOGLEPAY\_AUTHORIZENET](internal_.CheckoutButtonMethodType.md#googlepay_authorizenet)
+- [GOOGLEPAY\_BNZ](internal_.CheckoutButtonMethodType.md#googlepay_bnz)
+- [GOOGLEPAY\_BRAINTREE](internal_.CheckoutButtonMethodType.md#googlepay_braintree)
+- [GOOGLEPAY\_CHECKOUTCOM](internal_.CheckoutButtonMethodType.md#googlepay_checkoutcom)
+- [GOOGLEPAY\_CYBERSOURCEV2](internal_.CheckoutButtonMethodType.md#googlepay_cybersourcev2)
+- [GOOGLEPAY\_ORBITAL](internal_.CheckoutButtonMethodType.md#googlepay_orbital)
+- [GOOGLEPAY\_STRIPE](internal_.CheckoutButtonMethodType.md#googlepay_stripe)
+- [GOOGLEPAY\_STRIPEUPE](internal_.CheckoutButtonMethodType.md#googlepay_stripeupe)
+- [MASTERPASS](internal_.CheckoutButtonMethodType.md#masterpass)
+- [PAYPALCOMMERCE](internal_.CheckoutButtonMethodType.md#paypalcommerce)
+- [PAYPALCOMMERCE\_APMS](internal_.CheckoutButtonMethodType.md#paypalcommerce_apms)
+- [PAYPALCOMMERCE\_CREDIT](internal_.CheckoutButtonMethodType.md#paypalcommerce_credit)
+- [PAYPALCOMMERCE\_INLINE](internal_.CheckoutButtonMethodType.md#paypalcommerce_inline)
+- [PAYPALCOMMERCE\_VENMO](internal_.CheckoutButtonMethodType.md#paypalcommerce_venmo)
+- [PAYPALEXPRESS](internal_.CheckoutButtonMethodType.md#paypalexpress)
+
+## Enumeration Members
+
+### AMAZON\_PAY\_V2
+
+• **AMAZON\_PAY\_V2**
+
+___
+
+### APPLEPAY
+
+• **APPLEPAY**
+
+___
+
+### BRAINTREE\_PAYPAL
+
+• **BRAINTREE\_PAYPAL**
+
+___
+
+### BRAINTREE\_PAYPAL\_CREDIT
+
+• **BRAINTREE\_PAYPAL\_CREDIT**
+
+___
+
+### BRAINTREE\_VENMO
+
+• **BRAINTREE\_VENMO**
+
+___
+
+### GOOGLEPAY\_ADYENV2
+
+• **GOOGLEPAY\_ADYENV2**
+
+___
+
+### GOOGLEPAY\_ADYENV3
+
+• **GOOGLEPAY\_ADYENV3**
+
+___
+
+### GOOGLEPAY\_AUTHORIZENET
+
+• **GOOGLEPAY\_AUTHORIZENET**
+
+___
+
+### GOOGLEPAY\_BNZ
+
+• **GOOGLEPAY\_BNZ**
+
+___
+
+### GOOGLEPAY\_BRAINTREE
+
+• **GOOGLEPAY\_BRAINTREE**
+
+___
+
+### GOOGLEPAY\_CHECKOUTCOM
+
+• **GOOGLEPAY\_CHECKOUTCOM**
+
+___
+
+### GOOGLEPAY\_CYBERSOURCEV2
+
+• **GOOGLEPAY\_CYBERSOURCEV2**
+
+___
+
+### GOOGLEPAY\_ORBITAL
+
+• **GOOGLEPAY\_ORBITAL**
+
+___
+
+### GOOGLEPAY\_STRIPE
+
+• **GOOGLEPAY\_STRIPE**
+
+___
+
+### GOOGLEPAY\_STRIPEUPE
+
+• **GOOGLEPAY\_STRIPEUPE**
+
+___
+
+### MASTERPASS
+
+• **MASTERPASS**
+
+___
+
+### PAYPALCOMMERCE
+
+• **PAYPALCOMMERCE**
+
+___
+
+### PAYPALCOMMERCE\_APMS
+
+• **PAYPALCOMMERCE\_APMS**
+
+___
+
+### PAYPALCOMMERCE\_CREDIT
+
+• **PAYPALCOMMERCE\_CREDIT**
+
+___
+
+### PAYPALCOMMERCE\_INLINE
+
+• **PAYPALCOMMERCE\_INLINE**
+
+___
+
+### PAYPALCOMMERCE\_VENMO
+
+• **PAYPALCOMMERCE\_VENMO**
+
+___
+
+### PAYPALEXPRESS
+
+• **PAYPALEXPRESS**

package/docs/enums/internal_.PaypalButtonStyleColorOption.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleColorOption
+
+# Enumeration: PaypalButtonStyleColorOption
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleColorOption
+
+## Table of contents
+
+### Enumeration Members
+
+- [BLACK](internal_.PaypalButtonStyleColorOption.md#black)
+- [BLUE](internal_.PaypalButtonStyleColorOption.md#blue)
+- [GOLD](internal_.PaypalButtonStyleColorOption.md#gold)
+- [SIlVER](internal_.PaypalButtonStyleColorOption.md#silver)
+
+## Enumeration Members
+
+### BLACK
+
+• **BLACK**
+
+___
+
+### BLUE
+
+• **BLUE**
+
+___
+
+### GOLD
+
+• **GOLD**
+
+___
+
+### SIlVER
+
+• **SIlVER**

package/docs/enums/internal_.PaypalButtonStyleLabelOption.md

@@ -0,0 +1,45 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleLabelOption
+
+# Enumeration: PaypalButtonStyleLabelOption
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleLabelOption
+
+## Table of contents
+
+### Enumeration Members
+
+- [BUYNOW](internal_.PaypalButtonStyleLabelOption.md#buynow)
+- [CHECKOUT](internal_.PaypalButtonStyleLabelOption.md#checkout)
+- [CREDIT](internal_.PaypalButtonStyleLabelOption.md#credit)
+- [PAY](internal_.PaypalButtonStyleLabelOption.md#pay)
+- [PAYPAL](internal_.PaypalButtonStyleLabelOption.md#paypal)
+
+## Enumeration Members
+
+### BUYNOW
+
+• **BUYNOW**
+
+___
+
+### CHECKOUT
+
+• **CHECKOUT**
+
+___
+
+### CREDIT
+
+• **CREDIT**
+
+___
+
+### PAY
+
+• **PAY**
+
+___
+
+### PAYPAL
+
+• **PAYPAL**

package/docs/enums/internal_.PaypalButtonStyleLayoutOption.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleLayoutOption
+
+# Enumeration: PaypalButtonStyleLayoutOption
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleLayoutOption
+
+## Table of contents
+
+### Enumeration Members
+
+- [HORIZONTAL](internal_.PaypalButtonStyleLayoutOption.md#horizontal)
+- [VERTICAL](internal_.PaypalButtonStyleLayoutOption.md#vertical)
+
+## Enumeration Members
+
+### HORIZONTAL
+
+• **HORIZONTAL**
+
+___
+
+### VERTICAL
+
+• **VERTICAL**

package/docs/enums/internal_.PaypalButtonStyleShapeOption.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleShapeOption
+
+# Enumeration: PaypalButtonStyleShapeOption
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleShapeOption
+
+## Table of contents
+
+### Enumeration Members
+
+- [PILL](internal_.PaypalButtonStyleShapeOption.md#pill)
+- [RECT](internal_.PaypalButtonStyleShapeOption.md#rect)
+
+## Enumeration Members
+
+### PILL
+
+• **PILL**
+
+___
+
+### RECT
+
+• **RECT**

package/docs/enums/internal_.PaypalButtonStyleSizeOption.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalButtonStyleSizeOption
+
+# Enumeration: PaypalButtonStyleSizeOption
+
+[<internal>](../modules/internal_.md).PaypalButtonStyleSizeOption
+
+## Table of contents
+
+### Enumeration Members
+
+- [LARGE](internal_.PaypalButtonStyleSizeOption.md#large)
+- [MEDIUM](internal_.PaypalButtonStyleSizeOption.md#medium)
+- [RESPONSIVE](internal_.PaypalButtonStyleSizeOption.md#responsive)
+- [SMALL](internal_.PaypalButtonStyleSizeOption.md#small)
+
+## Enumeration Members
+
+### LARGE
+
+• **LARGE**
+
+___
+
+### MEDIUM
+
+• **MEDIUM**
+
+___
+
+### RESPONSIVE
+
+• **RESPONSIVE**
+
+___
+
+### SMALL
+
+• **SMALL**

package/docs/enums/internal_.StyleButtonColor.md

@@ -0,0 +1,45 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleButtonColor
+
+# Enumeration: StyleButtonColor
+
+[<internal>](../modules/internal_.md).StyleButtonColor
+
+## Table of contents
+
+### Enumeration Members
+
+- [black](internal_.StyleButtonColor.md#black)
+- [blue](internal_.StyleButtonColor.md#blue)
+- [gold](internal_.StyleButtonColor.md#gold)
+- [silver](internal_.StyleButtonColor.md#silver)
+- [white](internal_.StyleButtonColor.md#white)
+
+## Enumeration Members
+
+### black
+
+• **black**
+
+___
+
+### blue
+
+• **blue**
+
+___
+
+### gold
+
+• **gold**
+
+___
+
+### silver
+
+• **silver**
+
+___
+
+### white
+
+• **white**

package/docs/enums/internal_.StyleButtonLabel.md

@@ -0,0 +1,45 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleButtonLabel
+
+# Enumeration: StyleButtonLabel
+
+[<internal>](../modules/internal_.md).StyleButtonLabel
+
+## Table of contents
+
+### Enumeration Members
+
+- [buynow](internal_.StyleButtonLabel.md#buynow)
+- [checkout](internal_.StyleButtonLabel.md#checkout)
+- [installment](internal_.StyleButtonLabel.md#installment)
+- [pay](internal_.StyleButtonLabel.md#pay)
+- [paypal](internal_.StyleButtonLabel.md#paypal)
+
+## Enumeration Members
+
+### buynow
+
+• **buynow**
+
+___
+
+### checkout
+
+• **checkout**
+
+___
+
+### installment
+
+• **installment**
+
+___
+
+### pay
+
+• **pay**
+
+___
+
+### paypal
+
+• **paypal**

package/docs/enums/internal_.StyleButtonLayout.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleButtonLayout
+
+# Enumeration: StyleButtonLayout
+
+[<internal>](../modules/internal_.md).StyleButtonLayout
+
+## Table of contents
+
+### Enumeration Members
+
+- [horizontal](internal_.StyleButtonLayout.md#horizontal)
+- [vertical](internal_.StyleButtonLayout.md#vertical)
+
+## Enumeration Members
+
+### horizontal
+
+• **horizontal**
+
+___
+
+### vertical
+
+• **vertical**

package/docs/enums/internal_.StyleButtonShape.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleButtonShape
+
+# Enumeration: StyleButtonShape
+
+[<internal>](../modules/internal_.md).StyleButtonShape
+
+## Table of contents
+
+### Enumeration Members
+
+- [pill](internal_.StyleButtonShape.md#pill)
+- [rect](internal_.StyleButtonShape.md#rect)
+
+## Enumeration Members
+
+### pill
+
+• **pill**
+
+___
+
+### rect
+
+• **rect**

package/docs/interfaces/internal_.Address.md

@@ -10,10 +10,6 @@
 
   ↳ **`Address`**
 
-  ↳↳ [`BillingAddress`](internal_.BillingAddress.md)
-
-  ↳↳ [`CustomerAddress`](internal_.CustomerAddress.md)
-
 ## Table of contents
 
 ### Properties

package/docs/interfaces/internal_.AddressRequestBody.md

@@ -8,8 +8,6 @@
 
 - **`AddressRequestBody`**
 
-  ↳ [`BillingAddressRequestBody`](internal_.BillingAddressRequestBody.md)
-
   ↳ [`Address`](internal_.Address.md)
 
 ## Table of contents

package/docs/interfaces/internal_.AmazonPayV2ButtonConfig.md

@@ -0,0 +1,82 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2ButtonConfig
+
+# Interface: AmazonPayV2ButtonConfig
+
+[<internal>](../modules/internal_.md).AmazonPayV2ButtonConfig
+
+## Hierarchy
+
+- **`AmazonPayV2ButtonConfig`**
+
+  ↳ [`AmazonPayV2ButtonParams`](internal_.AmazonPayV2ButtonParams.md)
+
+  ↳ [`AmazonPayV2NewButtonParams`](internal_.AmazonPayV2NewButtonParams.md)
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](internal_.AmazonPayV2ButtonConfig.md#buttoncolor)
+- [checkoutLanguage](internal_.AmazonPayV2ButtonConfig.md#checkoutlanguage)
+- [ledgerCurrency](internal_.AmazonPayV2ButtonConfig.md#ledgercurrency)
+- [merchantId](internal_.AmazonPayV2ButtonConfig.md#merchantid)
+- [placement](internal_.AmazonPayV2ButtonConfig.md#placement)
+- [productType](internal_.AmazonPayV2ButtonConfig.md#producttype)
+- [sandbox](internal_.AmazonPayV2ButtonConfig.md#sandbox)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`AmazonPayV2ButtonColor`](../enums/internal_.AmazonPayV2ButtonColor.md)
+
+Color of the Amazon Pay button.
+
+___
+
+### checkoutLanguage
+
+• `Optional` **checkoutLanguage**: [`AmazonPayV2CheckoutLanguage`](../enums/internal_.AmazonPayV2CheckoutLanguage.md)
+
+Language used to render the button and text on Amazon Pay hosted pages.
+
+___
+
+### ledgerCurrency
+
+• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/internal_.AmazonPayV2LedgerCurrency.md)
+
+Ledger currency provided during registration for the given merchant identifier.
+
+___
+
+### merchantId
+
+• **merchantId**: `string`
+
+Amazon Pay merchant account identifier.
+
+___
+
+### placement
+
+• **placement**: [`AmazonPayV2Placement`](../enums/internal_.AmazonPayV2Placement.md)
+
+Placement of the Amazon Pay button on your website.
+
+___
+
+### productType
+
+• `Optional` **productType**: [`AmazonPayV2PayOptions`](../enums/internal_.AmazonPayV2PayOptions.md)
+
+Product type selected for checkout. Default is 'PayAndShip'.
+
+___
+
+### sandbox
+
+• `Optional` **sandbox**: `boolean`
+
+Sets button to Sandbox environment. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix. Default is false.

package/docs/interfaces/internal_.AmazonPayV2ButtonParams.md

@@ -0,0 +1,117 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2ButtonParams
+
+# Interface: AmazonPayV2ButtonParams
+
+[<internal>](../modules/internal_.md).AmazonPayV2ButtonParams
+
+## Hierarchy
+
+- [`AmazonPayV2ButtonConfig`](internal_.AmazonPayV2ButtonConfig.md)
+
+  ↳ **`AmazonPayV2ButtonParams`**
+
+## Table of contents
+
+### Properties
+
+- [buttonColor](internal_.AmazonPayV2ButtonParams.md#buttoncolor)
+- [checkoutLanguage](internal_.AmazonPayV2ButtonParams.md#checkoutlanguage)
+- [createCheckoutSession](internal_.AmazonPayV2ButtonParams.md#createcheckoutsession)
+- [ledgerCurrency](internal_.AmazonPayV2ButtonParams.md#ledgercurrency)
+- [merchantId](internal_.AmazonPayV2ButtonParams.md#merchantid)
+- [placement](internal_.AmazonPayV2ButtonParams.md#placement)
+- [productType](internal_.AmazonPayV2ButtonParams.md#producttype)
+- [sandbox](internal_.AmazonPayV2ButtonParams.md#sandbox)
+
+## Properties
+
+### buttonColor
+
+• `Optional` **buttonColor**: [`AmazonPayV2ButtonColor`](../enums/internal_.AmazonPayV2ButtonColor.md)
+
+Color of the Amazon Pay button.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[buttonColor](internal_.AmazonPayV2ButtonConfig.md#buttoncolor)
+
+___
+
+### checkoutLanguage
+
+• `Optional` **checkoutLanguage**: [`AmazonPayV2CheckoutLanguage`](../enums/internal_.AmazonPayV2CheckoutLanguage.md)
+
+Language used to render the button and text on Amazon Pay hosted pages.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[checkoutLanguage](internal_.AmazonPayV2ButtonConfig.md#checkoutlanguage)
+
+___
+
+### createCheckoutSession
+
+• **createCheckoutSession**: [`AmazonPayV2CheckoutSession`](internal_.AmazonPayV2CheckoutSession.md)
+
+Configuration for calling the endpoint to Create Checkout Session.
+
+___
+
+### ledgerCurrency
+
+• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/internal_.AmazonPayV2LedgerCurrency.md)
+
+Ledger currency provided during registration for the given merchant identifier.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[ledgerCurrency](internal_.AmazonPayV2ButtonConfig.md#ledgercurrency)
+
+___
+
+### merchantId
+
+• **merchantId**: `string`
+
+Amazon Pay merchant account identifier.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[merchantId](internal_.AmazonPayV2ButtonConfig.md#merchantid)
+
+___
+
+### placement
+
+• **placement**: [`AmazonPayV2Placement`](../enums/internal_.AmazonPayV2Placement.md)
+
+Placement of the Amazon Pay button on your website.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[placement](internal_.AmazonPayV2ButtonConfig.md#placement)
+
+___
+
+### productType
+
+• `Optional` **productType**: [`AmazonPayV2PayOptions`](../enums/internal_.AmazonPayV2PayOptions.md)
+
+Product type selected for checkout. Default is 'PayAndShip'.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[productType](internal_.AmazonPayV2ButtonConfig.md#producttype)
+
+___
+
+### sandbox
+
+• `Optional` **sandbox**: `boolean`
+
+Sets button to Sandbox environment. You do not have to set this parameter
+if your `publicKeyId` has an environment prefix. Default is false.
+
+#### Inherited from
+
+[AmazonPayV2ButtonConfig](internal_.AmazonPayV2ButtonConfig.md).[sandbox](internal_.AmazonPayV2ButtonConfig.md#sandbox)