@bigcommerce/checkout-sdk 1.263.0 → 1.264.2

package/docs/interfaces/StyleOptions.md

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

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

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

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

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

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

package/docs/interfaces/TextInputStyles.md

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

package/docs/interfaces/ThreeDSecure.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / ThreeDSecure
+
+# Interface: ThreeDSecure
+
+## Table of contents
+
+### Properties
+
+- [cavv](ThreeDSecure.md#cavv)
+- [eci](ThreeDSecure.md#eci)
+- [status](ThreeDSecure.md#status)
+- [vendor](ThreeDSecure.md#vendor)
+- [version](ThreeDSecure.md#version)
+- [xid](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/ThreeDSecureToken.md

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

package/docs/interfaces/TranslationData.md

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

package/docs/interfaces/Translations.md

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

package/docs/interfaces/UnknownObject.md

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

package/docs/interfaces/VaultedInstrument.md

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

package/docs/interfaces/WechatDataPaymentMethodState.md

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

package/docs/interfaces/WechatDataPaymentMethodState_2.md

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

package/docs/interfaces/WechatState.md

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

package/docs/interfaces/WechatState_2.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / WechatState_2
+
+# Interface: WechatState\_2
+
+## Table of contents
+
+### Properties
+
+- [data](WechatState_2.md#data)
+
+## Properties
+
+### data
+
+• **data**: [`WechatDataPaymentMethodState_2`](WechatDataPaymentMethodState_2.md)

package/docs/interfaces/WithAccountCreation.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / WithAccountCreation
+
+# Interface: WithAccountCreation
+
+## Table of contents
+
+### Properties
+
+- [shouldCreateAccount](WithAccountCreation.md#shouldcreateaccount)
+
+## Properties
+
+### shouldCreateAccount
+
+• `Optional` **shouldCreateAccount**: `boolean`

package/docs/interfaces/WithCheckoutcomFawryInstrument.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / WithCheckoutcomFawryInstrument
+
+# Interface: WithCheckoutcomFawryInstrument
+
+## Table of contents
+
+### Properties
+
+- [customerEmail](WithCheckoutcomFawryInstrument.md#customeremail)
+- [customerMobile](WithCheckoutcomFawryInstrument.md#customermobile)
+
+## Properties
+
+### customerEmail
+
+• **customerEmail**: `string`
+
+___
+
+### customerMobile
+
+• **customerMobile**: `string`

package/docs/interfaces/WithCheckoutcomSEPAInstrument.md

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

package/docs/interfaces/WithCheckoutcomiDealInstrument.md

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