@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

package/docs/interfaces/internal_.PaypalCommerceCreditCardPaymentInitializeOptions.md

@@ -1,92 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceCreditCardPaymentInitializeOptions
-
-# Interface: PaypalCommerceCreditCardPaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceCreditCardPaymentInitializeOptions
-
-A set of options that are required to initialize the PayPal Commerce payment
-method for presenting its credit card form.
-
-```html
-<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
-<div id="card-number"></div>
-<div id="card-name"></div>
-<div id="card-expiry"></div>
-<div id="card-code"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'paypalcommerce',
-    paypalcommerce: {
-        form: {
-            fields: {
-                cardNumber: { containerId: 'card-number' },
-                cardName: { containerId: 'card-name' },
-                cardExpiry: { containerId: 'card-expiry' },
-                cardCode: { containerId: 'card-code' },
-            },
-        },
-    },
-});
-```
-
-Additional options can be passed in to customize the fields and register
-event callbacks.
-
-```js
-service.initializePayment({
-    methodId: 'paypalcommerce',
-    creditCard: {
-        form: {
-            fields: {
-                cardNumber: { containerId: 'card-number', placeholder: 'Number of card' },
-                cardName: { containerId: 'card-name', placeholder: 'Name of card' },
-                cardExpiry: { containerId: 'card-expiry', placeholder: 'Expiry of card' },
-                cardCode: { containerId: 'card-code', placeholder: 'Code of card' },
-            },
-            styles: {
-                default: {
-                    color: '#000',
-                },
-                error: {
-                    color: '#f00',
-                },
-                focus: {
-                    color: '#0f0',
-                },
-            },
-            onBlur({ fieldType }) {
-                console.log(fieldType);
-            },
-            onFocus({ fieldType }) {
-                console.log(fieldType);
-            },
-            onEnter({ fieldType }) {
-                console.log(fieldType);
-            },
-            onCardTypeChange({ cardType }) {
-                console.log(cardType);
-            },
-            onValidate({ errors, isValid }) {
-                console.log(errors);
-                console.log(isValid);
-            },
-        },
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [form](internal_.PaypalCommerceCreditCardPaymentInitializeOptions.md#form)
-
-## Properties
-
-### form
-
-• **form**: [`PaypalCommerceFormOptions`](internal_.PaypalCommerceFormOptions.md)
-
-The form is data for Credit Card Form

package/docs/interfaces/internal_.PaypalCommerceFormFieldCardTypeChangeEventData.md

@@ -1,17 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldCardTypeChangeEventData
-
-# Interface: PaypalCommerceFormFieldCardTypeChangeEventData
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldCardTypeChangeEventData
-
-## Table of contents
-
-### Properties
-
-- [cardType](internal_.PaypalCommerceFormFieldCardTypeChangeEventData.md#cardtype)
-
-## Properties
-
-### cardType
-
-• `Optional` **cardType**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldKeyboardEventData.md

@@ -1,17 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldKeyboardEventData
-
-# Interface: PaypalCommerceFormFieldKeyboardEventData
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldKeyboardEventData
-
-## Table of contents
-
-### Properties
-
-- [fieldType](internal_.PaypalCommerceFormFieldKeyboardEventData.md#fieldtype)
-
-## Properties
-
-### fieldType
-
-• **fieldType**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldOptions.md

@@ -1,30 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldOptions
-
-# Interface: PaypalCommerceFormFieldOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldOptions
-
-## Hierarchy
-
-- **`PaypalCommerceFormFieldOptions`**
-
-  ↳ [`PaypalCommerceStoredCardFieldOptions`](internal_.PaypalCommerceStoredCardFieldOptions.md)
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.PaypalCommerceFormFieldOptions.md#containerid)
-- [placeholder](internal_.PaypalCommerceFormFieldOptions.md#placeholder)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldStylesMap.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldStylesMap
-
-# Interface: PaypalCommerceFormFieldStylesMap
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldStylesMap
-
-## Table of contents
-
-### Properties
-
-- [default](internal_.PaypalCommerceFormFieldStylesMap.md#default)
-- [error](internal_.PaypalCommerceFormFieldStylesMap.md#error)
-- [focus](internal_.PaypalCommerceFormFieldStylesMap.md#focus)
-
-## Properties
-
-### default
-
-• `Optional` **default**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
-
-___
-
-### error
-
-• `Optional` **error**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>
-
-___
-
-### focus
-
-• `Optional` **focus**: `Partial`<`Pick`<`CSSStyleDeclaration`, ``"color"`` \| ``"fontFamily"`` \| ``"fontSize"`` \| ``"fontWeight"``\>\>

package/docs/interfaces/internal_.PaypalCommerceFormFieldValidateErrorData.md

@@ -1,31 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldValidateErrorData
-
-# Interface: PaypalCommerceFormFieldValidateErrorData
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldValidateErrorData
-
-## Table of contents
-
-### Properties
-
-- [fieldType](internal_.PaypalCommerceFormFieldValidateErrorData.md#fieldtype)
-- [message](internal_.PaypalCommerceFormFieldValidateErrorData.md#message)
-- [type](internal_.PaypalCommerceFormFieldValidateErrorData.md#type)
-
-## Properties
-
-### fieldType
-
-• **fieldType**: `string`
-
-___
-
-### message
-
-• **message**: `string`
-
-___
-
-### type
-
-• **type**: `string`

package/docs/interfaces/internal_.PaypalCommerceFormFieldValidateEventData.md

@@ -1,35 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldValidateEventData
-
-# Interface: PaypalCommerceFormFieldValidateEventData
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldValidateEventData
-
-## Table of contents
-
-### Properties
-
-- [errors](internal_.PaypalCommerceFormFieldValidateEventData.md#errors)
-- [isValid](internal_.PaypalCommerceFormFieldValidateEventData.md#isvalid)
-
-## Properties
-
-### errors
-
-• **errors**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `cardCode?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-| `cardCodeVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-| `cardExpiry?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-| `cardName?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-| `cardNumber?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-| `cardNumberVerification?` | [`PaypalCommerceFormFieldValidateErrorData`](internal_.PaypalCommerceFormFieldValidateErrorData.md)[] |
-
-___
-
-### isValid
-
-• **isValid**: `boolean`

