Release artifacts updated for 1.7.2 (#146)

CHANGELOG.md

@@ -2,13 +2,22 @@
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.7.2] - (23/08/19) - O iOS
+
+### Bugs
+- SDK crashing during social media login is fixed
+
+---
+
+
 ## [1.7.1] - (21/08/19) - O iOS
 
 ### Features
 - Voice features STT & TTS can now be turned off
 
 ---
 
+
 ## [1.7.0] - (5/07/19) - I iOS
 
 ### Features

Feature Guides/analytics.md

@@ -4,7 +4,7 @@ title: Analytics
 
 ## HaptikLib Analytics
 
-HaptikLib uses **Analytics** internally and also _provides the functionality of giving callbacks for every event tracking_. `HPAnalyticsServiceDelegate` **protocol** is defined in `Haptik.h` class under which two optional methods are defined which are called if you confirm to the respective protocol. The class has a property named `analyticsCallbackObject` of type `HPAnalyticsServiceDelegate` which the application needs to set with the object that will confirm to the protocol.
+HaptikLib uses **Analytics** internally and also _provides the functionality of giving callbacks for every event tracking_. `HPAnalyticsServiceDelegate` **protocol** is defined in `HPConfiguration.h` class under which two optional methods are defined which are called if you confirm to the respective protocol. The class has a property named `analyticsCallbackObject` of type `HPAnalyticsServiceDelegate` which the application needs to set with the object that will confirm to the protocol.
 
 Example:
 
