refactor(GiniHealthSDK): Update the integration guide for the payment…

… component

IPC-208

HealthSDK/GiniHealthSDK/Documentation/source/Integration.md

@@ -8,14 +8,6 @@ The Gini Health API provides an information extraction service for analyzing hea
 **Note** For supporting each payment provider you need to specify `LSApplicationQueriesSchemes` in your `Info.plist` file. App schemes for specification will be provided by Gini.
 
 
-## Upload the document
-
-Document upload can be done in two ways:
-
-using `GiniHealthAPILibrary`
-using `GiniCapture`
-
-
 ## GiniHealthAPI initialization
 
 You should have received Gini Health API client credentials from us. Please get in touch with us in case you don't have them.
@@ -29,7 +21,7 @@ If you want to use a transparent proxy with your own authentication you can spec
 ```
 The token your provide will be added as a bearer token to all api.custom.net requests.
 
-## Certificate pinning
+## Certificate pinning (optional)
 
 If you want to use _Certificate pinning_, provide metadata for the upload process, you can pass both your public key pinning configuration (see [TrustKit repo](https://github.com/datatheorem/TrustKit) for more information)
 ```swift
@@ -51,6 +43,8 @@ Now that the `GiniHealthAPI` has been initialized, you can initialize `GiniHealt
 ```swift
  let healthSDK = GiniHealth(with: giniApiLib)
 ```
+## Upload the document
+
 and upload your document if you plan to do it with `GiniHealth`. First you need get document service and create partial document.
 
 ```swift
