@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/InlineElementStyles.md

@@ -0,0 +1,53 @@
+[@bigcommerce/checkout-sdk](../README.md) / InlineElementStyles
+
+# Interface: InlineElementStyles
+
+## Hierarchy
+
+- **`InlineElementStyles`**
+
+  ↳ [`BlockElementStyles`](BlockElementStyles.md)
+
+  ↳ [`LabelStyles`](LabelStyles.md)
+
+  ↳ [`LinkStyles`](LinkStyles.md)
+
+## Table of contents
+
+### Properties
+
+- [color](InlineElementStyles.md#color)
+- [fontFamily](InlineElementStyles.md#fontfamily)
+- [fontWeight](InlineElementStyles.md#fontweight)
+- [letterSpacing](InlineElementStyles.md#letterspacing)
+- [lineHeight](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/InputDetail.md

@@ -0,0 +1,80 @@
+[@bigcommerce/checkout-sdk](../README.md) / InputDetail
+
+# Interface: InputDetail
+
+## Table of contents
+
+### Properties
+
+- [configuration](InputDetail.md#configuration)
+- [details](InputDetail.md#details)
+- [itemSearchUrl](InputDetail.md#itemsearchurl)
+- [items](InputDetail.md#items)
+- [key](InputDetail.md#key)
+- [optional](InputDetail.md#optional)
+- [type](InputDetail.md#type)
+- [value](InputDetail.md#value)
+
+## Properties
+
+### configuration
+
+• `Optional` **configuration**: `object`
+
+Configuration parameters for the required input.
+
+___
+
+### details
+
+• `Optional` **details**: [`SubInputDetail`](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`](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/InputDetail_2.md

@@ -0,0 +1,80 @@
+[@bigcommerce/checkout-sdk](../README.md) / InputDetail_2
+
+# Interface: InputDetail\_2
+
+## Table of contents
+
+### Properties
+
+- [configuration](InputDetail_2.md#configuration)
+- [details](InputDetail_2.md#details)
+- [itemSearchUrl](InputDetail_2.md#itemsearchurl)
+- [items](InputDetail_2.md#items)
+- [key](InputDetail_2.md#key)
+- [optional](InputDetail_2.md#optional)
+- [type](InputDetail_2.md#type)
+- [value](InputDetail_2.md#value)
+
+## Properties
+
+### configuration
+
+• `Optional` **configuration**: `object`
+
+Configuration parameters for the required input.
+
+___
+
+### details
+
+• `Optional` **details**: [`SubInputDetail_2`](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`](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/InputStyles.md

@@ -0,0 +1,152 @@
+[@bigcommerce/checkout-sdk](../README.md) / InputStyles
+
+# Interface: InputStyles
+
+## Hierarchy
+
+- [`BlockElementStyles`](BlockElementStyles.md)
+
+  ↳ **`InputStyles`**
+
+  ↳↳ [`CheckableInputStyles`](CheckableInputStyles.md)
+
+  ↳↳ [`TextInputStyles`](TextInputStyles.md)
+
+## Table of contents
+
+### Properties
+
+- [active](InputStyles.md#active)
+- [backgroundColor](InputStyles.md#backgroundcolor)
+- [borderColor](InputStyles.md#bordercolor)
+- [borderWidth](InputStyles.md#borderwidth)
+- [boxShadow](InputStyles.md#boxshadow)
+- [color](InputStyles.md#color)
+- [disabled](InputStyles.md#disabled)
+- [error](InputStyles.md#error)
+- [focus](InputStyles.md#focus)
+- [fontFamily](InputStyles.md#fontfamily)
+- [fontWeight](InputStyles.md#fontweight)
+- [hover](InputStyles.md#hover)
+- [letterSpacing](InputStyles.md#letterspacing)
+- [lineHeight](InputStyles.md#lineheight)
+
+## Properties
+
+### active
+
+• `Optional` **active**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[backgroundColor](BlockElementStyles.md#backgroundcolor)
+
+___
+
+### borderColor
+
+• `Optional` **borderColor**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderColor](BlockElementStyles.md#bordercolor)
+
+___
+
+### borderWidth
+
+• `Optional` **borderWidth**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[borderWidth](BlockElementStyles.md#borderwidth)
+
+___
+
+### boxShadow
+
+• `Optional` **boxShadow**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[boxShadow](BlockElementStyles.md#boxshadow)
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[color](BlockElementStyles.md#color)
+
+___
+
+### disabled
+
+• `Optional` **disabled**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### error
+
+• `Optional` **error**: [`InputStyles`](InputStyles.md)
+
+___
+
+### focus
+
+• `Optional` **focus**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontFamily](BlockElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[fontWeight](BlockElementStyles.md#fontweight)
+
+___
+
+### hover
+
+• `Optional` **hover**: [`BlockElementStyles`](BlockElementStyles.md)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[letterSpacing](BlockElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[BlockElementStyles](BlockElementStyles.md).[lineHeight](BlockElementStyles.md#lineheight)

package/docs/interfaces/Item.md

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

package/docs/interfaces/Item_2.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) / Item_2
+
+# Interface: Item\_2
+
+## Table of contents
+
+### Properties
+
+- [id](Item_2.md#id)
+- [name](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/Item_3.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) / Item_3
+
+# Interface: Item\_3
+
+## Table of contents
+
+### Properties
+
+- [id](Item_3.md#id)
+- [name](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/KlarnaLoadResponse.md

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

package/docs/interfaces/KlarnaLoadResponse_2.md

@@ -0,0 +1,28 @@
+[@bigcommerce/checkout-sdk](../README.md) / KlarnaLoadResponse_2
+
+# Interface: KlarnaLoadResponse\_2
+
+## Table of contents
+
+### Properties
+
+- [error](KlarnaLoadResponse_2.md#error)
+- [show_form](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/KlarnaPaymentInitializeOptions.md

@@ -0,0 +1,73 @@
+[@bigcommerce/checkout-sdk](../README.md) / KlarnaPaymentInitializeOptions
+
+# Interface: 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](KlarnaPaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onLoad](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`](KlarnaLoadResponse.md) | The result of the initialization. It indicates whether or not the widget is loaded successfully. |
+
+#### Returns
+
+`void`

package/docs/interfaces/KlarnaV2PaymentInitializeOptions.md

@@ -0,0 +1,73 @@
+[@bigcommerce/checkout-sdk](../README.md) / KlarnaV2PaymentInitializeOptions
+
+# Interface: KlarnaV2PaymentInitializeOptions
+
+A set of options that are required to initialize the KlarnaV2 payment method.
+
+When KlarnaV2 is initialized, a list of payment options will be displayed for the customer to choose from.
+Each one with its own widget.
+
+```html
+<!-- This is where the widget will be inserted -->
+<div id="container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'klarnav2',
+    klarnav2: {
+        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](KlarnaV2PaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onLoad](KlarnaV2PaymentInitializeOptions.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_2`](KlarnaLoadResponse_2.md) | The result of the initialization. It indicates whether or not the widget is loaded successfully. |
+
+#### Returns
+
+`void`

package/docs/interfaces/LabelStyles.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / LabelStyles
+
+# Interface: LabelStyles
+
+## Hierarchy
+
+- [`InlineElementStyles`](InlineElementStyles.md)
+
+  ↳ **`LabelStyles`**
+
+## Table of contents
+
+### Properties
+
+- [color](LabelStyles.md#color)
+- [error](LabelStyles.md#error)
+- [fontFamily](LabelStyles.md#fontfamily)
+- [fontWeight](LabelStyles.md#fontweight)
+- [letterSpacing](LabelStyles.md#letterspacing)
+- [lineHeight](LabelStyles.md#lineheight)
+
+## Properties
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[color](InlineElementStyles.md#color)
+
+___
+
+### error
+
+• `Optional` **error**: [`InlineElementStyles`](InlineElementStyles.md)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[fontFamily](InlineElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[fontWeight](InlineElementStyles.md#fontweight)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[letterSpacing](InlineElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](InlineElementStyles.md).[lineHeight](InlineElementStyles.md#lineheight)