@bigcommerce/checkout-sdk 1.435.0 → 1.436.1

package/docs/interfaces/StripeEvent.md

@@ -1,37 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeEvent
-
-# Interface: StripeEvent
-
-## Hierarchy
-
-- **`StripeEvent`**
-
-  ↳ [`StripeCustomerEvent`](StripeCustomerEvent.md)
-
-  ↳ [`StripeShippingEvent`](StripeShippingEvent.md)
-
-## Table of contents
-
-### Properties
-
-- [complete](StripeEvent.md#complete)
-- [elementType](StripeEvent.md#elementtype)
-- [empty](StripeEvent.md#empty)
-
-## Properties
-
-### complete
-
-• **complete**: `boolean`
-
-___
-
-### elementType
-
-• **elementType**: `string`
-
-___
-
-### empty
-
-• **empty**: `boolean`

package/docs/interfaces/StripeShippingEvent.md

@@ -1,117 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeShippingEvent
-
-# Interface: StripeShippingEvent
-
-## Hierarchy
-
-- [`StripeEvent`](StripeEvent.md)
-
-  ↳ **`StripeShippingEvent`**
-
-## Table of contents
-
-### Properties
-
-- [complete](StripeShippingEvent.md#complete)
-- [display](StripeShippingEvent.md#display)
-- [elementType](StripeShippingEvent.md#elementtype)
-- [empty](StripeShippingEvent.md#empty)
-- [fields](StripeShippingEvent.md#fields)
-- [isNewAddress](StripeShippingEvent.md#isnewaddress)
-- [mode](StripeShippingEvent.md#mode)
-- [phoneFieldRequired](StripeShippingEvent.md#phonefieldrequired)
-- [value](StripeShippingEvent.md#value)
-
-## Properties
-
-### complete
-
-• **complete**: `boolean`
-
-#### Inherited from
-
-[StripeEvent](StripeEvent.md).[complete](StripeEvent.md#complete)
-
-___
-
-### display
-
-• `Optional` **display**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-
-___
-
-### elementType
-
-• **elementType**: `string`
-
-#### Inherited from
-
-[StripeEvent](StripeEvent.md).[elementType](StripeEvent.md#elementtype)
-
-___
-
-### empty
-
-• **empty**: `boolean`
-
-#### Inherited from
-
-[StripeEvent](StripeEvent.md).[empty](StripeEvent.md#empty)
-
-___
-
-### fields
-
-• `Optional` **fields**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `phone` | `string` |
-
-___
-
-### isNewAddress
-
-• `Optional` **isNewAddress**: `boolean`
-
-___
-
-### mode
-
-• `Optional` **mode**: `string`
-
-___
-
-### phoneFieldRequired
-
-• **phoneFieldRequired**: `boolean`
-
-___
-
-### value
-
-• **value**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `address` | `Object` |
-| `address.city` | `string` |
-| `address.country` | `string` |
-| `address.line1` | `string` |
-| `address.line2?` | `string` |
-| `address.postal_code` | `string` |
-| `address.state` | `string` |
-| `firstName?` | `string` |
-| `lastName?` | `string` |
-| `name?` | `string` |
-| `phone?` | `string` |

package/docs/interfaces/StripeUPECustomerInitializeOptions.md

@@ -1,92 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeUPECustomerInitializeOptions
-
-# Interface: StripeUPECustomerInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [container](StripeUPECustomerInitializeOptions.md#container)
-- [gatewayId](StripeUPECustomerInitializeOptions.md#gatewayid)
-- [methodId](StripeUPECustomerInitializeOptions.md#methodid)
-
-### Methods
-
-- [getStyles](StripeUPECustomerInitializeOptions.md#getstyles)
-- [isLoading](StripeUPECustomerInitializeOptions.md#isloading)
-- [onEmailChange](StripeUPECustomerInitializeOptions.md#onemailchange)
-
-## Properties
-
-### container
-
-• **container**: `string`
-
-The ID of a container which the stripe iframe should be inserted.
-
-___
-
-### gatewayId
-
-• **gatewayId**: `string`
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Stripeupe and Klarna.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-## Methods
-
-### getStyles
-
-▸ `Optional` **getStyles**(): `undefined` \| { [key: string]: `string`;  }
-
-get styles from store theme
-
-#### Returns
-
-`undefined` \| { [key: string]: `string`;  }
-
-___
-
-### isLoading
-
-▸ **isLoading**(`mounted`): `void`
-
-A callback that gets called when Stripe Link Authentication Element is Loaded.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `mounted` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### onEmailChange
-
-▸ **onEmailChange**(`authenticated`, `email`): `void`
-
-A callback that gets called whenever the Stripe Link Authentication Element's value changes.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `authenticated` | `boolean` | if the email is authenticated on Stripe. |
-| `email` | `string` | The new value of the email. |
-
-#### Returns
-
-`void`

package/docs/interfaces/StripeUPEPaymentInitializeOptions.md

@@ -1,81 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeUPEPaymentInitializeOptions
-
-# Interface: StripeUPEPaymentInitializeOptions
-
-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: 'stripeupe',
-    stripeupe {
-        containerId: 'container',
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [containerId](StripeUPEPaymentInitializeOptions.md#containerid)
-- [style](StripeUPEPaymentInitializeOptions.md#style)
-
-### Methods
-
-- [onError](StripeUPEPaymentInitializeOptions.md#onerror)
-- [render](StripeUPEPaymentInitializeOptions.md#render)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The location to insert the credit card number form field.
-
-___
-
-### style
-
-• `Optional` **style**: `Object`
-
-Checkout styles from store theme
-
-#### Index signature
-
-▪ [key: `string`]: `string`
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error?`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error?` | `Error` |
-
-#### Returns
-
-`void`
-
-___
-
-### render
-
-▸ **render**(): `void`
-
-#### Returns
-
-`void`

package/docs/interfaces/StripeUPEShippingInitializeOptions.md

@@ -1,107 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeUPEShippingInitializeOptions
-
-# Interface: StripeUPEShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of
-checkout in order to support StripeUpe.
-
-When StripeUpe is initialized, an iframe will be inserted into the DOM. The
-iframe has a list of shipping addresses for the customer to choose from.
-
-## Table of contents
-
-### Properties
-
-- [availableCountries](StripeUPEShippingInitializeOptions.md#availablecountries)
-- [container](StripeUPEShippingInitializeOptions.md#container)
-- [gatewayId](StripeUPEShippingInitializeOptions.md#gatewayid)
-- [methodId](StripeUPEShippingInitializeOptions.md#methodid)
-
-### Methods
-
-- [getStripeState](StripeUPEShippingInitializeOptions.md#getstripestate)
-- [getStyles](StripeUPEShippingInitializeOptions.md#getstyles)
-- [onChangeShipping](StripeUPEShippingInitializeOptions.md#onchangeshipping)
-
-## Properties
-
-### availableCountries
-
-• **availableCountries**: `string`
-
-Available countries configured on BC shipping setup.
-
-___
-
-### container
-
-• `Optional` **container**: `string`
-
-The ID of a container which the stripe iframe should be inserted.
-
-___
-
-### gatewayId
-
-• **gatewayId**: `string`
-
-The identifier of the payment provider providing the payment method. This
-option is only required if the provider offers multiple payment options.
-i.e.: Stripeupe and Klarna.
-
-___
-
-### methodId
-
-• **methodId**: `string`
-
-The identifier of the payment method.
-
-## Methods
-
-### getStripeState
-
-▸ **getStripeState**(`country`, `state`): `string`
-
-get the state code needed for shipping stripe element
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `country` | `string` |
-| `state` | `string` |
-
-#### Returns
-
-`string`
-
-___
-
-### getStyles
-
-▸ `Optional` **getStyles**(): `Object`
-
-get styles from store theme
-
-#### Returns
-
-`Object`
-
-___
-
-### onChangeShipping
-
-▸ **onChangeShipping**(`shipping`): `void`
-
-A callback that gets called whenever the Stripe Link Shipping Element's object is completed.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `shipping` | [`StripeEventType`](../README.md#stripeeventtype) |
-
-#### Returns
-
-`void`

package/docs/interfaces/StripeV3PaymentInitializeOptions.md

@@ -1,76 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / StripeV3PaymentInitializeOptions
-
-# Interface: 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](StripeV3PaymentInitializeOptions.md#containerid)
-- [form](StripeV3PaymentInitializeOptions.md#form)
-- [options](StripeV3PaymentInitializeOptions.md#options)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The location to insert the credit card number form field.
-
-___
-
-### form
-
-• `Optional` **form**: [`HostedFormOptions`](HostedFormOptions.md)
-
-Hosted Form Validation Options
-
-___
-
-### options
-
-• `Optional` **options**: [`CardCvcElementOptions`](CardCvcElementOptions.md) \| [`CardElementOptions`](CardElementOptions.md) \| [`CardExpiryElementOptions`](CardExpiryElementOptions.md) \| [`CardNumberElementOptions`](CardNumberElementOptions.md) \| [`IbanElementOptions`](IbanElementOptions.md) \| [`IdealElementOptions`](IdealElementOptions.md) \| [`IndividualCardElementOptions`](IndividualCardElementOptions.md) \| [`ZipCodeElementOptions`](ZipCodeElementOptions.md)

package/docs/interfaces/StyleOptions.md

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

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

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