@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/CardCvcElementOptions.md

@@ -0,0 +1,72 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardCvcElementOptions
+
+# Interface: CardCvcElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
+
+  ↳ **`CardCvcElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](CardCvcElementOptions.md#classes)
+- [containerId](CardCvcElementOptions.md#containerid)
+- [disabled](CardCvcElementOptions.md#disabled)
+- [placeholder](CardCvcElementOptions.md#placeholder)
+- [style](CardCvcElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[classes](BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[containerId](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](BaseIndividualElementOptions.md).[disabled](BaseIndividualElementOptions.md#disabled)
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](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](BaseIndividualElementOptions.md).[style](BaseIndividualElementOptions.md#style)

package/docs/interfaces/CardDataPaymentMethodState.md

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

package/docs/interfaces/CardDataPaymentMethodState_2.md

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

package/docs/interfaces/CardElementOptions.md

@@ -0,0 +1,91 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardElementOptions
+
+# Interface: CardElementOptions
+
+## Hierarchy
+
+- [`BaseElementOptions_2`](BaseElementOptions_2.md)
+
+  ↳ **`CardElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](CardElementOptions.md#classes)
+- [disabled](CardElementOptions.md#disabled)
+- [hideIcon](CardElementOptions.md#hideicon)
+- [hidePostalCode](CardElementOptions.md#hidepostalcode)
+- [iconStyle](CardElementOptions.md#iconstyle)
+- [style](CardElementOptions.md#style)
+- [value](CardElementOptions.md#value)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseElementOptions_2](BaseElementOptions_2.md).[classes](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](BaseElementOptions_2.md).[disabled](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**: [`Solid`](../enums/IconStyle.md#solid) \| [`Default`](../enums/IconStyle.md#default)
+
+Appearance of the icon in the Element.
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](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](BaseElementOptions_2.md).[style](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/CardExpiryElementOptions.md

@@ -0,0 +1,72 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardExpiryElementOptions
+
+# Interface: CardExpiryElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
+
+  ↳ **`CardExpiryElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](CardExpiryElementOptions.md#classes)
+- [containerId](CardExpiryElementOptions.md#containerid)
+- [disabled](CardExpiryElementOptions.md#disabled)
+- [placeholder](CardExpiryElementOptions.md#placeholder)
+- [style](CardExpiryElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[classes](BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[containerId](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](BaseIndividualElementOptions.md).[disabled](BaseIndividualElementOptions.md#disabled)
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](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](BaseIndividualElementOptions.md).[style](BaseIndividualElementOptions.md#style)

package/docs/interfaces/CardInstrument.md

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

package/docs/interfaces/CardNumberElementOptions.md

@@ -0,0 +1,88 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardNumberElementOptions
+
+# Interface: CardNumberElementOptions
+
+## Hierarchy
+
+- [`BaseIndividualElementOptions`](BaseIndividualElementOptions.md)
+
+  ↳ **`CardNumberElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](CardNumberElementOptions.md#classes)
+- [containerId](CardNumberElementOptions.md#containerid)
+- [disabled](CardNumberElementOptions.md#disabled)
+- [iconStyle](CardNumberElementOptions.md#iconstyle)
+- [placeholder](CardNumberElementOptions.md#placeholder)
+- [showIcon](CardNumberElementOptions.md#showicon)
+- [style](CardNumberElementOptions.md#style)
+
+## Properties
+
+### classes
+
+• `Optional` **classes**: [`StripeElementClasses`](StripeElementClasses.md)
+
+Set custom class names on the container DOM element when the Stripe element is in a particular state.
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[classes](BaseIndividualElementOptions.md#classes)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[BaseIndividualElementOptions](BaseIndividualElementOptions.md).[containerId](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](BaseIndividualElementOptions.md).[disabled](BaseIndividualElementOptions.md#disabled)
+
+___
+
+### iconStyle
+
+• `Optional` **iconStyle**: [`Solid`](../enums/IconStyle.md#solid) \| [`Default`](../enums/IconStyle.md#default)
+
+Appearance of the icon in the Element. Either `solid` or `default`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+___
+
+### showIcon
+
+• `Optional` **showIcon**: `boolean`
+
+___
+
+### style
+
+• `Optional` **style**: [`StripeElementStyle`](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](BaseIndividualElementOptions.md).[style](BaseIndividualElementOptions.md#style)

package/docs/interfaces/CardPaymentMethodState.md

@@ -0,0 +1,60 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardPaymentMethodState
+
+# Interface: CardPaymentMethodState
+
+## Hierarchy
+
+- [`AdyenPaymentMethodState`](AdyenPaymentMethodState.md)
+
+  ↳ **`CardPaymentMethodState`**
+
+## Table of contents
+
+### Properties
+
+- [encryptedCardNumber](CardPaymentMethodState.md#encryptedcardnumber)
+- [encryptedExpiryMonth](CardPaymentMethodState.md#encryptedexpirymonth)
+- [encryptedExpiryYear](CardPaymentMethodState.md#encryptedexpiryyear)
+- [encryptedSecurityCode](CardPaymentMethodState.md#encryptedsecuritycode)
+- [holderName](CardPaymentMethodState.md#holdername)
+- [type](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](AdyenPaymentMethodState.md).[type](AdyenPaymentMethodState.md#type)

package/docs/interfaces/CardPaymentMethodState_2.md

@@ -0,0 +1,43 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardPaymentMethodState_2
+
+# Interface: CardPaymentMethodState\_2
+
+## Table of contents
+
+### Properties
+
+- [encryptedCardNumber](CardPaymentMethodState_2.md#encryptedcardnumber)
+- [encryptedExpiryMonth](CardPaymentMethodState_2.md#encryptedexpirymonth)
+- [encryptedExpiryYear](CardPaymentMethodState_2.md#encryptedexpiryyear)
+- [encryptedSecurityCode](CardPaymentMethodState_2.md#encryptedsecuritycode)
+- [holderName](CardPaymentMethodState_2.md#holdername)
+
+## Properties
+
+### encryptedCardNumber
+
+• **encryptedCardNumber**: `string`
+
+___
+
+### encryptedExpiryMonth
+
+• **encryptedExpiryMonth**: `string`
+
+___
+
+### encryptedExpiryYear
+
+• **encryptedExpiryYear**: `string`
+
+___
+
+### encryptedSecurityCode
+
+• **encryptedSecurityCode**: `string`
+
+___
+
+### holderName
+
+• **holderName**: `string`

package/docs/interfaces/CardState.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardState
+
+# Interface: CardState
+
+## Table of contents
+
+### Properties
+
+- [data](CardState.md#data)
+- [errors](CardState.md#errors)
+- [isValid](CardState.md#isvalid)
+- [valid](CardState.md#valid)
+
+## Properties
+
+### data
+
+• **data**: [`CardDataPaymentMethodState`](CardDataPaymentMethodState.md)
+
+___
+
+### errors
+
+• `Optional` **errors**: [`CardStateErrors`](CardStateErrors.md)
+
+___
+
+### isValid
+
+• `Optional` **isValid**: `boolean`
+
+___
+
+### valid
+
+• `Optional` **valid**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `boolean`

package/docs/interfaces/CardStateErrors.md

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

package/docs/interfaces/CardStateErrors_2.md

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

package/docs/interfaces/CardState_2.md

@@ -0,0 +1,40 @@
+[@bigcommerce/checkout-sdk](../README.md) / CardState_2
+
+# Interface: CardState\_2
+
+## Table of contents
+
+### Properties
+
+- [data](CardState_2.md#data)
+- [errors](CardState_2.md#errors)
+- [isValid](CardState_2.md#isvalid)
+- [valid](CardState_2.md#valid)
+
+## Properties
+
+### data
+
+• **data**: [`CardDataPaymentMethodState_2`](CardDataPaymentMethodState_2.md)
+
+___
+
+### errors
+
+• `Optional` **errors**: [`CardStateErrors_2`](CardStateErrors_2.md)
+
+___
+
+### isValid
+
+• `Optional` **isValid**: `boolean`
+
+___
+
+### valid
+
+• `Optional` **valid**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `boolean`