@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/enums/internal_.PaypalButtonStyleLabelOption.md

@@ -1,45 +0,0 @@
-[@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

@@ -1,24 +0,0 @@
-[@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

@@ -1,24 +0,0 @@
-[@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

@@ -1,38 +0,0 @@
-[@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

@@ -1,45 +0,0 @@
-[@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

@@ -1,45 +0,0 @@
-[@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

@@ -1,24 +0,0 @@
-[@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

@@ -1,24 +0,0 @@
-[@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_.AmazonPayV2ButtonConfig.md

@@ -1,82 +0,0 @@
-[@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

@@ -1,117 +0,0 @@
-[@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)

package/docs/interfaces/internal_.AmazonPayV2CheckoutSession.md

@@ -1,37 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2CheckoutSession
-
-# Interface: AmazonPayV2CheckoutSession
-
-[<internal>](../modules/internal_.md).AmazonPayV2CheckoutSession
-
-## Table of contents
-
-### Properties
-
-- [extractAmazonCheckoutSessionId](internal_.AmazonPayV2CheckoutSession.md#extractamazoncheckoutsessionid)
-- [method](internal_.AmazonPayV2CheckoutSession.md#method)
-- [url](internal_.AmazonPayV2CheckoutSession.md#url)
-
-## Properties
-
-### extractAmazonCheckoutSessionId
-
-• `Optional` **extractAmazonCheckoutSessionId**: `string`
-
-Checkout Session ID parameter in the response. Default is 'checkoutSessionId'.
-
-___
-
-### method
-
-• `Optional` **method**: ``"GET"`` \| ``"POST"``
-
-HTTP request method. Default is 'POST'.
-
-___
-
-### url
-
-• **url**: `string`
-
-Endpoint URL to Create Checkout Session.

package/docs/interfaces/internal_.AmazonPayV2CheckoutSessionConfig.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2CheckoutSessionConfig
-
-# Interface: AmazonPayV2CheckoutSessionConfig
-
-[<internal>](../modules/internal_.md).AmazonPayV2CheckoutSessionConfig
-
-## Table of contents
-
-### Properties
-
-- [payloadJSON](internal_.AmazonPayV2CheckoutSessionConfig.md#payloadjson)
-- [publicKeyId](internal_.AmazonPayV2CheckoutSessionConfig.md#publickeyid)
-- [signature](internal_.AmazonPayV2CheckoutSessionConfig.md#signature)
-
-## Properties
-
-### payloadJSON
-
-• **payloadJSON**: `string`
-
-A payload that Amazon Pay will use to create a Checkout Session object.
-
-___
-
-### publicKeyId
-
-• `Optional` **publicKeyId**: `string`
-
-Credential provided by Amazon Pay. You do not have to set this parameter
-if your `publicKeyId` has an environment prefix.
-
-___
-
-### signature
-
-• **signature**: `string`
-
-Payload's signature.

package/docs/interfaces/internal_.AmazonPayV2NewButtonParams.md

@@ -1,139 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2NewButtonParams
-
-# Interface: AmazonPayV2NewButtonParams
-
-[<internal>](../modules/internal_.md).AmazonPayV2NewButtonParams
-
-## Hierarchy
-
-- [`AmazonPayV2ButtonConfig`](internal_.AmazonPayV2ButtonConfig.md)
-
-  ↳ **`AmazonPayV2NewButtonParams`**
-
-## Table of contents
-
-### Properties
-
-- [buttonColor](internal_.AmazonPayV2NewButtonParams.md#buttoncolor)
-- [checkoutLanguage](internal_.AmazonPayV2NewButtonParams.md#checkoutlanguage)
-- [createCheckoutSessionConfig](internal_.AmazonPayV2NewButtonParams.md#createcheckoutsessionconfig)
-- [estimatedOrderAmount](internal_.AmazonPayV2NewButtonParams.md#estimatedorderamount)
-- [ledgerCurrency](internal_.AmazonPayV2NewButtonParams.md#ledgercurrency)
-- [merchantId](internal_.AmazonPayV2NewButtonParams.md#merchantid)
-- [placement](internal_.AmazonPayV2NewButtonParams.md#placement)
-- [productType](internal_.AmazonPayV2NewButtonParams.md#producttype)
-- [publicKeyId](internal_.AmazonPayV2NewButtonParams.md#publickeyid)
-- [sandbox](internal_.AmazonPayV2NewButtonParams.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)
-
-___
-
-### createCheckoutSessionConfig
-
-• `Optional` **createCheckoutSessionConfig**: [`AmazonPayV2CheckoutSessionConfig`](internal_.AmazonPayV2CheckoutSessionConfig.md)
-
-Create Checkout Session configuration.
-
-___
-
-### estimatedOrderAmount
-
-• `Optional` **estimatedOrderAmount**: [`AmazonPayV2Price`](internal_.AmazonPayV2Price.md)
-
-It does not have to match the final order amount if the buyer updates
-their order after starting checkout. Amazon Pay will use this value to
-assess transaction risk and prevent buyers from selecting payment methods
-that can't be used to process the order.
-
-___
-
-### 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)
-
-___
-
-### publicKeyId
-
-• `Optional` **publicKeyId**: `string`
-
-Credential provided by Amazon Pay. You must also set the `sandbox`
-parameter if your `publicKeyId` does not have an environment prefix.
-
-___
-
-### 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)