@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/ChecklistStyles.md

@@ -1,127 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / ChecklistStyles
-
-# Interface: ChecklistStyles
-
-## Hierarchy
-
-- [`BlockElementStyles`](BlockElementStyles.md)
-
-  ↳ **`ChecklistStyles`**
-
-## Table of contents
-
-### Properties
-
-- [backgroundColor](ChecklistStyles.md#backgroundcolor)
-- [borderColor](ChecklistStyles.md#bordercolor)
-- [borderWidth](ChecklistStyles.md#borderwidth)
-- [boxShadow](ChecklistStyles.md#boxshadow)
-- [checked](ChecklistStyles.md#checked)
-- [color](ChecklistStyles.md#color)
-- [fontFamily](ChecklistStyles.md#fontfamily)
-- [fontWeight](ChecklistStyles.md#fontweight)
-- [hover](ChecklistStyles.md#hover)
-- [letterSpacing](ChecklistStyles.md#letterspacing)
-- [lineHeight](ChecklistStyles.md#lineheight)
-
-## Properties
-
-### backgroundColor
-
-• `Optional` **backgroundColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
-
-___
-
-### borderColor
-
-• `Optional` **borderColor**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
-
-___
-
-### borderWidth
-
-• `Optional` **borderWidth**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
-
-___
-
-### boxShadow
-
-• `Optional` **boxShadow**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
-
-___
-
-### checked
-
-• `Optional` **checked**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### color
-
-• `Optional` **color**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
-
-___
-
-### fontFamily
-
-• `Optional` **fontFamily**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
-
-___
-
-### fontWeight
-
-• `Optional` **fontWeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
-
-___
-
-### hover
-
-• `Optional` **hover**: [`BlockElementStyles`](BlockElementStyles.md)
-
-___
-
-### letterSpacing
-
-• `Optional` **letterSpacing**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
-
-___
-
-### lineHeight
-
-• `Optional` **lineHeight**: `string`
-
-#### Inherited from
-
-[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)

package/docs/interfaces/Checkout.md

@@ -1,195 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / Checkout
-
-# Interface: Checkout
-
-## Table of contents
-
-### Properties
-
-- [balanceDue](Checkout.md#balancedue)
-- [billingAddress](Checkout.md#billingaddress)
-- [cart](Checkout.md#cart)
-- [consignments](Checkout.md#consignments)
-- [coupons](Checkout.md#coupons)
-- [createdTime](Checkout.md#createdtime)
-- [customer](Checkout.md#customer)
-- [customerMessage](Checkout.md#customermessage)
-- [discounts](Checkout.md#discounts)
-- [giftCertificates](Checkout.md#giftcertificates)
-- [giftWrappingCostTotal](Checkout.md#giftwrappingcosttotal)
-- [grandTotal](Checkout.md#grandtotal)
-- [handlingCostTotal](Checkout.md#handlingcosttotal)
-- [id](Checkout.md#id)
-- [isStoreCreditApplied](Checkout.md#isstorecreditapplied)
-- [orderId](Checkout.md#orderid)
-- [outstandingBalance](Checkout.md#outstandingbalance)
-- [payments](Checkout.md#payments)
-- [promotions](Checkout.md#promotions)
-- [shippingCostBeforeDiscount](Checkout.md#shippingcostbeforediscount)
-- [shippingCostTotal](Checkout.md#shippingcosttotal)
-- [shouldExecuteSpamCheck](Checkout.md#shouldexecutespamcheck)
-- [subtotal](Checkout.md#subtotal)
-- [taxTotal](Checkout.md#taxtotal)
-- [taxes](Checkout.md#taxes)
-- [updatedTime](Checkout.md#updatedtime)
-
-## Properties
-
-### balanceDue
-
-• **balanceDue**: `number`
-
-___
-
-### billingAddress
-
-• `Optional` **billingAddress**: [`BillingAddress`](BillingAddress.md)
-
-___
-
-### cart
-
-• **cart**: [`Cart`](Cart.md)
-
-___
-
-### consignments
-
-• **consignments**: [`Consignment`](Consignment.md)[]
-
-___
-
-### coupons
-
-• **coupons**: [`Coupon`](Coupon.md)[]
-
-___
-
-### createdTime
-
-• **createdTime**: `string`
-
-___
-
-### customer
-
-• **customer**: [`Customer`](Customer.md)
-
-___
-
-### customerMessage
-
-• **customerMessage**: `string`
-
-___
-
-### discounts
-
-• **discounts**: [`Discount`](Discount.md)[]
-
-___
-
-### giftCertificates
-
-• **giftCertificates**: [`GiftCertificate`](GiftCertificate.md)[]
-
-___
-
-### giftWrappingCostTotal
-
-• **giftWrappingCostTotal**: `number`
-
-___
-
-### grandTotal
-
-• **grandTotal**: `number`
-
-___
-
-### handlingCostTotal
-
-• **handlingCostTotal**: `number`
-
-___
-
-### id
-
-• **id**: `string`
-
-___
-
-### isStoreCreditApplied
-
-• **isStoreCreditApplied**: `boolean`
-
-___
-
-### orderId
-
-• `Optional` **orderId**: `number`
-
-___
-
-### outstandingBalance
-
-• **outstandingBalance**: `number`
-
-___
-
-### payments
-
-• `Optional` **payments**: [`CheckoutPayment`](CheckoutPayment.md)[]
-
-___
-
-### promotions
-
-• `Optional` **promotions**: [`Promotion`](Promotion.md)[]
-
-___
-
-### shippingCostBeforeDiscount
-
-• **shippingCostBeforeDiscount**: `number`
-
-___
-
-### shippingCostTotal
-
-• **shippingCostTotal**: `number`
-
-___
-
-### shouldExecuteSpamCheck
-
-• **shouldExecuteSpamCheck**: `boolean`
-
-Whether the current checkout must execute spam protection
-before placing the order.
-
-Note: You need to enable Google ReCAPTCHA bot protection in your Checkout Settings.
-
-___
-
-### subtotal
-
-• **subtotal**: `number`
-
-___
-
-### taxTotal
-
-• **taxTotal**: `number`
-
-___
-
-### taxes
-
-• **taxes**: [`Tax`](Tax.md)[]
-
-___
-
-### updatedTime
-
-• **updatedTime**: `string`

package/docs/interfaces/CheckoutButtonInitializeOptions_3.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializeOptions_3
-
-# Interface: CheckoutButtonInitializeOptions\_3
-
-## Hierarchy
-
-- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
-
-  ↳ **`CheckoutButtonInitializeOptions_3`**
-
-## Indexable
-
-▪ [key: `string`]: `unknown`
-
-## Table of contents
-
-### Properties
-
-- [containerId](CheckoutButtonInitializeOptions_3.md#containerid)
-- [methodId](CheckoutButtonInitializeOptions_3.md#methodid)
-- [params](CheckoutButtonInitializeOptions_3.md#params)
-- [timeout](CheckoutButtonInitializeOptions_3.md#timeout)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The ID of a container which the checkout button should be inserted.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[methodId](CheckoutButtonOptions.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CheckoutButtonOptions](CheckoutButtonOptions.md).[params](CheckoutButtonOptions.md#params)
-
-___
-
-### 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](CheckoutButtonOptions.md).[timeout](CheckoutButtonOptions.md#timeout)

package/docs/interfaces/CheckoutButtonInitializeOptions_4.md

@@ -1,244 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializeOptions_4
-
-# Interface: CheckoutButtonInitializeOptions\_4
-
-## Hierarchy
-
-- [`CheckoutButtonOptions_2`](CheckoutButtonOptions_2.md)
-
-  ↳ **`CheckoutButtonInitializeOptions_4`**
-
-## Table of contents
-
-### Properties
-
-- [amazonpay](CheckoutButtonInitializeOptions_4.md#amazonpay)
-- [applepay](CheckoutButtonInitializeOptions_4.md#applepay)
-- [braintreepaypal](CheckoutButtonInitializeOptions_4.md#braintreepaypal)
-- [braintreepaypalcredit](CheckoutButtonInitializeOptions_4.md#braintreepaypalcredit)
-- [braintreevenmo](CheckoutButtonInitializeOptions_4.md#braintreevenmo)
-- [containerId](CheckoutButtonInitializeOptions_4.md#containerid)
-- [googlepayadyenv2](CheckoutButtonInitializeOptions_4.md#googlepayadyenv2)
-- [googlepayadyenv3](CheckoutButtonInitializeOptions_4.md#googlepayadyenv3)
-- [googlepayauthorizenet](CheckoutButtonInitializeOptions_4.md#googlepayauthorizenet)
-- [googlepaybraintree](CheckoutButtonInitializeOptions_4.md#googlepaybraintree)
-- [googlepaycheckoutcom](CheckoutButtonInitializeOptions_4.md#googlepaycheckoutcom)
-- [googlepaycybersourcev2](CheckoutButtonInitializeOptions_4.md#googlepaycybersourcev2)
-- [googlepayorbital](CheckoutButtonInitializeOptions_4.md#googlepayorbital)
-- [googlepaystripe](CheckoutButtonInitializeOptions_4.md#googlepaystripe)
-- [googlepaystripeupe](CheckoutButtonInitializeOptions_4.md#googlepaystripeupe)
-- [methodId](CheckoutButtonInitializeOptions_4.md#methodid)
-- [params](CheckoutButtonInitializeOptions_4.md#params)
-- [paypal](CheckoutButtonInitializeOptions_4.md#paypal)
-- [paypalCommerce](CheckoutButtonInitializeOptions_4.md#paypalcommerce)
-- [paypalcommercealternativemethods](CheckoutButtonInitializeOptions_4.md#paypalcommercealternativemethods)
-- [paypalcommercevenmo](CheckoutButtonInitializeOptions_4.md#paypalcommercevenmo)
-- [timeout](CheckoutButtonInitializeOptions_4.md#timeout)
-
-## Properties
-
-### amazonpay
-
-• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
-
-The options that are required to facilitate AmazonPayV2. They can be
-omitted unless you need to support AmazonPayV2.
-
-___
-
-### applepay
-
-• `Optional` **applepay**: [`ApplePayButtonInitializeOptions_2`](ApplePayButtonInitializeOptions_2.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`](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`](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`](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.
-
-___
-
-### googlepayadyenv2
-
-• `Optional` **googlepayadyenv2**: [`GooglePayButtonInitializeOptions`](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`](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`](GooglePayButtonInitializeOptions.md)
-
-The options that are required to facilitate Authorize.Net GooglePay.
-They can be omitted unless you need to support Authorize.Net GooglePay.
-
-___
-
-### googlepaybraintree
-
-• `Optional` **googlepaybraintree**: [`GooglePayButtonInitializeOptions`](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`](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`](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`](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`](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`](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/CheckoutButtonMethodType.md)
-
-The identifier of the payment method.
-
-#### Inherited from
-
-[CheckoutButtonOptions_2](CheckoutButtonOptions_2.md).[methodId](CheckoutButtonOptions_2.md#methodid)
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[CheckoutButtonOptions_2](CheckoutButtonOptions_2.md).[params](CheckoutButtonOptions_2.md#params)
-
-___
-
-### paypal
-
-• `Optional` **paypal**: [`PaypalButtonInitializeOptions`](PaypalButtonInitializeOptions.md)
-
-The options that are required to facilitate PayPal. They can be omitted
-unless you need to support Paypal.
-
-___
-
-### paypalCommerce
-
-• `Optional` **paypalCommerce**: [`PaypalCommerceButtonInitializeOptions`](PaypalCommerceButtonInitializeOptions.md)
-
-The options that are required to facilitate PayPal Commerce. They can be omitted
-unless you need to support Paypal.
-
-___
-
-### paypalcommercealternativemethods
-
-• `Optional` **paypalcommercealternativemethods**: [`PaypalCommerceAlternativeMethodsButtonOptions`](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.
-
-___
-
-### paypalcommercevenmo
-
-• `Optional` **paypalcommercevenmo**: [`PaypalCommerceVenmoButtonInitializeOptions`](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_2](CheckoutButtonOptions_2.md).[timeout](CheckoutButtonOptions_2.md#timeout)

package/docs/interfaces/CheckoutButtonInitializerOptions.md

@@ -1,22 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonInitializerOptions
-
-# Interface: CheckoutButtonInitializerOptions
-
-## Table of contents
-
-### Properties
-
-- [host](CheckoutButtonInitializerOptions.md#host)
-- [locale](CheckoutButtonInitializerOptions.md#locale)
-
-## Properties
-
-### host
-
-• `Optional` **host**: `string`
-
-___
-
-### locale
-
-• `Optional` **locale**: `string`

package/docs/interfaces/CheckoutButtonOptions.md

@@ -1,55 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / CheckoutButtonOptions
-
-# Interface: CheckoutButtonOptions
-
-The set of options for configuring the checkout button.
-
-## Hierarchy
-
-- [`RequestOptions_2`](RequestOptions_2.md)
-
-  ↳ **`CheckoutButtonOptions`**
-
-  ↳↳ [`CheckoutButtonInitializeOptions_3`](CheckoutButtonInitializeOptions_3.md)
-
-## Table of contents
-
-### Properties
-
-- [methodId](CheckoutButtonOptions.md#methodid)
-- [params](CheckoutButtonOptions.md#params)
-- [timeout](CheckoutButtonOptions.md#timeout)
-
-## Properties
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-___
-
-### params
-
-• `Optional` **params**: `Object`
-
-The parameters of the request, if required.
-
-#### Inherited from
-
-[RequestOptions_2](RequestOptions_2.md).[params](RequestOptions_2.md#params)
-
-___
-
-### 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
-
-[RequestOptions_2](RequestOptions_2.md).[timeout](RequestOptions_2.md#timeout)