Merge pull request #182 from finbox-in/feature/add-mode-android

feature/add-mode-android

Author: ChiragRayani

docs/bank-connect/android.md

@@ -1,4 +1,5 @@
 # BankConnect: Android
+
 The Android SDK helps user submits their bank statements via upload or net banking credentials in your Android application.
 
 ## Requirements
@@ -71,6 +72,7 @@ dependencies {
 </CodeSwitcher>
 
 ## Adding Dependency
+
 In the project level `build.gradle` file, add the repository URLs to all `allprojects` block.
 
 <CodeSwitcher :languages="{kotlin:'Kotlin',groovy:'Groovy'}">
@@ -131,27 +133,30 @@ implementation('in.finbox.bankconnect:hybrid:<BC_SDK_VERSION>:release@aar') {
 </template>
 </CodeSwitcher>
 
-
 ::: warning NOTE
 Following will be shared by FinBox team at the time of integration:
+
 - `ACCESS_KEY`
 - `SECRET_KEY`
 - `BC_SDK_VERSION`
 - `CLIENT_API_KEY`
 :::
 
 ## Integration Workflow
+
 The diagram below illustrates the integration workflow in a nutshell:
 <img src="/client_sdk.jpg" alt="Client SDK Workflow" />
 
 ## Sample Project
+
 We have hosted a sample project on GitHub, you can check it out here:
 <div class="button_holder">
 <a class="download_button" target="_blank" href="https://github.com/finbox-in/bankconnect-android">Open GitHub Repository</a>
 </div>
 
 ## Build Bank Connect
-Build the `FinBoxBankConnect` object by passing `apiKey`, `linkId`, `fromDate`, `toDate` and `bank`.
+
+Build the `FinBoxBankConnect` object by passing `apiKey`, `linkId`, `fromDate`, `toDate`, `bank` and `mode`.
 
 <CodeSwitcher :languages="{kotlin:'Kotlin',java:'Java'}">
 <template v-slot:kotlin>
@@ -162,7 +167,8 @@ FinBoxBankConnect.Builder(applicationContext)
     .linkId("your_link_id")
     .fromDate("01/01/2021") // Optional: Default 6 months old date
     .toDate("01/04/2021") // Optional: Default value 1 day less than current date
-    .bank("sbi") // Optional
+    .bank("sbi") // Optional: Short code of the bank
+    .mode(PDF) // Optional: PDF Mode
     .build()
 ```
 
@@ -175,27 +181,29 @@ new FinBoxBankConnect.Builder(getApplicationContext())
     .linkId("your_link_id")
     .fromDate("01/01/2021") // Optional: Default 6 months old date
     .toDate("01/04/2021") // Optional: Default value 1 day less than current date
-    .bank("sbi") // Optional
+    .bank("sbi") // Optional: Short code of the bank
+    .mode(PDF) // Optional: PDF Mode
     .build();
 ```
 
 </template>
 </CodeSwitcher>
 
-
 | Builder Property | Description | Required |
 | - | - | - |
 | `apiKey` | specifies the `api_key` | Yes |
 | `linkId` | specifies the `link_id` | Yes |
 | `fromDate` | specifies the starting period of the statement in `DD/MM/YYYY`format | No |
 | `toDate` | specifies the end period of the statement in `DD/MM/YYYY` format | No |
 | `bank` | pass the [bank identifier](/bank-connect/appendix.html#bank-identifiers) to skip the bank selection screen and directly open a that bank's screen instead | No |
+| `mode` | set the mode as pdf (manual upload) or aa (Account Aggregator) or online (Net Banking) | No |
 
 `fromDate` and `toDate` specify the period for which the statements will be fetched. For example, if you need the last 6 months of statements, `fromDate` will be today's date - 6 months and `toDate` will be today's date - 1 day. If not provided the default date range is 6 months from the current date. It should be in `DD/MM/YYYY` format.
 
 Once the above statement is added, a series of checks are done to make sure the SDK is implemented correctly. A `RunTimeException` will be thrown while trying to build the project in case any of the checks are not completed.
 
 ::: warning Minimal Requirements for SDK to work:
+
 1. `apiKey` is is mandatory
 2. `linkId` is mandatory, and should be at least 8 characters long
 3. In case `fromDate` / `toDate` is provided, make sure they are of correct date format: `DD/MM/YYYY`.
@@ -205,6 +213,7 @@ Once all these conditions are met, the BankConnect object will build.
 :::
 
 ## Show SDK Screen
+
 Start BankActivity and listten for the result
 
 <CodeSwitcher :languages="{kotlin:'Kotlin',java:'Java'}">
@@ -245,11 +254,13 @@ result.launch(new Intent(this, BankActivity.class));
 </CodeSwitcher>
 
 ## Parse Results
+
 Once the user navigates through the banks and uploads the bank statement, the sdk automatically closes `BankActivity` and returns `FinboxOnSuccessPayload`.
 
 `FinboxOnSuccessPayload` contains `linkId` and `entityId`. A successful upload contains a unique `entityId`.
-* linkId - Unique id passed when building the Bank Connect object
-* entityId - Unique id of a successful statement upload
+
+- linkId - Unique id passed when building the Bank Connect object
+- entityId - Unique id of a successful statement upload
 
 <CodeSwitcher :languages="{kotlin:'Kotlin',java:'Java'}">
 <template v-slot:kotlin>
@@ -309,29 +320,30 @@ if (result != null && result.getResultCode() == Activity.RESULT_OK) {
 </template>
 </CodeSwitcher>
 
-
 :::warning Webhook
 To track detailed errors, and transaction process completion at the server-side, it is recommended to also integrate [Webhook](/bank-connect/webhook.html).
 :::
 
 ## Customization
+
 `BankActivity` inherits the themes and color from Material Dark Action Bar Theme. Most of the case, there would be less customization requried but if there is a mismatch in colors, you can customize it through your `styles.xml` file.
 
 1. The sdk Toolbar color uses `colorPrimary`. If your app toolbar color is different from `colorPrimary` then change the color by updating the background color
-	```xml
+
+ ```xml
     <style name="BankConnectTheme.Toolbar">
         <item name="android:background">@color/colorWhite</item>
     </style>
-	```
+ ```
 
 2. `BankConnectTheme` is the base theme of the sdk and it inherits `Theme.MaterialComponents.Light.DarkActionBar`. If your app doesn't inherit Dark Action Bar theme then you can change the sdk theme to inherit your app base theme.
 
-	```xml
+ ```xml
     <style name="BankConnectTheme" parent="AppTheme">
 
     </style>
 
     <style name="BankConnectTheme.AppBarOverlay" parent="AppTheme.AppBarOverlay" />
 
     <style name="BankConnectTheme.PopupOverLay" parent="AppTheme.PopupOverlay" />
-	```
+ ```

docs/bank-connect/flutter.md

@@ -109,21 +109,8 @@ We have hosted a sample project on GitHub, you can check it out here:
 
 ## Show SDK Screen
 
-Initialize the `FinBoxBcPlugin` in Kotlin Application class
-
-```kotlin
-class MainApp:FlutterApplication() {
-    override fun onCreate() {
-        super.onCreate()
-        FinBoxBcPlugin.initLibrary(this)
-    }
-}
-```
-
-Initialize the `FinBoxBcPlugin` in dart file
-
 ```dart
-FinBoxBcPlugin.initSdk("CLIENT_API_KEY","FROM_DATE","TO_DATE","BANK_NAME");
+FinBoxBcPlugin.initSdk("CLIENT_API_KEY","FROM_DATE","TO_DATE","BANK_NAME","MODE");
 ```
 
 | Builder Property | Description | Required |
@@ -133,6 +120,7 @@ FinBoxBcPlugin.initSdk("CLIENT_API_KEY","FROM_DATE","TO_DATE","BANK_NAME");
 | `fromDate` | specifies the starting period of the statement in `DD/MM/YYYY`format | No |
 | `toDate` | specifies the end period of the statement in `DD/MM/YYYY` format | No |
 | `bank` | pass the [bank identifier](/bank-connect/appendix.html#bank-identifiers) to skip the bank selection screen and directly open a that bank's screen instead | No |
+| `mode` | set the mode as pdf (manual upload) or aa (Account Aggregator) or online (Net Banking) | No |
 
 `fromDate` and `toDate` specify the period for which the statements will be fetched. For example, if you need the last 6 months of statements, `fromDate` will be today's date - 6 months and `toDate` will be today's date - 1 day. If not provided the default date range is 6 months from the current date. It should be in `DD/MM/YYYY` format.