@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.AmazonPayV2CheckoutSession.md

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

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

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

package/docs/interfaces/internal_.AmazonPayV2Price.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / AmazonPayV2Price
+
+# Interface: AmazonPayV2Price
+
+[<internal>](../modules/internal_.md).AmazonPayV2Price
+
+## Table of contents
+
+### Properties
+
+- [amount](internal_.AmazonPayV2Price.md#amount)
+- [currencyCode](internal_.AmazonPayV2Price.md#currencycode)
+
+## Properties
+
+### amount
+
+• **amount**: `string`
+
+Transaction amount.
+
+___
+
+### currencyCode
+
+• **currencyCode**: `string`
+
+Transaction currency code in ISO 4217 format. Example: USD.

package/docs/interfaces/internal_.ApplePayButtonInitializeOptions.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ApplePayButtonInitializeOptions
+
+# Interface: ApplePayButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).ApplePayButtonInitializeOptions
+
+A set of options that are required to initialize ApplePay in cart.
+
+When ApplePay is initialized, an ApplePay button will be inserted into the
+DOM. When a customer clicks on it, it will trigger Apple sheet.
+
+## Table of contents
+
+### Properties
+
+- [buttonClassName](internal_.ApplePayButtonInitializeOptions.md#buttonclassname)
+
+### Methods
+
+- [onPaymentAuthorize](internal_.ApplePayButtonInitializeOptions.md#onpaymentauthorize)
+
+## Properties
+
+### buttonClassName
+
+• `Optional` **buttonClassName**: `string`
+
+The class name of the ApplePay button style.
+
+## Methods
+
+### onPaymentAuthorize
+
+▸ **onPaymentAuthorize**(): `void`
+
+A callback that gets called when a payment is successfully completed.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.ApplePayButtonInitializeOptions_2.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ApplePayButtonInitializeOptions\_2
+
+# Interface: ApplePayButtonInitializeOptions\_2
+
+[<internal>](../modules/internal_.md).ApplePayButtonInitializeOptions_2
+
+A set of options that are required to initialize ApplePay in cart.
+
+When ApplePay is initialized, an ApplePay button will be inserted into the
+DOM. When a customer clicks on it, it will trigger Apple sheet.
+
+## Table of contents
+
+### Properties
+
+- [buttonClassName](internal_.ApplePayButtonInitializeOptions_2.md#buttonclassname)
+
+### Methods
+
+- [onPaymentAuthorize](internal_.ApplePayButtonInitializeOptions_2.md#onpaymentauthorize)
+
+## Properties
+
+### buttonClassName
+
+• `Optional` **buttonClassName**: `string`
+
+The class name of the ApplePay button style.
+
+## Methods
+
+### onPaymentAuthorize
+
+▸ **onPaymentAuthorize**(): `void`
+
+A callback that gets called when a payment is successfully completed.
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.BaseCheckoutButtonInitializeOptions.md

@@ -0,0 +1,291 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BaseCheckoutButtonInitializeOptions
+
+# Interface: BaseCheckoutButtonInitializeOptions
+
+[<internal>](../modules/internal_.md).BaseCheckoutButtonInitializeOptions
+
+The set of options for configuring the checkout button.
+
+## Hierarchy
+
+- [`CheckoutButtonOptions`](internal_.CheckoutButtonOptions.md)
+
+  ↳ **`BaseCheckoutButtonInitializeOptions`**
+
+## Indexable
+
+▪ [key: `string`]: `unknown`
+
+## Table of contents
+
+### Properties
+
+- [amazonpay](internal_.BaseCheckoutButtonInitializeOptions.md#amazonpay)
+- [applepay](internal_.BaseCheckoutButtonInitializeOptions.md#applepay)
+- [braintreepaypal](internal_.BaseCheckoutButtonInitializeOptions.md#braintreepaypal)
+- [braintreepaypalcredit](internal_.BaseCheckoutButtonInitializeOptions.md#braintreepaypalcredit)
+- [braintreevenmo](internal_.BaseCheckoutButtonInitializeOptions.md#braintreevenmo)
+- [containerId](internal_.BaseCheckoutButtonInitializeOptions.md#containerid)
+- [currencyCode](internal_.BaseCheckoutButtonInitializeOptions.md#currencycode)
+- [googlepayadyenv2](internal_.BaseCheckoutButtonInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](internal_.BaseCheckoutButtonInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](internal_.BaseCheckoutButtonInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybnz](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaybnz)
+- [googlepaybraintree](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](internal_.BaseCheckoutButtonInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](internal_.BaseCheckoutButtonInitializeOptions.md#googlepaystripeupe)
+- [methodId](internal_.BaseCheckoutButtonInitializeOptions.md#methodid)
+- [params](internal_.BaseCheckoutButtonInitializeOptions.md#params)
+- [paypal](internal_.BaseCheckoutButtonInitializeOptions.md#paypal)
+- [paypalcommerce](internal_.BaseCheckoutButtonInitializeOptions.md#paypalcommerce)
+- [paypalcommercealternativemethods](internal_.BaseCheckoutButtonInitializeOptions.md#paypalcommercealternativemethods)
+- [paypalcommercecredit](internal_.BaseCheckoutButtonInitializeOptions.md#paypalcommercecredit)
+- [paypalcommerceinline](internal_.BaseCheckoutButtonInitializeOptions.md#paypalcommerceinline)
+- [paypalcommercevenmo](internal_.BaseCheckoutButtonInitializeOptions.md#paypalcommercevenmo)
+- [timeout](internal_.BaseCheckoutButtonInitializeOptions.md#timeout)
+
+## Properties
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2ButtonParameters`](../modules/internal_.md#amazonpayv2buttonparameters)
+
+The options that are required to facilitate AmazonPayV2. They can be
+omitted unless you need to support AmazonPayV2.
+
+___
+
+### applepay
+
+• `Optional` **applepay**: [`ApplePayButtonInitializeOptions`](internal_.ApplePayButtonInitializeOptions.md)
+
+The options that are required to initialize the ApplePay payment method.
+They can be omitted unless you need to support ApplePay in cart.
+
+___
+
+### braintreepaypal
+
+• `Optional` **braintreepaypal**: [`BraintreePaypalButtonInitializeOptions`](internal_.BraintreePaypalButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree PayPal. They can be
+omitted unless you need to support Braintree PayPal.
+
+___
+
+### braintreepaypalcredit
+
+• `Optional` **braintreepaypalcredit**: [`BraintreePaypalCreditButtonInitializeOptions`](internal_.BraintreePaypalCreditButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree Credit. They can be
+omitted unless you need to support Braintree Credit.
+
+___
+
+### braintreevenmo
+
+• `Optional` **braintreevenmo**: [`BraintreeVenmoButtonInitializeOptions`](internal_.BraintreeVenmoButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree Venmo. They can be
+omitted unless you need to support Braintree Venmo.
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container which the checkout button should be inserted.
+
+___
+
+### currencyCode
+
+• `Optional` **currencyCode**: `string`
+
+The option that is required to load payment method configuration for provided currency code in Buy Now flow.
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **googlepayadyenv2**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support adyenv2 GooglePay.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **googlepayadyenv3**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support adyenv2 GooglePay.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **googlepayauthorizenet**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Authorize.Net GooglePay.
+They can be omitted unless you need to support Authorize.Net GooglePay.
+
+___
+
+### googlepaybnz
+
+• `Optional` **googlepaybnz**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate BNZ GooglePay. They can be
+omitted unless you need to support BNZ GooglePay.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **googlepaybraintree**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Braintree GooglePay. They can be
+omitted unless you need to support Braintree GooglePay.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **googlepaycheckoutcom**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Checkout.com GooglePay. They can be
+omitted unless you need to support Checkout.com GooglePay.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **googlepaycybersourcev2**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate CybersourceV2 GooglePay. They can be
+omitted unless you need to support CybersourceV2 GooglePay.
+
+___
+
+### googlepayorbital
+
+• `Optional` **googlepayorbital**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Orbital GooglePay. They can be
+omitted unless you need to support Orbital GooglePay.
+
+___
+
+### googlepaystripe
+
+• `Optional` **googlepaystripe**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Stripe GooglePay. They can be
+omitted unless you need to support Stripe GooglePay.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **googlepaystripeupe**: [`GooglePayButtonInitializeOptions`](internal_.GooglePayButtonInitializeOptions.md)
+
+The options that are required to facilitate Stripe GooglePay. They can be
+omitted unless you need to support Stripe GooglePay.
+
+___
+
+### methodId
+
+• **methodId**: [`CheckoutButtonMethodType`](../enums/internal_.CheckoutButtonMethodType.md)
+
+The identifier of the payment method.
+
+#### Inherited from
+
+[CheckoutButtonOptions](internal_.CheckoutButtonOptions.md).[methodId](internal_.CheckoutButtonOptions.md#methodid)
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[CheckoutButtonOptions](internal_.CheckoutButtonOptions.md).[params](internal_.CheckoutButtonOptions.md#params)
+
+___
+
+### paypal
+
+• `Optional` **paypal**: [`PaypalButtonInitializeOptions`](internal_.PaypalButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal. They can be omitted
+unless you need to support Paypal.
+
+___
+
+### paypalcommerce
+
+• `Optional` **paypalcommerce**: [`PaypalCommerceButtonInitializeOptions`](internal_.PaypalCommerceButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce V2. They can be omitted
+unless you need to support Paypal Commerce.
+
+___
+
+### paypalcommercealternativemethods
+
+• `Optional` **paypalcommercealternativemethods**: [`PaypalCommerceAlternativeMethodsButtonOptions`](internal_.PaypalCommerceAlternativeMethodsButtonOptions.md)
+
+The options that are required to facilitate PayPal Commerce. They can be omitted
+unless you need to support PayPal Commerce Alternative Payment Methods.
+
+___
+
+### paypalcommercecredit
+
+• `Optional` **paypalcommercecredit**: [`PaypalCommerceCreditButtonInitializeOptions`](internal_.PaypalCommerceCreditButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce. They can be omitted
+unless you need to support PayPal Commerce Credit / PayLater.
+
+___
+
+### paypalcommerceinline
+
+• `Optional` **paypalcommerceinline**: [`PaypalCommerceInlineCheckoutButtonInitializeOptions`](internal_.PaypalCommerceInlineCheckoutButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce Inline Checkout. They can be omitted
+unless you need to support PayPal Commerce Inline(Accelerated) Checkout.
+
+___
+
+### paypalcommercevenmo
+
+• `Optional` **paypalcommercevenmo**: [`PaypalCommerceVenmoButtonInitializeOptions`](internal_.PaypalCommerceVenmoButtonInitializeOptions.md)
+
+The options that are required to facilitate PayPal Commerce Venmo. They can be omitted
+unless you need to support PayPal Commerce Venmo.
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `default`
+
+Provide this option if you want to cancel or time out the request. If the
+timeout object completes before the request, the request will be
+cancelled.
+
+#### Inherited from
+
+[CheckoutButtonOptions](internal_.CheckoutButtonOptions.md).[timeout](internal_.CheckoutButtonOptions.md#timeout)

package/docs/interfaces/internal_.BraintreeError.md

@@ -0,0 +1,37 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BraintreeError
+
+# Interface: BraintreeError
+
+[<internal>](../modules/internal_.md).BraintreeError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`BraintreeError`**
+
+## Table of contents
+
+### Properties
+
+- [code](internal_.BraintreeError.md#code)
+- [details](internal_.BraintreeError.md#details)
+- [type](internal_.BraintreeError.md#type)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+___
+
+### details
+
+• `Optional` **details**: `unknown`
+
+___
+
+### type
+
+• **type**: ``"CUSTOMER"`` \| ``"MERCHANT"`` \| ``"NETWORK"`` \| ``"INTERNAL"`` \| ``"UNKNOWN"``