@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/enums/StyleButtonLayout.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / StyleButtonLayout
+
+# Enumeration: StyleButtonLayout
+
+## Table of contents
+
+### Enumeration members
+
+- [horizontal](StyleButtonLayout.md#horizontal)
+- [vertical](StyleButtonLayout.md#vertical)
+
+## Enumeration members
+
+### horizontal
+
+• **horizontal** = `"horizontal"`
+
+___
+
+### vertical
+
+• **vertical** = `"vertical"`

package/docs/enums/StyleButtonShape.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / StyleButtonShape
+
+# Enumeration: StyleButtonShape
+
+## Table of contents
+
+### Enumeration members
+
+- [pill](StyleButtonShape.md#pill)
+- [rect](StyleButtonShape.md#rect)
+
+## Enumeration members
+
+### pill
+
+• **pill** = `"pill"`
+
+___
+
+### rect
+
+• **rect** = `"rect"`

package/docs/interfaces/Address.md

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

package/docs/interfaces/AddressRequestBody.md

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

package/docs/interfaces/AdyenAdditionalActionCallbacks.md

@@ -0,0 +1,68 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionCallbacks
+
+# Interface: AdyenAdditionalActionCallbacks
+
+## Hierarchy
+
+- **`AdyenAdditionalActionCallbacks`**
+
+  ↳ [`AdyenAdditionalActionOptions`](AdyenAdditionalActionOptions.md)
+
+  ↳ [`AdyenThreeDS2Options`](AdyenThreeDS2Options.md)
+
+## Table of contents
+
+### Methods
+
+- [onBeforeLoad](AdyenAdditionalActionCallbacks.md#onbeforeload)
+- [onComplete](AdyenAdditionalActionCallbacks.md#oncomplete)
+- [onLoad](AdyenAdditionalActionCallbacks.md#onload)
+
+## Methods
+
+### onBeforeLoad
+
+▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
+
+A callback that gets called before adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shopperInteraction?` | `boolean` |
+
+#### Returns
+
+`void`
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`cancel?`): `void`
+
+A callback that gets called when adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cancel?` | () => `void` |
+
+#### Returns
+
+`void`

package/docs/interfaces/AdyenAdditionalActionCallbacks_2.md

@@ -0,0 +1,66 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionCallbacks_2
+
+# Interface: AdyenAdditionalActionCallbacks\_2
+
+## Hierarchy
+
+- **`AdyenAdditionalActionCallbacks_2`**
+
+  ↳ [`AdyenAdditionalActionOptions_2`](AdyenAdditionalActionOptions_2.md)
+
+## Table of contents
+
+### Methods
+
+- [onBeforeLoad](AdyenAdditionalActionCallbacks_2.md#onbeforeload)
+- [onComplete](AdyenAdditionalActionCallbacks_2.md#oncomplete)
+- [onLoad](AdyenAdditionalActionCallbacks_2.md#onload)
+
+## Methods
+
+### onBeforeLoad
+
+▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
+
+A callback that gets called before adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shopperInteraction?` | `boolean` |
+
+#### Returns
+
+`void`
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`cancel?`): `void`
+
+A callback that gets called when adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cancel?` | () => `void` |
+
+#### Returns
+
+`void`

package/docs/interfaces/AdyenAdditionalActionOptions.md

@@ -0,0 +1,106 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionOptions
+
+# Interface: AdyenAdditionalActionOptions
+
+## Hierarchy
+
+- [`AdyenAdditionalActionCallbacks`](AdyenAdditionalActionCallbacks.md)
+
+  ↳ **`AdyenAdditionalActionOptions`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](AdyenAdditionalActionOptions.md#containerid)
+- [widgetSize](AdyenAdditionalActionOptions.md#widgetsize)
+
+### Methods
+
+- [onBeforeLoad](AdyenAdditionalActionOptions.md#onbeforeload)
+- [onComplete](AdyenAdditionalActionOptions.md#oncomplete)
+- [onLoad](AdyenAdditionalActionOptions.md#onload)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the additional action component.
+
+___
+
+### widgetSize
+
+• `Optional` **widgetSize**: `string`
+
+Specify Three3DS2Challenge Widget Size
+
+Values
+'01' = 250px x 400px
+'02' = 390px x 400px
+'03' = 500px x 600px
+'04' = 600px x 400px
+'05' = 100% x 100%
+
+## Methods
+
+### onBeforeLoad
+
+▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
+
+A callback that gets called before adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shopperInteraction?` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](AdyenAdditionalActionCallbacks.md).[onBeforeLoad](AdyenAdditionalActionCallbacks.md#onbeforeload)
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](AdyenAdditionalActionCallbacks.md).[onComplete](AdyenAdditionalActionCallbacks.md#oncomplete)
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`cancel?`): `void`
+
+A callback that gets called when adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cancel?` | () => `void` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks](AdyenAdditionalActionCallbacks.md).[onLoad](AdyenAdditionalActionCallbacks.md#onload)

package/docs/interfaces/AdyenAdditionalActionOptions_2.md

@@ -0,0 +1,106 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenAdditionalActionOptions_2
+
+# Interface: AdyenAdditionalActionOptions\_2
+
+## Hierarchy
+
+- [`AdyenAdditionalActionCallbacks_2`](AdyenAdditionalActionCallbacks_2.md)
+
+  ↳ **`AdyenAdditionalActionOptions_2`**
+
+## Table of contents
+
+### Properties
+
+- [containerId](AdyenAdditionalActionOptions_2.md#containerid)
+- [widgetSize](AdyenAdditionalActionOptions_2.md#widgetsize)
+
+### Methods
+
+- [onBeforeLoad](AdyenAdditionalActionOptions_2.md#onbeforeload)
+- [onComplete](AdyenAdditionalActionOptions_2.md#oncomplete)
+- [onLoad](AdyenAdditionalActionOptions_2.md#onload)
+
+## Properties
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the additional action component.
+
+___
+
+### widgetSize
+
+• `Optional` **widgetSize**: `string`
+
+Specify Three3DS2Challenge Widget Size
+
+Values
+'01' = 250px x 400px
+'02' = 390px x 400px
+'03' = 500px x 600px
+'04' = 600px x 400px
+'05' = 100% x 100%
+
+## Methods
+
+### onBeforeLoad
+
+▸ `Optional` **onBeforeLoad**(`shopperInteraction?`): `void`
+
+A callback that gets called before adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `shopperInteraction?` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks_2](AdyenAdditionalActionCallbacks_2.md).[onBeforeLoad](AdyenAdditionalActionCallbacks_2.md#onbeforeload)
+
+___
+
+### onComplete
+
+▸ `Optional` **onComplete**(): `void`
+
+A callback that gets called when adyen component verification
+is completed
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks_2](AdyenAdditionalActionCallbacks_2.md).[onComplete](AdyenAdditionalActionCallbacks_2.md#oncomplete)
+
+___
+
+### onLoad
+
+▸ `Optional` **onLoad**(`cancel?`): `void`
+
+A callback that gets called when adyen component is loaded
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cancel?` | () => `void` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenAdditionalActionCallbacks_2](AdyenAdditionalActionCallbacks_2.md).[onLoad](AdyenAdditionalActionCallbacks_2.md#onload)

package/docs/interfaces/AdyenBaseCardComponentOptions.md

@@ -0,0 +1,33 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenBaseCardComponentOptions
+
+# Interface: AdyenBaseCardComponentOptions
+
+## Hierarchy
+
+- **`AdyenBaseCardComponentOptions`**
+
+  ↳ [`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [brands](AdyenBaseCardComponentOptions.md#brands)
+- [styles](AdyenBaseCardComponentOptions.md#styles)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+___
+
+### styles
+
+• `Optional` **styles**: [`StyleOptions`](StyleOptions.md)
+
+Set a style object to customize the input fields. See Styling Secured Fields
+for a list of supported properties.

package/docs/interfaces/AdyenBaseCardComponentOptions_2.md

@@ -0,0 +1,33 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenBaseCardComponentOptions_2
+
+# Interface: AdyenBaseCardComponentOptions\_2
+
+## Hierarchy
+
+- **`AdyenBaseCardComponentOptions_2`**
+
+  ↳ [`AdyenV3CreditCardComponentOptions`](AdyenV3CreditCardComponentOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [brands](AdyenBaseCardComponentOptions_2.md#brands)
+- [styles](AdyenBaseCardComponentOptions_2.md#styles)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+___
+
+### styles
+
+• `Optional` **styles**: [`StyleOptions_2`](StyleOptions_2.md)
+
+Set a style object to customize the input fields. See Styling Secured Fields
+for a list of supported properties.