@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/PaypalButtonInitializeOptions.md

@@ -0,0 +1,76 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalButtonInitializeOptions
+
+# Interface: PaypalButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [allowCredit](PaypalButtonInitializeOptions.md#allowcredit)
+- [clientId](PaypalButtonInitializeOptions.md#clientid)
+- [style](PaypalButtonInitializeOptions.md#style)
+
+### Methods
+
+- [onAuthorizeError](PaypalButtonInitializeOptions.md#onauthorizeerror)
+- [onPaymentError](PaypalButtonInitializeOptions.md#onpaymenterror)
+
+## Properties
+
+### allowCredit
+
+• `Optional` **allowCredit**: `boolean`
+
+Whether or not to show a credit button.
+
+___
+
+### clientId
+
+• **clientId**: `string`
+
+The Client ID of the Paypal App
+
+___
+
+### style
+
+• `Optional` **style**: `Pick`<[`PaypalButtonStyleOptions`](PaypalButtonStyleOptions.md), ``"color"`` \| ``"layout"`` \| ``"size"`` \| ``"label"`` \| ``"shape"`` \| ``"tagline"`` \| ``"fundingicons"``\>
+
+A set of styling options for the checkout button.
+
+## Methods
+
+### onAuthorizeError
+
+▸ `Optional` **onAuthorizeError**(`error`): `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`
+
+___
+
+### onPaymentError
+
+▸ `Optional` **onPaymentError**(`error`): `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

@@ -0,0 +1,64 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalButtonStyleOptions
+
+# Interface: PaypalButtonStyleOptions
+
+## Table of contents
+
+### Properties
+
+- [color](PaypalButtonStyleOptions.md#color)
+- [fundingicons](PaypalButtonStyleOptions.md#fundingicons)
+- [height](PaypalButtonStyleOptions.md#height)
+- [label](PaypalButtonStyleOptions.md#label)
+- [layout](PaypalButtonStyleOptions.md#layout)
+- [shape](PaypalButtonStyleOptions.md#shape)
+- [size](PaypalButtonStyleOptions.md#size)
+- [tagline](PaypalButtonStyleOptions.md#tagline)
+
+## Properties
+
+### color
+
+• `Optional` **color**: [`GOLD`](../enums/PaypalButtonStyleColorOption.md#gold) \| [`BLUE`](../enums/PaypalButtonStyleColorOption.md#blue) \| [`SIlVER`](../enums/PaypalButtonStyleColorOption.md#silver) \| [`BLACK`](../enums/PaypalButtonStyleColorOption.md#black)
+
+___
+
+### fundingicons
+
+• `Optional` **fundingicons**: `boolean`
+
+___
+
+### height
+
+• `Optional` **height**: `number`
+
+___
+
+### label
+
+• `Optional` **label**: [`CHECKOUT`](../enums/PaypalButtonStyleLabelOption.md#checkout) \| [`PAY`](../enums/PaypalButtonStyleLabelOption.md#pay) \| [`BUYNOW`](../enums/PaypalButtonStyleLabelOption.md#buynow) \| [`PAYPAL`](../enums/PaypalButtonStyleLabelOption.md#paypal) \| [`CREDIT`](../enums/PaypalButtonStyleLabelOption.md#credit)
+
+___
+
+### layout
+
+• `Optional` **layout**: [`HORIZONTAL`](../enums/PaypalButtonStyleLayoutOption.md#horizontal) \| [`VERTICAL`](../enums/PaypalButtonStyleLayoutOption.md#vertical)
+
+___
+
+### shape
+
+• `Optional` **shape**: [`PILL`](../enums/PaypalButtonStyleShapeOption.md#pill) \| [`RECT`](../enums/PaypalButtonStyleShapeOption.md#rect)
+
+___
+
+### size
+
+• `Optional` **size**: [`SMALL`](../enums/PaypalButtonStyleSizeOption.md#small) \| [`MEDIUM`](../enums/PaypalButtonStyleSizeOption.md#medium) \| [`LARGE`](../enums/PaypalButtonStyleSizeOption.md#large) \| [`RESPONSIVE`](../enums/PaypalButtonStyleSizeOption.md#responsive)
+
+___
+
+### tagline
+
+• `Optional` **tagline**: `boolean`

package/docs/interfaces/PaypalButtonStyleOptions_2.md

@@ -0,0 +1,50 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalButtonStyleOptions_2
+
+# Interface: PaypalButtonStyleOptions\_2
+
+## Table of contents
+
+### Properties
+
+- [color](PaypalButtonStyleOptions_2.md#color)
+- [height](PaypalButtonStyleOptions_2.md#height)
+- [label](PaypalButtonStyleOptions_2.md#label)
+- [layout](PaypalButtonStyleOptions_2.md#layout)
+- [shape](PaypalButtonStyleOptions_2.md#shape)
+- [tagline](PaypalButtonStyleOptions_2.md#tagline)
+
+## Properties
+
+### color
+
+• `Optional` **color**: [`gold`](../enums/StyleButtonColor.md#gold) \| [`blue`](../enums/StyleButtonColor.md#blue) \| [`silver`](../enums/StyleButtonColor.md#silver) \| [`black`](../enums/StyleButtonColor.md#black) \| [`white`](../enums/StyleButtonColor.md#white)
+
+___
+
+### height
+
+• `Optional` **height**: `number`
+
+___
+
+### label
+
+• `Optional` **label**: [`paypal`](../enums/StyleButtonLabel.md#paypal) \| [`checkout`](../enums/StyleButtonLabel.md#checkout) \| [`buynow`](../enums/StyleButtonLabel.md#buynow) \| [`pay`](../enums/StyleButtonLabel.md#pay) \| [`installment`](../enums/StyleButtonLabel.md#installment)
+
+___
+
+### layout
+
+• `Optional` **layout**: [`vertical`](../enums/StyleButtonLayout.md#vertical) \| [`horizontal`](../enums/StyleButtonLayout.md#horizontal)
+
+___
+
+### shape
+
+• `Optional` **shape**: [`pill`](../enums/StyleButtonShape.md#pill) \| [`rect`](../enums/StyleButtonShape.md#rect)
+
+___
+
+### tagline
+
+• `Optional` **tagline**: `boolean`

package/docs/interfaces/PaypalCommerceAlternativeMethodsButtonOptions.md

@@ -0,0 +1,35 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceAlternativeMethodsButtonOptions
+
+# Interface: PaypalCommerceAlternativeMethodsButtonOptions
+
+## Table of contents
+
+### Properties
+
+- [apm](PaypalCommerceAlternativeMethodsButtonOptions.md#apm)
+- [initializesOnCheckoutPage](PaypalCommerceAlternativeMethodsButtonOptions.md#initializesoncheckoutpage)
+- [style](PaypalCommerceAlternativeMethodsButtonOptions.md#style)
+
+## Properties
+
+### apm
+
+• **apm**: `string`
+
+Alternative payment method id what used for initialization PayPal button as funding source.
+
+___
+
+### initializesOnCheckoutPage
+
+• `Optional` **initializesOnCheckoutPage**: `boolean`
+
+Flag which helps to detect that the strategy initializes on Checkout page.
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.

package/docs/interfaces/PaypalCommerceButtonInitializeOptions.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceButtonInitializeOptions
+
+# Interface: PaypalCommerceButtonInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [messagingContainer](PaypalCommerceButtonInitializeOptions.md#messagingcontainer)
+- [style](PaypalCommerceButtonInitializeOptions.md#style)
+
+## Properties
+
+### messagingContainer
+
+• `Optional` **messagingContainer**: `string`
+
+Container id for messaging banner container
+
+___
+
+### style
+
+• `Optional` **style**: [`PaypalButtonStyleOptions_2`](PaypalButtonStyleOptions_2.md)
+
+A set of styling options for the checkout button.

package/docs/interfaces/PaypalCommerceCreditCardPaymentInitializeOptions.md

@@ -0,0 +1,90 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceCreditCardPaymentInitializeOptions
+
+# Interface: 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](PaypalCommerceCreditCardPaymentInitializeOptions.md#form)
+
+## Properties
+
+### form
+
+• **form**: [`PaypalCommerceFormOptions`](PaypalCommerceFormOptions.md)
+
+The form is data for Credit Card Form

package/docs/interfaces/PaypalCommerceFormFieldCardTypeChangeEventData.md

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

package/docs/interfaces/PaypalCommerceFormFieldKeyboardEventData.md

@@ -0,0 +1,15 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldKeyboardEventData
+
+# Interface: PaypalCommerceFormFieldKeyboardEventData
+
+## Table of contents
+
+### Properties
+
+- [fieldType](PaypalCommerceFormFieldKeyboardEventData.md#fieldtype)
+
+## Properties
+
+### fieldType
+
+• **fieldType**: `string`

package/docs/interfaces/PaypalCommerceFormFieldOptions.md

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

package/docs/interfaces/PaypalCommerceFormFieldStylesMap.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldStylesMap
+
+# Interface: PaypalCommerceFormFieldStylesMap
+
+## Table of contents
+
+### Properties
+
+- [default](PaypalCommerceFormFieldStylesMap.md#default)
+- [error](PaypalCommerceFormFieldStylesMap.md#error)
+- [focus](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/PaypalCommerceFormFieldValidateErrorData.md

@@ -0,0 +1,29 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormFieldValidateErrorData
+
+# Interface: PaypalCommerceFormFieldValidateErrorData
+
+## Table of contents
+
+### 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

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

package/docs/interfaces/PaypalCommerceFormFieldsMap.md

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

package/docs/interfaces/PaypalCommerceFormOptions.md

@@ -0,0 +1,148 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaypalCommerceFormOptions
+
+# Interface: PaypalCommerceFormOptions
+
+## Table of contents
+
+### Properties
+
+- [fields](PaypalCommerceFormOptions.md#fields)
+- [styles](PaypalCommerceFormOptions.md#styles)
+
+### Methods
+
+- [onBlur](PaypalCommerceFormOptions.md#onblur)
+- [onCardTypeChange](PaypalCommerceFormOptions.md#oncardtypechange)
+- [onEnter](PaypalCommerceFormOptions.md#onenter)
+- [onFocus](PaypalCommerceFormOptions.md#onfocus)
+- [onValidate](PaypalCommerceFormOptions.md#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' }, }
+```
+
+___
+
+### styles
+
+• `Optional` **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
+
+### onBlur
+
+▸ `Optional` **onBlur**(`data`): `void`
+
+A callback that gets called when a field loses focus.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](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`](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`](PaypalCommerceFormFieldKeyboardEventData.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### onFocus
+
+▸ `Optional` **onFocus**(`data`): `void`
+
+A callback that gets called when a field gains focus.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`PaypalCommerceFormFieldKeyboardEventData`](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`](PaypalCommerceFormFieldValidateEventData.md) |
+
+#### Returns
+
+`void`