@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/CssProperties.md

@@ -0,0 +1,211 @@
+[@bigcommerce/checkout-sdk](../README.md) / CssProperties
+
+# Interface: CssProperties
+
+## Table of contents
+
+### Properties
+
+- [background](CssProperties.md#background)
+- [color](CssProperties.md#color)
+- [display](CssProperties.md#display)
+- [font](CssProperties.md#font)
+- [fontFamily](CssProperties.md#fontfamily)
+- [fontSize](CssProperties.md#fontsize)
+- [fontSizeAdjust](CssProperties.md#fontsizeadjust)
+- [fontSmoothing](CssProperties.md#fontsmoothing)
+- [fontStretch](CssProperties.md#fontstretch)
+- [fontStyle](CssProperties.md#fontstyle)
+- [fontVariant](CssProperties.md#fontvariant)
+- [fontVariantAlternates](CssProperties.md#fontvariantalternates)
+- [fontVariantCaps](CssProperties.md#fontvariantcaps)
+- [fontVariantEastAsian](CssProperties.md#fontvarianteastasian)
+- [fontVariantLigatures](CssProperties.md#fontvariantligatures)
+- [fontVariantNumeric](CssProperties.md#fontvariantnumeric)
+- [fontWeight](CssProperties.md#fontweight)
+- [letterSpacing](CssProperties.md#letterspacing)
+- [lineHeight](CssProperties.md#lineheight)
+- [mozOsxFontSmoothing](CssProperties.md#mozosxfontsmoothing)
+- [mozTransition](CssProperties.md#moztransition)
+- [opacity](CssProperties.md#opacity)
+- [outline](CssProperties.md#outline)
+- [padding](CssProperties.md#padding)
+- [textAlign](CssProperties.md#textalign)
+- [textShadow](CssProperties.md#textshadow)
+- [transition](CssProperties.md#transition)
+- [webkitFontSmoothing](CssProperties.md#webkitfontsmoothing)
+- [webkitTransition](CssProperties.md#webkittransition)
+
+## Properties
+
+### background
+
+• `Optional` **background**: `string`
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+___
+
+### display
+
+• `Optional` **display**: `string`
+
+___
+
+### font
+
+• `Optional` **font**: `string`
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+___
+
+### fontSize
+
+• `Optional` **fontSize**: `string`
+
+___
+
+### fontSizeAdjust
+
+• `Optional` **fontSizeAdjust**: `string`
+
+___
+
+### fontSmoothing
+
+• `Optional` **fontSmoothing**: `string`
+
+___
+
+### fontStretch
+
+• `Optional` **fontStretch**: `string`
+
+___
+
+### fontStyle
+
+• `Optional` **fontStyle**: `string`
+
+___
+
+### fontVariant
+
+• `Optional` **fontVariant**: `string`
+
+___
+
+### fontVariantAlternates
+
+• `Optional` **fontVariantAlternates**: `string`
+
+___
+
+### fontVariantCaps
+
+• `Optional` **fontVariantCaps**: `string`
+
+___
+
+### fontVariantEastAsian
+
+• `Optional` **fontVariantEastAsian**: `string`
+
+___
+
+### fontVariantLigatures
+
+• `Optional` **fontVariantLigatures**: `string`
+
+___
+
+### fontVariantNumeric
+
+• `Optional` **fontVariantNumeric**: `string`
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+___
+
+### mozOsxFontSmoothing
+
+• `Optional` **mozOsxFontSmoothing**: `string`
+
+___
+
+### mozTransition
+
+• `Optional` **mozTransition**: `string`
+
+___
+
+### opacity
+
+• `Optional` **opacity**: `string` \| `number`
+
+___
+
+### outline
+
+• `Optional` **outline**: `string`
+
+___
+
+### padding
+
+• `Optional` **padding**: `string`
+
+___
+
+### textAlign
+
+• `Optional` **textAlign**: `string`
+
+___
+
+### textShadow
+
+• `Optional` **textShadow**: `string`
+
+___
+
+### transition
+
+• `Optional` **transition**: `string`
+
+___
+
+### webkitFontSmoothing
+
+• `Optional` **webkitFontSmoothing**: `string`
+
+___
+
+### webkitTransition
+
+• `Optional` **webkitTransition**: `string`

package/docs/interfaces/CssProperties_2.md

@@ -0,0 +1,211 @@
+[@bigcommerce/checkout-sdk](../README.md) / CssProperties_2
+
+# Interface: CssProperties\_2
+
+## Table of contents
+
+### Properties
+
+- [background](CssProperties_2.md#background)
+- [color](CssProperties_2.md#color)
+- [display](CssProperties_2.md#display)
+- [font](CssProperties_2.md#font)
+- [fontFamily](CssProperties_2.md#fontfamily)
+- [fontSize](CssProperties_2.md#fontsize)
+- [fontSizeAdjust](CssProperties_2.md#fontsizeadjust)
+- [fontSmoothing](CssProperties_2.md#fontsmoothing)
+- [fontStretch](CssProperties_2.md#fontstretch)
+- [fontStyle](CssProperties_2.md#fontstyle)
+- [fontVariant](CssProperties_2.md#fontvariant)
+- [fontVariantAlternates](CssProperties_2.md#fontvariantalternates)
+- [fontVariantCaps](CssProperties_2.md#fontvariantcaps)
+- [fontVariantEastAsian](CssProperties_2.md#fontvarianteastasian)
+- [fontVariantLigatures](CssProperties_2.md#fontvariantligatures)
+- [fontVariantNumeric](CssProperties_2.md#fontvariantnumeric)
+- [fontWeight](CssProperties_2.md#fontweight)
+- [letterSpacing](CssProperties_2.md#letterspacing)
+- [lineHeight](CssProperties_2.md#lineheight)
+- [mozOsxFontSmoothing](CssProperties_2.md#mozosxfontsmoothing)
+- [mozTransition](CssProperties_2.md#moztransition)
+- [opacity](CssProperties_2.md#opacity)
+- [outline](CssProperties_2.md#outline)
+- [padding](CssProperties_2.md#padding)
+- [textAlign](CssProperties_2.md#textalign)
+- [textShadow](CssProperties_2.md#textshadow)
+- [transition](CssProperties_2.md#transition)
+- [webkitFontSmoothing](CssProperties_2.md#webkitfontsmoothing)
+- [webkitTransition](CssProperties_2.md#webkittransition)
+
+## Properties
+
+### background
+
+• `Optional` **background**: `string`
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+___
+
+### display
+
+• `Optional` **display**: `string`
+
+___
+
+### font
+
+• `Optional` **font**: `string`
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+___
+
+### fontSize
+
+• `Optional` **fontSize**: `string`
+
+___
+
+### fontSizeAdjust
+
+• `Optional` **fontSizeAdjust**: `string`
+
+___
+
+### fontSmoothing
+
+• `Optional` **fontSmoothing**: `string`
+
+___
+
+### fontStretch
+
+• `Optional` **fontStretch**: `string`
+
+___
+
+### fontStyle
+
+• `Optional` **fontStyle**: `string`
+
+___
+
+### fontVariant
+
+• `Optional` **fontVariant**: `string`
+
+___
+
+### fontVariantAlternates
+
+• `Optional` **fontVariantAlternates**: `string`
+
+___
+
+### fontVariantCaps
+
+• `Optional` **fontVariantCaps**: `string`
+
+___
+
+### fontVariantEastAsian
+
+• `Optional` **fontVariantEastAsian**: `string`
+
+___
+
+### fontVariantLigatures
+
+• `Optional` **fontVariantLigatures**: `string`
+
+___
+
+### fontVariantNumeric
+
+• `Optional` **fontVariantNumeric**: `string`
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+___
+
+### mozOsxFontSmoothing
+
+• `Optional` **mozOsxFontSmoothing**: `string`
+
+___
+
+### mozTransition
+
+• `Optional` **mozTransition**: `string`
+
+___
+
+### opacity
+
+• `Optional` **opacity**: `string` \| `number`
+
+___
+
+### outline
+
+• `Optional` **outline**: `string`
+
+___
+
+### padding
+
+• `Optional` **padding**: `string`
+
+___
+
+### textAlign
+
+• `Optional` **textAlign**: `string`
+
+___
+
+### textShadow
+
+• `Optional` **textShadow**: `string`
+
+___
+
+### transition
+
+• `Optional` **transition**: `string`
+
+___
+
+### webkitFontSmoothing
+
+• `Optional` **webkitFontSmoothing**: `string`
+
+___
+
+### webkitTransition
+
+• `Optional` **webkitTransition**: `string`

package/docs/interfaces/Currency.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / Currency
+
+# Interface: Currency
+
+## Table of contents
+
+### Properties
+
+- [code](Currency.md#code)
+- [decimalPlaces](Currency.md#decimalplaces)
+- [name](Currency.md#name)
+- [symbol](Currency.md#symbol)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+___
+
+### decimalPlaces
+
+• **decimalPlaces**: `number`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### symbol
+
+• **symbol**: `string`

package/docs/interfaces/CustomError.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomError
+
+# Interface: CustomError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`CustomError`**
+
+## Implemented by
+
+- [`StandardError`](../classes/StandardError.md)
+
+## Table of contents
+
+### Properties
+
+- [message](CustomError.md#message)
+- [subtype](CustomError.md#subtype)
+- [type](CustomError.md#type)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Overrides
+
+Error.message
+
+___
+
+### subtype
+
+• `Optional` **subtype**: `string`
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/CustomItem.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomItem
+
+# Interface: CustomItem
+
+## Table of contents
+
+### Properties
+
+- [extendedListPrice](CustomItem.md#extendedlistprice)
+- [id](CustomItem.md#id)
+- [listPrice](CustomItem.md#listprice)
+- [name](CustomItem.md#name)
+- [quantity](CustomItem.md#quantity)
+- [sku](CustomItem.md#sku)
+
+## Properties
+
+### extendedListPrice
+
+• **extendedListPrice**: `number`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### listPrice
+
+• **listPrice**: `number`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### quantity
+
+• **quantity**: `number`
+
+___
+
+### sku
+
+• **sku**: `string`

package/docs/interfaces/Customer.md

@@ -0,0 +1,84 @@
+[@bigcommerce/checkout-sdk](../README.md) / Customer
+
+# Interface: Customer
+
+## Table of contents
+
+### Properties
+
+- [addresses](Customer.md#addresses)
+- [customerGroup](Customer.md#customergroup)
+- [email](Customer.md#email)
+- [firstName](Customer.md#firstname)
+- [fullName](Customer.md#fullname)
+- [id](Customer.md#id)
+- [isGuest](Customer.md#isguest)
+- [lastName](Customer.md#lastname)
+- [shouldEncourageSignIn](Customer.md#shouldencouragesignin)
+- [storeCredit](Customer.md#storecredit)
+
+## Properties
+
+### addresses
+
+• **addresses**: [`CustomerAddress`](CustomerAddress.md)[]
+
+___
+
+### customerGroup
+
+• `Optional` **customerGroup**: [`CustomerGroup`](CustomerGroup.md)
+
+___
+
+### email
+
+• **email**: `string`
+
+The email address of the signed in customer.
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+___
+
+### fullName
+
+• **fullName**: `string`
+
+___
+
+### id
+
+• **id**: `number`
+
+___
+
+### isGuest
+
+• **isGuest**: `boolean`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+___
+
+### shouldEncourageSignIn
+
+• **shouldEncourageSignIn**: `boolean`
+
+Indicates whether the customer should be prompted to sign-in.
+
+Note: You need to enable "Prompt existing accounts to sign in" in your Checkout Settings.
+
+___
+
+### storeCredit
+
+• **storeCredit**: `number`

package/docs/interfaces/CustomerAccountRequestBody.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / CustomerAccountRequestBody
+
+# Interface: CustomerAccountRequestBody
+
+## Table of contents
+
+### Properties
+
+- [acceptsMarketingEmails](CustomerAccountRequestBody.md#acceptsmarketingemails)
+- [customFields](CustomerAccountRequestBody.md#customfields)
+- [email](CustomerAccountRequestBody.md#email)
+- [firstName](CustomerAccountRequestBody.md#firstname)
+- [lastName](CustomerAccountRequestBody.md#lastname)
+- [password](CustomerAccountRequestBody.md#password)
+
+## Properties
+
+### acceptsMarketingEmails
+
+• `Optional` **acceptsMarketingEmails**: `boolean`
+
+___
+
+### customFields
+
+• `Optional` **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+___
+
+### email
+
+• **email**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+___
+
+### password
+
+• **password**: `string`