@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/StripeElementCSSProperties.md

@@ -0,0 +1,170 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeElementCSSProperties
+
+# Interface: StripeElementCSSProperties
+
+CSS properties supported by Stripe.js.
+
+## Hierarchy
+
+- **`StripeElementCSSProperties`**
+
+  ↳ [`StripeElementStyleVariant`](StripeElementStyleVariant.md)
+
+## Table of contents
+
+### Properties
+
+- [backgroundColor](StripeElementCSSProperties.md#backgroundcolor)
+- [color](StripeElementCSSProperties.md#color)
+- [fontFamily](StripeElementCSSProperties.md#fontfamily)
+- [fontSize](StripeElementCSSProperties.md#fontsize)
+- [fontSmoothing](StripeElementCSSProperties.md#fontsmoothing)
+- [fontStyle](StripeElementCSSProperties.md#fontstyle)
+- [fontVariant](StripeElementCSSProperties.md#fontvariant)
+- [fontWeight](StripeElementCSSProperties.md#fontweight)
+- [iconColor](StripeElementCSSProperties.md#iconcolor)
+- [letterSpacing](StripeElementCSSProperties.md#letterspacing)
+- [lineHeight](StripeElementCSSProperties.md#lineheight)
+- [padding](StripeElementCSSProperties.md#padding)
+- [textAlign](StripeElementCSSProperties.md#textalign)
+- [textDecoration](StripeElementCSSProperties.md#textdecoration)
+- [textShadow](StripeElementCSSProperties.md#textshadow)
+- [textTransform](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/StripeElementClasses.md

@@ -0,0 +1,63 @@
+[@bigcommerce/checkout-sdk](../README.md) / StripeElementClasses
+
+# Interface: StripeElementClasses
+
+## Table of contents
+
+### Properties
+
+- [base](StripeElementClasses.md#base)
+- [complete](StripeElementClasses.md#complete)
+- [empty](StripeElementClasses.md#empty)
+- [focus](StripeElementClasses.md#focus)
+- [invalid](StripeElementClasses.md#invalid)
+- [webkitAutoFill](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/StripeElementStyle.md

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

package/docs/interfaces/StripeElementStyleVariant.md

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

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

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