package/docs/interfaces/internal_.PaypalCommerceFormFieldsMap.md

@@ -1,38 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormFieldsMap
-
-# Interface: PaypalCommerceFormFieldsMap
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormFieldsMap
-
-## Table of contents
-
-### Properties
-
-- [cardCode](internal_.PaypalCommerceFormFieldsMap.md#cardcode)
-- [cardExpiry](internal_.PaypalCommerceFormFieldsMap.md#cardexpiry)
-- [cardName](internal_.PaypalCommerceFormFieldsMap.md#cardname)
-- [cardNumber](internal_.PaypalCommerceFormFieldsMap.md#cardnumber)
-
-## Properties
-
-### cardCode
-
-• `Optional` **cardCode**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
-
-___
-
-### cardExpiry
-
-• **cardExpiry**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
-
-___
-
-### cardName
-
-• **cardName**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
-
-___
-
-### cardNumber
-
-• **cardNumber**: [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)

package/docs/interfaces/internal_.PaypalCommerceFormOptions.md

@@ -1,150 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceFormOptions
-
-# Interface: PaypalCommerceFormOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceFormOptions
-
-## Table of contents
-
-### Properties
-
-- [fields](internal_.PaypalCommerceFormOptions.md#fields)
-- [styles](internal_.PaypalCommerceFormOptions.md#styles)
-
-### Methods
-
-- [onBlur](internal_.PaypalCommerceFormOptions.md#onblur)
-- [onCardTypeChange](internal_.PaypalCommerceFormOptions.md#oncardtypechange)
-- [onEnter](internal_.PaypalCommerceFormOptions.md#onenter)
-- [onFocus](internal_.PaypalCommerceFormOptions.md#onfocus)
-- [onValidate](internal_.PaypalCommerceFormOptions.md#onvalidate)
-
-## Properties
-
-### fields
-
-• **fields**: [`PaypalCommerceFormFieldsMap`](internal_.PaypalCommerceFormFieldsMap.md) \| [`PaypalCommerceStoredCardFieldsMap`](internal_.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' }, }
-```
-
-___
-
-### styles
-
-• `Optional` **styles**: [`PaypalCommerceFormFieldStylesMap`](internal_.PaypalCommerceFormFieldStylesMap.md)
-
-Styles for inputs. Change the width, height and other styling.
-
-```js
- default: { color: '#000' },
- error: { color: '#f00' },
- focus: { color: '#0f0' }
-```
-
-## Methods
-
-### onBlur
-
-▸ `Optional` **onBlur**(`data`): `void`
-
-A callback that gets called when a field loses focus.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](internal_.PaypalCommerceFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onCardTypeChange
-
-▸ `Optional` **onCardTypeChange**(`data`): `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`](internal_.PaypalCommerceFormFieldCardTypeChangeEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onEnter
-
-▸ `Optional` **onEnter**(`data`): `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` | [`PaypalCommerceFormFieldKeyboardEventData`](internal_.PaypalCommerceFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onFocus
-
-▸ `Optional` **onFocus**(`data`): `void`
-
-A callback that gets called when a field gains focus.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](internal_.PaypalCommerceFormFieldKeyboardEventData.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### onValidate
-
-▸ `Optional` **onValidate**(`data`): `void`
-
-A callback that gets called when the validity of a field has changed.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | [`PaypalCommerceFormFieldValidateEventData`](internal_.PaypalCommerceFormFieldValidateEventData.md) |
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.PaypalCommercePaymentInitializeOptions.md

@@ -1,188 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommercePaymentInitializeOptions
-
-# Interface: PaypalCommercePaymentInitializeOptions
-
-[<internal>](../modules/internal_.md).PaypalCommercePaymentInitializeOptions
-
-A set of options that are required to initialize the PayPal Commerce payment
-method for presenting its PayPal button.
-
-Please note that the minimum version of checkout-sdk is 1.100
-
-Also, PayPal (also known as PayPal Commerce Platform) requires specific options to initialize the PayPal Smart Payment Button on checkout page that substitutes a standard submit button
-```html
-<!-- This is where the PayPal button will be inserted -->
-<div id="container"></div>
-<!-- This is where the PayPal alternative payment methods fields will be inserted.  -->
-<div id="apm-fields-container"></div>
-```
-
-```js
-service.initializePayment({
-    methodId: 'paypalcommerce',
-    paypalcommerce: {
-        container: '#container',
-        apmFieldsContainer: '#apm-fields-container',
-        apmFieldsStyles: {
-            base: {
-                  backgroundColor: 'transparent',
-              },
-              input: {
-                  backgroundColor: 'white',
-                  fontSize: '1rem',
-                  color: '#333',
-                  borderColor: '#d9d9d9',
-                  borderRadius: '4px',
-                  borderWidth: '1px',
-                  padding: '1rem',
-              },
-              invalid: {
-                  color: '#ed6a6a',
-              },
-              active: {
-                  color: '#4496f6',
-              },
-        },
-        clientId: 'YOUR_CLIENT_ID',
-// Callback for submitting payment form that gets called when a buyer approves PayPal payment
-        submitForm: () => {
-        // Example function
-            this.submitOrder(
-               {
-                  payment: { methodId: 'paypalcommerce', }
-              }
-           );
-        },
-// Callback is used to define the state of the payment form, validate if it is applicable for submit.
-        onValidate: (resolve, reject) => {
-        // Example function
-            const isValid = this.validatePaymentForm();
-            if (isValid) {
-                return resolve();
-            }
-            return reject();
-        },
-// Callback that is called right before render of a Smart Payment Button. It gets called when a buyer is eligible for use of the particular PayPal method. This callback can be used to hide the standard submit button.
-        onRenderButton: () => {
-        // Example function
-            this.hidePaymentSubmitButton();
-        }
-    },
-});
-```
-
-## Table of contents
-
-### Properties
-
-- [apmFieldsContainer](internal_.PaypalCommercePaymentInitializeOptions.md#apmfieldscontainer)
-- [apmFieldsStyles](internal_.PaypalCommercePaymentInitializeOptions.md#apmfieldsstyles)
-- [clientId](internal_.PaypalCommercePaymentInitializeOptions.md#clientid)
-- [container](internal_.PaypalCommercePaymentInitializeOptions.md#container)
-
-### Methods
-
-- [onError](internal_.PaypalCommercePaymentInitializeOptions.md#onerror)
-- [onRenderButton](internal_.PaypalCommercePaymentInitializeOptions.md#onrenderbutton)
-- [onValidate](internal_.PaypalCommercePaymentInitializeOptions.md#onvalidate)
-- [submitForm](internal_.PaypalCommercePaymentInitializeOptions.md#submitform)
-
-## Properties
-
-### apmFieldsContainer
-
-• `Optional` **apmFieldsContainer**: `string`
-
-The CSS selector of a container where the alternative payment methods fields widget should be inserted into.
-It's necessary to specify this parameter when using Alternative Payment Methods.
-Without it alternative payment methods will not work.
-
-___
-
-### apmFieldsStyles
-
-• `Optional` **apmFieldsStyles**: [`PaypalFieldsStyleOptions`](internal_.PaypalFieldsStyleOptions.md)
-
-Object with styles to customize alternative payment methods fields.
-
-___
-
-### clientId
-
-• **clientId**: `string`
-
-The Client ID of the Paypal App
-
-___
-
-### container
-
-• **container**: `string`
-
-The CSS selector of a container where the payment widget should be inserted into.
-
-## Methods
-
-### onError
-
-▸ `Optional` **onError**(`error`): `void`
-
-A callback for displaying error popup. This callback requires error object as parameter.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error` | `Error` |
-
-#### Returns
-
-`void`
-
-___
-
-### onRenderButton
-
-▸ `Optional` **onRenderButton**(): `void`
-
-A callback right before render Smart Payment Button that gets called when
-Smart Payment Button is eligible. This callback can be used to hide the standard submit button.
-
-#### Returns
-
-`void`
-
-___
-
-### onValidate
-
-▸ **onValidate**(`resolve`, `reject`): `Promise`<`void`\>
-
-A callback that gets called when a buyer click on Smart Payment Button
-and should validate payment form.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `resolve` | () => `void` | A function, that gets called if form is valid. |
-| `reject` | () => `void` | A function, that gets called if form is not valid. |
-
-#### Returns
-
-`Promise`<`void`\>
-
-reject() or resolve()
-
-___
-
-### submitForm
-
-▸ **submitForm**(): `void`
-
-A callback for submitting payment form that gets called
-when buyer approved PayPal account.
-
-#### Returns
-
-`void`

package/docs/interfaces/internal_.PaypalCommerceStoredCardFieldOptions.md

@@ -1,45 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceStoredCardFieldOptions
-
-# Interface: PaypalCommerceStoredCardFieldOptions
-
-[<internal>](../modules/internal_.md).PaypalCommerceStoredCardFieldOptions
-
-## Hierarchy
-
-- [`PaypalCommerceFormFieldOptions`](internal_.PaypalCommerceFormFieldOptions.md)
-
-  ↳ **`PaypalCommerceStoredCardFieldOptions`**
-
-## Table of contents
-
-### Properties
-
-- [containerId](internal_.PaypalCommerceStoredCardFieldOptions.md#containerid)
-- [instrumentId](internal_.PaypalCommerceStoredCardFieldOptions.md#instrumentid)
-- [placeholder](internal_.PaypalCommerceStoredCardFieldOptions.md#placeholder)
-
-## Properties
-
-### containerId
-
-• **containerId**: `string`
-
-#### Inherited from
-
-[PaypalCommerceFormFieldOptions](internal_.PaypalCommerceFormFieldOptions.md).[containerId](internal_.PaypalCommerceFormFieldOptions.md#containerid)
-
-___
-
-### instrumentId
-
-• **instrumentId**: `string`
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-#### Inherited from
-
-[PaypalCommerceFormFieldOptions](internal_.PaypalCommerceFormFieldOptions.md).[placeholder](internal_.PaypalCommerceFormFieldOptions.md#placeholder)