@@ -74,61 +68,11 @@ let partialDocs = [PartialDocumentInfo(document: createdDocument.links.document)
 
 ```
 
-##  Check preconditions
+## Check which documents/invoices are payable
 
 There is a method in GiniHealth:
 
-* `healthSDK.checkIfDocumentIsPayable(docId: String)` returns true if Iban was extracted.
-
-## Fetching data for payment review screen
-
-If the preconditions checks are succeeded you can fetch the document and extractions for Payment Review screen:
-
-```swift
-healthSDK.fetchDataForReview(documentId: documentId,
-                              completion: @escaping (Result<DataForReview, GiniHealthError>) -> Void)
-```
-The method above returns the completion block with the struct `DataForReview`, which includes document and extractions.
-
-## Payment review screen initialization
-
-```swift
-let vc = PaymentReviewViewController.instantiate(with giniHealth: healthSDK,
-                                                 data: dataForReview)
-```
-The screen can be presented modally, used in a container view or pushed to a navigation view controller. Make sure to add your own navigational elements around the provided views.
-
-To also use the `GiniHealthConfiguration`:
-
-```swift
-let giniConfiguration = GiniHealthConfiguration()
-config.loadingIndicatorColor = .black
-.
-.
-.
-healthSDK.setConfiguration(config)
-```
-
-## Payment component view initialization
-We provide a custom payment component view to help users pay the invoice/document.
-Payment component looks like this: 
-<br>
-<center><img src="img/Customization guide/PaymentComponentView.PNG" height="400"/></center>
-</br>
-
-### Steps to integrate payment component view:
-
-#### 1. You need to create an instance of the `PaymentComponentsController` class with a `GiniHealth` as parameter.
-
-```swift
-let paymentComponentsController = PaymentComponentsController(giniHealth: health)
-```
-
-#### 2. For each invoice/document, you need to call the `checkIfDocumentIsPayable` function from the `PaymentComponentsController` and store the value for each invoice in the `isPayable` field.
-
-```swift
-public func checkIfDocumentIsPayable(docId: String, completion: @escaping (Result<Bool, GiniHealthError>) -> Void)
-```
+* `healthSDK.checkIfDocumentIsPayable(docId: String, completion: @escaping (Result<Bool, GiniHealthError>) -> Void)` returns success and `true` value if Iban was extracted.
 
 > - We recommend using a `DispatchGroup` for these requests, waiting till all of them are ready, and then, reloading the list.
 
@@ -147,29 +91,73 @@ dispatchGroup.notify(queue: .main) {
 }
 ```
 
-#### 3. You have to load the payment providers by calling the `loadPaymentProviders` function from the `PaymentComponentsController` and listen to the `PaymentComponentsControllerProtocol`.
+## Integrate the Payment component view
+
+We provide a custom payment component view to help users pay the invoice/document.
+Please follow the steps below for the payment component integration.
+
+### 1. Create an instance of the `PaymentComponentsController` class with a `GiniHealth` as parameter.
+
+```swift
+let paymentComponentsController = PaymentComponentsController(giniHealth: health)
+```
+
+### 2. Load the payment providers by calling the `loadPaymentProviders` function from the `PaymentComponentsController` and listen to the `PaymentComponentsControllerProtocol`.
+
+```swift
+paymentComponentsController.delegate = self // where self is your viewController
+paymentComponentsController.loadPaymentProviders()
+```
+* `PaymentComponentsControllerProtocol` provides information when the `PaymentComponentsController` is loading.
+You can show/hide an `UIActivityIndicator` based on that.
+* `PaymentComponentsControllerProtocol` provides completion handlers when `PaymentComponentsController` fetched successfully payment providers or when it failed with an error.
+
+**Note:**
+It should be sufficient to call paymentComponentsController.loadPaymentProviderApps() only once when your app starts.
 
 > - We effectively handle situations where there are no payment providers available.
 > - Based on the payment provider's colors, the `UIView` will automatically change its color.
 
-#### 4. Depending on the value of `isPayable`, incorporate the corresponding payment component view into your cells using this function:
+### 3. Show the Payment Component view and listen to the `PaymentComponentViewProtocol`.
+
+Depending on the value of `isPayable`, incorporate the corresponding payment component view into your cells using this function:
 
 ```swift
-public func paymentView(paymentProvider: PaymentProvider?) -> UIView
+public func paymentView(documentId: String) -> UIView
 ```
 
 > - We suggest placing this `UIView` within a vertical `UIStackView`. Additionally, in the `prepareForReuse()` function of each cell, remove the payment component view if it exists.
 > - Furthermore, employing automatic dimension height in the `UITableView` containing the cells is recommended.
 
-#### 5. `PaymentComponentsController` has 2 delegates that you can listen to: `PaymentComponentsControllerProtocol` and the `PaymentComponentViewProtocol`
-
-* `PaymentComponentsControllerProtocol` provides information when the `PaymentComponentsController` is loading. You can show/hide an `UIActivityIndicator` based on that.
-* `PaymentComponentsControllerProtocol` provides completion handlers when `PaymentComponentsController` fetched successfully payment providers or when it failed with an error.
-
 * `PaymentComponentViewProtocol` is the view protocol and provides events handlers when the user tapped on various areas on the payment component view (more information icon, bank/payment provider picker, the pay invoice button and etc.).
 
 > - Make sure you properly link these delegates to get notified.
 
-<br>
-<center><img src="img/Customization guide/PaymentComponentScreen.PNG" height="500"/></center>
-</br>
+## Payment review screen
+
+If the preconditions checks are succeeded you can fetch the document and extractions for Payment Review screen:
+
+```swift
+healthSDK.fetchDataForReview(documentId: documentId,
+                              completion: @escaping (Result<DataForReview, GiniHealthError>) -> Void)
+```
+The method above returns the completion block with the struct `DataForReview`, which includes document and extractions.
+
+### Payment review screen initialization
+
+```swift
+let vc = PaymentReviewViewController.instantiate(with giniHealth: healthSDK,
+                                                 data: dataForReview)
+```
+The screen can be presented modally, used in a container view or pushed to a navigation view controller. Make sure to add your own navigational elements around the provided views.
+
+To also use the `GiniHealthConfiguration`:
+
+```swift
+let giniConfiguration = GiniHealthConfiguration()
+config.loadingIndicatorColor = .black
+.
+.
+.
+healthSDK.setConfiguration(config)
+```

HealthSDK/GiniHealthSDK/Sources/GiniHealthSDK/Core/GiniHealth.swift

@@ -150,8 +150,8 @@ public struct DataForReview {
     }
 
     /**
-     Checks if the document is payable which looks for iban extraction.
-     
+     Checks if the document is payable, looks for iban extraction.
+
      - Parameters:
         - docId: Id of uploaded document.
         - completion: An action for processing asynchronous data received from the service with Result type as a paramater. Result is a value that represents either a success or a failure, including an associated value in each case. Completion block called on main thread.