Add IOS Docs for BankConnect and Lending Product

docs/.vuepress/config.js

@@ -169,6 +169,14 @@ module.exports = {
               title: 'Cordova',
               path: '/bank-connect/cordova.html'
             },
+            {
+              title: 'Ionic Capacitor',
+              path: '/bank-connect/ionic-capacitor.html'
+            },
+            {
+              title: 'IOS',
+              path: '/bank-connect/ios.html'
+            },
             {
               title: 'JavaScript',
               path: '/bank-connect/javascript.html'
@@ -405,6 +413,10 @@ module.exports = {
               title: 'Flutter',
               path: '/middleware/flutter.html'
             },
+            {
+              title: 'IOS',
+              path: '/middleware/ios.html'
+            },
             {
               title: 'REST API',
               path: '/middleware/sourcing-rest-api.html'

docs/.vuepress/styles/index.styl

@@ -66,4 +66,8 @@
     text-decoration: none !important
 
 .custom-block.tip
-    border-color: $accentColor
+    border-color: $accentColor
+
+.theme-default-content:not(.custom) {
+    max-width: 800px; /* Adjust to your desired width */
+}

docs/README.md

@@ -38,7 +38,7 @@ footer: Copyright © 2023 Moshpit Technologies Pvt. Ltd.
       Lets businesses get access to enriched transaction data of customers using bank statements uploaded manually or via Net Banking.
     </p>
     <p>
-      <a href="bank-connect/" class="doc_link">See Documentation →</a>
+      <a href="session-flow/" class="doc_link">See Documentation →</a>
     </p>
   </div>
 </div>

docs/bank-connect/android.md

@@ -165,16 +165,16 @@ Build the `FinBoxBankConnect` object by passing `apiKey`, `linkId`, `fromDate`,
 FinBoxBankConnect.Builder(applicationContext)
     .apiKey("CLIENT_API_KEY")
     .linkId("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: Short code of the bank
-    .mode(PDF) // Optional: PDF Mode
-    .mobileNumber("9876543210") // Optional: Mobile number
-    .journeyMode(MULTI_PDF) // Optional: Multi PDF journey
-    .aaJourneyMode(ONLY_RECURRING) // Optional: Recurring AA pulls
-    .aaRecurringTenureMonthCount(3) // Optional: Consent duration is valid for 3 months
-    .aaRecurringFrequencyUnit(TimeUnit.DAYS) // Optional: Frequency value is in Days
-    .aaRecurringFrequencyValue(2) // Optional: Number of times to pull the data
+    .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: Short code of the bank
+    .mode(PDF)                                  // Optional: PDF Mode
+    .mobileNumber("9876543210")                 // Optional: Mobile number
+    .journeyMode(MULTI_PDF)                     // Optional: Multi PDF journey
+    .aaJourneyMode(ONLY_RECURRING)              // Optional: Recurring AA pulls
+    .aaRecurringTenureMonthCount(3)             // Optional: Consent duration is valid for 3 months
+    .aaRecurringFrequencyUnit(TimeUnit.DAYS)    // Optional: Frequency value is in Days
+    .aaRecurringFrequencyValue(2)               // Optional: Number of times to pull the data
     .build()
 ```
 
@@ -185,16 +185,16 @@ FinBoxBankConnect.Builder(applicationContext)
 new FinBoxBankConnect.Builder(getApplicationContext())
     .apiKey("CLIENT_API_KEY")
     .linkId("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: Short code of the bank
-    .mode(PDF) // Optional: PDF Mode
-    .mobileNumber("9876543210") // Optional: Mobile number
-    .journeyMode(MULTI_PDF) // Optional: Multi PDF journey
-    .aaJourneyMode(ONLY_RECURRING) // Optional: Recurring AA pulls
-    .aaRecurringTenureMonthCount(3) // Optional: Consent duration is valid for 3 months
-    .aaRecurringFrequencyUnit(TimeUnit.DAYS) // Optional: Frequency value is in Days
-    .aaRecurringFrequencyValue(2) // Optional: Number of times to pull the data
+    .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: Short code of the bank
+    .mode(PDF)                                  // Optional: PDF Mode
+    .mobileNumber("9876543210")                 // Optional: Mobile number
+    .journeyMode(MULTI_PDF)                     // Optional: Multi PDF journey
+    .aaJourneyMode(ONLY_RECURRING)              // Optional: Recurring AA pulls
+    .aaRecurringTenureMonthCount(3)             // Optional: Consent duration is valid for 3 months
+    .aaRecurringFrequencyUnit(TimeUnit.DAYS)    // Optional: Frequency value is in Days
+    .aaRecurringFrequencyValue(2)               // Optional: Number of times to pull the data
     .build();
 ```
 

docs/bank-connect/flutter.md

@@ -112,16 +112,16 @@ We have hosted a sample project on GitHub, you can check it out here:
 ```dart
 FinBoxBcPlugin.initSdk(
     "CLIENT_API_KEY",
-    "FROM_DATE",
-    "TO_DATE",
-    "BANK_NAME",
-    "MODE",
-    "MOBILE_NUMBER",
-    "JOURNEY_MODE",
-    "AA_JOURNEY_MODE",
-    "AA_RECURRING_TENURE_MONTH_COUNT",
-    "AA_RECURRING_FREQUENCY_UNIT",
-    "AA_RECURRING_FREQUENCY_VALUE"
+    "FROM_DATE",                        // Optional: Default 6 months old date
+    "TO_DATE",                          // Optional: Default value 1 day less than current date
+    "BANK_NAME",                        // Optional: Short code of the bank
+    "MODE",                             // Optional: PDF Mode
+    "MOBILE_NUMBER",                    // Optional: Mobile number
+    "JOURNEY_MODE",                     // Optional: Multi PDF journey
+    "AA_JOURNEY_MODE",                  // Optional: Recurring AA pulls
+    "AA_RECURRING_TENURE_MONTH_COUNT",  // Optional: Consent duration is valid for 3 months
+    "AA_RECURRING_FREQUENCY_UNIT",      // Optional: Frequency value is in Days
+    "AA_RECURRING_FREQUENCY_VALUE"      // Optional: Number of times to pull the data
 );
 ```
 

docs/bank-connect/ionic-capacitor.md

@@ -0,0 +1,232 @@
+# BankConnect: Ionic Capacitor
+
+Bank Connect Ionic Capacitor SDK helps user submits their bank statements via upload or net banking credentials in your Android application.
+
+## Requirements
+
+Bank Connect SDK works on Android 5.0+ (API level 21+), Java 8+ and AndroidX. In addition to the changes, enable desugaring to support older versions.
+
+<CodeSwitcher :languages="{kotlin:'Kotlin',groovy:'Groovy'}">
+<template v-slot:kotlin>
+
+```kotlin
+android {
+    ...
+    defaultConfig {
+        ...
+        // Minimum 5.0+ devices
+        minSdkVersion(21)
+        ...
+    }
+    ...
+    compileOptions {
+        // Flag to enable support for the new language APIs
+        coreLibraryDesugaringEnabled = true
+        // Sets Java compatibility to Java 8
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    // For Kotlin projects
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
+}
+```
+
+</template>
+<template v-slot:groovy>
+
+```groovy
+android {
+    ...
+    defaultConfig {
+        ...
+        // Minimum 5.0+ devices
+        minSdkVersion 21
+        ...
+    }
+    ...
+    compileOptions {
+        // Flag to enable support for the new language APIs
+        coreLibraryDesugaringEnabled true
+        // Sets Java compatibility to Java 8
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    // For Kotlin projects
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5'
+}
+```
+
+</template>
+</CodeSwitcher>
+
+## Add Plugin
+
+Specify the following in `local.properties` file:
+
+```properties
+ACCESS_KEY=<ACCESS_KEY>
+SECRET_KEY=<SECRET_KEY>
+BC_SDK_VERSION=<BC_SDK_VERSION>
+```
+
+In the project level `build.gradle` file or `settings.gradle`, add the repository URLs to all `allprojects` block or `repositories` block inside `dependencyResolutionManagement`.
+
+<CodeSwitcher :languages="{kotlin:'Kotlin',groovy:'Groovy'}">
+<template v-slot:kotlin>
+
+```kotlin
+maven {
+    setUrl("s3://risk-manager-android-sdk/artifacts")
+    credentials(AwsCredentials::class) {
+        accessKey = <ACCESS_KEY>
+        secretKey = <SECRET_KEY>
+    }
+    content {
+        includeGroup("in.finbox.bankconnect")
+    }
+}
+```
+
+</template>
+<template v-slot:groovy>
+
+```groovy
+maven {
+    url "s3://risk-manager-android-sdk/artifacts"
+    credentials(AwsCredentials) {
+        accessKey = <ACCESS_KEY>
+        secretKey = <SECRET_KEY>
+    }
+    content {
+        includeGroup("in.finbox.bankconnect")
+    }
+}
+```
+
+</template>
+</CodeSwitcher>
+
+Add plugin dependency
+
+<CodeSwitcher :languages="{npm:'NPM',yarn:'Yarn'}">
+<template v-slot:yarn>
+
+```sh
+yarn add ionic-bank-connect-sdk
+```
+
+</template>
+<template v-slot:npm>
+
+```sh
+yarn add ionic-bank-connect-sdk
+```
+
+</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/bank-connect-sample-ionic-capacitor">Open GitHub Repository</a>
+</div>
+
+## Build Bank Connect
+
+Build the `IonicBankConnectSdk` object by passing `apiKey`, `linkId`, `fromDate`, `toDate`, `bank`, `mode` and others.
+
+```javascript
+// Build BankConnect
+IonicBankConnectSdk.buildBankConnect(options: {
+    apiKey: "CLIENT_API_KEY",
+    linkId: "LINK_ID",
+    fromDate: "FROM_DATE",                                          // Optional: Default 6 months old date
+    toDate: "TO_DATE",                                              // Optional: Default value 1 day less than current date
+    bank: "BANK_NAME",                                              // Optional: Short code of the bank
+    mode: "MODE",                                                   // Optional: PDF Mode
+    mobileNumber: "MOBILE_NUMBER",                                  // Optional: Mobile number
+    journeyMode: "JOURNEY_MODE",                                    // Optional: Multi PDF journey
+    aaJourneyMode: "AA_JOURNEY_MODE",                               // Optional: Recurring AA pulls
+    aaRecurringTenureMonthCount: "AA_RECURRING_TENURE_MONTH_COUNT", // Optional: Consent duration is valid for 3 months
+    aaRecurringFrequencyUnit: "AA_RECURRING_FREQUENCY_UNIT",        // Optional: Frequency value is in Days
+    aaRecurringFrequencyValue: "AA_RECURRING_FREQUENCY_VALUE",      // Optional: Number of times to pull the data
+});
+```
+
+| 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 |
+| `mobile_number` | Prefills phone number in Account Aggregator mode | No |
+| `journey_mode` | Optional parameter to set the journey (i.e.multi_pdf or multi_banking) | No |
+| `aa_journey_mode` | set the journey mode for AA (i.e only_once or only_recurring) | No |
+| `aa_recurring_tenure_month_count` | set the recurring consent duration (min: 1 and max: 24) | No |
+| `aa_recurring_frequency_unit` | set the frequency unit to pull the data during the recurring consent duration (year, month, day, hour) | No |
+| `aa_recurring_frequency_value` | set the frequency value to pull the data during the recurring consent duration (min: 1 and max: 3) | 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`.
+4. Make sure `fromDate` is always less than `toDate`
+5. Make sure `toDate` is never today's date, the maximum possible value for it is today's date - 1 day
+Once all these conditions are met, the BankConnect object will build.
+:::
+
+## Show SDK Screen
+
+Start Bank Screen and listen for the result
+
+```javascript
+// Show BankConnect UI
+IonicBankConnectSdk.showBankConnect((error: any) => {
+    // error callback
+  }, (entityId: any, sessionId: any) => {
+    // Success callback
+  });
+```
+
+## Parse Results
+
+Once the user navigates through the banks and uploads the bank statement, the sdk automatically closes `IonicBankConnectSdk` and returns the results.
+
+Success callback contains `entityId` (or `sessionId`). A successful upload contains a unique `entityId` (or `sessionId`).
+
+- entityId - Unique id of a successful statement upload during Entity flow
+- sessionId - Session id of a successful statement upload during Session flow