@bigcommerce/checkout-sdk 1.374.3 → 1.374.5

package/docs/README.md

@@ -290,7 +290,9 @@
 - [PayPalCommerceCreditButtonInitializeOptions](interfaces/PayPalCommerceCreditButtonInitializeOptions.md)
 - [PayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/PayPalCommerceCreditCardsPaymentInitializeOptions.md)
 - [PayPalCommerceCreditCustomerInitializeOptions](interfaces/PayPalCommerceCreditCustomerInitializeOptions.md)
+- [PayPalCommerceCreditPaymentInitializeOptions](interfaces/PayPalCommerceCreditPaymentInitializeOptions.md)
 - [PayPalCommerceCustomerInitializeOptions](interfaces/PayPalCommerceCustomerInitializeOptions.md)
+- [PayPalCommercePaymentInitializeOptions](interfaces/PayPalCommercePaymentInitializeOptions.md)
 - [PayPalCommerceVenmoButtonInitializeOptions](interfaces/PayPalCommerceVenmoButtonInitializeOptions.md)
 - [PayPalCommerceVenmoCustomerInitializeOptions](interfaces/PayPalCommerceVenmoCustomerInitializeOptions.md)
 - [PayPalInstrument](interfaces/PayPalInstrument.md)
@@ -380,7 +382,9 @@
 - [WithPayPalCommerceCreditButtonInitializeOptions](interfaces/WithPayPalCommerceCreditButtonInitializeOptions.md)
 - [WithPayPalCommerceCreditCardsPaymentInitializeOptions](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md)
 - [WithPayPalCommerceCreditCustomerInitializeOptions](interfaces/WithPayPalCommerceCreditCustomerInitializeOptions.md)
+- [WithPayPalCommerceCreditPaymentInitializeOptions](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md)
 - [WithPayPalCommerceCustomerInitializeOptions](interfaces/WithPayPalCommerceCustomerInitializeOptions.md)
+- [WithPayPalCommercePaymentInitializeOptions](interfaces/WithPayPalCommercePaymentInitializeOptions.md)
 - [WithPayPalCommerceVenmoButtonInitializeOptions](interfaces/WithPayPalCommerceVenmoButtonInitializeOptions.md)
 - [WithPayPalCommerceVenmoCustomerInitializeOptions](interfaces/WithPayPalCommerceVenmoCustomerInitializeOptions.md)
 - [WithSquareV2PaymentInitializeOptions](interfaces/WithSquareV2PaymentInitializeOptions.md)
@@ -705,7 +709,7 @@ ___
 
 ### PaymentInitializeOptions
 
-Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
+Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithAdyenV2PaymentInitializeOptions`](interfaces/WithAdyenV2PaymentInitializeOptions.md) & [`WithAdyenV3PaymentInitializeOptions`](interfaces/WithAdyenV3PaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md) & [`WithBoltPaymentInitializeOptions`](interfaces/WithBoltPaymentInitializeOptions.md) & [`WithCreditCardPaymentInitializeOptions`](interfaces/WithCreditCardPaymentInitializeOptions.md) & [`WithPayPalCommercePaymentInitializeOptions`](interfaces/WithPayPalCommercePaymentInitializeOptions.md) & [`WithPayPalCommerceCreditPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditPaymentInitializeOptions.md) & [`WithPayPalCommerceCreditCardsPaymentInitializeOptions`](interfaces/WithPayPalCommerceCreditCardsPaymentInitializeOptions.md) & [`WithSquareV2PaymentInitializeOptions`](interfaces/WithSquareV2PaymentInitializeOptions.md)
 
 ___
 

package/docs/interfaces/PayPalCommerceCreditPaymentInitializeOptions.md

@@ -0,0 +1,133 @@
+[@bigcommerce/checkout-sdk](../README.md) / PayPalCommerceCreditPaymentInitializeOptions
+
+# Interface: PayPalCommerceCreditPaymentInitializeOptions
+
+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>
+```
+
+```js
+service.initializePayment({
+    methodId: 'paypalcommercecredit',
+    paypalcommercecredit: {
+        container: '#container',
+// Callback for submitting payment form that gets called when a buyer approves PayPal payment
+        submitForm: () => {
+        // Example function
+            this.submitOrder(
+               {
+                  payment: { methodId: 'paypalcommercecredit', }
+              }
+           );
+        },
+// 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
+
+- [container](PayPalCommerceCreditPaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onError](PayPalCommerceCreditPaymentInitializeOptions.md#onerror)
+- [onRenderButton](PayPalCommerceCreditPaymentInitializeOptions.md#onrenderbutton)
+- [onValidate](PayPalCommerceCreditPaymentInitializeOptions.md#onvalidate)
+- [submitForm](PayPalCommerceCreditPaymentInitializeOptions.md#submitform)
+
+## Properties
+
+### 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/PayPalCommercePaymentInitializeOptions.md

@@ -0,0 +1,133 @@
+[@bigcommerce/checkout-sdk](../README.md) / PayPalCommercePaymentInitializeOptions
+
+# Interface: 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>
+```
+
+```js
+service.initializePayment({
+    methodId: 'paypalcommerce',
+    paypalcommerce: {
+        container: '#container',
+// 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
+
+- [container](PayPalCommercePaymentInitializeOptions.md#container)
+
+### Methods
+
+- [onError](PayPalCommercePaymentInitializeOptions.md#onerror)
+- [onRenderButton](PayPalCommercePaymentInitializeOptions.md#onrenderbutton)
+- [onValidate](PayPalCommercePaymentInitializeOptions.md#onvalidate)
+- [submitForm](PayPalCommercePaymentInitializeOptions.md#submitform)
+
+## Properties
+
+### 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/WithPayPalCommerceCreditPaymentInitializeOptions.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / WithPayPalCommerceCreditPaymentInitializeOptions
+
+# Interface: WithPayPalCommerceCreditPaymentInitializeOptions
+
+## Table of contents
+
+### Properties
+
+- [paypalcommerce](WithPayPalCommerceCreditPaymentInitializeOptions.md#paypalcommerce)
+- [paypalcommercecredit](WithPayPalCommerceCreditPaymentInitializeOptions.md#paypalcommercecredit)
+
+## Properties
+
+### paypalcommerce
+
+• `Optional` **paypalcommerce**: [`PayPalCommerceCreditPaymentInitializeOptions`](PayPalCommerceCreditPaymentInitializeOptions.md)
+
+___
+
+### paypalcommercecredit
+
+• `Optional` **paypalcommercecredit**: [`PayPalCommerceCreditPaymentInitializeOptions`](PayPalCommerceCreditPaymentInitializeOptions.md)

package/docs/interfaces/WithPayPalCommercePaymentInitializeOptions.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.374.3",
+  "version": "1.374.5",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",