@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/LanguageConfig.md

@@ -0,0 +1,57 @@
+[@bigcommerce/checkout-sdk](../README.md) / LanguageConfig
+
+# Interface: LanguageConfig
+
+## Table of contents
+
+### Properties
+
+- [defaultLocale](LanguageConfig.md#defaultlocale)
+- [defaultTranslations](LanguageConfig.md#defaulttranslations)
+- [fallbackLocale](LanguageConfig.md#fallbacklocale)
+- [fallbackTranslations](LanguageConfig.md#fallbacktranslations)
+- [locale](LanguageConfig.md#locale)
+- [locales](LanguageConfig.md#locales)
+- [translations](LanguageConfig.md#translations)
+
+## Properties
+
+### defaultLocale
+
+• `Optional` **defaultLocale**: `string`
+
+___
+
+### defaultTranslations
+
+• **defaultTranslations**: [`Translations`](Translations.md)
+
+___
+
+### fallbackLocale
+
+• `Optional` **fallbackLocale**: `string`
+
+___
+
+### fallbackTranslations
+
+• `Optional` **fallbackTranslations**: [`Translations`](Translations.md)
+
+___
+
+### locale
+
+• **locale**: `string`
+
+___
+
+### locales
+
+• **locales**: [`Locales`](Locales.md)
+
+___
+
+### translations
+
+• **translations**: [`Translations`](Translations.md)

package/docs/interfaces/LineItem.md

@@ -0,0 +1,191 @@
+[@bigcommerce/checkout-sdk](../README.md) / LineItem
+
+# Interface: LineItem
+
+## Hierarchy
+
+- **`LineItem`**
+
+  ↳ [`DigitalItem`](DigitalItem.md)
+
+  ↳ [`PhysicalItem`](PhysicalItem.md)
+
+## Table of contents
+
+### Properties
+
+- [addedByPromotion](LineItem.md#addedbypromotion)
+- [brand](LineItem.md#brand)
+- [categories](LineItem.md#categories)
+- [categoryNames](LineItem.md#categorynames)
+- [comparisonPrice](LineItem.md#comparisonprice)
+- [couponAmount](LineItem.md#couponamount)
+- [discountAmount](LineItem.md#discountamount)
+- [discounts](LineItem.md#discounts)
+- [extendedComparisonPrice](LineItem.md#extendedcomparisonprice)
+- [extendedListPrice](LineItem.md#extendedlistprice)
+- [extendedSalePrice](LineItem.md#extendedsaleprice)
+- [id](LineItem.md#id)
+- [imageUrl](LineItem.md#imageurl)
+- [isTaxable](LineItem.md#istaxable)
+- [listPrice](LineItem.md#listprice)
+- [name](LineItem.md#name)
+- [options](LineItem.md#options)
+- [parentId](LineItem.md#parentid)
+- [productId](LineItem.md#productid)
+- [quantity](LineItem.md#quantity)
+- [salePrice](LineItem.md#saleprice)
+- [sku](LineItem.md#sku)
+- [socialMedia](LineItem.md#socialmedia)
+- [url](LineItem.md#url)
+- [variantId](LineItem.md#variantid)
+
+## Properties
+
+### addedByPromotion
+
+• **addedByPromotion**: `boolean`
+
+___
+
+### brand
+
+• **brand**: `string`
+
+___
+
+### categories
+
+• `Optional` **categories**: [`LineItemCategory`](LineItemCategory.md)[][]
+
+___
+
+### categoryNames
+
+• `Optional` **categoryNames**: `string`[]
+
+___
+
+### comparisonPrice
+
+• **comparisonPrice**: `number`
+
+___
+
+### couponAmount
+
+• **couponAmount**: `number`
+
+___
+
+### discountAmount
+
+• **discountAmount**: `number`
+
+___
+
+### discounts
+
+• **discounts**: { `discountedAmount`: `number` ; `name`: `string`  }[]
+
+___
+
+### extendedComparisonPrice
+
+• **extendedComparisonPrice**: `number`
+
+___
+
+### extendedListPrice
+
+• **extendedListPrice**: `number`
+
+___
+
+### extendedSalePrice
+
+• **extendedSalePrice**: `number`
+
+___
+
+### id
+
+• **id**: `string` \| `number`
+
+___
+
+### imageUrl
+
+• **imageUrl**: `string`
+
+___
+
+### isTaxable
+
+• **isTaxable**: `boolean`
+
+___
+
+### listPrice
+
+• **listPrice**: `number`
+
+___
+
+### name
+
+• **name**: `string`
+
+___
+
+### options
+
+• `Optional` **options**: [`LineItemOption`](LineItemOption.md)[]
+
+___
+
+### parentId
+
+• `Optional` **parentId**: ``null`` \| `string`
+
+___
+
+### productId
+
+• **productId**: `number`
+
+___
+
+### quantity
+
+• **quantity**: `number`
+
+___
+
+### salePrice
+
+• **salePrice**: `number`
+
+___
+
+### sku
+
+• **sku**: `string`
+
+___
+
+### socialMedia
+
+• `Optional` **socialMedia**: [`LineItemSocialData`](LineItemSocialData.md)[]
+
+___
+
+### url
+
+• **url**: `string`
+
+___
+
+### variantId
+
+• **variantId**: `number`

package/docs/interfaces/LineItemCategory.md

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

package/docs/interfaces/LineItemMap.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / LineItemMap
+
+# Interface: LineItemMap
+
+## Table of contents
+
+### Properties
+
+- [customItems](LineItemMap.md#customitems)
+- [digitalItems](LineItemMap.md#digitalitems)
+- [giftCertificates](LineItemMap.md#giftcertificates)
+- [physicalItems](LineItemMap.md#physicalitems)
+
+## Properties
+
+### customItems
+
+• `Optional` **customItems**: [`CustomItem`](CustomItem.md)[]
+
+___
+
+### digitalItems
+
+• **digitalItems**: [`DigitalItem`](DigitalItem.md)[]
+
+___
+
+### giftCertificates
+
+• **giftCertificates**: [`GiftCertificateItem`](GiftCertificateItem.md)[]
+
+___
+
+### physicalItems
+
+• **physicalItems**: [`PhysicalItem`](PhysicalItem.md)[]

package/docs/interfaces/LineItemOption.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / LineItemOption
+
+# Interface: LineItemOption
+
+## Table of contents
+
+### Properties
+
+- [name](LineItemOption.md#name)
+- [nameId](LineItemOption.md#nameid)
+- [value](LineItemOption.md#value)
+- [valueId](LineItemOption.md#valueid)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+___
+
+### nameId
+
+• **nameId**: `number`
+
+___
+
+### value
+
+• **value**: `string`
+
+___
+
+### valueId
+
+• **valueId**: ``null`` \| `number`

package/docs/interfaces/LineItemSocialData.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / LineItemSocialData
+
+# Interface: LineItemSocialData
+
+## Table of contents
+
+### Properties
+
+- [channel](LineItemSocialData.md#channel)
+- [code](LineItemSocialData.md#code)
+- [link](LineItemSocialData.md#link)
+- [text](LineItemSocialData.md#text)
+
+## Properties
+
+### channel
+
+• **channel**: `string`
+
+___
+
+### code
+
+• **code**: `string`
+
+___
+
+### link
+
+• **link**: `string`
+
+___
+
+### text
+
+• **text**: `string`

package/docs/interfaces/LinkStyles.md

@@ -0,0 +1,90 @@
+[@bigcommerce/checkout-sdk](../README.md) / LinkStyles
+
+# Interface: LinkStyles
+
+## Hierarchy
+
+- [`InlineElementStyles`](InlineElementStyles.md)
+
+  ↳ **`LinkStyles`**
+
+## Table of contents
+
+### Properties
+
+- [active](LinkStyles.md#active)
+- [color](LinkStyles.md#color)
+- [focus](LinkStyles.md#focus)
+- [fontFamily](LinkStyles.md#fontfamily)
+- [fontWeight](LinkStyles.md#fontweight)
+- [hover](LinkStyles.md#hover)
+- [letterSpacing](LinkStyles.md#letterspacing)
+- [lineHeight](LinkStyles.md#lineheight)
+
+## Properties
+
+### active
+
+• `Optional` **active**: [`InlineElementStyles`](InlineElementStyles.md)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[color](InlineElementStyles.md#color)
+
+___
+
+### focus
+
+• `Optional` **focus**: [`InlineElementStyles`](InlineElementStyles.md)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[fontFamily](InlineElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[fontWeight](InlineElementStyles.md#fontweight)
+
+___
+
+### hover
+
+• `Optional` **hover**: [`InlineElementStyles`](InlineElementStyles.md)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[letterSpacing](InlineElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[lineHeight](InlineElementStyles.md#lineheight)

package/docs/interfaces/LoadingIndicatorStyles.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / LoadingIndicatorStyles
+
+# Interface: LoadingIndicatorStyles
+
+## Table of contents
+
+### Properties
+
+- [backgroundColor](LoadingIndicatorStyles.md#backgroundcolor)
+- [color](LoadingIndicatorStyles.md#color)
+- [size](LoadingIndicatorStyles.md#size)
+
+## Properties
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+___
+
+### size
+
+• `Optional` **size**: `number`

package/docs/interfaces/Locales.md

@@ -0,0 +1,7 @@
+[@bigcommerce/checkout-sdk](../README.md) / Locales
+
+# Interface: Locales
+
+## Indexable
+
+▪ [key: `string`]: `string`

package/docs/interfaces/MasterpassCustomerInitializeOptions.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / MasterpassCustomerInitializeOptions
+
+# Interface: MasterpassCustomerInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [container](MasterpassCustomerInitializeOptions.md#container)
+
+## Properties
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the checkout button should be inserted into.

package/docs/interfaces/MasterpassPaymentInitializeOptions.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / MasterpassPaymentInitializeOptions
+
+# Interface: MasterpassPaymentInitializeOptions
+
+A set of options that are required to initialize the Masterpass payment method.
+
+```html
+<!-- This is where the Masterpass button will be inserted -->
+<div id="wallet-button"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'masterpass',
+    masterpass: {
+        walletButton: 'wallet-button'
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [walletButton](MasterpassPaymentInitializeOptions.md#walletbutton)
+
+## Properties
+
+### 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.

package/docs/interfaces/MolliePaymentInitializeOptions.md

@@ -0,0 +1,96 @@
+[@bigcommerce/checkout-sdk](../README.md) / MolliePaymentInitializeOptions
+
+# Interface: MolliePaymentInitializeOptions
+
+A set of options that are required to initialize the Mollie payment method.
+
+Once Mollie payment is initialized, credit card form fields are provided by the
+payment provider as IFrames, these will be inserted into the current page. These
+options provide a location and styling for each of the form fields.
+
+```js
+service.initializePayment({
+     methodId: 'mollie',
+     mollie: {
+         containerId: 'container',
+         cardNumberId: '',
+         cardHolderId: '',
+         cardCvcId: '',
+         cardExpiryId: '',
+         styles : {
+             base: {
+                 color: '#fff'
+             }
+         }
+     }
+});
+
+## Table of contents
+
+### Properties
+
+- [cardCvcId](MolliePaymentInitializeOptions.md#cardcvcid)
+- [cardExpiryId](MolliePaymentInitializeOptions.md#cardexpiryid)
+- [cardHolderId](MolliePaymentInitializeOptions.md#cardholderid)
+- [cardNumberId](MolliePaymentInitializeOptions.md#cardnumberid)
+- [containerId](MolliePaymentInitializeOptions.md#containerid)
+- [form](MolliePaymentInitializeOptions.md#form)
+- [styles](MolliePaymentInitializeOptions.md#styles)
+
+## Properties
+
+### cardCvcId
+
+• **cardCvcId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardExpiryId
+
+• **cardExpiryId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardHolderId
+
+• **cardHolderId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### cardNumberId
+
+• **cardNumberId**: `string`
+
+The location to insert Mollie Component
+
+___
+
+### containerId
+
+• `Optional` **containerId**: `string`
+
+ContainerId is use in Mollie for determined either its showing or not the
+container, because when Mollie has Vaulted Instruments it gets hide,
+and shows an error because can't mount Provider Components
+
+___
+
+### form
+
+• `Optional` **form**: [`HostedFormOptions`](HostedFormOptions.md)
+
+Hosted Form Validation Options
+
+___
+
+### styles
+
+• **styles**: `object`
+
+A set of styles required for the mollie components

package/docs/interfaces/MonerisPaymentInitializeOptions.md

@@ -0,0 +1,57 @@
+[@bigcommerce/checkout-sdk](../README.md) / MonerisPaymentInitializeOptions
+
+# Interface: MonerisPaymentInitializeOptions
+
+A set of options that are required to initialize the Moneris payment method.
+
+Once Moneris payment is initialized, a credit card payment form is provided by the
+payment provider as an IFrame, it will be inserted into the current page. These
+options provide a location and styling for the payment form.
+
+```js
+service.initializePayment({
+     methodId: 'moneris',
+     moneris: {
+         containerId: 'container',
+         style : {
+             cssBody: 'background:white;';
+             cssTextbox: 'border-width:2px;';
+             cssTextboxCardNumber: 'width:140px;';
+             cssTextboxExpiryDate: 'width:40px;';
+             cssTextboxCVV: 'width:40px';
+         }
+     }
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [containerId](MonerisPaymentInitializeOptions.md#containerid)
+- [form](MonerisPaymentInitializeOptions.md#form)
+- [style](MonerisPaymentInitializeOptions.md#style)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The ID of a container where the Moneris iframe component should be mounted
+
+___
+
+### form
+
+• `Optional` **form**: [`HostedFormOptions`](HostedFormOptions.md)
+
+Hosted Form Validation Options
+
+___
+
+### style
+
+• `Optional` **style**: [`MonerisStylingProps`](MonerisStylingProps.md)
+
+The styling props to apply to the iframe component