@bigcommerce/checkout-sdk 1.271.2 → 1.272.1

package/docs/interfaces/AdyenV2PaymentInitializeOptions.md

@@ -0,0 +1,161 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenV2PaymentInitializeOptions
+
+# Interface: AdyenV2PaymentInitializeOptions
+
+A set of options that are required to initialize the AdyenV2 payment method.
+
+Once AdyenV2 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>
+
+<!-- This is where the secondary components (i.e.: 3DS) will be inserted -->
+<div id="additional-action-container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'adyenv2',
+    adyenv2: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+        },
+    },
+});
+```
+
+Additional options can be passed in to customize the components and register
+event callbacks.
+
+```js
+service.initializePayment({
+    methodId: 'adyenv2',
+    adyenv2: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+            onBeforeLoad(shopperInteraction) {
+                console.log(shopperInteraction);
+            },
+            onLoad(cancel) {
+                console.log(cancel);
+            },
+            onComplete() {
+                console.log('Completed');
+            },
+        },
+        options: {
+            scheme: {
+                hasHolderName: true,
+            },
+            bcmc: {
+                hasHolderName: true,
+            },
+            ideal: {
+                showImage: true,
+            },
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [additionalActionOptions](AdyenV2PaymentInitializeOptions.md#additionalactionoptions)
+- [cardVerificationContainerId](AdyenV2PaymentInitializeOptions.md#cardverificationcontainerid)
+- [containerId](AdyenV2PaymentInitializeOptions.md#containerid)
+- [hasVaultedInstruments](AdyenV2PaymentInitializeOptions.md#hasvaultedinstruments)
+- [options](AdyenV2PaymentInitializeOptions.md#options)
+- [shouldShowNumberField](AdyenV2PaymentInitializeOptions.md#shouldshownumberfield)
+- [threeDS2ContainerId](AdyenV2PaymentInitializeOptions.md#threeds2containerid)
+- [threeDS2Options](AdyenV2PaymentInitializeOptions.md#threeds2options)
+
+### Methods
+
+- [validateCardFields](AdyenV2PaymentInitializeOptions.md#validatecardfields)
+
+## Properties
+
+### additionalActionOptions
+
+• **additionalActionOptions**: [`AdyenAdditionalActionOptions`](AdyenAdditionalActionOptions.md)
+
+A set of options that are required to initialize additional payment actions.
+
+___
+
+### cardVerificationContainerId
+
+• `Optional` **cardVerificationContainerId**: `string`
+
+The location to insert the Adyen custom card component
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the Adyen component.
+
+___
+
+### hasVaultedInstruments
+
+• `Optional` **hasVaultedInstruments**: `boolean`
+
+True if the Adyen component has some Vaulted instrument
+
+___
+
+### options
+
+• `Optional` **options**: [`AdyenIdealComponentOptions`](AdyenIdealComponentOptions.md) \| `Pick`<[`AdyenCreditCardComponentOptions`](AdyenCreditCardComponentOptions.md), ``"details"`` \| ``"enableStoreDetails"`` \| ``"hasHolderName"`` \| ``"holderNameRequired"`` \| ``"data"`` \| ``"groupTypes"`` \| ``"placeholders"`` \| ``"brands"`` \| ``"styles"`` \| ``"onError"`` \| ``"onFieldValid"``\>
+
+Optional. Overwriting the default options
+
+___
+
+### shouldShowNumberField
+
+• `Optional` **shouldShowNumberField**: `boolean`
+
+___
+
+### threeDS2ContainerId
+
+• **threeDS2ContainerId**: `string`
+
+**`deprecated`** The location to insert the Adyen 3DS V2 component.
+Use additionalActionOptions instead as this property will be removed in the future
+
+___
+
+### threeDS2Options
+
+• `Optional` **threeDS2Options**: [`AdyenThreeDS2Options`](AdyenThreeDS2Options.md)
+
+**`deprecated`**
+Use additionalActionOptions instead as this property will be removed in the future
+
+## Methods
+
+### validateCardFields
+
+▸ **validateCardFields**(`componentState`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `componentState` | [`AdyenComponentState`](../README.md#adyencomponentstate) |
+
+#### Returns
+
+`void`

package/docs/interfaces/AdyenV3CreditCardComponentOptions.md

@@ -0,0 +1,185 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenV3CreditCardComponentOptions
+
+# Interface: AdyenV3CreditCardComponentOptions
+
+## Hierarchy
+
+- [`AdyenBaseCardComponentOptions_2`](AdyenBaseCardComponentOptions_2.md)
+
+- [`AdyenComponentEvents_2`](AdyenComponentEvents_2.md)
+
+  ↳ **`AdyenV3CreditCardComponentOptions`**
+
+## Table of contents
+
+### Properties
+
+- [brands](AdyenV3CreditCardComponentOptions.md#brands)
+- [data](AdyenV3CreditCardComponentOptions.md#data)
+- [details](AdyenV3CreditCardComponentOptions.md#details)
+- [enableStoreDetails](AdyenV3CreditCardComponentOptions.md#enablestoredetails)
+- [groupTypes](AdyenV3CreditCardComponentOptions.md#grouptypes)
+- [hasHolderName](AdyenV3CreditCardComponentOptions.md#hasholdername)
+- [holderNameRequired](AdyenV3CreditCardComponentOptions.md#holdernamerequired)
+- [placeholders](AdyenV3CreditCardComponentOptions.md#placeholders)
+- [styles](AdyenV3CreditCardComponentOptions.md#styles)
+
+### Methods
+
+- [onChange](AdyenV3CreditCardComponentOptions.md#onchange)
+- [onError](AdyenV3CreditCardComponentOptions.md#onerror)
+- [onFieldValid](AdyenV3CreditCardComponentOptions.md#onfieldvalid)
+
+## Properties
+
+### brands
+
+• `Optional` **brands**: `string`[]
+
+Array of card brands that will be recognized by the component.
+
+#### Inherited from
+
+[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[brands](AdyenBaseCardComponentOptions_2.md#brands)
+
+___
+
+### data
+
+• `Optional` **data**: [`AdyenPlaceholderData_2`](AdyenPlaceholderData_2.md)
+
+Information to prefill fields.
+
+___
+
+### details
+
+• `Optional` **details**: [`InputDetail_2`](InputDetail_2.md)[]
+
+Set an object containing the details array for type: scheme from
+the /paymentMethods response.
+
+___
+
+### enableStoreDetails
+
+• `Optional` **enableStoreDetails**: `boolean`
+
+Set to true to show the checkbox to save card details for the next payment.
+
+___
+
+### groupTypes
+
+• `Optional` **groupTypes**: `string`[]
+
+Defaults to ['mc','visa','amex']. Configure supported card types to
+facilitate brand recognition used in the Secured Fields onBrand callback.
+See list of available card types. If a shopper enters a card type not
+specified in the GroupTypes configuration, the onBrand callback will not be invoked.
+
+___
+
+### hasHolderName
+
+• `Optional` **hasHolderName**: `boolean`
+
+Set to true to request the name of the card holder.
+
+___
+
+### holderNameRequired
+
+• `Optional` **holderNameRequired**: `boolean`
+
+Set to true to require the card holder name.
+
+___
+
+### placeholders
+
+• `Optional` **placeholders**: [`CreditCardPlaceHolder_2`](CreditCardPlaceHolder_2.md) \| [`SepaPlaceHolder_2`](SepaPlaceHolder_2.md)
+
+Specify the sample values you want to appear for card detail input fields.
+
+___
+
+### 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.
+
+#### Inherited from
+
+[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[styles](AdyenBaseCardComponentOptions_2.md#styles)
+
+## Methods
+
+### onChange
+
+▸ `Optional` **onChange**(`state`, `component`): `void`
+
+Called when the shopper enters data in the card input fields.
+Here you have the option to override your main Adyen Checkout configuration.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
+| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onChange](AdyenComponentEvents_2.md#onchange)
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`state`, `component`): `void`
+
+Called in case of an invalid card number, invalid expiry date, or
+ incomplete field. Called again when errors are cleared.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
+| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onError](AdyenComponentEvents_2.md#onerror)
+
+___
+
+### onFieldValid
+
+▸ `Optional` **onFieldValid**(`state`, `component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
+| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onFieldValid](AdyenComponentEvents_2.md#onfieldvalid)

package/docs/interfaces/AdyenV3PaymentInitializeOptions.md

@@ -0,0 +1,135 @@
+[@bigcommerce/checkout-sdk](../README.md) / AdyenV3PaymentInitializeOptions
+
+# Interface: AdyenV3PaymentInitializeOptions
+
+A set of options that are required to initialize the Adyenv3 payment method.
+
+Once Adyenv3 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>
+
+<!-- This is where the secondary components (i.e.: 3DS) will be inserted -->
+<div id="additional-action-container"></div>
+```
+
+```js
+service.initializePayment({
+    methodId: 'adyenv3',
+    adyenv3: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+        },
+    },
+});
+```
+
+Additional options can be passed in to customize the components and register
+event callbacks.
+
+```js
+service.initializePayment({
+    methodId: 'adyenv3',
+    adyenv3: {
+        containerId: 'container',
+        additionalActionOptions: {
+            containerId: 'additional-action-container',
+            onBeforeLoad(shopperInteraction) {
+                console.log(shopperInteraction);
+            },
+            onLoad(cancel) {
+                console.log(cancel);
+            },
+            onComplete() {
+                console.log('Completed');
+            },
+        },
+        options: {
+            scheme: {
+                hasHolderName: true,
+            },
+        },
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [additionalActionOptions](AdyenV3PaymentInitializeOptions.md#additionalactionoptions)
+- [cardVerificationContainerId](AdyenV3PaymentInitializeOptions.md#cardverificationcontainerid)
+- [containerId](AdyenV3PaymentInitializeOptions.md#containerid)
+- [hasVaultedInstruments](AdyenV3PaymentInitializeOptions.md#hasvaultedinstruments)
+- [options](AdyenV3PaymentInitializeOptions.md#options)
+- [shouldShowNumberField](AdyenV3PaymentInitializeOptions.md#shouldshownumberfield)
+
+### Methods
+
+- [validateCardFields](AdyenV3PaymentInitializeOptions.md#validatecardfields)
+
+## Properties
+
+### additionalActionOptions
+
+• **additionalActionOptions**: [`AdyenAdditionalActionOptions_2`](AdyenAdditionalActionOptions_2.md)
+
+A set of options that are required to initialize additional payment actions.
+
+___
+
+### cardVerificationContainerId
+
+• `Optional` **cardVerificationContainerId**: `string`
+
+The location to insert the Adyen custom card component
+
+___
+
+### containerId
+
+• **containerId**: `string`
+
+The location to insert the Adyen component.
+
+___
+
+### hasVaultedInstruments
+
+• `Optional` **hasVaultedInstruments**: `boolean`
+
+True if the Adyen component has some Vaulted instrument
+
+___
+
+### options
+
+• `Optional` **options**: `Pick`<[`AdyenV3CreditCardComponentOptions`](AdyenV3CreditCardComponentOptions.md), ``"details"`` \| ``"enableStoreDetails"`` \| ``"hasHolderName"`` \| ``"holderNameRequired"`` \| ``"data"`` \| ``"groupTypes"`` \| ``"placeholders"`` \| ``"brands"`` \| ``"styles"`` \| ``"onError"`` \| ``"onFieldValid"``\>
+
+Optional. Overwriting the default options
+
+___
+
+### shouldShowNumberField
+
+• `Optional` **shouldShowNumberField**: `boolean`
+
+## Methods
+
+### validateCardFields
+
+▸ **validateCardFields**(`componentState`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `componentState` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
+
+#### Returns
+
+`void`

package/docs/interfaces/AmazonPayCustomerInitializeOptions.md

@@ -0,0 +1,65 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayCustomerInitializeOptions
+
+# Interface: AmazonPayCustomerInitializeOptions
+
+A set of options that are required to initialize the customer step of
+checkout to support Amazon Pay.
+
+When AmazonPay is initialized, a sign-in button will be inserted into the
+DOM. When the customer clicks on it, they will be redirected to Amazon to
+sign in.
+
+## Table of contents
+
+### Properties
+
+- [color](AmazonPayCustomerInitializeOptions.md#color)
+- [container](AmazonPayCustomerInitializeOptions.md#container)
+- [size](AmazonPayCustomerInitializeOptions.md#size)
+
+### Methods
+
+- [onError](AmazonPayCustomerInitializeOptions.md#onerror)
+
+## Properties
+
+### color
+
+• `Optional` **color**: ``"Gold"`` \| ``"LightGray"`` \| ``"DarkGray"``
+
+The colour of the sign-in button.
+
+___
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the sign-in button should insert into.
+
+___
+
+### size
+
+• `Optional` **size**: ``"small"`` \| ``"medium"`` \| ``"large"`` \| ``"x-large"``
+
+The size of the sign-in button.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called if unable to initialize the widget or select
+one of the address options provided by the widget.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`AmazonPayWidgetError`](AmazonPayWidgetError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`

package/docs/interfaces/AmazonPayOrderReference.md

@@ -0,0 +1,30 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayOrderReference
+
+# Interface: AmazonPayOrderReference
+
+## Table of contents
+
+### Methods
+
+- [getAmazonBillingAgreementId](AmazonPayOrderReference.md#getamazonbillingagreementid)
+- [getAmazonOrderReferenceId](AmazonPayOrderReference.md#getamazonorderreferenceid)
+
+## Methods
+
+### getAmazonBillingAgreementId
+
+▸ **getAmazonBillingAgreementId**(): `string`
+
+#### Returns
+
+`string`
+
+___
+
+### getAmazonOrderReferenceId
+
+▸ **getAmazonOrderReferenceId**(): `string`
+
+#### Returns
+
+`string`

package/docs/interfaces/AmazonPayPaymentInitializeOptions.md

@@ -0,0 +1,100 @@
+[@bigcommerce/checkout-sdk](../README.md) / AmazonPayPaymentInitializeOptions
+
+# Interface: AmazonPayPaymentInitializeOptions
+
+A set of options that are required to initialize the Amazon Pay payment
+method.
+
+When AmazonPay 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: 'amazon',
+    amazon: {
+        container: 'container',
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [container](AmazonPayPaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onError](AmazonPayPaymentInitializeOptions.md#onerror)
+- [onPaymentSelect](AmazonPayPaymentInitializeOptions.md#onpaymentselect)
+- [onReady](AmazonPayPaymentInitializeOptions.md#onready)
+
+## Properties
+
+### container
+
+• **container**: `string`
+
+The ID of a container which the payment widget should insert into.
+
+## Methods
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+A callback that gets called if unable to initialize the widget or select
+one of the payment options.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | [`AmazonPayWidgetError`](AmazonPayWidgetError.md) \| [`StandardError`](../classes/StandardError.md) | The error object describing the failure. |
+
+#### Returns
+
+`void`
+
+___
+
+### onPaymentSelect
+
+▸ `Optional` **onPaymentSelect**(`reference`): `void`
+
+A callback that gets called when the customer selects one of the payment
+options provided by the widget.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `reference` | [`AmazonPayOrderReference`](AmazonPayOrderReference.md) | The order reference provided by Amazon. |
+
+#### Returns
+
+`void`
+
+___
+
+### onReady
+
+▸ `Optional` **onReady**(`reference`): `void`
+
+A callback that gets called when the widget is loaded and ready to be
+interacted with.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `reference` | [`AmazonPayOrderReference`](AmazonPayOrderReference.md) | The order reference provided by Amazon. |
+
+#### Returns
+
+`void`