@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.StoreConfig.md

@@ -0,0 +1,117 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StoreConfig
+
+# Interface: StoreConfig
+
+[<internal>](../modules/internal_.md).StoreConfig
+
+## Table of contents
+
+### Properties
+
+- [cdnPath](internal_.StoreConfig.md#cdnpath)
+- [checkoutSettings](internal_.StoreConfig.md#checkoutsettings)
+- [currency](internal_.StoreConfig.md#currency)
+- [displayDateFormat](internal_.StoreConfig.md#displaydateformat)
+- [displaySettings](internal_.StoreConfig.md#displaysettings)
+- [formFields](internal_.StoreConfig.md#formfields)
+- [imageDirectory](internal_.StoreConfig.md#imagedirectory)
+- [inputDateFormat](internal_.StoreConfig.md#inputdateformat)
+- [isAngularDebuggingEnabled](internal_.StoreConfig.md#isangulardebuggingenabled)
+- [links](internal_.StoreConfig.md#links)
+- [paymentSettings](internal_.StoreConfig.md#paymentsettings)
+- [shopperConfig](internal_.StoreConfig.md#shopperconfig)
+- [shopperCurrency](internal_.StoreConfig.md#shoppercurrency)
+- [storeProfile](internal_.StoreConfig.md#storeprofile)
+
+## Properties
+
+### cdnPath
+
+• **cdnPath**: `string`
+
+___
+
+### checkoutSettings
+
+• **checkoutSettings**: [`CheckoutSettings`](internal_.CheckoutSettings.md)
+
+___
+
+### currency
+
+• **currency**: [`StoreCurrency`](internal_.StoreCurrency.md)
+
+___
+
+### displayDateFormat
+
+• **displayDateFormat**: `string`
+
+___
+
+### displaySettings
+
+• **displaySettings**: [`DisplaySettings`](internal_.DisplaySettings.md)
+
+___
+
+### formFields
+
+• **formFields**: [`FormFields`](internal_.FormFields.md)
+
+**`deprecated`** Please use instead the data selectors
+
+**`remarks`** ```js
+const data = CheckoutService.getState().data;
+const shippingAddressFields = data.getShippingAddressFields('US');
+const billingAddressFields = data.getBillingAddressFields('US');
+const customerAccountFields = data.getCustomerAccountFields();
+```
+
+___
+
+### imageDirectory
+
+• **imageDirectory**: `string`
+
+___
+
+### inputDateFormat
+
+• **inputDateFormat**: `string`
+
+___
+
+### isAngularDebuggingEnabled
+
+• **isAngularDebuggingEnabled**: `boolean`
+
+___
+
+### links
+
+• **links**: [`StoreLinks`](internal_.StoreLinks.md)
+
+___
+
+### paymentSettings
+
+• **paymentSettings**: [`PaymentSettings`](internal_.PaymentSettings.md)
+
+___
+
+### shopperConfig
+
+• **shopperConfig**: [`ShopperConfig`](internal_.ShopperConfig.md)
+
+___
+
+### shopperCurrency
+
+• **shopperCurrency**: [`ShopperCurrency`](internal_.ShopperCurrency.md)
+
+___
+
+### storeProfile
+
+• **storeProfile**: [`StoreProfile`](internal_.StoreProfile.md)

package/docs/interfaces/internal_.StoreCurrency.md

@@ -0,0 +1,58 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StoreCurrency
+
+# Interface: StoreCurrency
+
+[<internal>](../modules/internal_.md).StoreCurrency
+
+## Hierarchy
+
+- **`StoreCurrency`**
+
+  ↳ [`ShopperCurrency`](internal_.ShopperCurrency.md)
+
+## Table of contents
+
+### Properties
+
+- [code](internal_.StoreCurrency.md#code)
+- [decimalPlaces](internal_.StoreCurrency.md#decimalplaces)
+- [decimalSeparator](internal_.StoreCurrency.md#decimalseparator)
+- [symbol](internal_.StoreCurrency.md#symbol)
+- [symbolLocation](internal_.StoreCurrency.md#symbollocation)
+- [thousandsSeparator](internal_.StoreCurrency.md#thousandsseparator)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+___
+
+### decimalPlaces
+
+• **decimalPlaces**: `string`
+
+___
+
+### decimalSeparator
+
+• **decimalSeparator**: `string`
+
+___
+
+### symbol
+
+• **symbol**: `string`
+
+___
+
+### symbolLocation
+
+• **symbolLocation**: `string`
+
+___
+
+### thousandsSeparator
+
+• **thousandsSeparator**: `string`

package/docs/interfaces/internal_.StoreLinks.md

@@ -0,0 +1,59 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StoreLinks
+
+# Interface: StoreLinks
+
+[<internal>](../modules/internal_.md).StoreLinks
+
+## Table of contents
+
+### Properties
+
+- [cartLink](internal_.StoreLinks.md#cartlink)
+- [checkoutLink](internal_.StoreLinks.md#checkoutlink)
+- [createAccountLink](internal_.StoreLinks.md#createaccountlink)
+- [forgotPasswordLink](internal_.StoreLinks.md#forgotpasswordlink)
+- [loginLink](internal_.StoreLinks.md#loginlink)
+- [orderConfirmationLink](internal_.StoreLinks.md#orderconfirmationlink)
+- [siteLink](internal_.StoreLinks.md#sitelink)
+
+## Properties
+
+### cartLink
+
+• **cartLink**: `string`
+
+___
+
+### checkoutLink
+
+• **checkoutLink**: `string`
+
+___
+
+### createAccountLink
+
+• **createAccountLink**: `string`
+
+___
+
+### forgotPasswordLink
+
+• **forgotPasswordLink**: `string`
+
+___
+
+### loginLink
+
+• **loginLink**: `string`
+
+___
+
+### orderConfirmationLink
+
+• **orderConfirmationLink**: `string`
+
+___
+
+### siteLink
+
+• **siteLink**: `string`

package/docs/interfaces/internal_.StoreProfile.md

@@ -0,0 +1,73 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StoreProfile
+
+# Interface: StoreProfile
+
+[<internal>](../modules/internal_.md).StoreProfile
+
+## Table of contents
+
+### Properties
+
+- [orderEmail](internal_.StoreProfile.md#orderemail)
+- [shopPath](internal_.StoreProfile.md#shoppath)
+- [storeCountry](internal_.StoreProfile.md#storecountry)
+- [storeCountryCode](internal_.StoreProfile.md#storecountrycode)
+- [storeHash](internal_.StoreProfile.md#storehash)
+- [storeId](internal_.StoreProfile.md#storeid)
+- [storeLanguage](internal_.StoreProfile.md#storelanguage)
+- [storeName](internal_.StoreProfile.md#storename)
+- [storePhoneNumber](internal_.StoreProfile.md#storephonenumber)
+
+## Properties
+
+### orderEmail
+
+• **orderEmail**: `string`
+
+___
+
+### shopPath
+
+• **shopPath**: `string`
+
+___
+
+### storeCountry
+
+• **storeCountry**: `string`
+
+___
+
+### storeCountryCode
+
+• **storeCountryCode**: `string`
+
+___
+
+### storeHash
+
+• **storeHash**: `string`
+
+___
+
+### storeId
+
+• **storeId**: `string`
+
+___
+
+### storeLanguage
+
+• **storeLanguage**: `string`
+
+___
+
+### storeName
+
+• **storeName**: `string`
+
+___
+
+### storePhoneNumber
+
+• **storePhoneNumber**: `string`

package/docs/interfaces/internal_.StripeCustomerEvent.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeCustomerEvent
+
+# Interface: StripeCustomerEvent
+
+[<internal>](../modules/internal_.md).StripeCustomerEvent
+
+## Hierarchy
+
+- [`StripeEvent`](internal_.StripeEvent.md)
+
+  ↳ **`StripeCustomerEvent`**
+
+## Table of contents
+
+### Properties
+
+- [authenticated](internal_.StripeCustomerEvent.md#authenticated)
+- [collapsed](internal_.StripeCustomerEvent.md#collapsed)
+- [complete](internal_.StripeCustomerEvent.md#complete)
+- [elementType](internal_.StripeCustomerEvent.md#elementtype)
+- [empty](internal_.StripeCustomerEvent.md#empty)
+- [value](internal_.StripeCustomerEvent.md#value)
+
+## Properties
+
+### authenticated
+
+• **authenticated**: `boolean`
+
+___
+
+### collapsed
+
+• `Optional` **collapsed**: `boolean`
+
+___
+
+### complete
+
+• **complete**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[complete](internal_.StripeEvent.md#complete)
+
+___
+
+### elementType
+
+• **elementType**: `string`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[elementType](internal_.StripeEvent.md#elementtype)
+
+___
+
+### empty
+
+• **empty**: `boolean`
+
+#### Inherited from
+
+[StripeEvent](internal_.StripeEvent.md).[empty](internal_.StripeEvent.md#empty)
+
+___
+
+### value
+
+• **value**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |

package/docs/interfaces/internal_.StripeElementCSSProperties.md

@@ -0,0 +1,172 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeElementCSSProperties
+
+# Interface: StripeElementCSSProperties
+
+[<internal>](../modules/internal_.md).StripeElementCSSProperties
+
+CSS properties supported by Stripe.js.
+
+## Hierarchy
+
+- **`StripeElementCSSProperties`**
+
+  ↳ [`StripeElementStyleVariant`](internal_.StripeElementStyleVariant.md)
+
+## Table of contents
+
+### Properties
+
+- [backgroundColor](internal_.StripeElementCSSProperties.md#backgroundcolor)
+- [color](internal_.StripeElementCSSProperties.md#color)
+- [fontFamily](internal_.StripeElementCSSProperties.md#fontfamily)
+- [fontSize](internal_.StripeElementCSSProperties.md#fontsize)
+- [fontSmoothing](internal_.StripeElementCSSProperties.md#fontsmoothing)
+- [fontStyle](internal_.StripeElementCSSProperties.md#fontstyle)
+- [fontVariant](internal_.StripeElementCSSProperties.md#fontvariant)
+- [fontWeight](internal_.StripeElementCSSProperties.md#fontweight)
+- [iconColor](internal_.StripeElementCSSProperties.md#iconcolor)
+- [letterSpacing](internal_.StripeElementCSSProperties.md#letterspacing)
+- [lineHeight](internal_.StripeElementCSSProperties.md#lineheight)
+- [padding](internal_.StripeElementCSSProperties.md#padding)
+- [textAlign](internal_.StripeElementCSSProperties.md#textalign)
+- [textDecoration](internal_.StripeElementCSSProperties.md#textdecoration)
+- [textShadow](internal_.StripeElementCSSProperties.md#textshadow)
+- [textTransform](internal_.StripeElementCSSProperties.md#texttransform)
+
+## Properties
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+The [background-color](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) CSS property.
+
+This property works best with the `::selection` pseudo-class.
+In other cases, consider setting the background color on the element's container instaed.
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+The [color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) CSS property.
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+The [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) CSS property.
+
+___
+
+### fontSize
+
+• `Optional` **fontSize**: `string`
+
+The [font-size](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) CSS property.
+
+___
+
+### fontSmoothing
+
+• `Optional` **fontSmoothing**: `string`
+
+The [font-smoothing](https://developer.mozilla.org/en-US/docs/Web/CSS/font-smoothing) CSS property.
+
+___
+
+### fontStyle
+
+• `Optional` **fontStyle**: `string`
+
+The [font-style](https://developer.mozilla.org/en-US/docs/Web/CSS/font-style) CSS property.
+
+___
+
+### fontVariant
+
+• `Optional` **fontVariant**: `string`
+
+The [font-variant](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant) CSS property.
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+The [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) CSS property.
+
+___
+
+### iconColor
+
+• `Optional` **iconColor**: `string`
+
+A custom property, used to set the color of the icons that are rendered in an element.
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+The [letter-spacing](https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing) CSS property.
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+The [line-height](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height) CSS property.
+
+To avoid cursors being rendered inconsistently across browsers, consider using a padding on the element's container instead.
+
+___
+
+### padding
+
+• `Optional` **padding**: `string`
+
+The [padding](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) CSS property.
+
+Available for the `idealBank` element.
+Accepts integer `px` values.
+
+___
+
+### textAlign
+
+• `Optional` **textAlign**: `string`
+
+The [text-align](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) CSS property.
+
+Available for the `cardNumber`, `cardExpiry`, and `cardCvc` elements.
+
+___
+
+### textDecoration
+
+• `Optional` **textDecoration**: `string`
+
+The [text-decoration](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) CSS property.
+
+___
+
+### textShadow
+
+• `Optional` **textShadow**: `string`
+
+The [text-shadow](https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow) CSS property.
+
+___
+
+### textTransform
+
+• `Optional` **textTransform**: `string`
+
+The [text-transform](https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform) CSS property.

package/docs/interfaces/internal_.StripeElementClasses.md

@@ -0,0 +1,65 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeElementClasses
+
+# Interface: StripeElementClasses
+
+[<internal>](../modules/internal_.md).StripeElementClasses
+
+## Table of contents
+
+### Properties
+
+- [base](internal_.StripeElementClasses.md#base)
+- [complete](internal_.StripeElementClasses.md#complete)
+- [empty](internal_.StripeElementClasses.md#empty)
+- [focus](internal_.StripeElementClasses.md#focus)
+- [invalid](internal_.StripeElementClasses.md#invalid)
+- [webkitAutoFill](internal_.StripeElementClasses.md#webkitautofill)
+
+## Properties
+
+### base
+
+• `Optional` **base**: `string`
+
+The base class applied to the container. Defaults to StripeElement.
+
+___
+
+### complete
+
+• `Optional` **complete**: `string`
+
+The class name to apply when the Element is complete. Defaults to StripeElement--complete.
+
+___
+
+### empty
+
+• `Optional` **empty**: `string`
+
+The class name to apply when the Element is empty. Defaults to StripeElement--empty.
+
+___
+
+### focus
+
+• `Optional` **focus**: `string`
+
+The class name to apply when the Element is focused. Defaults to StripeElement--focus.
+
+___
+
+### invalid
+
+• `Optional` **invalid**: `string`
+
+The class name to apply when the Element is invalid. Defaults to StripeElement--invalid.
+
+___
+
+### webkitAutoFill
+
+• `Optional` **webkitAutoFill**: `string`
+
+The class name to apply when the Element has its value autofilled by the browser
+(only on Chrome and Safari). Defaults to StripeElement--webkit-autofill.

package/docs/interfaces/internal_.StripeElementStyle.md

@@ -0,0 +1,46 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeElementStyle
+
+# Interface: StripeElementStyle
+
+[<internal>](../modules/internal_.md).StripeElementStyle
+
+## Table of contents
+
+### Properties
+
+- [base](internal_.StripeElementStyle.md#base)
+- [complete](internal_.StripeElementStyle.md#complete)
+- [empty](internal_.StripeElementStyle.md#empty)
+- [invalid](internal_.StripeElementStyle.md#invalid)
+
+## Properties
+
+### base
+
+• `Optional` **base**: [`StripeElementStyleVariant`](internal_.StripeElementStyleVariant.md)
+
+Base variant—all other variants inherit from these styles.
+
+___
+
+### complete
+
+• `Optional` **complete**: [`StripeElementStyleVariant`](internal_.StripeElementStyleVariant.md)
+
+Applied when the element has valid input.
+
+___
+
+### empty
+
+• `Optional` **empty**: [`StripeElementStyleVariant`](internal_.StripeElementStyleVariant.md)
+
+Applied when the element has no customer input.
+
+___
+
+### invalid
+
+• `Optional` **invalid**: [`StripeElementStyleVariant`](internal_.StripeElementStyleVariant.md)
+
+Applied when the element has invalid input.