@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.StripeV3PaymentInitializeOptions.md

@@ -0,0 +1,78 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeV3PaymentInitializeOptions
+
+# Interface: StripeV3PaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).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](internal_.StripeV3PaymentInitializeOptions.md#containerid)
+- [form](internal_.StripeV3PaymentInitializeOptions.md#form)
+- [options](internal_.StripeV3PaymentInitializeOptions.md#options)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the credit card number form field.
+
+___
+
+### form
+
+• `Optional` **form**: [`HostedFormOptions`](internal_.HostedFormOptions.md)
+
+Hosted Form Validation Options
+
+___
+
+### options
+
+• `Optional` **options**: [`StripeElementOptions`](../modules/internal_.md#stripeelementoptions) \| [`IndividualCardElementOptions`](internal_.IndividualCardElementOptions.md)

package/docs/interfaces/internal_.StyleOptions.md

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

package/docs/interfaces/internal_.StyleOptions_2.md

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

package/docs/interfaces/internal_.SubInputDetail.md

@@ -0,0 +1,64 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SubInputDetail
+
+# Interface: SubInputDetail
+
+[<internal>](../modules/internal_.md).SubInputDetail
+
+## Table of contents
+
+### Properties
+
+- [configuration](internal_.SubInputDetail.md#configuration)
+- [items](internal_.SubInputDetail.md#items)
+- [key](internal_.SubInputDetail.md#key)
+- [optional](internal_.SubInputDetail.md#optional)
+- [type](internal_.SubInputDetail.md#type)
+- [value](internal_.SubInputDetail.md#value)
+
+## Properties
+
+### configuration
+
+• `Optional` **configuration**: `object`
+
+Configuration parameters for the required input.
+
+___
+
+### items
+
+• `Optional` **items**: [`Item_2`](internal_.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/internal_.SubInputDetail_2.md

@@ -0,0 +1,64 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SubInputDetail\_2
+
+# Interface: SubInputDetail\_2
+
+[<internal>](../modules/internal_.md).SubInputDetail_2
+
+## Table of contents
+
+### Properties
+
+- [configuration](internal_.SubInputDetail_2.md#configuration)
+- [items](internal_.SubInputDetail_2.md#items)
+- [key](internal_.SubInputDetail_2.md#key)
+- [optional](internal_.SubInputDetail_2.md#optional)
+- [type](internal_.SubInputDetail_2.md#type)
+- [value](internal_.SubInputDetail_2.md#value)
+
+## Properties
+
+### configuration
+
+• `Optional` **configuration**: `object`
+
+Configuration parameters for the required input.
+
+___
+
+### items
+
+• `Optional` **items**: [`Item_3`](internal_.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/internal_.Subscriptions.md

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

package/docs/interfaces/internal_.Tax.md

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

package/docs/interfaces/internal_.TextInputStyles.md

@@ -0,0 +1,177 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / TextInputStyles
+
+# Interface: TextInputStyles
+
+[<internal>](../modules/internal_.md).TextInputStyles
+
+## Hierarchy
+
+- [`InputStyles`](internal_.InputStyles.md)
+
+  ↳ **`TextInputStyles`**
+
+## Table of contents
+
+### Properties
+
+- [active](internal_.TextInputStyles.md#active)
+- [backgroundColor](internal_.TextInputStyles.md#backgroundcolor)
+- [borderColor](internal_.TextInputStyles.md#bordercolor)
+- [borderWidth](internal_.TextInputStyles.md#borderwidth)
+- [boxShadow](internal_.TextInputStyles.md#boxshadow)
+- [color](internal_.TextInputStyles.md#color)
+- [disabled](internal_.TextInputStyles.md#disabled)
+- [error](internal_.TextInputStyles.md#error)
+- [focus](internal_.TextInputStyles.md#focus)
+- [fontFamily](internal_.TextInputStyles.md#fontfamily)
+- [fontWeight](internal_.TextInputStyles.md#fontweight)
+- [hover](internal_.TextInputStyles.md#hover)
+- [letterSpacing](internal_.TextInputStyles.md#letterspacing)
+- [lineHeight](internal_.TextInputStyles.md#lineheight)
+- [placeholder](internal_.TextInputStyles.md#placeholder)
+
+## Properties
+
+### active
+
+• `Optional` **active**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[active](internal_.InputStyles.md#active)
+
+___
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[backgroundColor](internal_.InputStyles.md#backgroundcolor)
+
+___
+
+### borderColor
+
+• `Optional` **borderColor**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[borderColor](internal_.InputStyles.md#bordercolor)
+
+___
+
+### borderWidth
+
+• `Optional` **borderWidth**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[borderWidth](internal_.InputStyles.md#borderwidth)
+
+___
+
+### boxShadow
+
+• `Optional` **boxShadow**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[boxShadow](internal_.InputStyles.md#boxshadow)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[color](internal_.InputStyles.md#color)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[disabled](internal_.InputStyles.md#disabled)
+
+___
+
+### error
+
+• `Optional` **error**: [`InputStyles`](internal_.InputStyles.md)
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[error](internal_.InputStyles.md#error)
+
+___
+
+### focus
+
+• `Optional` **focus**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[focus](internal_.InputStyles.md#focus)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[fontFamily](internal_.InputStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[fontWeight](internal_.InputStyles.md#fontweight)
+
+___
+
+### hover
+
+• `Optional` **hover**: [`BlockElementStyles`](internal_.BlockElementStyles.md)
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[hover](internal_.InputStyles.md#hover)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[letterSpacing](internal_.InputStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[InputStyles](internal_.InputStyles.md).[lineHeight](internal_.InputStyles.md#lineheight)
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: [`InlineElementStyles`](internal_.InlineElementStyles.md)

package/docs/interfaces/internal_.ThreeDSecure.md

@@ -0,0 +1,52 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ThreeDSecure
+
+# Interface: ThreeDSecure
+
+[<internal>](../modules/internal_.md).ThreeDSecure
+
+## Table of contents
+
+### Properties
+
+- [cavv](internal_.ThreeDSecure.md#cavv)
+- [eci](internal_.ThreeDSecure.md#eci)
+- [status](internal_.ThreeDSecure.md#status)
+- [vendor](internal_.ThreeDSecure.md#vendor)
+- [version](internal_.ThreeDSecure.md#version)
+- [xid](internal_.ThreeDSecure.md#xid)
+
+## Properties
+
+### cavv
+
+• **cavv**: `string`
+
+___
+
+### eci
+
+• **eci**: `string`
+
+___
+
+### status
+
+• **status**: `string`
+
+___
+
+### vendor
+
+• **vendor**: `string`
+
+___
+
+### version
+
+• **version**: `string`
+
+___
+
+### xid
+
+• **xid**: `string`

package/docs/interfaces/internal_.ThreeDSecureToken.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / ThreeDSecureToken
+
+# Interface: ThreeDSecureToken
+
+[<internal>](../modules/internal_.md).ThreeDSecureToken
+
+## Table of contents
+
+### Properties
+
+- [token](internal_.ThreeDSecureToken.md#token)
+
+## Properties
+
+### token
+
+• **token**: `string`

package/docs/interfaces/internal_.TranslationData.md

@@ -0,0 +1,9 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / TranslationData
+
+# Interface: TranslationData
+
+[<internal>](../modules/internal_.md).TranslationData
+
+## Indexable
+
+▪ [key: `string`]: `string` \| `number`

package/docs/interfaces/internal_.Translations.md

@@ -0,0 +1,9 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Translations
+
+# Interface: Translations
+
+[<internal>](../modules/internal_.md).Translations
+
+## Indexable
+
+▪ [key: `string`]: `string` \| [`Translations`](internal_.Translations.md)

package/docs/interfaces/internal_.UnknownObject.md

@@ -0,0 +1,9 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / UnknownObject
+
+# Interface: UnknownObject
+
+[<internal>](../modules/internal_.md).UnknownObject
+
+## Indexable
+
+▪ [key: `string`]: `unknown`

package/docs/interfaces/internal_.VaultedInstrument.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / VaultedInstrument
+
+# Interface: VaultedInstrument
+
+[<internal>](../modules/internal_.md).VaultedInstrument
+
+## Table of contents
+
+### Properties
+
+- [ccCvv](internal_.VaultedInstrument.md#cccvv)
+- [ccNumber](internal_.VaultedInstrument.md#ccnumber)
+- [instrumentId](internal_.VaultedInstrument.md#instrumentid)
+
+## Properties
+
+### ccCvv
+
+• `Optional` **ccCvv**: `string`
+
+___
+
+### ccNumber
+
+• `Optional` **ccNumber**: `string`
+
+___
+
+### instrumentId
+
+• **instrumentId**: `string`

package/docs/interfaces/internal_.WechatDataPaymentMethodState.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / WechatDataPaymentMethodState
+
+# Interface: WechatDataPaymentMethodState
+
+[<internal>](../modules/internal_.md).WechatDataPaymentMethodState
+
+## Table of contents
+
+### Properties
+
+- [paymentMethod](internal_.WechatDataPaymentMethodState.md#paymentmethod)
+
+## Properties
+
+### paymentMethod
+
+• **paymentMethod**: [`AdyenPaymentMethodState`](internal_.AdyenPaymentMethodState.md)

package/docs/interfaces/internal_.WechatDataPaymentMethodState_2.md

@@ -0,0 +1,17 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / WechatDataPaymentMethodState\_2
+
+# Interface: WechatDataPaymentMethodState\_2
+
+[<internal>](../modules/internal_.md).WechatDataPaymentMethodState_2
+
+## Table of contents
+
+### Properties
+
+- [paymentMethod](internal_.WechatDataPaymentMethodState_2.md#paymentmethod)
+
+## Properties
+
+### paymentMethod
+
+• **paymentMethod**: [`AdyenPaymentMethodState_2`](internal_.AdyenPaymentMethodState_2.md)