@bigcommerce/checkout-sdk 1.264.0 → 1.265.0

package/docs/interfaces/checkableinputstyles.md

@@ -1,147 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CheckableInputStyles](checkableinputstyles.md)
-
-# Interface: CheckableInputStyles
-
-## Hierarchy
-
-  ↳ [InputStyles](inputstyles.md)
-
-  ↳ **CheckableInputStyles**
-
-## Index
-
-### Properties
-
-* [active](checkableinputstyles.md#optional-active)
-* [backgroundColor](checkableinputstyles.md#optional-backgroundcolor)
-* [borderColor](checkableinputstyles.md#optional-bordercolor)
-* [borderWidth](checkableinputstyles.md#optional-borderwidth)
-* [boxShadow](checkableinputstyles.md#optional-boxshadow)
-* [checked](checkableinputstyles.md#optional-checked)
-* [color](checkableinputstyles.md#optional-color)
-* [disabled](checkableinputstyles.md#optional-disabled)
-* [error](checkableinputstyles.md#optional-error)
-* [focus](checkableinputstyles.md#optional-focus)
-* [fontFamily](checkableinputstyles.md#optional-fontfamily)
-* [fontWeight](checkableinputstyles.md#optional-fontweight)
-* [hover](checkableinputstyles.md#optional-hover)
-* [letterSpacing](checkableinputstyles.md#optional-letterspacing)
-* [lineHeight](checkableinputstyles.md#optional-lineheight)
-
-## Properties
-
-### `Optional` active
-
-• **active**? : *[BlockElementStyles](blockelementstyles.md)*
-
-*Inherited from [CheckableInputStyles](checkableinputstyles.md).[active](checkableinputstyles.md#optional-active)*
-
-___
-
-### `Optional` backgroundColor
-
-• **backgroundColor**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[backgroundColor](blockelementstyles.md#optional-backgroundcolor)*
-
-___
-
-### `Optional` borderColor
-
-• **borderColor**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[borderColor](blockelementstyles.md#optional-bordercolor)*
-
-___
-
-### `Optional` borderWidth
-
-• **borderWidth**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[borderWidth](blockelementstyles.md#optional-borderwidth)*
-
-___
-
-### `Optional` boxShadow
-
-• **boxShadow**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[boxShadow](blockelementstyles.md#optional-boxshadow)*
-
-___
-
-### `Optional` checked
-
-• **checked**? : *[BlockElementStyles](blockelementstyles.md)*
-
-___
-
-### `Optional` color
-
-• **color**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[color](blockelementstyles.md#optional-color)*
-
-___
-
-### `Optional` disabled
-
-• **disabled**? : *[BlockElementStyles](blockelementstyles.md)*
-
-*Inherited from [CheckableInputStyles](checkableinputstyles.md).[disabled](checkableinputstyles.md#optional-disabled)*
-
-___
-
-### `Optional` error
-
-• **error**? : *[InputStyles](inputstyles.md)*
-
-*Overrides [InputStyles](inputstyles.md).[error](inputstyles.md#optional-error)*
-
-___
-
-### `Optional` focus
-
-• **focus**? : *[BlockElementStyles](blockelementstyles.md)*
-
-*Inherited from [CheckableInputStyles](checkableinputstyles.md).[focus](checkableinputstyles.md#optional-focus)*
-
-___
-
-### `Optional` fontFamily
-
-• **fontFamily**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[fontFamily](blockelementstyles.md#optional-fontfamily)*
-
-___
-
-### `Optional` fontWeight
-
-• **fontWeight**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[fontWeight](blockelementstyles.md#optional-fontweight)*
-
-___
-
-### `Optional` hover
-
-• **hover**? : *[BlockElementStyles](blockelementstyles.md)*
-
-*Inherited from [CheckableInputStyles](checkableinputstyles.md).[hover](checkableinputstyles.md#optional-hover)*
-
-___
-
-### `Optional` letterSpacing
-
-• **letterSpacing**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[letterSpacing](blockelementstyles.md#optional-letterspacing)*
-
-___
-
-### `Optional` lineHeight
-
-• **lineHeight**? : *undefined | string*
-
-*Inherited from [BlockElementStyles](blockelementstyles.md).[lineHeight](blockelementstyles.md#optional-lineheight)*

package/docs/interfaces/checkliststyles.md

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

package/docs/interfaces/checkout.md

@@ -1,199 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [Checkout](checkout.md)
-
-# Interface: Checkout
-
-## Hierarchy
-
-* **Checkout**
-
-## Index
-
-### Properties
-
-* [balanceDue](checkout.md#balancedue)
-* [billingAddress](checkout.md#optional-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#optional-orderid)
-* [outstandingBalance](checkout.md#outstandingbalance)
-* [payments](checkout.md#optional-payments)
-* [promotions](checkout.md#optional-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*
-
-___
-
-### `Optional` billingAddress
-
-• **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*
-
-___
-
-### `Optional` orderId
-
-• **orderId**? : *undefined | number*
-
-___
-
-###  outstandingBalance
-
-• **outstandingBalance**: *number*
-
-___
-
-### `Optional` payments
-
-• **payments**? : *[CheckoutPayment](checkoutpayment.md)[]*
-
-___
-
-### `Optional` promotions
-
-• **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.md

@@ -1,232 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md)
-
-# Interface: CheckoutButtonInitializeOptions ‹**TParams**›
-
-## Type parameters
-
-▪ **TParams**
-
-## Hierarchy
-
-  ↳ [CheckoutButtonOptions](checkoutbuttonoptions.md)
-
-  ↳ **CheckoutButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [amazonpay](checkoutbuttoninitializeoptions.md#optional-amazonpay)
-* [applepay](checkoutbuttoninitializeoptions.md#optional-applepay)
-* [braintreepaypal](checkoutbuttoninitializeoptions.md#optional-braintreepaypal)
-* [braintreepaypalcredit](checkoutbuttoninitializeoptions.md#optional-braintreepaypalcredit)
-* [braintreevenmo](checkoutbuttoninitializeoptions.md#optional-braintreevenmo)
-* [containerId](checkoutbuttoninitializeoptions.md#containerid)
-* [googlepayadyenv2](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv2)
-* [googlepayadyenv3](checkoutbuttoninitializeoptions.md#optional-googlepayadyenv3)
-* [googlepayauthorizenet](checkoutbuttoninitializeoptions.md#optional-googlepayauthorizenet)
-* [googlepaybraintree](checkoutbuttoninitializeoptions.md#optional-googlepaybraintree)
-* [googlepaycheckoutcom](checkoutbuttoninitializeoptions.md#optional-googlepaycheckoutcom)
-* [googlepaycybersourcev2](checkoutbuttoninitializeoptions.md#optional-googlepaycybersourcev2)
-* [googlepayorbital](checkoutbuttoninitializeoptions.md#optional-googlepayorbital)
-* [googlepaystripe](checkoutbuttoninitializeoptions.md#optional-googlepaystripe)
-* [googlepaystripeupe](checkoutbuttoninitializeoptions.md#optional-googlepaystripeupe)
-* [methodId](checkoutbuttoninitializeoptions.md#methodid)
-* [params](checkoutbuttoninitializeoptions.md#optional-params)
-* [paypal](checkoutbuttoninitializeoptions.md#optional-paypal)
-* [paypalCommerce](checkoutbuttoninitializeoptions.md#optional-paypalcommerce)
-* [paypalcommercevenmo](checkoutbuttoninitializeoptions.md#optional-paypalcommercevenmo)
-* [timeout](checkoutbuttoninitializeoptions.md#optional-timeout)
-
-## Properties
-
-### `Optional` amazonpay
-
-• **amazonpay**? : *[AmazonPayV2ButtonInitializeOptions](../README.md#amazonpayv2buttoninitializeoptions)*
-
-The options that are required to facilitate AmazonPayV2. They can be
-omitted unless you need to support AmazonPayV2.
-
-___
-
-### `Optional` applepay
-
-• **applepay**? : *[ApplePayButtonInitializeOptions](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.
-
-___
-
-### `Optional` braintreepaypal
-
-• **braintreepaypal**? : *[BraintreePaypalButtonInitializeOptions](braintreepaypalbuttoninitializeoptions.md)*
-
-The options that are required to facilitate Braintree PayPal. They can be
-omitted unless you need to support Braintree PayPal.
-
-___
-
-### `Optional` braintreepaypalcredit
-
-• **braintreepaypalcredit**? : *[BraintreePaypalCreditButtonInitializeOptions](braintreepaypalcreditbuttoninitializeoptions.md)*
-
-The options that are required to facilitate Braintree Credit. They can be
-omitted unless you need to support Braintree Credit.
-
-___
-
-### `Optional` braintreevenmo
-
-• **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.
-
-___
-
-### `Optional` googlepayadyenv2
-
-• **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.
-
-___
-
-### `Optional` googlepayadyenv3
-
-• **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.
-
-___
-
-### `Optional` googlepayauthorizenet
-
-• **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.
-
-___
-
-### `Optional` googlepaybraintree
-
-• **googlepaybraintree**? : *[GooglePayButtonInitializeOptions](googlepaybuttoninitializeoptions.md)*
-
-The options that are required to facilitate Braintree GooglePay. They can be
-omitted unless you need to support Braintree GooglePay.
-
-___
-
-### `Optional` googlepaycheckoutcom
-
-• **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.
-
-___
-
-### `Optional` googlepaycybersourcev2
-
-• **googlepaycybersourcev2**? : *[GooglePayButtonInitializeOptions](googlepaybuttoninitializeoptions.md)*
-
-The options that are required to facilitate CybersourceV2 GooglePay. They can be
-omitted unless you need to support CybersourceV2 GooglePay.
-
-___
-
-### `Optional` googlepayorbital
-
-• **googlepayorbital**? : *[GooglePayButtonInitializeOptions](googlepaybuttoninitializeoptions.md)*
-
-The options that are required to facilitate Orbital GooglePay. They can be
-omitted unless you need to support Orbital GooglePay.
-
-___
-
-### `Optional` googlepaystripe
-
-• **googlepaystripe**? : *[GooglePayButtonInitializeOptions](googlepaybuttoninitializeoptions.md)*
-
-The options that are required to facilitate Stripe GooglePay. They can be
-omitted unless you need to support Stripe GooglePay.
-
-___
-
-### `Optional` googlepaystripeupe
-
-• **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)*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[methodId](checkoutbuttoninitializeoptions.md#methodid)*
-
-The identifier of the payment method.
-
-___
-
-### `Optional` params
-
-• **params**? : *TParams*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[params](checkoutbuttoninitializeoptions.md#optional-params)*
-
-The parameters of the request, if required.
-
-___
-
-### `Optional` paypal
-
-• **paypal**? : *[PaypalButtonInitializeOptions](paypalbuttoninitializeoptions.md)*
-
-The options that are required to facilitate PayPal. They can be omitted
-unless you need to support Paypal.
-
-___
-
-### `Optional` paypalCommerce
-
-• **paypalCommerce**? : *[PaypalCommerceButtonInitializeOptions](paypalcommercebuttoninitializeoptions.md)*
-
-The options that are required to facilitate PayPal Commerce. They can be omitted
-unless you need to support Paypal.
-
-___
-
-### `Optional` paypalcommercevenmo
-
-• **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.
-
-___
-
-### `Optional` timeout
-
-• **timeout**? : *Timeout*
-
-*Inherited from [CheckoutButtonInitializeOptions](checkoutbuttoninitializeoptions.md).[timeout](checkoutbuttoninitializeoptions.md#optional-timeout)*
-
-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.

package/docs/interfaces/checkoutbuttoninitializeroptions.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [CheckoutButtonInitializerOptions](checkoutbuttoninitializeroptions.md)
-
-# Interface: CheckoutButtonInitializerOptions
-
-## Hierarchy
-
-* **CheckoutButtonInitializerOptions**
-
-## Index
-
-### Properties
-
-* [host](checkoutbuttoninitializeroptions.md#optional-host)
-* [locale](checkoutbuttoninitializeroptions.md#optional-locale)
-
-## Properties
-
-### `Optional` host
-
-• **host**? : *undefined | string*
-
-___
-
-### `Optional` locale
-
-• **locale**? : *undefined | string*