@bigcommerce/checkout-sdk 1.308.1 → 1.308.2

package/docs/interfaces/internal_.PaypalCommerceFormOptions.md

@@ -0,0 +1,150 @@
+[@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

@@ -0,0 +1,188 @@
+[@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

@@ -0,0 +1,45 @@
+[@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)

package/docs/interfaces/internal_.PaypalCommerceStoredCardFieldsMap.md

@@ -0,0 +1,24 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalCommerceStoredCardFieldsMap
+
+# Interface: PaypalCommerceStoredCardFieldsMap
+
+[<internal>](../modules/internal_.md).PaypalCommerceStoredCardFieldsMap
+
+## Table of contents
+
+### Properties
+
+- [cardCodeVerification](internal_.PaypalCommerceStoredCardFieldsMap.md#cardcodeverification)
+- [cardNumberVerification](internal_.PaypalCommerceStoredCardFieldsMap.md#cardnumberverification)
+
+## Properties
+
+### cardCodeVerification
+
+• `Optional` **cardCodeVerification**: [`PaypalCommerceStoredCardFieldOptions`](internal_.PaypalCommerceStoredCardFieldOptions.md)
+
+___
+
+### cardNumberVerification
+
+• `Optional` **cardNumberVerification**: [`PaypalCommerceStoredCardFieldOptions`](internal_.PaypalCommerceStoredCardFieldOptions.md)

package/docs/interfaces/internal_.PaypalExpressPaymentInitializeOptions.md

@@ -0,0 +1,38 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalExpressPaymentInitializeOptions
+
+# Interface: PaypalExpressPaymentInitializeOptions
+
+[<internal>](../modules/internal_.md).PaypalExpressPaymentInitializeOptions
+
+A set of options that are required to initialize the PayPal Express payment
+method.
+
+```js
+service.initializePayment({
+    methodId: 'paypalexpress',
+});
+```
+
+An additional flag can be passed in to always start the payment flow through
+a redirect rather than a popup.
+
+```js
+service.initializePayment({
+    methodId: 'paypalexpress',
+    paypalexpress: {
+        useRedirectFlow: true,
+    },
+});
+```
+
+## Table of contents
+
+### Properties
+
+- [useRedirectFlow](internal_.PaypalExpressPaymentInitializeOptions.md#useredirectflow)
+
+## Properties
+
+### useRedirectFlow
+
+• `Optional` **useRedirectFlow**: `boolean`

package/docs/interfaces/internal_.PaypalFieldsStyleOptions.md

@@ -0,0 +1,48 @@
+[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / PaypalFieldsStyleOptions
+
+# Interface: PaypalFieldsStyleOptions
+
+[<internal>](../modules/internal_.md).PaypalFieldsStyleOptions
+
+## Table of contents
+
+### Properties
+
+- [rules](internal_.PaypalFieldsStyleOptions.md#rules)
+- [variables](internal_.PaypalFieldsStyleOptions.md#variables)
+
+## Properties
+
+### rules
+
+• `Optional` **rules**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+___
+
+### variables
+
+• `Optional` **variables**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `borderColor?` | `string` |
+| `borderFocusColor?` | `string` |
+| `borderRadius?` | `string` |
+| `borderWidth?` | `string` |
+| `colorBackground?` | `string` |
+| `colorDanger?` | `string` |
+| `colorInfo?` | `string` |
+| `colorTextPlaceholder?` | `string` |
+| `fontFamily?` | `string` |
+| `fontSizeBase?` | `string` |
+| `fontSizeLg?` | `string` |
+| `fontSizeM?` | `string` |
+| `fontSizeSm?` | `string` |
+| `spacingUnit?` | `string` |
+| `textColor?` | `string` |