@bigcommerce/checkout-sdk 1.264.1 → 1.266.0

package/docs/interfaces/paypalbuttoninitializeoptions.md

@@ -1,76 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonInitializeOptions](paypalbuttoninitializeoptions.md)
-
-# Interface: PaypalButtonInitializeOptions
-
-## Hierarchy
-
-* **PaypalButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [allowCredit](paypalbuttoninitializeoptions.md#optional-allowcredit)
-* [clientId](paypalbuttoninitializeoptions.md#clientid)
-* [style](paypalbuttoninitializeoptions.md#optional-style)
-
-### Methods
-
-* [onAuthorizeError](paypalbuttoninitializeoptions.md#optional-onauthorizeerror)
-* [onPaymentError](paypalbuttoninitializeoptions.md#optional-onpaymenterror)
-
-## Properties
-
-### `Optional` allowCredit
-
-• **allowCredit**? : *undefined | false | true*
-
-Whether or not to show a credit button.
-
-___
-
-###  clientId
-
-• **clientId**: *string*
-
-The Client ID of the Paypal App
-
-___
-
-### `Optional` style
-
-• **style**? : *Pick‹[PaypalButtonStyleOptions](paypalbuttonstyleoptions.md), "layout" | "size" | "color" | "label" | "shape" | "tagline" | "fundingicons"›*
-
-A set of styling options for the checkout button.
-
-## Methods
-
-### `Optional` onAuthorizeError
-
-▸ **onAuthorizeError**(`error`: [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to authorize and tokenize payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onPaymentError
-
-▸ **onPaymentError**(`error`: [StandardError](../classes/standarderror.md)): *void*
-
-A callback that gets called if unable to submit payment.
-
-**Parameters:**
-
-Name | Type | Description |
------- | ------ | ------ |
-`error` | [StandardError](../classes/standarderror.md) | The error object describing the failure.  |
-
-**Returns:** *void*

package/docs/interfaces/paypalbuttonstyleoptions.md

@@ -1,68 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleOptions](paypalbuttonstyleoptions.md)
-
-# Interface: PaypalButtonStyleOptions
-
-## Hierarchy
-
-* **PaypalButtonStyleOptions**
-
-## Index
-
-### Properties
-
-* [color](paypalbuttonstyleoptions.md#optional-color)
-* [fundingicons](paypalbuttonstyleoptions.md#optional-fundingicons)
-* [height](paypalbuttonstyleoptions.md#optional-height)
-* [label](paypalbuttonstyleoptions.md#optional-label)
-* [layout](paypalbuttonstyleoptions.md#optional-layout)
-* [shape](paypalbuttonstyleoptions.md#optional-shape)
-* [size](paypalbuttonstyleoptions.md#optional-size)
-* [tagline](paypalbuttonstyleoptions.md#optional-tagline)
-
-## Properties
-
-### `Optional` color
-
-• **color**? : *[PaypalButtonStyleColorOption](../enums/paypalbuttonstylecoloroption.md)*
-
-___
-
-### `Optional` fundingicons
-
-• **fundingicons**? : *undefined | false | true*
-
-___
-
-### `Optional` height
-
-• **height**? : *undefined | number*
-
-___
-
-### `Optional` label
-
-• **label**? : *[PaypalButtonStyleLabelOption](../enums/paypalbuttonstylelabeloption.md)*
-
-___
-
-### `Optional` layout
-
-• **layout**? : *[PaypalButtonStyleLayoutOption](../enums/paypalbuttonstylelayoutoption.md)*
-
-___
-
-### `Optional` shape
-
-• **shape**? : *[PaypalButtonStyleShapeOption](../enums/paypalbuttonstyleshapeoption.md)*
-
-___
-
-### `Optional` size
-
-• **size**? : *[PaypalButtonStyleSizeOption](../enums/paypalbuttonstylesizeoption.md)*
-
-___
-
-### `Optional` tagline
-
-• **tagline**? : *undefined | false | true*

package/docs/interfaces/paypalbuttonstyleoptions_2.md

@@ -1,54 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalButtonStyleOptions_2](paypalbuttonstyleoptions_2.md)
-
-# Interface: PaypalButtonStyleOptions_2
-
-## Hierarchy
-
-* **PaypalButtonStyleOptions_2**
-
-## Index
-
-### Properties
-
-* [color](paypalbuttonstyleoptions_2.md#optional-color)
-* [height](paypalbuttonstyleoptions_2.md#optional-height)
-* [label](paypalbuttonstyleoptions_2.md#optional-label)
-* [layout](paypalbuttonstyleoptions_2.md#optional-layout)
-* [shape](paypalbuttonstyleoptions_2.md#optional-shape)
-* [tagline](paypalbuttonstyleoptions_2.md#optional-tagline)
-
-## Properties
-
-### `Optional` color
-
-• **color**? : *[StyleButtonColor](../enums/stylebuttoncolor.md)*
-
-___
-
-### `Optional` height
-
-• **height**? : *undefined | number*
-
-___
-
-### `Optional` label
-
-• **label**? : *[StyleButtonLabel](../enums/stylebuttonlabel.md)*
-
-___
-
-### `Optional` layout
-
-• **layout**? : *[StyleButtonLayout](../enums/stylebuttonlayout.md)*
-
-___
-
-### `Optional` shape
-
-• **shape**? : *[StyleButtonShape](../enums/stylebuttonshape.md)*
-
-___
-
-### `Optional` tagline
-
-• **tagline**? : *undefined | false | true*

package/docs/interfaces/paypalcommercebuttoninitializeoptions.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceButtonInitializeOptions](paypalcommercebuttoninitializeoptions.md)
-
-# Interface: PaypalCommerceButtonInitializeOptions
-
-## Hierarchy
-
-* **PaypalCommerceButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [messagingContainer](paypalcommercebuttoninitializeoptions.md#optional-messagingcontainer)
-* [style](paypalcommercebuttoninitializeoptions.md#optional-style)
-
-## Properties
-
-### `Optional` messagingContainer
-
-• **messagingContainer**? : *undefined | string*
-
-Container id for messaging banner container
-
-___
-
-### `Optional` style
-
-• **style**? : *[PaypalButtonStyleOptions_2](paypalbuttonstyleoptions_2.md)*
-
-A set of styling options for the checkout button.

package/docs/interfaces/paypalcommerceformfieldcardtypechangeeventdata.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldCardTypeChangeEventData](paypalcommerceformfieldcardtypechangeeventdata.md)
-
-# Interface: PaypalCommerceFormFieldCardTypeChangeEventData
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldCardTypeChangeEventData**
-
-## Index
-
-### Properties
-
-* [cardType](paypalcommerceformfieldcardtypechangeeventdata.md#optional-cardtype)
-
-## Properties
-
-### `Optional` cardType
-
-• **cardType**? : *undefined | string*

package/docs/interfaces/paypalcommerceformfieldkeyboardeventdata.md

@@ -1,19 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldKeyboardEventData](paypalcommerceformfieldkeyboardeventdata.md)
-
-# Interface: PaypalCommerceFormFieldKeyboardEventData
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldKeyboardEventData**
-
-## Index
-
-### Properties
-
-* [fieldType](paypalcommerceformfieldkeyboardeventdata.md#fieldtype)
-
-## Properties
-
-###  fieldType
-
-• **fieldType**: *string*

package/docs/interfaces/paypalcommerceformfieldoptions.md

@@ -1,28 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)
-
-# Interface: PaypalCommerceFormFieldOptions
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldOptions**
-
-  ↳ [PaypalCommerceStoredCardFieldOptions](paypalcommercestoredcardfieldoptions.md)
-
-## Index
-
-### Properties
-
-* [containerId](paypalcommerceformfieldoptions.md#containerid)
-* [placeholder](paypalcommerceformfieldoptions.md#optional-placeholder)
-
-## Properties
-
-###  containerId
-
-• **containerId**: *string*
-
-___
-
-### `Optional` placeholder
-
-• **placeholder**? : *undefined | string*

package/docs/interfaces/paypalcommerceformfieldsmap.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldsMap](paypalcommerceformfieldsmap.md)
-
-# Interface: PaypalCommerceFormFieldsMap
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldsMap**
-
-## Index
-
-### Properties
-
-* [[PaypalCommerceFormFieldType.CardCode]](paypalcommerceformfieldsmap.md#optional-[paypalcommerceformfieldtype.cardcode])
-* [[PaypalCommerceFormFieldType.CardExpiry]](paypalcommerceformfieldsmap.md#[paypalcommerceformfieldtype.cardexpiry])
-* [[PaypalCommerceFormFieldType.CardName]](paypalcommerceformfieldsmap.md#[paypalcommerceformfieldtype.cardname])
-* [[PaypalCommerceFormFieldType.CardNumber]](paypalcommerceformfieldsmap.md#[paypalcommerceformfieldtype.cardnumber])
-
-## Properties
-
-### `Optional` [PaypalCommerceFormFieldType.CardCode]
-
-• **[PaypalCommerceFormFieldType.CardCode]**? : *[PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)*
-
-___
-
-###  [PaypalCommerceFormFieldType.CardExpiry]
-
-• **[PaypalCommerceFormFieldType.CardExpiry]**: *[PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)*
-
-___
-
-###  [PaypalCommerceFormFieldType.CardName]
-
-• **[PaypalCommerceFormFieldType.CardName]**: *[PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)*
-
-___
-
-###  [PaypalCommerceFormFieldType.CardNumber]
-
-• **[PaypalCommerceFormFieldType.CardNumber]**: *[PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)*

package/docs/interfaces/paypalcommerceformfieldstylesmap.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldStylesMap](paypalcommerceformfieldstylesmap.md)
-
-# Interface: PaypalCommerceFormFieldStylesMap
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldStylesMap**
-
-## Index
-
-### Properties
-
-* [default](paypalcommerceformfieldstylesmap.md#optional-default)
-* [error](paypalcommerceformfieldstylesmap.md#optional-error)
-* [focus](paypalcommerceformfieldstylesmap.md#optional-focus)
-
-## Properties
-
-### `Optional` default
-
-• **default**? : *[PaypalCommerceFormFieldStyles](../README.md#paypalcommerceformfieldstyles)*
-
-___
-
-### `Optional` error
-
-• **error**? : *[PaypalCommerceFormFieldStyles](../README.md#paypalcommerceformfieldstyles)*
-
-___
-
-### `Optional` focus
-
-• **focus**? : *[PaypalCommerceFormFieldStyles](../README.md#paypalcommerceformfieldstyles)*

package/docs/interfaces/paypalcommerceformfieldvalidateerrordata.md

@@ -1,33 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)
-
-# Interface: PaypalCommerceFormFieldValidateErrorData
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldValidateErrorData**
-
-## Index
-
-### Properties
-
-* [fieldType](paypalcommerceformfieldvalidateerrordata.md#fieldtype)
-* [message](paypalcommerceformfieldvalidateerrordata.md#message)
-* [type](paypalcommerceformfieldvalidateerrordata.md#type)
-
-## Properties
-
-###  fieldType
-
-• **fieldType**: *string*
-
-___
-
-###  message
-
-• **message**: *string*
-
-___
-
-###  type
-
-• **type**: *string*

package/docs/interfaces/paypalcommerceformfieldvalidateeventdata.md

@@ -1,40 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormFieldValidateEventData](paypalcommerceformfieldvalidateeventdata.md)
-
-# Interface: PaypalCommerceFormFieldValidateEventData
-
-## Hierarchy
-
-* **PaypalCommerceFormFieldValidateEventData**
-
-## Index
-
-### Properties
-
-* [errors](paypalcommerceformfieldvalidateeventdata.md#errors)
-* [isValid](paypalcommerceformfieldvalidateeventdata.md#isvalid)
-
-## Properties
-
-###  errors
-
-• **errors**: *object*
-
-#### Type declaration:
-
-* **[PaypalCommerceFormFieldType.CardCodeVerification]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-* **[PaypalCommerceFormFieldType.CardCode]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-* **[PaypalCommerceFormFieldType.CardExpiry]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-* **[PaypalCommerceFormFieldType.CardName]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-* **[PaypalCommerceFormFieldType.CardNumberVerification]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-* **[PaypalCommerceFormFieldType.CardNumber]**? : *[PaypalCommerceFormFieldValidateErrorData](paypalcommerceformfieldvalidateerrordata.md)[]*
-
-___
-
-###  isValid
-
-• **isValid**: *boolean*

package/docs/interfaces/paypalcommerceformoptions.md

@@ -1,142 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceFormOptions](paypalcommerceformoptions.md)
-
-# Interface: PaypalCommerceFormOptions
-
-## Hierarchy
-
-* **PaypalCommerceFormOptions**
-
-## Index
-
-### Properties
-
-* [fields](paypalcommerceformoptions.md#fields)
-* [styles](paypalcommerceformoptions.md#optional-styles)
-
-### Methods
-
-* [onBlur](paypalcommerceformoptions.md#optional-onblur)
-* [onCardTypeChange](paypalcommerceformoptions.md#optional-oncardtypechange)
-* [onEnter](paypalcommerceformoptions.md#optional-onenter)
-* [onFocus](paypalcommerceformoptions.md#optional-onfocus)
-* [onValidate](paypalcommerceformoptions.md#optional-onvalidate)
-
-## Properties
-
-###  fields
-
-• **fields**: *[PaypalCommerceFormFieldsMap](paypalcommerceformfieldsmap.md) | [PaypalCommerceStoredCardFieldsMap](paypalcommercestoredcardfieldsmap.md)*
-
-Containers for fields can be to present in one set of values
-
-```js
-{ cardNumber: { containerId: 'card-number' },
-  cardName: { containerId: 'card-name' },
-  cardExpiry: { containerId: 'card-expiry' },
-  cardCode: { containerId: 'card-code' }, }
-```
-
-  Or in another set of values.
-
-```js
-{ cardCodeVerification: { containerId: 'card-number' },
-  cardNumberVerification: { containerId: 'card-name' }, }
-```
-
-___
-
-### `Optional` styles
-
-• **styles**? : *[PaypalCommerceFormFieldStylesMap](paypalcommerceformfieldstylesmap.md)*
-
-Styles for inputs. Change the width, height and other styling.
-
-```js
- default: { color: '#000' },
- error: { color: '#f00' },
- focus: { color: '#0f0' }
-```
-
-## Methods
-
-### `Optional` onBlur
-
-▸ **onBlur**(`data`: [PaypalCommerceFormFieldBlurEventData](../README.md#paypalcommerceformfieldblureventdata)): *void*
-
-A callback that gets called when a field loses focus.
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`data` | [PaypalCommerceFormFieldBlurEventData](../README.md#paypalcommerceformfieldblureventdata) |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onCardTypeChange
-
-▸ **onCardTypeChange**(`data`: [PaypalCommerceFormFieldCardTypeChangeEventData](paypalcommerceformfieldcardtypechangeeventdata.md)): *void*
-
-A callback that gets called when activity within
-the number field has changed such that the possible
-card type has changed.
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`data` | [PaypalCommerceFormFieldCardTypeChangeEventData](paypalcommerceformfieldcardtypechangeeventdata.md) |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onEnter
-
-▸ **onEnter**(`data`: [PaypalCommerceFormFieldEnterEventData](../README.md#paypalcommerceformfieldentereventdata)): *void*
-
-A callback that gets called when the user requests submission
-of an input field, by pressing the Enter or Return key
-on their keyboard, or mobile equivalent.
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`data` | [PaypalCommerceFormFieldEnterEventData](../README.md#paypalcommerceformfieldentereventdata) |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onFocus
-
-▸ **onFocus**(`data`: [PaypalCommerceFormFieldFocusEventData](../README.md#paypalcommerceformfieldfocuseventdata)): *void*
-
-A callback that gets called when a field gains focus.
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`data` | [PaypalCommerceFormFieldFocusEventData](../README.md#paypalcommerceformfieldfocuseventdata) |
-
-**Returns:** *void*
-
-___
-
-### `Optional` onValidate
-
-▸ **onValidate**(`data`: [PaypalCommerceFormFieldValidateEventData](paypalcommerceformfieldvalidateeventdata.md)): *void*
-
-A callback that gets called when the validity of a field has changed.
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`data` | [PaypalCommerceFormFieldValidateEventData](paypalcommerceformfieldvalidateeventdata.md) |
-
-**Returns:** *void*

package/docs/interfaces/paypalcommercestoredcardfieldoptions.md

@@ -1,39 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceStoredCardFieldOptions](paypalcommercestoredcardfieldoptions.md)
-
-# Interface: PaypalCommerceStoredCardFieldOptions
-
-## Hierarchy
-
-* [PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md)
-
-  ↳ **PaypalCommerceStoredCardFieldOptions**
-
-## Index
-
-### Properties
-
-* [containerId](paypalcommercestoredcardfieldoptions.md#containerid)
-* [instrumentId](paypalcommercestoredcardfieldoptions.md#instrumentid)
-* [placeholder](paypalcommercestoredcardfieldoptions.md#optional-placeholder)
-
-## Properties
-
-###  containerId
-
-• **containerId**: *string*
-
-*Inherited from [PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md).[containerId](paypalcommerceformfieldoptions.md#containerid)*
-
-___
-
-###  instrumentId
-
-• **instrumentId**: *string*
-
-___
-
-### `Optional` placeholder
-
-• **placeholder**? : *undefined | string*
-
-*Inherited from [PaypalCommerceFormFieldOptions](paypalcommerceformfieldoptions.md).[placeholder](paypalcommerceformfieldoptions.md#optional-placeholder)*

package/docs/interfaces/paypalcommercestoredcardfieldsmap.md

@@ -1,26 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceStoredCardFieldsMap](paypalcommercestoredcardfieldsmap.md)
-
-# Interface: PaypalCommerceStoredCardFieldsMap
-
-## Hierarchy
-
-* **PaypalCommerceStoredCardFieldsMap**
-
-## Index
-
-### Properties
-
-* [[PaypalCommerceFormFieldType.CardCodeVerification]](paypalcommercestoredcardfieldsmap.md#optional-[paypalcommerceformfieldtype.cardcodeverification])
-* [[PaypalCommerceFormFieldType.CardNumberVerification]](paypalcommercestoredcardfieldsmap.md#optional-[paypalcommerceformfieldtype.cardnumberverification])
-
-## Properties
-
-### `Optional` [PaypalCommerceFormFieldType.CardCodeVerification]
-
-• **[PaypalCommerceFormFieldType.CardCodeVerification]**? : *[PaypalCommerceStoredCardFieldOptions](paypalcommercestoredcardfieldoptions.md)*
-
-___
-
-### `Optional` [PaypalCommerceFormFieldType.CardNumberVerification]
-
-• **[PaypalCommerceFormFieldType.CardNumberVerification]**? : *[PaypalCommerceStoredCardFieldOptions](paypalcommercestoredcardfieldoptions.md)*

package/docs/interfaces/paypalcommercevenmobuttoninitializeoptions.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) › [PaypalCommerceVenmoButtonInitializeOptions](paypalcommercevenmobuttoninitializeoptions.md)
-
-# Interface: PaypalCommerceVenmoButtonInitializeOptions
-
-## Hierarchy
-
-* **PaypalCommerceVenmoButtonInitializeOptions**
-
-## Index
-
-### Properties
-
-* [initializesOnCheckoutPage](paypalcommercevenmobuttoninitializeoptions.md#optional-initializesoncheckoutpage)
-* [style](paypalcommercevenmobuttoninitializeoptions.md#optional-style)
-
-## Properties
-
-### `Optional` initializesOnCheckoutPage
-
-• **initializesOnCheckoutPage**? : *undefined | false | true*
-
-Flag which helps to detect that the strategy initializes on Checkout page
-
-___
-
-### `Optional` style
-
-• **style**? : *[PaypalButtonStyleOptions_2](paypalbuttonstyleoptions_2.md)*
-
-A set of styling options for the checkout button.