@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.ButtonStyles.md

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

package/docs/interfaces/internal_.CardCvcElementOptions.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardCvcElementOptions
+
+# Interface: CardCvcElementOptions
+
+[<internal>](../modules/internal_.md).CardCvcElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](internal_.BaseIndividualElementOptions.md)
+
+  ↳ **`CardCvcElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.CardCvcElementOptions.md#classes)
+- [containerId](internal_.CardCvcElementOptions.md#containerid)
+- [disabled](internal_.CardCvcElementOptions.md#disabled)
+- [placeholder](internal_.CardCvcElementOptions.md#placeholder)
+- [style](internal_.CardCvcElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[classes](internal_.BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[containerId](internal_.BaseIndividualElementOptions.md#containerid)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: `boolean`
+
+Applies a disabled state to the Element such that user input is not accepted. Default is false.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[disabled](internal_.BaseIndividualElementOptions.md#disabled)
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
+
+Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
+which consists of CSS properties nested under objects for each variant.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[style](internal_.BaseIndividualElementOptions.md#style)

package/docs/interfaces/internal_.CardDataPaymentMethodState.md

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

package/docs/interfaces/internal_.CardDataPaymentMethodState_2.md

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

package/docs/interfaces/internal_.CardElementOptions.md

@@ -0,0 +1,93 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardElementOptions
+
+# Interface: CardElementOptions
+
+[<internal>](../modules/internal_.md).CardElementOptions
+
+## Hierarchy
+
+- [`BaseElementOptions_2`](internal_.BaseElementOptions_2.md)
+
+  ↳ **`CardElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.CardElementOptions.md#classes)
+- [disabled](internal_.CardElementOptions.md#disabled)
+- [hideIcon](internal_.CardElementOptions.md#hideicon)
+- [hidePostalCode](internal_.CardElementOptions.md#hidepostalcode)
+- [iconStyle](internal_.CardElementOptions.md#iconstyle)
+- [style](internal_.CardElementOptions.md#style)
+- [value](internal_.CardElementOptions.md#value)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[classes](internal_.BaseElementOptions_2.md#classes)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: `boolean`
+
+Applies a disabled state to the Element such that user input is not accepted. Default is false.
+
+#### Inherited from
+
+[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[disabled](internal_.BaseElementOptions_2.md#disabled)
+
+___
+
+### hideIcon
+
+• `Optional` **hideIcon**: `boolean`
+
+___
+
+### hidePostalCode
+
+• `Optional` **hidePostalCode**: `boolean`
+
+Hide the postal code field. Default is false. If you are already collecting a
+full billing address or postal code elsewhere, set this to true.
+
+___
+
+### iconStyle
+
+• `Optional` **iconStyle**: [`IconStyle`](../enums/internal_.IconStyle.md)
+
+Appearance of the icon in the Element.
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
+
+Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
+which consists of CSS properties nested under objects for each variant.
+
+#### Inherited from
+
+[BaseElementOptions_2](internal_.BaseElementOptions_2.md).[style](internal_.BaseElementOptions_2.md#style)
+
+___
+
+### value
+
+• `Optional` **value**: `string`
+
+A pre-filled set of values to include in the input (e.g., {postalCode: '94110'}).
+Note that sensitive card information (card number, CVC, and expiration date)
+cannot be pre-filled

package/docs/interfaces/internal_.CardExpiryElementOptions.md

@@ -0,0 +1,74 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardExpiryElementOptions
+
+# Interface: CardExpiryElementOptions
+
+[<internal>](../modules/internal_.md).CardExpiryElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](internal_.BaseIndividualElementOptions.md)
+
+  ↳ **`CardExpiryElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.CardExpiryElementOptions.md#classes)
+- [containerId](internal_.CardExpiryElementOptions.md#containerid)
+- [disabled](internal_.CardExpiryElementOptions.md#disabled)
+- [placeholder](internal_.CardExpiryElementOptions.md#placeholder)
+- [style](internal_.CardExpiryElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[classes](internal_.BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[containerId](internal_.BaseIndividualElementOptions.md#containerid)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: `boolean`
+
+Applies a disabled state to the Element such that user input is not accepted. Default is false.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[disabled](internal_.BaseIndividualElementOptions.md#disabled)
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
+
+Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
+which consists of CSS properties nested under objects for each variant.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[style](internal_.BaseIndividualElementOptions.md#style)

package/docs/interfaces/internal_.CardInstrument.md

@@ -0,0 +1,117 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardInstrument
+
+# Interface: CardInstrument
+
+[<internal>](../modules/internal_.md).CardInstrument
+
+## Hierarchy
+
+- [`BaseInstrument`](internal_.BaseInstrument.md)
+
+  ↳ **`CardInstrument`**
+
+## Table of contents
+
+### Properties
+
+- [bigpayToken](internal_.CardInstrument.md#bigpaytoken)
+- [brand](internal_.CardInstrument.md#brand)
+- [defaultInstrument](internal_.CardInstrument.md#defaultinstrument)
+- [expiryMonth](internal_.CardInstrument.md#expirymonth)
+- [expiryYear](internal_.CardInstrument.md#expiryyear)
+- [iin](internal_.CardInstrument.md#iin)
+- [last4](internal_.CardInstrument.md#last4)
+- [method](internal_.CardInstrument.md#method)
+- [provider](internal_.CardInstrument.md#provider)
+- [trustedShippingAddress](internal_.CardInstrument.md#trustedshippingaddress)
+- [type](internal_.CardInstrument.md#type)
+
+## Properties
+
+### bigpayToken
+
+• **bigpayToken**: `string`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[bigpayToken](internal_.BaseInstrument.md#bigpaytoken)
+
+___
+
+### brand
+
+• **brand**: `string`
+
+___
+
+### defaultInstrument
+
+• **defaultInstrument**: `boolean`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[defaultInstrument](internal_.BaseInstrument.md#defaultinstrument)
+
+___
+
+### expiryMonth
+
+• **expiryMonth**: `string`
+
+___
+
+### expiryYear
+
+• **expiryYear**: `string`
+
+___
+
+### iin
+
+• **iin**: `string`
+
+___
+
+### last4
+
+• **last4**: `string`
+
+___
+
+### method
+
+• **method**: `string`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[method](internal_.BaseInstrument.md#method)
+
+___
+
+### provider
+
+• **provider**: `string`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[provider](internal_.BaseInstrument.md#provider)
+
+___
+
+### trustedShippingAddress
+
+• **trustedShippingAddress**: `boolean`
+
+#### Inherited from
+
+[BaseInstrument](internal_.BaseInstrument.md).[trustedShippingAddress](internal_.BaseInstrument.md#trustedshippingaddress)
+
+___
+
+### type
+
+• **type**: ``"card"``
+
+#### Overrides
+
+[BaseInstrument](internal_.BaseInstrument.md).[type](internal_.BaseInstrument.md#type)

package/docs/interfaces/internal_.CardNumberElementOptions.md

@@ -0,0 +1,90 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardNumberElementOptions
+
+# Interface: CardNumberElementOptions
+
+[<internal>](../modules/internal_.md).CardNumberElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](internal_.BaseIndividualElementOptions.md)
+
+  ↳ **`CardNumberElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](internal_.CardNumberElementOptions.md#classes)
+- [containerId](internal_.CardNumberElementOptions.md#containerid)
+- [disabled](internal_.CardNumberElementOptions.md#disabled)
+- [iconStyle](internal_.CardNumberElementOptions.md#iconstyle)
+- [placeholder](internal_.CardNumberElementOptions.md#placeholder)
+- [showIcon](internal_.CardNumberElementOptions.md#showicon)
+- [style](internal_.CardNumberElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](internal_.StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[classes](internal_.BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[containerId](internal_.BaseIndividualElementOptions.md#containerid)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: `boolean`
+
+Applies a disabled state to the Element such that user input is not accepted. Default is false.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[disabled](internal_.BaseIndividualElementOptions.md#disabled)
+
+___
+
+### iconStyle
+
+• `Optional` **iconStyle**: [`IconStyle`](../enums/internal_.IconStyle.md)
+
+Appearance of the icon in the Element. Either `solid` or `default`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### showIcon
+
+• `Optional` **showIcon**: `boolean`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](internal_.StripeElementStyle.md)
+
+Customize the appearance of an element using CSS properties passed in a [Style](https://stripe.com/docs/js/appendix/style) object,
+which consists of CSS properties nested under objects for each variant.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](internal_.BaseIndividualElementOptions.md).[style](internal_.BaseIndividualElementOptions.md#style)

package/docs/interfaces/internal_.CardPaymentMethodState.md

@@ -0,0 +1,62 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CardPaymentMethodState
+
+# Interface: CardPaymentMethodState
+
+[<internal>](../modules/internal_.md).CardPaymentMethodState
+
+## Hierarchy
+
+- [`AdyenPaymentMethodState`](internal_.AdyenPaymentMethodState.md)
+
+  ↳ **`CardPaymentMethodState`**
+
+## Table of contents
+
+### Properties
+
+- [encryptedCardNumber](internal_.CardPaymentMethodState.md#encryptedcardnumber)
+- [encryptedExpiryMonth](internal_.CardPaymentMethodState.md#encryptedexpirymonth)
+- [encryptedExpiryYear](internal_.CardPaymentMethodState.md#encryptedexpiryyear)
+- [encryptedSecurityCode](internal_.CardPaymentMethodState.md#encryptedsecuritycode)
+- [holderName](internal_.CardPaymentMethodState.md#holdername)
+- [type](internal_.CardPaymentMethodState.md#type)
+
+## Properties
+
+### encryptedCardNumber
+
+• **encryptedCardNumber**: `string`
+
+___
+
+### encryptedExpiryMonth
+
+• **encryptedExpiryMonth**: `string`
+
+___
+
+### encryptedExpiryYear
+
+• **encryptedExpiryYear**: `string`
+
+___
+
+### encryptedSecurityCode
+
+• **encryptedSecurityCode**: `string`
+
+___
+
+### holderName
+
+• **holderName**: `string`
+
+___
+
+### type
+
+• **type**: `string`
+
+#### Inherited from
+
+[AdyenPaymentMethodState](internal_.AdyenPaymentMethodState.md).[type](internal_.AdyenPaymentMethodState.md#type)