@@ -15,7 +15,7 @@ Example:
 
 - (void)viewDidLoad {
 
-    [Haptik sharedSDK].analyticsCallbackObject = self;
+    [HPConfiguration shared].analyticsCallbackObject = self;
 }
 
 - (void)eventTracked:(NSString *)eventName forParams:(NSDictionary *)params {

Feature Guides/features.md

@@ -27,7 +27,7 @@ else {
 This BOOL controls the functionality of the `EdgePanGestureRecognizer` feature of UINavigationController that allows to set the slide to go back functionality for Haptik Screens. By default the value will be true.
 
 ```
-[Haptik sharedSDK].useInteractivePopGesture = YES;
+[HPConfiguration shared].useInteractivePopGesture = YES;
 ```
 
 ---
@@ -36,6 +36,8 @@ This BOOL controls the functionality of the `EdgePanGestureRecognizer` feature o
 
 Once the user has been signed up, you also have the ability to open Conversation View for a specific channel directly. It needs to be Initialized with the unique business name of the channel that you wish to open Conversation for and an optional message text (can be `nil`) if you want to log any.
 
+> Make sure to turn the `useInbox` flag on **HPConfiguration** to `NO` for it
+
 Example:
 
 ```

Feature Guides/integration-guide.md

@@ -12,7 +12,7 @@ Minimum Deployment Target: **iOS 9.0**
 
 Supported Device Orientation: **Portrait**
 
-You also need to have [git-lfs](https://git-lfs.github.com/) installed for using the sdk
+You also need to have [git-lfs](https://git-lfs.github.com/) installed on your machine for running the SDK
 
 ---
 
@@ -23,6 +23,13 @@ You also need to have [git-lfs](https://git-lfs.github.com/) installed for using
    ```
    pod 'HaptikLib'
    ```
+
+   You need to install a submodule of HaptikLib too if you want to make use of Voice Capabilities
+
+   ```
+   pod 'HaptikLib/Speech'
+   ```
+
 
 2. Run `pod install`
 
@@ -171,16 +178,16 @@ Add the following snippets in your `info.plist` file -
 3. Haptik internally also opens urls which the client needs to return it true.
 
 
-   ```
-   - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
+    ```
+    (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
 
       ...
 
       BOOL isRedirectHandledByHaptik = [[Haptik sharedSDK] isRedirectHandled:url options:options];
 
       return isRedirectHandledByHaptik;
-   }
-   ```
+    }
+    ```
 
 4. Haptik can also be configured to send Push Notifications to the user. The client application needs to configure push notifications on their own end and have to pass the deviceToken which the application gets after requesting the user to send them Push Notifications.
 

Feature Guides/payments.md

@@ -37,7 +37,7 @@ HaptikLib has an inbuilt wallet information screen to which you can push the use
 
 ###### Is Haptik Wallet Created?
 
-Haptik only creates `Wallet` for the users which are verified(phone number of the user must verified). If the user is not verified and the `Haptik Wallet VC` is pushed, then the user is automatically taken to the **user verification flow**.
+Haptik only creates `wallet` for the users which are verified(phone number of the user must verified). If the user is not verified and the `Haptik Wallet VC` is pushed, then the user is automatically taken to the **user verification flow**.
 
 HapikLib give a helper function which tells if the `Wallet` is created for the user or not. You can use the below function to check:
 
@@ -50,34 +50,40 @@ HapikLib give a helper function which tells if the `Wallet` is created for the u
 Haptik class provides custom method to route to this screen:
 
 ```
-- (void)pushToHaptikWalletFrom:(__kindof UIViewController *__weak)controller
-                   showHistory:(BOOL)showHistory
-                    completion:(void(^)(BOOL success))completion;
+- (void)getHaptikWalletViewController:(BOOL)defaultsToHistory
+                 shareAndEarnDelegate:(nullable id <HPShareAndEarnDelegate>)delegate
+                           controller:(__kindof UIViewController *__weak)controller
+                           completion:(void(^)(BOOL success, __kindof UIViewController *_Nullable haptikWalletVC))completion;
 ```
 
 Example:
 
 ```
-[[Haptik sharedSDK] pushToHaptikWalletFrom:self
-                               showHistory:NO
-                                completion:^(BOOL success) {
-     if (success) {
-        NSLog(@"do housekeeping");
-     }
- }];
+[[Haptik sharedSDK] getHaptikWalletViewController:NO
+                                  shareAndEarnDelegate:nil
+                                            controller:controller
+                                            completion:^(BOOL success, __kindof UIViewController * _Nullable haptikWalletVC) {
+            if (success) {
+                [controller.navigationController pushViewController:haptikWalletVC animated:YES];
+            }
+        }];
 ```
 
 **Discussion**
 
 > The user should be a verified user (phone number of the user is verified) in order to see & use the wallet scene. If the user is not verified and this scene is pushed, HaptikLib takes the user through the verification flow. You don't have to do anything else for it. You'll just get the `Haptik Wallet VC` in the completion.
 
+- The `param`: `defaultsToHistory` indicates which tab should selected by default when the scene is pushed.
+
+- The `param`: `shareAndEarnDelegate` should be passed nil as referral flow is not yet supported for clients other than `Haptik` itself.
+
 - The `param`: `controller` requires the current controller from where this scene is to be pushed potentially. This controller is required for `HaptikLib` in order to handle the user verification flow.
 
-- The `param`: `showHistory` A boolean indicating whether the wallet history tab should be selected by default or not.
+- In the `completion`, you get two parameters:
 
-- In the `completion`, you get one parameter:
+      	- `success`: Indicates whether the user is verified or not.
 
-    	- `success`: Indicates whether the user is verified or not.
+      	- `haptikWalletVC`: You'll get the instance of the `Haptik Wallet VC` only if the user is verified, which you'll know from the `success` param.
 
 ###### Can I get the current wallet balance of the user?
 
@@ -105,29 +111,32 @@ HaptikLib has an inbuilt transaction history screen to which you can push the us
 Haptik class provides custom method to route to this screen:
 
 ```
-- (void)pushToTransactionHistoryFrom:(__kindof UIViewController *__weak)controller
-                          completion:(void(^)(BOOL success))completion;
+- (void)getTransactionHistoryFor:(__kindof UIViewController *__weak)controller
+                      completion:(void(^)(BOOL success, __kindof UIViewController *_Nullable transactionsVC))completion;
 ```
 
 Example:
 
 ```
-[[Haptik sharedSDK] pushToTransactionHistoryFrom:self
-                                      completion:^(BOOL success) {
-     if (success) {
-        NSLog(@"do housekeeping");
-     }
- }];
+[[Haptik sharedSDK] getTransactionHistoryFor:controller
+                                       completion:^(BOOL success, __kindof UIViewController * _Nullable transactionsVC) {
+
+            if (success) {
+                [controller.navigationController pushViewController:transactionsVC animated:YES];
+            }
+        }];
 ```
 
-> Just like the case with the `Haptik Wallet Screen`, the user should be a verified user (phone number of the user is verified) in order to see & use the `Transaction History` scene. If the user is not verified and this scene is pushed, HaptikLib takes the user through the verification flow. You don't have to do anything else for it.
+> Just like the case with the `Haptik Wallet Screen`, the user should be a verified user (phone number of the user is verified) in order to see & use the `Transaction History` scene. If the user is not verified and this scene is pushed, HaptikLib takes the user through the verification flow. You don't have to do anything else for it. You'll just get the `Transaction History VC` in the completion.
 
 **Discussion**
 
 - The `param`: `controller` requires the current controller from where this scene is to be pushed potentially. This controller is required for `HaptikLib` in order to handle the user verification flow.
 
-- In the `completion`, you get one parameter:
+- In the `completion`, you get two parameters:
+
+      	- `success`: Indicates whether the user is verified or not.
 
-    	- `success`: Indicates whether the user is verified or not.
+      	- `transactionsVC`: You'll get the instance of the `Transaction History VC` only if the user is verified, which you'll know from the `success` param.
 
 ---

Feature Guides/theming.md

@@ -4,16 +4,14 @@ title: Theming
 
 ## HaptikLib Theme Configurations
 
-`@import HaptikBase;`
-
 You can refer the Design Guidelines Document for HaptikLib to know what all theming it supports. To set the specific style guide HaptikLib gives another Public Class `HPThemeService` which also follows the builder pattern just like you did with `HPSignUpObject`.
 
 You have to set the instance of `HPThemeService` to the `themeConfig` property of Haptik Class to see its effects.
 
 Example:
 
 ```
-[HPConfiguration shared].themeConfig = [HPThemeService buildWithData:^(HPThemeServiceBuilder * _Nullable builder) {
+[Haptik sharedSDK].themeConfig = [HPThemeService buildWithData:^(HPThemeServiceBuilder * _Nullable builder) {
 
         builder.brandColor =                // UIColor object here
         builder.businessChatText =          // UIColor object here
@@ -46,7 +44,7 @@ If you wish to use your own font, pass all the required fonts in the builder, el
 HaptikLib does not control the Navigation Controller (hence the navigation bar), but the client does. HaptikLib only gives an instance of a `ViewController` that the client application pushes on their navigation stack. To configure that navigation bar of that navigationController (modify `tint color` and `barTintColor` of navigation bar of the SDK View Controllers), use the following helper method:
 
 ```
-[[HPConfiguration shared] configureNavigationBarWithTintColor:[UIColor redColor]
+[[Haptik sharedSDK] configureNavigationBarWithTintColor:[UIColor redColor]
                                             barTintColor:[UIColor whiteColor]
                                          makeTranslucent:YES
                                  forNavigationController:navController];