@bigcommerce/checkout-sdk 1.271.1 → 1.271.2

package/docs/interfaces/StripeElementStyleVariant.md

@@ -1,285 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeElementStyleVariant
-
-# Interface: StripeElementStyleVariant
-
-## Hierarchy
-
-- [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-  ↳ **`StripeElementStyleVariant`**
-
-## Table of contents
-
-### Properties
-
-- [%3A-webkit-autofill](StripeElementStyleVariant.md#:-webkit-autofill)
-- [%3A%3A-ms-clear](StripeElementStyleVariant.md#::-ms-clear)
-- [%3A%3Aplaceholder](StripeElementStyleVariant.md#::placeholder)
-- [%3A%3Aselection](StripeElementStyleVariant.md#::selection)
-- [%3Adisabled](StripeElementStyleVariant.md#:disabled)
-- [%3Afocus](StripeElementStyleVariant.md#:focus)
-- [%3Ahover](StripeElementStyleVariant.md#:hover)
-- [backgroundColor](StripeElementStyleVariant.md#backgroundcolor)
-- [color](StripeElementStyleVariant.md#color)
-- [fontFamily](StripeElementStyleVariant.md#fontfamily)
-- [fontSize](StripeElementStyleVariant.md#fontsize)
-- [fontSmoothing](StripeElementStyleVariant.md#fontsmoothing)
-- [fontStyle](StripeElementStyleVariant.md#fontstyle)
-- [fontVariant](StripeElementStyleVariant.md#fontvariant)
-- [fontWeight](StripeElementStyleVariant.md#fontweight)
-- [iconColor](StripeElementStyleVariant.md#iconcolor)
-- [letterSpacing](StripeElementStyleVariant.md#letterspacing)
-- [lineHeight](StripeElementStyleVariant.md#lineheight)
-- [padding](StripeElementStyleVariant.md#padding)
-- [textAlign](StripeElementStyleVariant.md#textalign)
-- [textDecoration](StripeElementStyleVariant.md#textdecoration)
-- [textShadow](StripeElementStyleVariant.md#textshadow)
-- [textTransform](StripeElementStyleVariant.md#texttransform)
-
-## Properties
-
-### :-webkit-autofill
-
-• `Optional` **:-webkit-autofill**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-___
-
-### ::-ms-clear
-
-• `Optional` **::-ms-clear**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md) & { `display`: `string`  }
-
-Available for the `cardNumber`, `cardExpiry`, and `cardCvc` elements.
-
-___
-
-### ::placeholder
-
-• `Optional` **::placeholder**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-___
-
-### ::selection
-
-• `Optional` **::selection**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-___
-
-### :disabled
-
-• `Optional` **:disabled**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-Available for all elements except the `paymentRequestButton` element
-
-___
-
-### :focus
-
-• `Optional` **:focus**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-___
-
-### :hover
-
-• `Optional` **:hover**: [`StripeElementCSSProperties`](StripeElementCSSProperties.md)
-
-___
-
-### 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.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[backgroundColor](StripeElementCSSProperties.md#backgroundcolor)
-
-___
-
-### color
-
-• `Optional` **color**: `string`
-
-The [color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[color](StripeElementCSSProperties.md#color)
-
-___
-
-### fontFamily
-
-• `Optional` **fontFamily**: `string`
-
-The [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontFamily](StripeElementCSSProperties.md#fontfamily)
-
-___
-
-### fontSize
-
-• `Optional` **fontSize**: `string`
-
-The [font-size](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontSize](StripeElementCSSProperties.md#fontsize)
-
-___
-
-### fontSmoothing
-
-• `Optional` **fontSmoothing**: `string`
-
-The [font-smoothing](https://developer.mozilla.org/en-US/docs/Web/CSS/font-smoothing) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontSmoothing](StripeElementCSSProperties.md#fontsmoothing)
-
-___
-
-### fontStyle
-
-• `Optional` **fontStyle**: `string`
-
-The [font-style](https://developer.mozilla.org/en-US/docs/Web/CSS/font-style) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontStyle](StripeElementCSSProperties.md#fontstyle)
-
-___
-
-### fontVariant
-
-• `Optional` **fontVariant**: `string`
-
-The [font-variant](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontVariant](StripeElementCSSProperties.md#fontvariant)
-
-___
-
-### fontWeight
-
-• `Optional` **fontWeight**: `string`
-
-The [font-weight](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[fontWeight](StripeElementCSSProperties.md#fontweight)
-
-___
-
-### iconColor
-
-• `Optional` **iconColor**: `string`
-
-A custom property, used to set the color of the icons that are rendered in an element.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[iconColor](StripeElementCSSProperties.md#iconcolor)
-
-___
-
-### letterSpacing
-
-• `Optional` **letterSpacing**: `string`
-
-The [letter-spacing](https://developer.mozilla.org/en-US/docs/Web/CSS/letter-spacing) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[letterSpacing](StripeElementCSSProperties.md#letterspacing)
-
-___
-
-### 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.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[lineHeight](StripeElementCSSProperties.md#lineheight)
-
-___
-
-### 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.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[padding](StripeElementCSSProperties.md#padding)
-
-___
-
-### 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.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[textAlign](StripeElementCSSProperties.md#textalign)
-
-___
-
-### textDecoration
-
-• `Optional` **textDecoration**: `string`
-
-The [text-decoration](https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[textDecoration](StripeElementCSSProperties.md#textdecoration)
-
-___
-
-### textShadow
-
-• `Optional` **textShadow**: `string`
-
-The [text-shadow](https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[textShadow](StripeElementCSSProperties.md#textshadow)
-
-___
-
-### textTransform
-
-• `Optional` **textTransform**: `string`
-
-The [text-transform](https://developer.mozilla.org/en-US/docs/Web/CSS/text-transform) CSS property.
-
-#### Inherited from
-
-[StripeElementCSSProperties](StripeElementCSSProperties.md).[textTransform](StripeElementCSSProperties.md#texttransform)

package/docs/interfaces/StripeUPEPaymentInitializeOptions.md

@@ -1,70 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeUPEPaymentInitializeOptions
-
-# Interface: StripeUPEPaymentInitializeOptions
-
-A set of options that are required to initialize the Stripe payment method.
-
-Once Stripe payment is initialized, credit card form fields, provided by the
-payment provider as iframes, will be inserted into the current page. These
-options provide a location and styling for each of the form fields.
-
-```html
-<!-- This is where the credit card component will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'stripeupe',
-    stripeupe {
-        containerId: 'container',
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](StripeUPEPaymentInitializeOptions.md#containerid)
-- [style](StripeUPEPaymentInitializeOptions.md#style)
-
-### Methods
-
-- [onError](StripeUPEPaymentInitializeOptions.md#onerror)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The location to insert the credit card number form field.
-
-___
-
-### style
-
-• `Optional` **style**: `Object`
-
-Checkout styles from store theme
-
-#### Index signature
-
-▪ [key: `string`]: `string`
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error?` | `Error` |
-
-#### Returns
-
-`void`

package/docs/interfaces/StripeV3PaymentInitializeOptions.md

@@ -1,76 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeV3PaymentInitializeOptions
-
-# Interface: StripeV3PaymentInitializeOptions
-
-A set of options that are required to initialize the Stripe payment method.
-
-Once Stripe payment is initialized, credit card form fields, provided by the
-payment provider as iframes, will be inserted into the current page. These
-options provide a location and styling for each of the form fields.
-
-```html
-<!-- This is where the credit card component will be inserted -->
-<div id="container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'stripev3',
-    stripev3: {
-        containerId: 'container',
-    },
-});
-```
-
-Additional options can be passed in to customize the fields.
-
-```js
-service.initializePayment({
-    methodId: 'stripev3',
-    stripev3: {
-        containerId: 'container',
-        options: {
-            card: {
-                classes: { base: 'form-input' },
-            },
-            iban: {
-                classes: { base: 'form-input' },
-                supportedCountries: ['SEPA'],
-            },
-            idealBank: {
-                classes: { base: 'form-input' },
-            },
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](StripeV3PaymentInitializeOptions.md#containerid)
-- [form](StripeV3PaymentInitializeOptions.md#form)
-- [options](StripeV3PaymentInitializeOptions.md#options)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The location to insert the credit card number form field.
-
-___
-
-### form
-
-• `Optional` **form**: [`HostedFormOptions`](HostedFormOptions.md)
-
-Hosted Form Validation Options
-
-___
-
-### options
-
-• `Optional` **options**: [`CardCvcElementOptions`](CardCvcElementOptions.md) \| [`CardElementOptions`](CardElementOptions.md) \| [`CardExpiryElementOptions`](CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](CardNumberElementOptions.md) \| [`IbanElementOptions`](IbanElementOptions.md) \| [`IdealElementOptions`](IdealElementOptions.md) \| [`IndividualCardElementOptions`](IndividualCardElementOptions.md) \| [`ZipCodeElementOptions`](ZipCodeElementOptions.md)

package/docs/interfaces/StyleOptions.md

@@ -1,44 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StyleOptions
-
-# Interface: StyleOptions
-
-## Table of contents
-
-### Properties
-
-- [base](StyleOptions.md#base)
-- [error](StyleOptions.md#error)
-- [placeholder](StyleOptions.md#placeholder)
-- [validated](StyleOptions.md#validated)
-
-## Properties
-
-### base
-
-• `Optional` **base**: [`CssProperties`](CssProperties.md)
-
-Base styling applied to the iframe. All styling extends from this style.
-
-___
-
-### error
-
-• `Optional` **error**: [`CssProperties`](CssProperties.md)
-
-Styling applied when a field fails validation.
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: [`CssProperties`](CssProperties.md)
-
-Styling applied to the field's placeholder values.
-
-___
-
-### validated
-
-• `Optional` **validated**: [`CssProperties`](CssProperties.md)
-
-Styling applied once a field passes validation.

package/docs/interfaces/StyleOptions_2.md

@@ -1,44 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StyleOptions_2
-
-# Interface: StyleOptions\_2
-
-## Table of contents
-
-### Properties
-
-- [base](StyleOptions_2.md#base)
-- [error](StyleOptions_2.md#error)
-- [placeholder](StyleOptions_2.md#placeholder)
-- [validated](StyleOptions_2.md#validated)
-
-## Properties
-
-### base
-
-• `Optional` **base**: [`CssProperties_2`](CssProperties_2.md)
-
-Base styling applied to the iframe. All styling extends from this style.
-
-___
-
-### error
-
-• `Optional` **error**: [`CssProperties_2`](CssProperties_2.md)
-
-Styling applied when a field fails validation.
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: [`CssProperties_2`](CssProperties_2.md)
-
-Styling applied to the field's placeholder values.
-
-___
-
-### validated
-
-• `Optional` **validated**: [`CssProperties_2`](CssProperties_2.md)
-
-Styling applied once a field passes validation.

package/docs/interfaces/SubInputDetail.md

@@ -1,62 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / SubInputDetail
-
-# Interface: SubInputDetail
-
-## Table of contents
-
-### Properties
-
-- [configuration](SubInputDetail.md#configuration)
-- [items](SubInputDetail.md#items)
-- [key](SubInputDetail.md#key)
-- [optional](SubInputDetail.md#optional)
-- [type](SubInputDetail.md#type)
-- [value](SubInputDetail.md#value)
-
-## Properties
-
-### configuration
-
-• `Optional` **configuration**: `object`
-
-Configuration parameters for the required input.
-
-___
-
-### items
-
-• `Optional` **items**: [`Item_2`](Item_2.md)[]
-
-In case of a select, the items to choose from.
-
-___
-
-### key
-
-• `Optional` **key**: `string`
-
-The value to provide in the result.
-
-___
-
-### optional
-
-• `Optional` **optional**: `boolean`
-
-True if this input is optional to provide.
-
-___
-
-### type
-
-• `Optional` **type**: `string`
-
-The type of the required input.
-
-___
-
-### value
-
-• `Optional` **value**: `string`
-
-The value can be pre-filled, if available.

package/docs/interfaces/SubInputDetail_2.md

@@ -1,62 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / SubInputDetail_2
-
-# Interface: SubInputDetail\_2
-
-## Table of contents
-
-### Properties
-
-- [configuration](SubInputDetail_2.md#configuration)
-- [items](SubInputDetail_2.md#items)
-- [key](SubInputDetail_2.md#key)
-- [optional](SubInputDetail_2.md#optional)
-- [type](SubInputDetail_2.md#type)
-- [value](SubInputDetail_2.md#value)
-
-## Properties
-
-### configuration
-
-• `Optional` **configuration**: `object`
-
-Configuration parameters for the required input.
-
-___
-
-### items
-
-• `Optional` **items**: [`Item_3`](Item_3.md)[]
-
-In case of a select, the items to choose from.
-
-___
-
-### key
-
-• `Optional` **key**: `string`
-
-The value to provide in the result.
-
-___
-
-### optional
-
-• `Optional` **optional**: `boolean`
-
-True if this input is optional to provide.
-
-___
-
-### type
-
-• `Optional` **type**: `string`
-
-The type of the required input.
-
-___
-
-### value
-
-• `Optional` **value**: `string`
-
-The value can be pre-filled, if available.

package/docs/interfaces/Subscriptions.md

@@ -1,29 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / Subscriptions
-
-# Interface: Subscriptions
-
-## Table of contents
-
-### Properties
-
-- [acceptsAbandonedCartEmails](Subscriptions.md#acceptsabandonedcartemails)
-- [acceptsMarketingNewsletter](Subscriptions.md#acceptsmarketingnewsletter)
-- [email](Subscriptions.md#email)
-
-## Properties
-
-### acceptsAbandonedCartEmails
-
-• **acceptsAbandonedCartEmails**: `boolean`
-
-___
-
-### acceptsMarketingNewsletter
-
-• **acceptsMarketingNewsletter**: `boolean`
-
-___
-
-### email
-
-• **email**: `string`

package/docs/interfaces/Tax.md

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