🎉Source PayPal Transactions: Updated docs (#15105)

* Updated docs * Updated docs
airbytehq · Jul 28, 2022 · 65295b7 · 65295b7
1 parent 39029f8
commit 65295b7
Showing 1 changed file with 55 additions and 39 deletions.
diff --git a/docs/integrations/sources/paypal-transaction.md b/docs/integrations/sources/paypal-transaction.md
@@ -1,44 +1,52 @@
 # Paypal Transaction
 
-## Overview
+This page contains the setup guide and reference information for the Paypal Transaction source connector.
 
-The [Paypal Transaction API](https://developer.paypal.com/docs/api/transaction-search/v1/). is used to get the history of transactions for a PayPal account.
+## Prerequisites
 
-#### Output schema
+The [Paypal Transaction API](https://developer.paypal.com/docs/api/transaction-search/v1/) is used to get the history of transactions for a PayPal account.
 
-This Source is capable of syncing the following core Streams:
+## Setup guide
+### Step 1: Set up Paypal Transaction
 
-* [Transactions](https://developer.paypal.com/docs/api/transaction-search/v1/#transactions)
-* [Balances](https://developer.paypal.com/docs/api/transaction-search/v1/#balances)
+In order to get an `Client ID` and `Secret` please go to [this](https://developer.paypal.com/docs/platforms/get-started/) page and follow the instructions. After registration you may find your `Client ID` and `Secret` [here](https://developer.paypal.com/developer/accounts/).
 
-#### Data type mapping
+## Step 2: Set up the Paypal Transaction connector in Airbyte
 
-| Integration Type | Airbyte Type | Notes |
-| :--- | :--- | :--- |
-| `string` | `string` |  |
-| `number` | `number` |  |
-| `array` | `array` |  |
-| `object` | `object` |  |
+### For Airbyte Cloud:
+1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
+2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
+3. On the Set up the source page, enter the name for the Paypal Transaction connector and select **Paypal Transaction** from the Source type dropdown.
+4. For Airbyte Cloud, click **Authenticate your Paypal Transaction account** to sign in with Paypal and authorize your account.
+5. Choose if your account is sandbox
+6. Enter the date you want your sync to start from
+7. Click **Set up source**.
 
-#### Features
+### For Airbyte OSS:
+1. Navigate to the Airbyte Open Source dashboard
+2. Set the name for your source
+4. Enter your client id
+4. Enter your secret
+4. Choose if your account is sandbox
+5. Enter the date you want your sync to start from
+6. Click **Set up source**
 
-| Feature | Supported? |
-| :--- | :--- |
-| Full Refresh Sync | Yes |
-| Incremental - Append Sync | Yes |
-| Namespaces | No |
+## Supported sync modes
 
-### Getting started
+The PayPal Transaction source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
 
-### Requirements
+| Feature                   | Supported? |
+| :------------------------ | :--------- |
+| Full Refresh Sync         |    Yes     |
+| Incremental - Append Sync |    Yes     |
+| Namespaces                |     No     |
 
-* client\_id. 
-* secret.
-* is\_sandbox.
+## Supported Streams
 
-### Setup guide
+This Source is capable of syncing the following core Streams:
 
-In order to get an `Client ID` and `Secret` please go to \[this\]\([https://developer.paypal.com/docs/platforms/get-started/](https://developer.paypal.com/docs/platforms/get-started/) page and follow the instructions. After registration you may find your `Client ID` and `Secret` [here](https://developer.paypal.com/developer/accounts/).
+* [Transactions](https://developer.paypal.com/docs/api/transaction-search/v1/#transactions)
+* [Balances](https://developer.paypal.com/docs/api/transaction-search/v1/#balances)
 
 ## Performance considerations
 
@@ -51,19 +59,27 @@ Paypal transaction API has some [limits](https://developer.paypal.com/docs/integ
 * `page_size` = 500, the maximum page size is 500.
 * `requests_per_minute` = 30, maximum limit is 50 requests per minute from IP address to all endpoint
 
-Transactions sync is performed with default `stream_slice_period` = 1 day, it means that there will be 1 request for each day between start\_date and now \(or end\_date\). if `start_date` is greater then `start_date_max`. Balances sync is similarly performed with default `stream_slice_period` = 1 day, but it will do additional request for the end\_date of the sync \(now\).
+Transactions sync is performed with default `stream_slice_period` = 1 day, it means that there will be 1 request for each day between start_date and now or end_date. if `start_date` is greater then `start_date_max`. Balances sync is similarly performed with default `stream_slice_period` = 1 day, but it will do additional request for the end_date of the sync now.
 
-## Changelog
+## Data type map
 
-| Version | Date       | Pull Request                                             | Subject                                                                 |
-|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------------------------------|
-| 0.1.8   | 2022-07-25 | [15000](https://github.com/airbytehq/airbyte/pull/15000) | Added support of `OAuth2.0` authentication, fixed bug when normalization couldn't handle nested cursor field and primary key 
-| 0.1.7   | 2022-07-18 | [14804](https://github.com/airbytehq/airbyte/pull/14804) | Adding `RESULTSET_TOO_LARGE` error validation                                       |
-| 0.1.6   | 2022-06-10 | [13682](https://github.com/airbytehq/airbyte/pull/13682) | Update paypal transaction schema                                        |
-| 0.1.5   | 2022-04-27 | [12335](https://github.com/airbytehq/airbyte/pull/12335) | Adding fixtures to mock time.sleep for connectors that explicitly sleep |
-| 0.1.4   | 2021-12-22 | [9034](https://github.com/airbytehq/airbyte/pull/9034)   | Update connector fields title/description                               |
-| 0.1.3   | 2021-12-16 | [8580](https://github.com/airbytehq/airbyte/pull/8580)   | Added more logs during `check connection` stage                         |
-| 0.1.2   | 2021-11-08 | [7499](https://github.com/airbytehq/airbyte/pull/7499)   | Remove base-python dependencies                                         |
-| 0.1.1   | 2021-08-03 | [5155](https://github.com/airbytehq/airbyte/pull/5155)   | Fix start\_date\_min limit                                              |
-| 0.1.0   | 2021-06-10 | [4240](https://github.com/airbytehq/airbyte/pull/4240)   | PayPal Transaction Search API                                           |
+| Integration Type | Airbyte Type |
+| :--------------- | :----------- |
+|     `string`     |   `string`   |
+|     `number`     |   `number`   |
+|     `array`      |   `array`    |
+|     `object`     |   `object`   |
+
+## Changelog
 
+| Version | Date       | Pull Request                                             | Subject                                                                                                                            |
+|:--------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
+| 0.1.8   | 2022-07-25 | [15000](https://github.com/airbytehq/airbyte/pull/15000) | Added support of `OAuth2.0` authentication, fixed bug when normalization couldn't handle nested cursor field and primary key       |
+| 0.1.7   | 2022-07-18 | [14804](https://github.com/airbytehq/airbyte/pull/14804) | Added `RESULTSET_TOO_LARGE` error validation                                                                                       |
+| 0.1.6   | 2022-06-10 | [13682](https://github.com/airbytehq/airbyte/pull/13682) | Updated paypal transaction schema                                                                                                  |
+| 0.1.5   | 2022-04-27 | [12335](https://github.com/airbytehq/airbyte/pull/12335) | Added fixtures to mock time.sleep for connectors that explicitly sleep                                                             |
+| 0.1.4   | 2021-12-22 | [9034](https://github.com/airbytehq/airbyte/pull/9034)   | Updated connector fields title/description                                                                                         |
+| 0.1.3   | 2021-12-16 | [8580](https://github.com/airbytehq/airbyte/pull/8580)   | Added more logs during `check connection` stage                                                                                    |
+| 0.1.2   | 2021-11-08 | [7499](https://github.com/airbytehq/airbyte/pull/7499)   | Removed base-python dependencies                                                                                                   |
+| 0.1.1   | 2021-08-03 | [5155](https://github.com/airbytehq/airbyte/pull/5155)   | Fixed start_date_min limit                                                                                                         |
+| 0.1.0   | 2021-06-10 | [4240](https://github.com/airbytehq/airbyte/pull/4240)   | PayPal Transaction Search API                                                                                                      |