@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/Cart.md

@@ -0,0 +1,99 @@
+[@bigcommerce/checkout-sdk](../README.md) / Cart
+
+# Interface: Cart
+
+## Table of contents
+
+### Properties
+
+- [baseAmount](Cart.md#baseamount)
+- [cartAmount](Cart.md#cartamount)
+- [coupons](Cart.md#coupons)
+- [createdTime](Cart.md#createdtime)
+- [currency](Cart.md#currency)
+- [customerId](Cart.md#customerid)
+- [discountAmount](Cart.md#discountamount)
+- [discounts](Cart.md#discounts)
+- [email](Cart.md#email)
+- [id](Cart.md#id)
+- [isTaxIncluded](Cart.md#istaxincluded)
+- [lineItems](Cart.md#lineitems)
+- [updatedTime](Cart.md#updatedtime)
+
+## Properties
+
+### baseAmount
+
+• **baseAmount**: `number`
+
+___
+
+### cartAmount
+
+• **cartAmount**: `number`
+
+___
+
+### coupons
+
+• **coupons**: [`Coupon`](Coupon.md)[]
+
+___
+
+### createdTime
+
+• **createdTime**: `string`
+
+___
+
+### currency
+
+• **currency**: [`Currency`](Currency.md)
+
+___
+
+### customerId
+
+• **customerId**: `number`
+
+___
+
+### discountAmount
+
+• **discountAmount**: `number`
+
+___
+
+### discounts
+
+• **discounts**: [`Discount`](Discount.md)[]
+
+___
+
+### email
+
+• **email**: `string`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### isTaxIncluded
+
+• **isTaxIncluded**: `boolean`
+
+___
+
+### lineItems
+
+• **lineItems**: [`LineItemMap`](LineItemMap.md)
+
+___
+
+### updatedTime
+
+• **updatedTime**: `string`

package/docs/interfaces/ChasePayCustomerInitializeOptions.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / ChasePayCustomerInitializeOptions
+
+# Interface: ChasePayCustomerInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [container](ChasePayCustomerInitializeOptions.md#container)
+
+## Properties
+
+### container
+
+• **container**: `string`

package/docs/interfaces/ChasePayInitializeOptions.md

@@ -0,0 +1,98 @@
+[@bigcommerce/checkout-sdk](../README.md) / ChasePayInitializeOptions
+
+# Interface: ChasePayInitializeOptions
+
+A set of options that are required to initialize the Chase Pay payment method.
+
+```html
+<!-- This is where the Chase Pay button will be inserted -->
+<div id="wallet-button"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'chasepay',
+    chasepay: {
+        walletButton: 'wallet-button',
+    },
+});
+```
+
+Additional options can be passed in to customize the fields and register
+event callbacks.
+
+```html
+<!-- This is where the Chase Pay logo will be inserted -->
+<div id="logo"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'chasepay',
+    chasepay: {
+        walletButton: 'wallet-button',
+        logoContainer: 'logo',
+        onPaymentSelect() {
+            console.log('Selected');
+        },
+        onCancel() {
+            console.log('Cancelled');
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [logoContainer](ChasePayInitializeOptions.md#logocontainer)
+- [walletButton](ChasePayInitializeOptions.md#walletbutton)
+
+### Methods
+
+- [onCancel](ChasePayInitializeOptions.md#oncancel)
+- [onPaymentSelect](ChasePayInitializeOptions.md#onpaymentselect)
+
+## Properties
+
+### logoContainer
+
+• `Optional` **logoContainer**: `string`
+
+This container is used to host the chasepay branding logo.
+It should be an HTML element.
+
+___
+
+### walletButton
+
+• `Optional` **walletButton**: `string`
+
+This walletButton is used to set an event listener, provide an element ID if you want
+users to be able to launch the ChasePay wallet modal by clicking on a button.
+It should be an HTML element.
+
+## Methods
+
+### onCancel
+
+▸ `Optional` **onCancel**(): `void`
+
+A callback that gets called when the customer cancels their payment selection.
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(): `void`
+
+A callback that gets called when the customer selects a payment option.
+
+#### Returns
+
+`void`

package/docs/interfaces/CheckableInputStyles.md

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

package/docs/interfaces/ChecklistStyles.md

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

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