@paypal/merchant-onboarding-sdk 1.0.1 → 1.0.3

package/README.md

@@ -9,10 +9,17 @@ to manage the onboarding process, including:
 - [Getting Started](#getting-started)
   - [Installation](#installation)
   - [Usage](#usage)
-- [SDK Reference](#sdk-reference)
-  - [`Paypal.onboard.initialize()`](#paypalonboardinitialize)
-  - [`Paypal.onboard.render()`](#paypalonboardrender)
-  - [Styling Options](#styling-options)
+- [Onboarding SDK Reference](#onboarding-sdk-reference)
+  - [Install Onboarding SDK](#install-onboarding-sdk)
+  - [Initialize Onboarding SDK](#initialize-onboarding-sdk)
+    - [Onboarding Props Reference](#onboarding-props-reference)
+  - [Render Onboarding SDK](#render-onboarding-sdk)
+- [Servicing SDK Reference](#servicing-sdk-reference)
+  - [Install Servicing SDK](#install-servicing-sdk)
+  - [Initialize and Render Servicing SDK](#initialize-and-render-servicing-sdk)
+    - [Supported Modules](#supported-modules)
+    - [Servicing Props Reference](#servicing-props-reference)
+- [Styling Options](#styling-options)
 
 ## Getting Started
 
@@ -113,9 +120,21 @@ onboard
     .render('root')
 ```
 
-## SDK Reference
+## Onboarding SDK Reference
 
-### `Paypal.onboard.initialize(props)`
+### Install Onboarding SDK
+
+```aiexclude
+import { onboard } from "@paypal/merchant-onboarding-sdk/onboarding";
+```
+
+### Initialize Onboarding SDK
+
+```aiexclude
+Paypal.onboard.initialize(props)
+```
+
+### Onboarding Props Reference
 
 | Parameter               | Type       | Description                                                                                                                          | Required                                           |
 | ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
@@ -134,9 +153,94 @@ onboard
 | `onContactUs`           | `function` | Async Callback function to display contact information when appropriate.                                                             | No                                                 |
 | `onLoginRequested`      | `function` | Async Callback function to fetch access token for STANDALONE_HYBRID merchant.                                                        | Yes (only for spoke-only partners)                 |
 
-### `Paypal.onboard.render(containerId)`
+### Render Onboarding SDK
+
+```aiexclude
+Paypal.onboard.render(<containerId>)
+```
+
+`containerId` is the id of the html container to render the onboarding flow
+
+#### Example
+
+To render Onboarding in the following div:
+
+```aiexclude
+<div id="container"></div>
+```
+
+Render the SDK like:
+
+```aiexclude
+Paypal.onboard.render('container')
+```
+
+## Servicing SDK Reference
+
+### Install Servicing SDK
+
+```aiexclude
+import { servicing } from "@paypal/merchant-onboarding-sdk/servicing";
+```
+
+### Initialize And Render Servicing SDK
+
+`PayPal.servicing.<MODULE_NAME>.initialize(props)`
+
+```aiexclude
+servicing.ACTION_WIDGETS.initialize({
+        targetElementId: 'container',
+        getAccessToken: async () => { // implementation here to get spoke access token} ,
+        style: {
+          color: {
+            primary: {
+              main: 'red',
+            },
+            secondary: {
+              main: 'green',
+            },
+          },
+        },
+        partnerName: 'partner',
+        partnerHostedModuleUrls: {
+          MONEY: 'www.partner.com/balance', // Partner web url where money SDK is used
+          ACTION_WIDGETS: 'www.partner.com/notification' // Partner web url where action widget SDK is used
+        }
+      });
+```
+
+#### Supported modules
+
+| Supported Module Names               |
+| ------------------------------------ |
+| MONEY                                |
+| BANKS                                |
+| ACTION_WIDGETS                       |
+| PAID_FEATURES                        |
+| PHONE                                |
+| LIFT_LIMITS                          |
+| LANGUAGE_EDIT                        |
+| TIMEZONE_EDIT                        |
+| INSIGHTS                             |
+| REPORT                               |
+| PAYMENT_PREFERENCES                  |
+| VIEW_BUSINESS_PROFILE                |
+| CSM                                  |
+| ACCOUNT_SETTINGS_PAYMENT_PREFERENCES |
+| MERCHANT_LISTING                     |
+| ACTIVITY_REFUND                      |
+| WORKING_CAPITAL                      |
+
+### Servicing Props Reference
 
-This will render the PayPal Merchant Onboarding flow inside the container
+| Parameter                 | Type       | Description                                                                | Required                                           |
+| ------------------------- | ---------- | -------------------------------------------------------------------------- | -------------------------------------------------- |
+| `targetElementId`         | `string`   | The id of the HTML container to render the Servicing SDK                   | Yes                                                |
+| `getAccessToken`          | `function` | Async Callback function that returns spoke account access token            | Yes                                                |
+| `env`                     | `string`   | The env that should be used. Possible values are 'sandbox' or 'production' | No (defaults to 'production' for npm integrations) |
+| `partnerName`             | `string`   | The Partner's name                                                         | No                                                 |
+| `partnerHostedModuleUrls` | `object`   | The URL to return from onboarding on cancel.                               | No                                                 |
+| `style`                   | `object`   | Styling options (see below, same as onboarding).                           | No                                                 |
 
 ### Styling Options