@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.StripeUPECustomerInitializeOptions.md

@@ -1,94 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPECustomerInitializeOptions
-
-# Interface: StripeUPECustomerInitializeOptions
-
-[<internal>](../modules/internal_.md).StripeUPECustomerInitializeOptions
-
-## Table of contents
-
-### Properties
-
-- [container](internal_.StripeUPECustomerInitializeOptions.md#container)
-- [gatewayId](internal_.StripeUPECustomerInitializeOptions.md#gatewayid)
-- [methodId](internal_.StripeUPECustomerInitializeOptions.md#methodid)
-
-### Methods
-
-- [getStyles](internal_.StripeUPECustomerInitializeOptions.md#getstyles)
-- [isLoading](internal_.StripeUPECustomerInitializeOptions.md#isloading)
-- [onEmailChange](internal_.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/internal_.StripeUPEPaymentInitializeOptions.md

@@ -1,72 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPEPaymentInitializeOptions
-
-# Interface: StripeUPEPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).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](internal_.StripeUPEPaymentInitializeOptions.md#containerid)
-- [style](internal_.StripeUPEPaymentInitializeOptions.md#style)
-
-### Methods
-
-- [onError](internal_.StripeUPEPaymentInitializeOptions.md#onerror)
-
-## 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`

package/docs/interfaces/internal_.StripeUPEShippingInitializeOptions.md

@@ -1,109 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeUPEShippingInitializeOptions
-
-# Interface: StripeUPEShippingInitializeOptions
-
-[<internal>](../modules/internal_.md).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](internal_.StripeUPEShippingInitializeOptions.md#availablecountries)
-- [container](internal_.StripeUPEShippingInitializeOptions.md#container)
-- [gatewayId](internal_.StripeUPEShippingInitializeOptions.md#gatewayid)
-- [methodId](internal_.StripeUPEShippingInitializeOptions.md#methodid)
-
-### Methods
-
-- [getStripeState](internal_.StripeUPEShippingInitializeOptions.md#getstripestate)
-- [getStyles](internal_.StripeUPEShippingInitializeOptions.md#getstyles)
-- [onChangeShipping](internal_.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`](../modules/internal_.md#stripeeventtype) |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.StripeV3PaymentInitializeOptions.md

@@ -1,78 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StripeV3PaymentInitializeOptions
-
-# Interface: StripeV3PaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).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](internal_.StripeV3PaymentInitializeOptions.md#containerid)
-- [form](internal_.StripeV3PaymentInitializeOptions.md#form)
-- [options](internal_.StripeV3PaymentInitializeOptions.md#options)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-The location to insert the credit card number form field.
-
-___
-
-### form
-
-• `Optional` **form**: [`HostedFormOptions`](internal_.HostedFormOptions.md)
-
-Hosted Form Validation Options
-
-___
-
-### options
-
-• `Optional` **options**: [`StripeElementOptions`](../modules/internal_.md#stripeelementoptions) \| [`IndividualCardElementOptions`](internal_.IndividualCardElementOptions.md)

package/docs/interfaces/internal_.StyleOptions.md

@@ -1,46 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleOptions
-
-# Interface: StyleOptions
-
-[<internal>](../modules/internal_.md).StyleOptions
-
-## Table of contents
-
-### Properties
-
-- [base](internal_.StyleOptions.md#base)
-- [error](internal_.StyleOptions.md#error)
-- [placeholder](internal_.StyleOptions.md#placeholder)
-- [validated](internal_.StyleOptions.md#validated)
-
-## Properties
-
-### base
-
-• `Optional` **base**: [`CssProperties`](internal_.CssProperties.md)
-
-Base styling applied to the iframe. All styling extends from this style.
-
-___
-
-### error
-
-• `Optional` **error**: [`CssProperties`](internal_.CssProperties.md)
-
-Styling applied when a field fails validation.
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: [`CssProperties`](internal_.CssProperties.md)
-
-Styling applied to the field's placeholder values.
-
-___
-
-### validated
-
-• `Optional` **validated**: [`CssProperties`](internal_.CssProperties.md)
-
-Styling applied once a field passes validation.

package/docs/interfaces/internal_.StyleOptions_2.md

@@ -1,46 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / StyleOptions\_2
-
-# Interface: StyleOptions\_2
-
-[<internal>](../modules/internal_.md).StyleOptions_2
-
-## Table of contents
-
-### Properties
-
-- [base](internal_.StyleOptions_2.md#base)
-- [error](internal_.StyleOptions_2.md#error)
-- [placeholder](internal_.StyleOptions_2.md#placeholder)
-- [validated](internal_.StyleOptions_2.md#validated)
-
-## Properties
-
-### base
-
-• `Optional` **base**: [`CssProperties_2`](internal_.CssProperties_2.md)
-
-Base styling applied to the iframe. All styling extends from this style.
-
-___
-
-### error
-
-• `Optional` **error**: [`CssProperties_2`](internal_.CssProperties_2.md)
-
-Styling applied when a field fails validation.
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: [`CssProperties_2`](internal_.CssProperties_2.md)
-
-Styling applied to the field's placeholder values.
-
-___
-
-### validated
-
-• `Optional` **validated**: [`CssProperties_2`](internal_.CssProperties_2.md)
-
-Styling applied once a field passes validation.

package/docs/interfaces/internal_.SubInputDetail.md

@@ -1,64 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SubInputDetail
-
-# Interface: SubInputDetail
-
-[<internal>](../modules/internal_.md).SubInputDetail
-
-## Table of contents
-
-### Properties
-
-- [configuration](internal_.SubInputDetail.md#configuration)
-- [items](internal_.SubInputDetail.md#items)
-- [key](internal_.SubInputDetail.md#key)
-- [optional](internal_.SubInputDetail.md#optional)
-- [type](internal_.SubInputDetail.md#type)
-- [value](internal_.SubInputDetail.md#value)
-
-## Properties
-
-### configuration
-
-• `Optional` **configuration**: `object`
-
-Configuration parameters for the required input.
-
-___
-
-### items
-
-• `Optional` **items**: [`Item_2`](internal_.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/internal_.SubInputDetail_2.md

@@ -1,64 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / SubInputDetail\_2
-
-# Interface: SubInputDetail\_2
-
-[<internal>](../modules/internal_.md).SubInputDetail_2
-
-## Table of contents
-
-### Properties
-
-- [configuration](internal_.SubInputDetail_2.md#configuration)
-- [items](internal_.SubInputDetail_2.md#items)
-- [key](internal_.SubInputDetail_2.md#key)
-- [optional](internal_.SubInputDetail_2.md#optional)
-- [type](internal_.SubInputDetail_2.md#type)
-- [value](internal_.SubInputDetail_2.md#value)
-
-## Properties
-
-### configuration
-
-• `Optional` **configuration**: `object`
-
-Configuration parameters for the required input.
-
-___
-
-### items
-
-• `Optional` **items**: [`Item_3`](internal_.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/internal_.Subscriptions.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Subscriptions
-
-# Interface: Subscriptions
-
-[<internal>](../modules/internal_.md).Subscriptions
-
-## Table of contents
-
-### Properties
-
-- [acceptsAbandonedCartEmails](internal_.Subscriptions.md#acceptsabandonedcartemails)
-- [acceptsMarketingNewsletter](internal_.Subscriptions.md#acceptsmarketingnewsletter)
-- [email](internal_.Subscriptions.md#email)
-
-## Properties
-
-### acceptsAbandonedCartEmails
-
-• **acceptsAbandonedCartEmails**: `boolean`
-
-___
-
-### acceptsMarketingNewsletter
-
-• **acceptsMarketingNewsletter**: `boolean`
-
-___
-
-### email
-
-• **email**: `string`

package/docs/interfaces/internal_.Tax.md

@@ -1,24 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Tax
-
-# Interface: Tax
-
-[<internal>](../modules/internal_.md).Tax
-
-## Table of contents
-
-### Properties
-
-- [amount](internal_.Tax.md#amount)
-- [name](internal_.Tax.md#name)
-
-## Properties
-
-### amount
-
-• **amount**: `number`
-
-___
-
-### name
-
-• **name**: `string`