Skip to content

Commit

Permalink
doc(GiniBankSDK): Bumps version 3.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
zladzeyka committed Jun 27, 2023
1 parent 7d20ce2 commit 4e6846a
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 50 deletions.
4 changes: 2 additions & 2 deletions BankSDK/GiniBankSDK/Documentation/sections/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ You need to specify the NSCameraUsageDescription key in your Info.plist file. Th
**Note: iOS 14**
Starting in iOS 14, PhotoKit further enhances user privacy controls with the addition of the limited Photos library, which lets users select specific assets and resources to share with an app. Add an entry to your Info.plist file with the appropriate key. If your app only adds to the library, use the NSPhotoLibraryAddUsageDescription key. For all other cases, use NSPhotoLibraryUsageDescription.

In order to run [the example app](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample), clone the repo ,open the project file and Resolve Package Versions in Xcode `File->Packages->Resolve Package Versions`.
In order to run [the example app](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample), clone the repo ,open the project file and Resolve Package Versions in Xcode `File->Packages->Resolve Package Versions`.

### Payment feature

The banking example app demonstrates how to integrate the Gini Bank SDK.
To run the apps, clone the repo, open the project file and Resolve Package Versions in Xcode `File->Packages->Resolve Package Versions`.
To inject your API credentials into the Health and Bank example apps you need to fill in your credentials in [`HealthSDK/GiniHealthSDKExample/GiniHealthSDKExample/Credentials.plist`](https://github.com/gini/gini-mobile-ios/blob/main/HealthSDK/GiniHealthSDKExample/GiniHealthSDKExample/Credentials.plist) and [`BankSDK/GiniBankSDKExample/GiniBankSDKExampleBank/Credentials.plist`](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExampleBank/Credentials.plist/), respectively.
To inject your API credentials into the Health and Bank example apps you need to fill in your credentials in [`HealthSDK/GiniHealthSDKExample/GiniHealthSDKExample/Credentials.plist`](https://github.com/gini/gini-mobile-ios/blob/main/HealthSDK/GiniHealthSDKExample/GiniHealthSDKExample/Credentials.plist) and [`BankSDK/GiniBankSDKExample/GiniBankSDKExampleBank/Credentials.plist`](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExampleBank/Credentials.plist/), respectively.

An example health app is available under the link [Gini Health SDK's example](https://github.com/gini/gini-mobile-ios/blob/main/HealthSDK/GiniHeathSDKExample).
You can use the same Gini Bank API client credentials in the health example app as in your app, if not otherwise specified.
Expand Down
16 changes: 8 additions & 8 deletions BankSDK/GiniBankSDK/Documentation/source/Customization guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Gini Bank SDK components can be customized either through the `GiniBankConfi
## Colors

We are providing a global color palette `GiniColors.xcassets` which you are free to override. The custom colors will be then applied on all screens.
You can find the names of the colors in [GiniColors.xcassets](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/GiniColors.xcassets).
You can find the names of the colors in [GiniColors.xcassets](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/GiniColors.xcassets).

You can view our color palette here:

Expand Down Expand Up @@ -64,15 +64,15 @@ To override them in your application please use `GiniBankConfiguration.updateFon

## Images

Images customization is done via overriding of [GiniImages.xcassets](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/GiniImages.xcassets) resources.
Images customization is done via overriding of [GiniImages.xcassets](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/GiniImages.xcassets) resources.

## Text

Text customization is done via overriding of string resources.

If you plan to use a custom name for localizable strings, you need to set it in `GiniBankConfiguration.localizedStringsTableName`.

You can find all the string resources in [Localizable.strings](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/de.lproj/Localizable.strings).
You can find all the string resources in [Localizable.strings](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDK/Sources/GiniBankSDK/Resources/de.lproj/Localizable.strings).

## Generic components

Expand Down Expand Up @@ -166,7 +166,7 @@ Please find more information in the [Import PDFs and images guide](https://devel
You can show a custom loading indicator with custom animation support on the process button.
Your custom loading indicator should implement `OnButtonLoadingIndicatorAdapter` interface and be passed to `GiniBankConfiguration.shared.onButtonLoadingIndicator`.

The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift#L36).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift#L36).

## Analysis screen

Expand All @@ -175,7 +175,7 @@ The example implementation is available [here](https://github.com/gini/gini-mobi
You can show a custom loading indicator with custom animation support.
Your custom loading indicator should implement `CustomLoadingIndicatorAdapter` interface and be passed to `GiniBankConfiguration.shared.customLoadingIndicator`.

The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift).

## Help screens

Expand All @@ -192,7 +192,7 @@ You can pass the title and view controller for each screen to the
configuration.customMenuItems = [customMenuItem]
```

The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomMenuItemViewController.swift).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomMenuItemViewController.swift).

You can also disable the supported formats help screen by passing `false` to
`GiniBankConfiguration.shared.shouldShowSupportedFormatsScreen`.
Expand All @@ -208,13 +208,13 @@ You can also disable the supported formats help screen by passing `false` to
You can show your own UI for data input if an error occurred and the user clicks the "Enter manually" button on the error screen.
For this you must to implement `GiniCaptureResultsDelegate.giniCaptureDidEnterManually() `.

You can find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/features.html#no-result-screen-customization).
You can find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/features.html#no-result-screen-customization).

## Error screen

<iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="600" height="450" src="https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Ffile%2Fz2naLjqFknlrlbHhfAWx85%2FiOS-Gini-Bank-SDK-3.1.2-UI-Customisation%3Ftype%3Ddesign%26node-id%3D263%253A6858%26t%3DkpmaxiSASzEV6nAe-1" allowfullscreen></iframe>

You can find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/features.html#error-screen-customization).
You can find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/features.html#error-screen-customization).

# Return Assistant

Expand Down
18 changes: 9 additions & 9 deletions BankSDK/GiniBankSDK/Documentation/source/Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The QR Code scanning may be triggered directly without the need to analyze the d

If the QR code does not have a supported payment format then a popup informs the user that a QR code was detected, but it cannot be used.

Please find more information in the [QR Code scanning guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/qr-code-scanning-guide.html).
Please find more information in the [QR Code scanning guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/qr-code-scanning-guide.html).

## QR Code Only

Expand All @@ -95,13 +95,13 @@ For enabling QR code only mode the both flags `GiniBankConfiguration.shared.qrCo

This feature enables the Gini Bank SDK to import documents from the camera screen. When it's enabled an additional button is shown next to the camera trigger. Using this button allows the user to pick either an image or a pdf from the device.

Please find more information in the [Import PDFs and images guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/import-pdfs-and-images-guide.html).
Please find more information in the [Import PDFs and images guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/import-pdfs-and-images-guide.html).

# Open with

The `Open with` feature allows importing of files from other apps via iOS `share` functionality.

Please find more information in the [Open with guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/open-with-guide.html).
Please find more information in the [Open with guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/open-with-guide.html).

# Help screen customization

Expand All @@ -115,7 +115,7 @@ You can pass the title and view controller for each screen to the

configuration.customMenuItems = [customMenuItem]
```
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomMenuItemViewController.swift).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomMenuItemViewController.swift).

You can also disable the supported formats help screen by passing `false` to
`GiniBankConfiguration.shared.shouldShowSupportedFormatsScreen`.
Expand All @@ -125,14 +125,14 @@ You can also disable the supported formats help screen by passing `false` to
You can show a custom loading indicator with custom animation support on the process button.
Your custom loading indicator should implement `OnButtonLoadingIndicatorAdapter` interface and be passed to `GiniBankConfiguration.shared.onButtonLoadingIndicator`.

The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift#L36).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift#L36).

# Analysis screen customization

You can show a custom loading indicator with custom animation support.
Your custom loading indicator should implement `CustomLoadingIndicatorAdapter` interface and be passed to `GiniBankConfiguration.shared.customLoadingIndicator`.

The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift).
The example implementation is available [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/CustomLoadingIndicator.swift).

# No result screen customization

Expand All @@ -150,13 +150,13 @@ The buttom "Retake images" will be shown only if you took or imported images.

You have the possibility to track various events which occur during the usage of the Gini Bank SDK.

Please find more information in the [Event tracking guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/event-tracking-guide.html).
Please find more information in the [Event tracking guide](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/event-tracking-guide.html).

# Error Logging

The SDK logs errors to the Gini Bank API when the default networking implementation is used. See the `Default networking` implementation in the [Integration](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/integration.html).
The SDK logs errors to the Gini Bank API when the default networking implementation is used. See the `Default networking` implementation in the [Integration](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/integration.html).

Please find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.1/error-logging-guide.html).
Please find more details [here](https://developer.gini.net/gini-mobile-ios/GiniBankSDK/3.1.2/error-logging-guide.html).

## Return Assistant

Expand Down
4 changes: 2 additions & 2 deletions BankSDK/GiniBankSDK/Documentation/source/Getting started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ Once you have your Swift package set up, adding `GiniBankSDK` as a dependency is

```swift
dependencies: [
.package(url: "https://github.com/gini/bank-sdk-ios.git", .exact("3.1.1"))
.package(url: "https://github.com/gini/bank-sdk-ios.git", .exact("3.1.2"))
]
```
**Note: Available from iOS 12**
In case that you want to use the certificate pinning in the library, add `GiniBankSDKPinning`:
```swift
dependencies: [
.package(url: "https://github.com/gini/bank-sdk-pinning-ios.git", .exact("3.1.1"))
.package(url: "https://github.com/gini/bank-sdk-pinning-ios.git", .exact("3.1.2"))
]
```

Expand Down
10 changes: 5 additions & 5 deletions BankSDK/GiniBankSDK/Documentation/source/Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ You may also use the [Gini Bank API Library](https://github.com/gini/bank-api-li

Your app should clean up the SDK and provide feedback for the extractions the Gini Bank API delivered. Feedback should be sent only for the extractions the user has seen and accepted (or corrected).

We provide a sample test case [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/Tests/ExtractionFeedbackIntegrationTest.swift) to verify that extraction feedback sending works.
We provide a sample test case [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/Tests/ExtractionFeedbackIntegrationTest.swift) to verify that extraction feedback sending works.
You may use it along with the example pdf and json files as a starting point to write your own test case.

The sample test case is based on the Bank API documentation's [recommended steps](https://pay-api.gini.net/documentation/#test-example) for testing extraction feedback sending.
Expand Down Expand Up @@ -285,12 +285,12 @@ To launch the Gini Bank SDK you only need to:

1. Request camera access via configuring `Info.plist` in your project.

2. Configure `GiniBankConfiguration.shared`. The implementation example can be found [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/AppCoordinator.swift#L32)
2. Configure `GiniBankConfiguration.shared`. The implementation example can be found [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/AppCoordinator.swift#L32)

3. Present the `UIViewController`. You can find the example [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/Screen%20API/ScreenAPICoordinator.swift#L68)
3. Present the `UIViewController`. You can find the example [here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/Screen%20API/ScreenAPICoordinator.swift#L68)

4. Handle the extraction results.
For handling the extraction results you need to implement `GiniCaptureResultsDelegate`. [Here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample/Screen%20API/ScreenAPICoordinator.swift#L135) you can find the implementation example.
For handling the extraction results you need to implement `GiniCaptureResultsDelegate`. [Here](https://github.com/gini/gini-mobile-ios/blob/GiniBankSDK%3B3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample/Screen%20API/ScreenAPICoordinator.swift#L135) you can find the implementation example.

5. Cleanup configuration and resources while also providing the required extraction feedback to
improve the future extraction accuracy. You don't need to implement any extra steps, just follow the recommendations below:
Expand All @@ -310,4 +310,4 @@ To launch the Gini Bank SDK you only need to:
amountToPay: ExtractionAmount(value: 10.242, currency: .EUR))
```

Check out the [example app](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK;3.1.1/BankSDK/GiniBankSDKExample/GiniBankSDKExample) to see how an integration could look like.
Check out the [example app](https://github.com/gini/gini-mobile-ios/tree/GiniBankSDK;3.1.2/BankSDK/GiniBankSDKExample/GiniBankSDKExample) to see how an integration could look like.

0 comments on commit 4e6846a

Please sign in to comment.