@bigcommerce/checkout-sdk 1.263.0 → 1.264.2

package/docs/interfaces/HostedFormOptions.md

@@ -0,0 +1,114 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedFormOptions
+
+# Interface: HostedFormOptions
+
+## Table of contents
+
+### Properties
+
+- [fields](HostedFormOptions.md#fields)
+- [styles](HostedFormOptions.md#styles)
+
+### Methods
+
+- [onBlur](HostedFormOptions.md#onblur)
+- [onCardTypeChange](HostedFormOptions.md#oncardtypechange)
+- [onEnter](HostedFormOptions.md#onenter)
+- [onFocus](HostedFormOptions.md#onfocus)
+- [onValidate](HostedFormOptions.md#onvalidate)
+
+## Properties
+
+### fields
+
+• **fields**: [`HostedFieldOptionsMap`](../README.md#hostedfieldoptionsmap)
+
+___
+
+### styles
+
+• `Optional` **styles**: [`HostedFieldStylesMap`](HostedFieldStylesMap.md)
+
+## Methods
+
+### onBlur
+
+▸ `Optional` **onBlur**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` |
+| `data.fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onCardTypeChange
+
+▸ `Optional` **onCardTypeChange**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` |
+| `data.cardType?` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### onEnter
+
+▸ `Optional` **onEnter**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` |
+| `data.fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onFocus
+
+▸ `Optional` **onFocus**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` |
+| `data.fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onValidate
+
+▸ `Optional` **onValidate**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HostedInputValidateResults`](HostedInputValidateResults.md) |
+
+#### Returns
+
+`void`

package/docs/interfaces/HostedInputBlurEvent.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputBlurEvent
+
+# Interface: HostedInputBlurEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](HostedInputBlurEvent.md#payload)
+- [type](HostedInputBlurEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+___
+
+### type
+
+• **type**: [`Blurred`](../enums/HostedInputEventType.md#blurred)

package/docs/interfaces/HostedInputCardTypeChangeEvent.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputCardTypeChangeEvent
+
+# Interface: HostedInputCardTypeChangeEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](HostedInputCardTypeChangeEvent.md#payload)
+- [type](HostedInputCardTypeChangeEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cardType?` | `string` |
+
+___
+
+### type
+
+• **type**: [`CardTypeChanged`](../enums/HostedInputEventType.md#cardtypechanged)

package/docs/interfaces/HostedInputEnterEvent.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputEnterEvent
+
+# Interface: HostedInputEnterEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](HostedInputEnterEvent.md#payload)
+- [type](HostedInputEnterEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+___
+
+### type
+
+• **type**: [`Entered`](../enums/HostedInputEventType.md#entered)

package/docs/interfaces/HostedInputFocusEvent.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputFocusEvent
+
+# Interface: HostedInputFocusEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](HostedInputFocusEvent.md#payload)
+- [type](HostedInputFocusEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `fieldType` | [`HostedFieldType`](../enums/HostedFieldType.md) |
+
+___
+
+### type
+
+• **type**: [`Focused`](../enums/HostedInputEventType.md#focused)

package/docs/interfaces/HostedInputValidateErrorData.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputValidateErrorData
+
+# Interface: HostedInputValidateErrorData
+
+## Table of contents
+
+### Properties
+
+- [fieldType](HostedInputValidateErrorData.md#fieldtype)
+- [message](HostedInputValidateErrorData.md#message)
+- [type](HostedInputValidateErrorData.md#type)
+
+## Properties
+
+### fieldType
+
+• **fieldType**: `string`
+
+___
+
+### message
+
+• **message**: `string`
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/HostedInputValidateErrorDataMap.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputValidateErrorDataMap
+
+# Interface: HostedInputValidateErrorDataMap
+
+## Table of contents
+
+### Properties
+
+- [cardCode](HostedInputValidateErrorDataMap.md#cardcode)
+- [cardCodeVerification](HostedInputValidateErrorDataMap.md#cardcodeverification)
+- [cardExpiry](HostedInputValidateErrorDataMap.md#cardexpiry)
+- [cardName](HostedInputValidateErrorDataMap.md#cardname)
+- [cardNumber](HostedInputValidateErrorDataMap.md#cardnumber)
+- [cardNumberVerification](HostedInputValidateErrorDataMap.md#cardnumberverification)
+
+## Properties
+
+### cardCode
+
+• `Optional` **cardCode**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]
+
+___
+
+### cardCodeVerification
+
+• `Optional` **cardCodeVerification**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]
+
+___
+
+### cardExpiry
+
+• `Optional` **cardExpiry**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]
+
+___
+
+### cardName
+
+• `Optional` **cardName**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]
+
+___
+
+### cardNumber
+
+• `Optional` **cardNumber**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]
+
+___
+
+### cardNumberVerification
+
+• `Optional` **cardNumberVerification**: [`HostedInputValidateErrorData`](HostedInputValidateErrorData.md)[]

package/docs/interfaces/HostedInputValidateEvent.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputValidateEvent
+
+# Interface: HostedInputValidateEvent
+
+## Table of contents
+
+### Properties
+
+- [payload](HostedInputValidateEvent.md#payload)
+- [type](HostedInputValidateEvent.md#type)
+
+## Properties
+
+### payload
+
+• **payload**: [`HostedInputValidateResults`](HostedInputValidateResults.md)
+
+___
+
+### type
+
+• **type**: [`Validated`](../enums/HostedInputEventType.md#validated)

package/docs/interfaces/HostedInputValidateResults.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInputValidateResults
+
+# Interface: HostedInputValidateResults
+
+## Table of contents
+
+### Properties
+
+- [errors](HostedInputValidateResults.md#errors)
+- [isValid](HostedInputValidateResults.md#isvalid)
+
+## Properties
+
+### errors
+
+• **errors**: [`HostedInputValidateErrorDataMap`](HostedInputValidateErrorDataMap.md)
+
+___
+
+### isValid
+
+• **isValid**: `boolean`

package/docs/interfaces/HostedInstrument.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedInstrument
+
+# Interface: HostedInstrument
+
+## Table of contents
+
+### Properties
+
+- [shouldSaveInstrument](HostedInstrument.md#shouldsaveinstrument)
+- [shouldSetAsDefaultInstrument](HostedInstrument.md#shouldsetasdefaultinstrument)
+
+## Properties
+
+### shouldSaveInstrument
+
+• `Optional` **shouldSaveInstrument**: `boolean`
+
+___
+
+### shouldSetAsDefaultInstrument
+
+• `Optional` **shouldSetAsDefaultInstrument**: `boolean`

package/docs/interfaces/HostedStoredCardFieldOptions.md

@@ -0,0 +1,54 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedStoredCardFieldOptions
+
+# Interface: HostedStoredCardFieldOptions
+
+## Hierarchy
+
+- [`HostedCardFieldOptions`](HostedCardFieldOptions.md)
+
+  ↳ **`HostedStoredCardFieldOptions`**
+
+## Table of contents
+
+### Properties
+
+- [accessibilityLabel](HostedStoredCardFieldOptions.md#accessibilitylabel)
+- [containerId](HostedStoredCardFieldOptions.md#containerid)
+- [instrumentId](HostedStoredCardFieldOptions.md#instrumentid)
+- [placeholder](HostedStoredCardFieldOptions.md#placeholder)
+
+## Properties
+
+### accessibilityLabel
+
+• `Optional` **accessibilityLabel**: `string`
+
+#### Inherited from
+
+[HostedCardFieldOptions](HostedCardFieldOptions.md).[accessibilityLabel](HostedCardFieldOptions.md#accessibilitylabel)
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+#### Inherited from
+
+[HostedCardFieldOptions](HostedCardFieldOptions.md).[containerId](HostedCardFieldOptions.md#containerid)
+
+___
+
+### instrumentId
+
+• **instrumentId**: `string`
+
+___
+
+### placeholder
+
+• `Optional` **placeholder**: `string`
+
+#### Inherited from
+
+[HostedCardFieldOptions](HostedCardFieldOptions.md).[placeholder](HostedCardFieldOptions.md#placeholder)

package/docs/interfaces/HostedStoredCardFieldOptionsMap.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / HostedStoredCardFieldOptionsMap
+
+# Interface: HostedStoredCardFieldOptionsMap
+
+## Table of contents
+
+### Properties
+
+- [cardCodeVerification](HostedStoredCardFieldOptionsMap.md#cardcodeverification)
+- [cardNumberVerification](HostedStoredCardFieldOptionsMap.md#cardnumberverification)
+
+## Properties
+
+### cardCodeVerification
+
+• `Optional` **cardCodeVerification**: [`HostedStoredCardFieldOptions`](HostedStoredCardFieldOptions.md)
+
+___
+
+### cardNumberVerification
+
+• `Optional` **cardNumberVerification**: [`HostedStoredCardFieldOptions`](HostedStoredCardFieldOptions.md)

package/docs/interfaces/IbanElementOptions.md

@@ -0,0 +1,82 @@
+[@bigcommerce/checkout-sdk](../README.md) / IbanElementOptions
+
+# Interface: IbanElementOptions
+
+## Hierarchy
+
+- [`BaseElementOptions_2`](BaseElementOptions_2.md)
+
+  ↳ **`IbanElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](IbanElementOptions.md#classes)
+- [disabled](IbanElementOptions.md#disabled)
+- [iconStyle](IbanElementOptions.md#iconstyle)
+- [placeholderCountry](IbanElementOptions.md#placeholdercountry)
+- [style](IbanElementOptions.md#style)
+- [supportedCountries](IbanElementOptions.md#supportedcountries)
+
+## 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)
+
+___
+
+### iconStyle
+
+• `Optional` **iconStyle**: [`Solid`](../enums/IconStyle.md#solid) \| [`Default`](../enums/IconStyle.md#default)
+
+Appearance of the icon in the Element.
+
+___
+
+### placeholderCountry
+
+• `Optional` **placeholderCountry**: `string`
+
+Customize the country and format of the placeholder IBAN. Default is DE.
+
+___
+
+### 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)
+
+___
+
+### supportedCountries
+
+• `Optional` **supportedCountries**: `string`[]
+
+Specify the list of countries or country-groups whose IBANs you want to allow.
+Must be ['SEPA'].

package/docs/interfaces/IdealElementOptions.md

@@ -0,0 +1,70 @@
+[@bigcommerce/checkout-sdk](../README.md) / IdealElementOptions
+
+# Interface: IdealElementOptions
+
+## Hierarchy
+
+- [`BaseElementOptions_2`](BaseElementOptions_2.md)
+
+  ↳ **`IdealElementOptions`**
+
+## Table of contents
+
+### Properties
+
+- [classes](IdealElementOptions.md#classes)
+- [disabled](IdealElementOptions.md#disabled)
+- [hideIcon](IdealElementOptions.md#hideicon)
+- [style](IdealElementOptions.md#style)
+- [value](IdealElementOptions.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`
+
+Hides the icon in the Element. Default is false.
+
+___
+
+### 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`

package/docs/interfaces/IndividualCardElementOptions.md

@@ -0,0 +1,36 @@
+[@bigcommerce/checkout-sdk](../README.md) / IndividualCardElementOptions
+
+# Interface: IndividualCardElementOptions
+
+## Table of contents
+
+### Properties
+
+- [cardCvcElementOptions](IndividualCardElementOptions.md#cardcvcelementoptions)
+- [cardExpiryElementOptions](IndividualCardElementOptions.md#cardexpiryelementoptions)
+- [cardNumberElementOptions](IndividualCardElementOptions.md#cardnumberelementoptions)
+- [zipCodeElementOptions](IndividualCardElementOptions.md#zipcodeelementoptions)
+
+## Properties
+
+### cardCvcElementOptions
+
+• **cardCvcElementOptions**: [`CardCvcElementOptions`](CardCvcElementOptions.md)
+
+___
+
+### cardExpiryElementOptions
+
+• **cardExpiryElementOptions**: [`CardExpiryElementOptions`](CardExpiryElementOptions.md)
+
+___
+
+### cardNumberElementOptions
+
+• **cardNumberElementOptions**: [`CardNumberElementOptions`](CardNumberElementOptions.md)
+
+___
+
+### zipCodeElementOptions
+
+• `Optional` **zipCodeElementOptions**: [`ZipCodeElementOptions`](ZipCodeElementOptions.md)

package/docs/interfaces/InitializationStrategy.md

@@ -0,0 +1,21 @@
+[@bigcommerce/checkout-sdk](../README.md) / InitializationStrategy
+
+# Interface: InitializationStrategy
+
+## Hierarchy
+
+- `Partial`<[`UnknownObject`](UnknownObject.md)\>
+
+  ↳ **`InitializationStrategy`**
+
+## Table of contents
+
+### Properties
+
+- [type](InitializationStrategy.md#type)
+
+## Properties
+
+### type
+
+• **type**: `string`