@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.BillingAddress.md

@@ -0,0 +1,184 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BillingAddress
+
+# Interface: BillingAddress
+
+[<internal>](../modules/internal_.md).BillingAddress
+
+## Hierarchy
+
+- [`Address`](internal_.Address.md)
+
+  ↳ **`BillingAddress`**
+
+## Table of contents
+
+### Properties
+
+- [address1](internal_.BillingAddress.md#address1)
+- [address2](internal_.BillingAddress.md#address2)
+- [city](internal_.BillingAddress.md#city)
+- [company](internal_.BillingAddress.md#company)
+- [country](internal_.BillingAddress.md#country)
+- [countryCode](internal_.BillingAddress.md#countrycode)
+- [customFields](internal_.BillingAddress.md#customfields)
+- [email](internal_.BillingAddress.md#email)
+- [firstName](internal_.BillingAddress.md#firstname)
+- [id](internal_.BillingAddress.md#id)
+- [lastName](internal_.BillingAddress.md#lastname)
+- [phone](internal_.BillingAddress.md#phone)
+- [postalCode](internal_.BillingAddress.md#postalcode)
+- [shouldSaveAddress](internal_.BillingAddress.md#shouldsaveaddress)
+- [stateOrProvince](internal_.BillingAddress.md#stateorprovince)
+- [stateOrProvinceCode](internal_.BillingAddress.md#stateorprovincecode)
+
+## Properties
+
+### address1
+
+• **address1**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[address1](internal_.Address.md#address1)
+
+___
+
+### address2
+
+• **address2**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[address2](internal_.Address.md#address2)
+
+___
+
+### city
+
+• **city**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[city](internal_.Address.md#city)
+
+___
+
+### company
+
+• **company**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[company](internal_.Address.md#company)
+
+___
+
+### country
+
+• **country**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[country](internal_.Address.md#country)
+
+___
+
+### countryCode
+
+• **countryCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[countryCode](internal_.Address.md#countrycode)
+
+___
+
+### customFields
+
+• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### Inherited from
+
+[Address](internal_.Address.md).[customFields](internal_.Address.md#customfields)
+
+___
+
+### email
+
+• `Optional` **email**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[firstName](internal_.Address.md#firstname)
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[lastName](internal_.Address.md#lastname)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[phone](internal_.Address.md#phone)
+
+___
+
+### postalCode
+
+• **postalCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[postalCode](internal_.Address.md#postalcode)
+
+___
+
+### shouldSaveAddress
+
+• `Optional` **shouldSaveAddress**: `boolean`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[shouldSaveAddress](internal_.Address.md#shouldsaveaddress)
+
+___
+
+### stateOrProvince
+
+• **stateOrProvince**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[stateOrProvince](internal_.Address.md#stateorprovince)
+
+___
+
+### stateOrProvinceCode
+
+• **stateOrProvinceCode**: `string`
+
+#### Inherited from
+
+[Address](internal_.Address.md).[stateOrProvinceCode](internal_.Address.md#stateorprovincecode)

package/docs/interfaces/internal_.BillingAddressRequestBody.md

@@ -0,0 +1,155 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BillingAddressRequestBody
+
+# Interface: BillingAddressRequestBody
+
+[<internal>](../modules/internal_.md).BillingAddressRequestBody
+
+## Hierarchy
+
+- [`AddressRequestBody`](internal_.AddressRequestBody.md)
+
+  ↳ **`BillingAddressRequestBody`**
+
+## Table of contents
+
+### Properties
+
+- [address1](internal_.BillingAddressRequestBody.md#address1)
+- [address2](internal_.BillingAddressRequestBody.md#address2)
+- [city](internal_.BillingAddressRequestBody.md#city)
+- [company](internal_.BillingAddressRequestBody.md#company)
+- [countryCode](internal_.BillingAddressRequestBody.md#countrycode)
+- [customFields](internal_.BillingAddressRequestBody.md#customfields)
+- [email](internal_.BillingAddressRequestBody.md#email)
+- [firstName](internal_.BillingAddressRequestBody.md#firstname)
+- [lastName](internal_.BillingAddressRequestBody.md#lastname)
+- [phone](internal_.BillingAddressRequestBody.md#phone)
+- [postalCode](internal_.BillingAddressRequestBody.md#postalcode)
+- [stateOrProvince](internal_.BillingAddressRequestBody.md#stateorprovince)
+- [stateOrProvinceCode](internal_.BillingAddressRequestBody.md#stateorprovincecode)
+
+## Properties
+
+### address1
+
+• **address1**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[address1](internal_.AddressRequestBody.md#address1)
+
+___
+
+### address2
+
+• **address2**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[address2](internal_.AddressRequestBody.md#address2)
+
+___
+
+### city
+
+• **city**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[city](internal_.AddressRequestBody.md#city)
+
+___
+
+### company
+
+• **company**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[company](internal_.AddressRequestBody.md#company)
+
+___
+
+### countryCode
+
+• **countryCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[countryCode](internal_.AddressRequestBody.md#countrycode)
+
+___
+
+### customFields
+
+• **customFields**: { `fieldId`: `string` ; `fieldValue`: `string` \| `number` \| `string`[]  }[]
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[customFields](internal_.AddressRequestBody.md#customfields)
+
+___
+
+### email
+
+• `Optional` **email**: `string`
+
+___
+
+### firstName
+
+• **firstName**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[firstName](internal_.AddressRequestBody.md#firstname)
+
+___
+
+### lastName
+
+• **lastName**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[lastName](internal_.AddressRequestBody.md#lastname)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[phone](internal_.AddressRequestBody.md#phone)
+
+___
+
+### postalCode
+
+• **postalCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[postalCode](internal_.AddressRequestBody.md#postalcode)
+
+___
+
+### stateOrProvince
+
+• **stateOrProvince**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[stateOrProvince](internal_.AddressRequestBody.md#stateorprovince)
+
+___
+
+### stateOrProvinceCode
+
+• **stateOrProvinceCode**: `string`
+
+#### Inherited from
+
+[AddressRequestBody](internal_.AddressRequestBody.md).[stateOrProvinceCode](internal_.AddressRequestBody.md#stateorprovincecode)

package/docs/interfaces/internal_.BlockElementStyles.md

@@ -0,0 +1,107 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BlockElementStyles
+
+# Interface: BlockElementStyles
+
+[<internal>](../modules/internal_.md).BlockElementStyles
+
+## Hierarchy
+
+- [`InlineElementStyles`](internal_.InlineElementStyles.md)
+
+  ↳ **`BlockElementStyles`**
+
+  ↳↳ [`ButtonStyles`](internal_.ButtonStyles.md)
+
+  ↳↳ [`InputStyles`](internal_.InputStyles.md)
+
+  ↳↳ [`ChecklistStyles`](internal_.ChecklistStyles.md)
+
+  ↳↳ [`StepStyles`](internal_.StepStyles.md)
+
+## Table of contents
+
+### Properties
+
+- [backgroundColor](internal_.BlockElementStyles.md#backgroundcolor)
+- [borderColor](internal_.BlockElementStyles.md#bordercolor)
+- [borderWidth](internal_.BlockElementStyles.md#borderwidth)
+- [boxShadow](internal_.BlockElementStyles.md#boxshadow)
+- [color](internal_.BlockElementStyles.md#color)
+- [fontFamily](internal_.BlockElementStyles.md#fontfamily)
+- [fontWeight](internal_.BlockElementStyles.md#fontweight)
+- [letterSpacing](internal_.BlockElementStyles.md#letterspacing)
+- [lineHeight](internal_.BlockElementStyles.md#lineheight)
+
+## Properties
+
+### backgroundColor
+
+• `Optional` **backgroundColor**: `string`
+
+___
+
+### borderColor
+
+• `Optional` **borderColor**: `string`
+
+___
+
+### borderWidth
+
+• `Optional` **borderWidth**: `string`
+
+___
+
+### boxShadow
+
+• `Optional` **boxShadow**: `string`
+
+___
+
+### color
+
+• `Optional` **color**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](internal_.InlineElementStyles.md).[color](internal_.InlineElementStyles.md#color)
+
+___
+
+### fontFamily
+
+• `Optional` **fontFamily**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](internal_.InlineElementStyles.md).[fontFamily](internal_.InlineElementStyles.md#fontfamily)
+
+___
+
+### fontWeight
+
+• `Optional` **fontWeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](internal_.InlineElementStyles.md).[fontWeight](internal_.InlineElementStyles.md#fontweight)
+
+___
+
+### letterSpacing
+
+• `Optional` **letterSpacing**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](internal_.InlineElementStyles.md).[letterSpacing](internal_.InlineElementStyles.md#letterspacing)
+
+___
+
+### lineHeight
+
+• `Optional` **lineHeight**: `string`
+
+#### Inherited from
+
+[InlineElementStyles](internal_.InlineElementStyles.md).[lineHeight](internal_.InlineElementStyles.md#lineheight)

package/docs/interfaces/internal_.BlueSnapV2PaymentInitializeOptions.md

@@ -0,0 +1,75 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BlueSnapV2PaymentInitializeOptions
+
+# Interface: BlueSnapV2PaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).BlueSnapV2PaymentInitializeOptions
+
+A set of options that are required to initialize the BlueSnap V2 payment
+method.
+
+The payment step is done through a web page via an iframe provided by the
+strategy.
+
+```html
+<!-- This is where the BlueSnap iframe will be inserted. It can be an in-page container or a modal -->
+<div id="container"></div>
+
+<!-- This is a cancellation button -->
+<button type="button" id="cancel-button"></button>
+```
+
+```js
+service.initializePayment({
+    methodId: 'bluesnapv2',
+    bluesnapv2: {
+        onLoad: (iframe) => {
+            document.getElementById('container')
+                .appendChild(iframe);
+
+            document.getElementById('cancel-button')
+                .addEventListener('click', () => {
+                    document.getElementById('container').innerHTML = '';
+                });
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [style](internal_.BlueSnapV2PaymentInitializeOptions.md#style)
+
+### Methods
+
+- [onLoad](internal_.BlueSnapV2PaymentInitializeOptions.md#onload)
+
+## Properties
+
+### style
+
+• `Optional` **style**: [`BlueSnapV2StyleProps`](internal_.BlueSnapV2StyleProps.md)
+
+A set of CSS properties to apply to the iframe.
+
+## Methods
+
+### onLoad
+
+▸ **onLoad**(`iframe`, `cancel`): `void`
+
+A callback that gets called when the iframe is ready to be added to the
+current page. It is responsible for determining where the iframe should
+be inserted in the DOM.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `iframe` | `HTMLIFrameElement` | The iframe element containing the payment web page provided by the strategy. |
+| `cancel` | () => `void` | A function, when called, will cancel the payment process and remove the iframe. |
+
+#### Returns
+
+`void`

package/docs/interfaces/internal_.BlueSnapV2StyleProps.md

@@ -0,0 +1,31 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BlueSnapV2StyleProps
+
+# Interface: BlueSnapV2StyleProps
+
+[<internal>](../modules/internal_.md).BlueSnapV2StyleProps
+
+## Table of contents
+
+### Properties
+
+- [border](internal_.BlueSnapV2StyleProps.md#border)
+- [height](internal_.BlueSnapV2StyleProps.md#height)
+- [width](internal_.BlueSnapV2StyleProps.md#width)
+
+## Properties
+
+### border
+
+• `Optional` **border**: `string`
+
+___
+
+### height
+
+• `Optional` **height**: `string`
+
+___
+
+### width
+
+• `Optional` **width**: `string`

package/docs/interfaces/internal_.BodlEventsPayload.md

@@ -0,0 +1,9 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / BodlEventsPayload
+
+# Interface: BodlEventsPayload
+
+[<internal>](../modules/internal_.md).BodlEventsPayload
+
+## Indexable
+
+▪ [key: `string`]: `unknown`