@bigcommerce/checkout-sdk 1.436.0 → 1.436.1

package/docs/interfaces/AdyenV3CreditCardComponentOptions.md

@@ -1,220 +0,0 @@
-[@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)
-- [showBrandsUnderCardNumber](AdyenV3CreditCardComponentOptions.md#showbrandsundercardnumber)
-- [styles](AdyenV3CreditCardComponentOptions.md#styles)
-
-### Methods
-
-- [onChange](AdyenV3CreditCardComponentOptions.md#onchange)
-- [onError](AdyenV3CreditCardComponentOptions.md#onerror)
-- [onFieldValid](AdyenV3CreditCardComponentOptions.md#onfieldvalid)
-- [onSubmit](AdyenV3CreditCardComponentOptions.md#onsubmit)
-
-## 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.
-
-___
-
-### showBrandsUnderCardNumber
-
-• `Optional` **showBrandsUnderCardNumber**: `boolean`
-
-#### Inherited from
-
-[AdyenBaseCardComponentOptions_2](AdyenBaseCardComponentOptions_2.md).[showBrandsUnderCardNumber](AdyenBaseCardComponentOptions_2.md#showbrandsundercardnumber)
-
-___
-
-### 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` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `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` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onFieldValid](AdyenComponentEvents_2.md#onfieldvalid)
-
-___
-
-### onSubmit
-
-▸ `Optional` **onSubmit**(`state`, `component`): `void`
-
-Called when the shopper selects the Pay button and payment details are valid.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | [`AdyenV3ComponentState`](../README.md#adyenv3componentstate) |
-| `component` | [`AdyenComponent_2`](AdyenComponent_2.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[AdyenComponentEvents_2](AdyenComponentEvents_2.md).[onSubmit](AdyenComponentEvents_2.md#onsubmit)

package/docs/interfaces/AdyenV3PaymentInitializeOptions.md

@@ -1,135 +0,0 @@
-[@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"`` \| ``"showBrandsUnderCardNumber"`` \| ``"onSubmit"``\>
-
-Optional. Overwriting the default options
-
-___
-
-### shouldShowNumberField
-
-• `Optional` **shouldShowNumberField**: `boolean`
-
-## Methods
-
-### validateCardFields
-
-▸ **validateCardFields**(`validateState`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `validateState` | [`AdyenV3ValidationState`](AdyenV3ValidationState.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/AdyenV3ValidationState.md

@@ -1,57 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AdyenV3ValidationState
-
-# Interface: AdyenV3ValidationState
-
-## Table of contents
-
-### Properties
-
-- [encryptedFieldName](AdyenV3ValidationState.md#encryptedfieldname)
-- [endDigits](AdyenV3ValidationState.md#enddigits)
-- [error](AdyenV3ValidationState.md#error)
-- [errorKey](AdyenV3ValidationState.md#errorkey)
-- [fieldType](AdyenV3ValidationState.md#fieldtype)
-- [i18n](AdyenV3ValidationState.md#i18n)
-- [valid](AdyenV3ValidationState.md#valid)
-
-## Properties
-
-### encryptedFieldName
-
-• `Optional` **encryptedFieldName**: `string`
-
-___
-
-### endDigits
-
-• `Optional` **endDigits**: `string`
-
-___
-
-### error
-
-• `Optional` **error**: `string`
-
-___
-
-### errorKey
-
-• `Optional` **errorKey**: `string`
-
-___
-
-### fieldType
-
-• `Optional` **fieldType**: [`CardNumber`](../enums/AdyenV3CardFields.md#cardnumber) \| [`SecurityCode`](../enums/AdyenV3CardFields.md#securitycode) \| [`ExpiryDate`](../enums/AdyenV3CardFields.md#expirydate)
-
-___
-
-### i18n
-
-• `Optional` **i18n**: `string`
-
-___
-
-### valid
-
-• **valid**: `boolean`

package/docs/interfaces/AmazonPayV2ButtonConfig.md

@@ -1,91 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonConfig
-
-# Interface: AmazonPayV2ButtonConfig
-
-## Hierarchy
-
-- **`AmazonPayV2ButtonConfig`**
-
-  ↳ [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
-
-  ↳ [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
-
-  ↳ [`WithBuyNowFeature`](WithBuyNowFeature.md)
-
-## Table of contents
-
-### Properties
-
-- [buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
-- [checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
-- [design](AmazonPayV2ButtonConfig.md#design)
-- [ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
-- [merchantId](AmazonPayV2ButtonConfig.md#merchantid)
-- [placement](AmazonPayV2ButtonConfig.md#placement)
-- [productType](AmazonPayV2ButtonConfig.md#producttype)
-- [sandbox](AmazonPayV2ButtonConfig.md#sandbox)
-
-## Properties
-
-### buttonColor
-
-• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
-
-Color of the Amazon Pay button.
-
-___
-
-### checkoutLanguage
-
-• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
-
-Language used to render the button and text on Amazon Pay hosted pages.
-
-___
-
-### design
-
-• `Optional` **design**: [`C0001`](../enums/AmazonPayV2ButtonDesign.md#c0001)
-
-Sets Amazon Pay button design.
-
-___
-
-### ledgerCurrency
-
-• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
-
-Ledger currency provided during registration for the given merchant identifier.
-
-___
-
-### merchantId
-
-• **merchantId**: `string`
-
-Amazon Pay merchant account identifier.
-
-___
-
-### placement
-
-• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
-
-Placement of the Amazon Pay button on your website.
-
-___
-
-### productType
-
-• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
-
-Product type selected for checkout. Default is 'PayAndShip'.
-
-___
-
-### sandbox
-
-• `Optional` **sandbox**: `boolean`
-
-Sets button to Sandbox environment. You do not have to set this parameter
-if your `publicKeyId` has an environment prefix. Default is false.

package/docs/interfaces/AmazonPayV2ButtonParams.md

@@ -1,128 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2ButtonParams
-
-# Interface: AmazonPayV2ButtonParams
-
-## Hierarchy
-
-- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
-
-  ↳ **`AmazonPayV2ButtonParams`**
-
-## Table of contents
-
-### Properties
-
-- [buttonColor](AmazonPayV2ButtonParams.md#buttoncolor)
-- [checkoutLanguage](AmazonPayV2ButtonParams.md#checkoutlanguage)
-- [createCheckoutSession](AmazonPayV2ButtonParams.md#createcheckoutsession)
-- [design](AmazonPayV2ButtonParams.md#design)
-- [ledgerCurrency](AmazonPayV2ButtonParams.md#ledgercurrency)
-- [merchantId](AmazonPayV2ButtonParams.md#merchantid)
-- [placement](AmazonPayV2ButtonParams.md#placement)
-- [productType](AmazonPayV2ButtonParams.md#producttype)
-- [sandbox](AmazonPayV2ButtonParams.md#sandbox)
-
-## Properties
-
-### buttonColor
-
-• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
-
-Color of the Amazon Pay button.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
-
-___
-
-### checkoutLanguage
-
-• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
-
-Language used to render the button and text on Amazon Pay hosted pages.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
-
-___
-
-### createCheckoutSession
-
-• **createCheckoutSession**: [`AmazonPayV2CheckoutSession`](AmazonPayV2CheckoutSession.md)
-
-Configuration for calling the endpoint to Create Checkout Session.
-
-___
-
-### design
-
-• `Optional` **design**: [`C0001`](../enums/AmazonPayV2ButtonDesign.md#c0001)
-
-Sets Amazon Pay button design.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[design](AmazonPayV2ButtonConfig.md#design)
-
-___
-
-### ledgerCurrency
-
-• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
-
-Ledger currency provided during registration for the given merchant identifier.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
-
-___
-
-### merchantId
-
-• **merchantId**: `string`
-
-Amazon Pay merchant account identifier.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
-
-___
-
-### placement
-
-• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
-
-Placement of the Amazon Pay button on your website.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
-
-___
-
-### productType
-
-• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
-
-Product type selected for checkout. Default is 'PayAndShip'.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
-
-___
-
-### sandbox
-
-• `Optional` **sandbox**: `boolean`
-
-Sets button to Sandbox environment. You do not have to set this parameter
-if your `publicKeyId` has an environment prefix. Default is false.
-
-#### Inherited from
-
-[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)

package/docs/interfaces/AmazonPayV2CheckoutSession.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSession
-
-# Interface: AmazonPayV2CheckoutSession
-
-## Table of contents
-
-### Properties
-
-- [extractAmazonCheckoutSessionId](AmazonPayV2CheckoutSession.md#extractamazoncheckoutsessionid)
-- [method](AmazonPayV2CheckoutSession.md#method)
-- [url](AmazonPayV2CheckoutSession.md#url)
-
-## Properties
-
-### extractAmazonCheckoutSessionId
-
-• `Optional` **extractAmazonCheckoutSessionId**: `string`
-
-Checkout Session ID parameter in the response. Default is 'checkoutSessionId'.
-
-___
-
-### method
-
-• `Optional` **method**: ``"GET"`` \| ``"POST"``
-
-HTTP request method. Default is 'POST'.
-
-___
-
-### url
-
-• **url**: `string`
-
-Endpoint URL to Create Checkout Session.

package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md

@@ -1,36 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSessionConfig
-
-# Interface: AmazonPayV2CheckoutSessionConfig
-
-## Table of contents
-
-### Properties
-
-- [payloadJSON](AmazonPayV2CheckoutSessionConfig.md#payloadjson)
-- [publicKeyId](AmazonPayV2CheckoutSessionConfig.md#publickeyid)
-- [signature](AmazonPayV2CheckoutSessionConfig.md#signature)
-
-## Properties
-
-### payloadJSON
-
-• **payloadJSON**: `string`
-
-A payload that Amazon Pay will use to create a Checkout Session object.
-
-___
-
-### publicKeyId
-
-• `Optional` **publicKeyId**: `string`
-
-Credential provided by Amazon Pay. You do not have to set this parameter
-if your `publicKeyId` has an environment prefix.
-
-___
-
-### signature
-
-• **signature**: `string`
-
-Payload's signature.