npm - @bigcommerce/checkout-sdk - Versions diffs - 1.308.2 → 1.308.3 - Mend

@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (345) hide show

package/docs/interfaces/internal_.IndividualCardElementOptions.md DELETED Viewed

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

package/docs/interfaces/internal_.InitializationStrategy.md DELETED Viewed

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

package/docs/interfaces/internal_.InlineElementStyles.md DELETED Viewed

@@ -1,55 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / InlineElementStyles
-# Interface: InlineElementStyles
-[<internal>](../modules/internal_.md).InlineElementStyles
-## Hierarchy
-- **`InlineElementStyles`**
-  ↳ [`BlockElementStyles`](internal_.BlockElementStyles.md)
-  ↳ [`LinkStyles`](internal_.LinkStyles.md)
-  ↳ [`LabelStyles`](internal_.LabelStyles.md)
-## Table of contents
-### Properties
-- [color](internal_.InlineElementStyles.md#color)
-- [fontFamily](internal_.InlineElementStyles.md#fontfamily)
-- [fontWeight](internal_.InlineElementStyles.md#fontweight)
-- [letterSpacing](internal_.InlineElementStyles.md#letterspacing)
-- [lineHeight](internal_.InlineElementStyles.md#lineheight)
-## Properties
-### color
-• `Optional` **color**: `string`
-___
-### fontFamily
-• `Optional` **fontFamily**: `string`
-___
-### fontWeight
-• `Optional` **fontWeight**: `string`
-___
-### letterSpacing
-• `Optional` **letterSpacing**: `string`
-___
-### lineHeight
-• `Optional` **lineHeight**: `string`

package/docs/interfaces/internal_.InputDetail.md DELETED Viewed

@@ -1,82 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / InputDetail
-# Interface: InputDetail
-[<internal>](../modules/internal_.md).InputDetail
-## Table of contents
-### Properties
-- [configuration](internal_.InputDetail.md#configuration)
-- [details](internal_.InputDetail.md#details)
-- [itemSearchUrl](internal_.InputDetail.md#itemsearchurl)
-- [items](internal_.InputDetail.md#items)
-- [key](internal_.InputDetail.md#key)
-- [optional](internal_.InputDetail.md#optional)
-- [type](internal_.InputDetail.md#type)
-- [value](internal_.InputDetail.md#value)
-## Properties
-### configuration
-• `Optional` **configuration**: `object`
-Configuration parameters for the required input.
-___
-### details
-• `Optional` **details**: [`SubInputDetail`](internal_.SubInputDetail.md)[]
-Input details can also be provided recursively.
-___
-### itemSearchUrl
-• `Optional` **itemSearchUrl**: `string`
-In case of a select, the URL from which to query the items.
-___
-### 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 value is optional.
-___
-### 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_.InputDetail_2.md DELETED Viewed

@@ -1,82 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / InputDetail\_2
-# Interface: InputDetail\_2
-[<internal>](../modules/internal_.md).InputDetail_2
-## Table of contents
-### Properties
-- [configuration](internal_.InputDetail_2.md#configuration)
-- [details](internal_.InputDetail_2.md#details)
-- [itemSearchUrl](internal_.InputDetail_2.md#itemsearchurl)
-- [items](internal_.InputDetail_2.md#items)
-- [key](internal_.InputDetail_2.md#key)
-- [optional](internal_.InputDetail_2.md#optional)
-- [type](internal_.InputDetail_2.md#type)
-- [value](internal_.InputDetail_2.md#value)
-## Properties
-### configuration
-• `Optional` **configuration**: `object`
-Configuration parameters for the required input.
-___
-### details
-• `Optional` **details**: [`SubInputDetail_2`](internal_.SubInputDetail_2.md)[]
-Input details can also be provided recursively.
-___
-### itemSearchUrl
-• `Optional` **itemSearchUrl**: `string`
-In case of a select, the URL from which to query the items.
-___
-### 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 value is optional.
-___
-### 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_.InputStyles.md DELETED Viewed

@@ -1,154 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / InputStyles
-# Interface: InputStyles
-[<internal>](../modules/internal_.md).InputStyles
-## Hierarchy
-- [`BlockElementStyles`](internal_.BlockElementStyles.md)
-  ↳ **`InputStyles`**
-  ↳↳ [`TextInputStyles`](internal_.TextInputStyles.md)
-  ↳↳ [`CheckableInputStyles`](internal_.CheckableInputStyles.md)
-## Table of contents
-### Properties
-- [active](internal_.InputStyles.md#active)
-- [backgroundColor](internal_.InputStyles.md#backgroundcolor)
-- [borderColor](internal_.InputStyles.md#bordercolor)
-- [borderWidth](internal_.InputStyles.md#borderwidth)
-- [boxShadow](internal_.InputStyles.md#boxshadow)
-- [color](internal_.InputStyles.md#color)
-- [disabled](internal_.InputStyles.md#disabled)
-- [error](internal_.InputStyles.md#error)
-- [focus](internal_.InputStyles.md#focus)
-- [fontFamily](internal_.InputStyles.md#fontfamily)
-- [fontWeight](internal_.InputStyles.md#fontweight)
-- [hover](internal_.InputStyles.md#hover)
-- [letterSpacing](internal_.InputStyles.md#letterspacing)
-- [lineHeight](internal_.InputStyles.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)
-___
-### error
-• `Optional` **error**: [`InputStyles`](internal_.InputStyles.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_.Item.md DELETED Viewed

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

package/docs/interfaces/internal_.Item_2.md DELETED Viewed

@@ -1,28 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Item\_2
-# Interface: Item\_2
-[<internal>](../modules/internal_.md).Item_2
-## Table of contents
-### Properties
-- [id](internal_.Item_2.md#id)
-- [name](internal_.Item_2.md#name)
-## Properties
-### id
-• `Optional` **id**: `string`
-The value to provide in the result.
-___
-### name
-• `Optional` **name**: `string`
-The display name.

package/docs/interfaces/internal_.Item_3.md DELETED Viewed

@@ -1,28 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / Item\_3
-# Interface: Item\_3
-[<internal>](../modules/internal_.md).Item_3
-## Table of contents
-### Properties
-- [id](internal_.Item_3.md#id)
-- [name](internal_.Item_3.md#name)
-## Properties
-### id
-• `Optional` **id**: `string`
-The value to provide in the result.
-___
-### name
-• `Optional` **name**: `string`
-The display name.

package/docs/interfaces/internal_.KlarnaLoadResponse.md DELETED Viewed

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / KlarnaLoadResponse
-# Interface: KlarnaLoadResponse
-[<internal>](../modules/internal_.md).KlarnaLoadResponse
-## Table of contents
-### Properties
-- [error](internal_.KlarnaLoadResponse.md#error)
-- [show\_form](internal_.KlarnaLoadResponse.md#show_form)
-## Properties
-### error
-• `Optional` **error**: `Object`
-#### Type declaration
-| Name | Type |
-| :------ | :------ |
-| `invalid_fields` | `string`[] |
-___
-### show\_form
-• **show\_form**: `boolean`

package/docs/interfaces/internal_.KlarnaLoadResponse_2.md DELETED Viewed

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / KlarnaLoadResponse\_2
-# Interface: KlarnaLoadResponse\_2
-[<internal>](../modules/internal_.md).KlarnaLoadResponse_2
-## Table of contents
-### Properties
-- [error](internal_.KlarnaLoadResponse_2.md#error)
-- [show\_form](internal_.KlarnaLoadResponse_2.md#show_form)
-## Properties
-### error
-• `Optional` **error**: `Object`
-#### Type declaration
-| Name | Type |
-| :------ | :------ |
-| `invalid_fields` | `string`[] |
-___
-### show\_form
-• **show\_form**: `boolean`

package/docs/interfaces/internal_.KlarnaPaymentInitializeOptions.md DELETED Viewed

@@ -1,75 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / KlarnaPaymentInitializeOptions
-# Interface: KlarnaPaymentInitializeOptions
-[<internal>](../modules/internal_.md).KlarnaPaymentInitializeOptions
-A set of options that are required to initialize the Klarna payment method.
-When Klarna is initialized, a widget will be inserted into the DOM. The
-widget has a list of payment options for the customer to choose from.
-```html
-<!-- This is where the widget will be inserted -->
-<div id="container"></div>
-```
-```js
-service.initializePayment({
-    methodId: 'klarna',
-    klarna: {
-        container: 'container'
-    },
-});
-```
-An additional event callback can be registered.
-```js
-service.initializePayment({
-    methodId: 'klarnav2',
-    klarnav2: {
-        container: 'container',
-        onLoad(response) {
-            console.log(response);
-        },
-    },
-});
-```
-## Table of contents
-### Properties
-- [container](internal_.KlarnaPaymentInitializeOptions.md#container)
-### Methods
-- [onLoad](internal_.KlarnaPaymentInitializeOptions.md#onload)
-## Properties
-### container
-• **container**: `string`
-The ID of a container which the payment widget should insert into.
-## Methods
-### onLoad
-▸ `Optional` **onLoad**(`response`): `void`
-A callback that gets called when the widget is loaded and ready to be
-interacted with.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `response` | [`KlarnaLoadResponse`](internal_.KlarnaLoadResponse.md) | The result of the initialization. It indicates whether or not the widget is loaded successfully. |
-#### Returns
-`void`