@bigcommerce/checkout-sdk 1.263.0 → 1.264.2

package/docs/interfaces/adyenv3creditcardcomponentoptions.md

@@ -1,169 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AdyenV3CreditCardComponentOptions](adyenv3creditcardcomponentoptions.md)
-
-# Interface: AdyenV3CreditCardComponentOptions
-
-## Hierarchy
-
-* [AdyenBaseCardComponentOptions_2](adyenbasecardcomponentoptions_2.md)
-
-* [AdyenComponentEvents_2](adyencomponentevents_2.md)
-
-  ↳ **AdyenV3CreditCardComponentOptions**
-
-## Index
-
-### Properties
-
-* [brands](adyenv3creditcardcomponentoptions.md#optional-brands)
-* [data](adyenv3creditcardcomponentoptions.md#optional-data)
-* [details](adyenv3creditcardcomponentoptions.md#optional-details)
-* [enableStoreDetails](adyenv3creditcardcomponentoptions.md#optional-enablestoredetails)
-* [groupTypes](adyenv3creditcardcomponentoptions.md#optional-grouptypes)
-* [hasHolderName](adyenv3creditcardcomponentoptions.md#optional-hasholdername)
-* [holderNameRequired](adyenv3creditcardcomponentoptions.md#optional-holdernamerequired)
-* [placeholders](adyenv3creditcardcomponentoptions.md#optional-placeholders)
-* [styles](adyenv3creditcardcomponentoptions.md#optional-styles)
-
-### Methods
-
-* [onChange](adyenv3creditcardcomponentoptions.md#optional-onchange)
-* [onError](adyenv3creditcardcomponentoptions.md#optional-onerror)
-* [onFieldValid](adyenv3creditcardcomponentoptions.md#optional-onfieldvalid)
-
-## Properties
-
-### `Optional` brands
-
-• **brands**? : *string[]*
-
-*Inherited from [AdyenBaseCardComponentOptions_2](adyenbasecardcomponentoptions_2.md).[brands](adyenbasecardcomponentoptions_2.md#optional-brands)*
-
-Array of card brands that will be recognized by the component.
-
-___
-
-### `Optional` data
-
-• **data**? : *[AdyenPlaceholderData_2](adyenplaceholderdata_2.md)*
-
-Information to prefill fields.
-
-___
-
-### `Optional` details
-
-• **details**? : *[InputDetail_2](inputdetail_2.md)[]*
-
-Set an object containing the details array for type: scheme from
-the /paymentMethods response.
-
-___
-
-### `Optional` enableStoreDetails
-
-• **enableStoreDetails**? : *undefined | false | true*
-
-Set to true to show the checkbox to save card details for the next payment.
-
-___
-
-### `Optional` groupTypes
-
-• **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.
-
-___
-
-### `Optional` hasHolderName
-
-• **hasHolderName**? : *undefined | false | true*
-
-Set to true to request the name of the card holder.
-
-___
-
-### `Optional` holderNameRequired
-
-• **holderNameRequired**? : *undefined | false | true*
-
-Set to true to require the card holder name.
-
-___
-
-### `Optional` placeholders
-
-• **placeholders**? : *[CreditCardPlaceHolder_2](creditcardplaceholder_2.md) | [SepaPlaceHolder_2](sepaplaceholder_2.md)*
-
-Specify the sample values you want to appear for card detail input fields.
-
-___
-
-### `Optional` styles
-
-• **styles**? : *[StyleOptions_2](styleoptions_2.md)*
-
-*Inherited from [AdyenBaseCardComponentOptions_2](adyenbasecardcomponentoptions_2.md).[styles](adyenbasecardcomponentoptions_2.md#optional-styles)*
-
-Set a style object to customize the input fields. See Styling Secured Fields
-for a list of supported properties.
-
-## Methods
-
-### `Optional` onChange
-
-▸ **onChange**(`state`: [AdyenV3ComponentState](../README.md#adyenv3componentstate), `component`: [AdyenComponent_2](adyencomponent_2.md)): *void*
-
-*Inherited from [AdyenComponentEvents_2](adyencomponentevents_2.md).[onChange](adyencomponentevents_2.md#optional-onchange)*
-
-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*
-
-___
-
-### `Optional` onError
-
-▸ **onError**(`state`: [AdyenV3ComponentState](../README.md#adyenv3componentstate), `component`: [AdyenComponent_2](adyencomponent_2.md)): *void*
-
-*Inherited from [AdyenComponentEvents_2](adyencomponentevents_2.md).[onError](adyencomponentevents_2.md#optional-onerror)*
-
-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*
-
-___
-
-### `Optional` onFieldValid
-
-▸ **onFieldValid**(`state`: [AdyenV3ComponentState](../README.md#adyenv3componentstate), `component`: [AdyenComponent_2](adyencomponent_2.md)): *void*
-
-*Inherited from [AdyenComponentEvents_2](adyencomponentevents_2.md).[onFieldValid](adyencomponentevents_2.md#optional-onfieldvalid)*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`state` | [AdyenV3ComponentState](../README.md#adyenv3componentstate) |
-`component` | [AdyenComponent_2](adyencomponent_2.md) |
-
-**Returns:** *void*

package/docs/interfaces/amazonpaycustomerinitializeoptions.md

@@ -1,67 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayCustomerInitializeOptions](amazonpaycustomerinitializeoptions.md)
-
-# 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.
-
-## Hierarchy
-
-* **AmazonPayCustomerInitializeOptions**
-
-## Index
-
-### Properties
-
-* [color](amazonpaycustomerinitializeoptions.md#optional-color)
-* [container](amazonpaycustomerinitializeoptions.md#container)
-* [size](amazonpaycustomerinitializeoptions.md#optional-size)
-
-### Methods
-
-* [onError](amazonpaycustomerinitializeoptions.md#optional-onerror)
-
-## Properties
-
-### `Optional` color
-
-• **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.
-
-___
-
-### `Optional` size
-
-• **size**? : *"small" | "medium" | "large" | "x-large"*
-
-The size of the sign-in button.
-
-## Methods
-
-### `Optional` onError
-
-▸ **onError**(`error`: [AmazonPayWidgetError](amazonpaywidgeterror.md) | [StandardError](../classes/standarderror.md)): *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

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayOrderReference](amazonpayorderreference.md)
-
-# Interface: AmazonPayOrderReference
-
-## Hierarchy
-
-* **AmazonPayOrderReference**
-
-## Index
-
-### 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

@@ -1,98 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayPaymentInitializeOptions](amazonpaypaymentinitializeoptions.md)
-
-# 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',
-    },
-});
-```
-
-## Hierarchy
-
-* **AmazonPayPaymentInitializeOptions**
-
-## Index
-
-### Properties
-
-* [container](amazonpaypaymentinitializeoptions.md#container)
-
-### Methods
-
-* [onError](amazonpaypaymentinitializeoptions.md#optional-onerror)
-* [onPaymentSelect](amazonpaypaymentinitializeoptions.md#optional-onpaymentselect)
-* [onReady](amazonpaypaymentinitializeoptions.md#optional-onready)
-
-## Properties
-
-###  container
-
-• **container**: *string*
-
-The ID of a container which the payment widget should insert into.
-
-## Methods
-
-### `Optional` onError
-
-▸ **onError**(`error`: [AmazonPayWidgetError](amazonpaywidgeterror.md) | [StandardError](../classes/standarderror.md)): *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) &#124; [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onPaymentSelect
-
-▸ **onPaymentSelect**(`reference`: [AmazonPayOrderReference](amazonpayorderreference.md)): *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*
-
-___
-
-### `Optional` onReady
-
-▸ **onReady**(`reference`: [AmazonPayOrderReference](amazonpayorderreference.md)): *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*

package/docs/interfaces/amazonpayshippinginitializeoptions.md

@@ -1,83 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayShippingInitializeOptions](amazonpayshippinginitializeoptions.md)
-
-# Interface: AmazonPayShippingInitializeOptions
-
-A set of options that are required to initialize the shipping step of
-checkout in order to support Amazon Pay.
-
-When Amazon Pay is initialized, a widget will be inserted into the DOM. The
-widget has a list of shipping addresses for the customer to choose from.
-
-## Hierarchy
-
-* **AmazonPayShippingInitializeOptions**
-
-## Index
-
-### Properties
-
-* [container](amazonpayshippinginitializeoptions.md#container)
-
-### Methods
-
-* [onAddressSelect](amazonpayshippinginitializeoptions.md#optional-onaddressselect)
-* [onError](amazonpayshippinginitializeoptions.md#optional-onerror)
-* [onReady](amazonpayshippinginitializeoptions.md#optional-onready)
-
-## Properties
-
-###  container
-
-• **container**: *string*
-
-The ID of a container which the address widget should insert into.
-
-## Methods
-
-### `Optional` onAddressSelect
-
-▸ **onAddressSelect**(`reference`: [AmazonPayOrderReference](amazonpayorderreference.md)): *void*
-
-A callback that gets called when the customer selects an address option.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`reference` | [AmazonPayOrderReference](amazonpayorderreference.md) | The order reference provided by Amazon.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onError
-
-▸ **onError**(`error`: [AmazonPayWidgetError](amazonpaywidgeterror.md) | [StandardError](../classes/standarderror.md)): *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 of the initialization.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onReady
-
-▸ **onReady**(`reference`: [AmazonPayOrderReference](amazonpayorderreference.md)): *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*

package/docs/interfaces/amazonpayv2buttonparams.md

@@ -1,75 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayV2ButtonParams](amazonpayv2buttonparams.md)
-
-# Interface: AmazonPayV2ButtonParams
-
-## Hierarchy
-
-* **AmazonPayV2ButtonParams**
-
-## Index
-
-### Properties
-
-* [checkoutLanguage](amazonpayv2buttonparams.md#optional-checkoutlanguage)
-* [createCheckoutSession](amazonpayv2buttonparams.md#createcheckoutsession)
-* [ledgerCurrency](amazonpayv2buttonparams.md#ledgercurrency)
-* [merchantId](amazonpayv2buttonparams.md#merchantid)
-* [placement](amazonpayv2buttonparams.md#placement)
-* [productType](amazonpayv2buttonparams.md#optional-producttype)
-* [sandbox](amazonpayv2buttonparams.md#optional-sandbox)
-
-## Properties
-
-### `Optional` checkoutLanguage
-
-• **checkoutLanguage**? : *[AmazonPayV2CheckoutLanguage](../enums/amazonpayv2checkoutlanguage.md)*
-
-Language used to render the button and text on Amazon Pay hosted pages.
-
-___
-
-###  createCheckoutSession
-
-• **createCheckoutSession**: *[AmazonPayV2CheckoutSession](amazonpayv2checkoutsession.md)*
-
-Configuration for calling the endpoint to Create Checkout Session.
-
-___
-
-###  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.
-
-___
-
-### `Optional` productType
-
-• **productType**? : *[AmazonPayV2PayOptions](../enums/amazonpayv2payoptions.md)*
-
-Product type selected for checkout. Default is 'PayAndShip'.
-
-___
-
-### `Optional` sandbox
-
-• **sandbox**? : *undefined | false | true*
-
-Sets button to Sandbox environment. Default is false.

package/docs/interfaces/amazonpayv2checkoutsession.md

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

package/docs/interfaces/amazonpaywidgeterror.md

@@ -1,60 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [AmazonPayWidgetError](amazonpaywidgeterror.md)
-
-# Interface: AmazonPayWidgetError
-
-## Hierarchy
-
-* [Error](amazonpaywidgeterror.md#error)
-
-  ↳ **AmazonPayWidgetError**
-
-## Index
-
-### Properties
-
-* [Error](amazonpaywidgeterror.md#error)
-* [message](amazonpaywidgeterror.md#message)
-* [name](amazonpaywidgeterror.md#name)
-* [stack](amazonpaywidgeterror.md#optional-stack)
-
-### Methods
-
-* [getErrorCode](amazonpaywidgeterror.md#geterrorcode)
-
-## Properties
-
-###  Error
-
-• **Error**: *ErrorConstructor*
-
-___
-
-###  message
-
-• **message**: *string*
-
-*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[message](amazonpaywidgeterror.md#message)*
-
-___
-
-###  name
-
-• **name**: *string*
-
-*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[name](amazonpaywidgeterror.md#name)*
-
-___
-
-### `Optional` stack
-
-• **stack**? : *undefined | string*
-
-*Inherited from [AmazonPayWidgetError](amazonpaywidgeterror.md).[stack](amazonpaywidgeterror.md#optional-stack)*
-
-## Methods
-
-###  getErrorCode
-
-▸ **getErrorCode**(): *string*
-
-**Returns:** *string*

package/docs/interfaces/applepaybuttoninitializeoptions.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [ApplePayButtonInitializeOptions](applepaybuttoninitializeoptions.md)
-
-# Interface: ApplePayButtonInitializeOptions
-
-A set of options that are required to initialize ApplePay in cart.
-
-When ApplePay is initialized, an ApplePay button will be inserted into the
-DOM. When a customer clicks on it, it will trigger Apple sheet.
-
-## Hierarchy
-
-* **ApplePayButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [buttonClassName](applepaybuttoninitializeoptions.md#optional-buttonclassname)
-
-### Methods
-
-* [onPaymentAuthorize](applepaybuttoninitializeoptions.md#onpaymentauthorize)
-
-## Properties
-
-### `Optional` buttonClassName
-
-• **buttonClassName**? : *undefined | string*
-
-The class name of the ApplePay button style.
-
-## Methods
-
-###  onPaymentAuthorize
-
-▸ **onPaymentAuthorize**(): *void*
-
-A callback that gets called when a payment is successfully completed.
-
-**Returns:** *void*