Adds in updateSubscriptions functionality (#42)

* Adds in updateSubscriptions functionality

* code review fixes

* update documentation

Author: davidtruong

Artifacts/include/Iterable-iOS-SDK/IterableAPI.h

@@ -445,6 +445,17 @@ typedef NS_ENUM(NSInteger, PushServicePlatform) {
  */
 - (void)track:(NSString *)eventName dataFields:(nullable NSDictionary *)dataFields onSuccess:(OnSuccessHandler)onSuccess onFailure:(OnFailureHandler)onFailure;
 
+/*!
+ @method
+ 
+ @abstract Updates a user's subscription preferences
+ 
+ @param emailListIds                Email lists to subscribe to
+ @param unsubscribedChannelIds      List of channels to unsubscribe from
+ @param unsubscribedMessageTypeIds  List of message types to unsubscribe from
+ */
+- (void)updateSubscriptions:(nullable NSArray *)emailListIds unsubscribedChannelIds:(nullable NSArray *)unsubscribedChannelIds unsubscribedMessageTypeIds:(nullable NSArray *)unsubscribedMessageTypeIds;
+
 /////////////////////////
 /// @name In-App Notifications
 /////////////////////////

Iterable-iOS-SDK/IterableAPI.h

@@ -445,6 +445,19 @@ typedef NS_ENUM(NSInteger, PushServicePlatform) {
  */
 - (void)track:(NSString *)eventName dataFields:(nullable NSDictionary *)dataFields onSuccess:(OnSuccessHandler)onSuccess onFailure:(OnFailureHandler)onFailure;
 
+/*!
+ @method
+ 
+ @abstract Updates a user's subscription preferences
+ 
+ @param emailListIds                Email lists to subscribe to
+ @param unsubscribedChannelIds      List of channels to unsubscribe from
+ @param unsubscribedMessageTypeIds  List of message types to unsubscribe from
+ 
+ @discussion passing in an empty array will clear subscription list, passing in nil will not modify the list
+ */
+- (void)updateSubscriptions:(nullable NSArray *)emailListIds unsubscribedChannelIds:(nullable NSArray *)unsubscribedChannelIds unsubscribedMessageTypeIds:(nullable NSArray *)unsubscribedMessageTypeIds;
+
 /////////////////////////
 /// @name In-App Notifications
 /////////////////////////

Iterable-iOS-SDK/IterableAPI.m

@@ -860,6 +860,21 @@ - (void)trackPurchase:(NSNumber *)total items:(NSArray<CommerceItem *> *)items d
     [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];
 }
 
+// documented in IterableAPI.h
+- (void)updateSubscriptions:(NSArray *)emailListIds unsubscribedChannelIds:(NSArray *)unsubscribedChannelIds unsubscribedMessageTypeIds:(NSArray *)unsubscribedMessageTypeIds
+{
+    NSMutableDictionary *mutableDictionary = [[NSMutableDictionary alloc] init];
+    
+    [self addEmailOrUserIdToDictionary:mutableDictionary];
+    
+    [self tryAddValueToMutableDictionary:mutableDictionary key:ITBL_KEY_EMAIL_LIST_IDS value:emailListIds];
+    [self tryAddValueToMutableDictionary:mutableDictionary key:ITBL_KEY_UNSUB_CHANNEL value:unsubscribedChannelIds];
+    [self tryAddValueToMutableDictionary:mutableDictionary key:ITBL_KEY_UNSUB_MESSAGE value:unsubscribedMessageTypeIds];
+
+    NSURLRequest *request = [self createRequestForAction:ENDPOINT_UPDATE_SUBSCRIPTIONS withArgs:mutableDictionary];
+    [self sendRequest:request onSuccess:[IterableAPI defaultOnSuccess:@"updateSubscriptions"] onFailure:[IterableAPI defaultOnFailure:@"updateSubscriptions"]];
+}
+
 // documented in IterableAPI.h
 - (void)spawnInAppNotification:(ITEActionBlock)callbackBlock
 {
@@ -937,4 +952,40 @@ -(void) showSystemNotification:(NSString *)title body:(NSString *)body buttonLef
     [IterableInAppManager showSystemNotification:title body:body buttonLeft:buttonLeft buttonRight:buttonRight  callbackBlock:callbackBlock];
 }
 
+/*!
+ @method
+ 
+ @abstract Helper function to add the email or userId to the dictionary
+ 
+ @param mutableDictionary  the dictionary
+ 
+ */
+- (void)addEmailOrUserIdToDictionary:(NSMutableDictionary *) mutableDictionary
+{
+    if (mutableDictionary != nil) {
+        if (self.email != nil) {
+            [self tryAddValueToMutableDictionary:mutableDictionary key:ITBL_KEY_EMAIL value:self.email];
+        } else {
+            if (self.userId != nil) {
+                [self tryAddValueToMutableDictionary:mutableDictionary key:ITBL_KEY_USER_ID value:self.userId];
+            }
+        }
+    }
+}
+
+/*!
+ @method
+ 
+ @abstract Helper function to add a kvp to a dictionary
+ 
+ @param callbackBlock  Callback ITEActionBlock
+ 
+ */
+- (void)tryAddValueToMutableDictionary:(NSMutableDictionary *)mutableDictionary key:(NSString *)key value:(NSObject *)value
+{
+    if (mutableDictionary != nil && value != nil && key != nil) {
+        [mutableDictionary setObject:value forKey:key];
+    }
+}
+
 @end

Iterable-iOS-SDK/IterableConstants.h

@@ -17,6 +17,7 @@ extern NSString *const ITBL_KEY_CURRENT_EMAIL;
 extern NSString *const ITBL_KEY_DATA_FIELDS;
 extern NSString *const ITBL_KEY_DEVICE;
 extern NSString *const ITBL_KEY_EMAIL;
+extern NSString *const ITBL_KEY_EMAIL_LIST_IDS;
 extern NSString *const ITBL_KEY_EVENT_NAME;
 extern NSString *const ITBL_KEY_ITEMS;
 extern NSString *const ITBL_KEY_MERGE_NESTED;
@@ -29,6 +30,8 @@ extern NSString *const ITBL_KEY_SEND_AT;
 extern NSString *const ITBL_KEY_TOKEN;
 extern NSString *const ITBL_KEY_TEMPLATE_ID;
 extern NSString *const ITBL_KEY_TOTAL;
+extern NSString *const ITBL_KEY_UNSUB_CHANNEL;
+extern NSString *const ITBL_KEY_UNSUB_MESSAGE;
 extern NSString *const ITBL_KEY_USER;
 extern NSString *const ITBL_KEY_USER_ID;
 
@@ -53,8 +56,9 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 #define ENDPOINT_TRACK_INAPP_CLICK @"events/trackInAppClick"
 #define ENDPOINT_TRACK_INAPP_OPEN @"events/trackInAppOpen"
 #define ENDPOINT_TRACK_PUSH_OPEN @"events/trackPushOpen"
-#define ENDPOINT_UPDATE_EMAIL @"users/updateEmail"
 #define ENDPOINT_UPDATE_USER @"users/update"
+#define ENDPOINT_UPDATE_EMAIL @"users/updateEmail"
+#define ENDPOINT_UPDATE_SUBSCRIPTIONS @"users/updateSubscriptions"
 
 //MISC
 #define ITBL_KEY_GET @"GET"

Iterable-iOS-SDK/IterableConstants.m

@@ -19,6 +19,7 @@ @implementation IterableConstants : NSObject
 NSString *const ITBL_KEY_DATA_FIELDS         = @"dataFields";
 NSString *const ITBL_KEY_DEVICE              = @"device";
 NSString *const ITBL_KEY_EMAIL               = @"email";
+NSString *const ITBL_KEY_EMAIL_LIST_IDS      = @"emailListIds";
 NSString *const ITBL_KEY_EVENT_NAME          = @"eventName";
 NSString *const ITBL_KEY_INAPP_DISPLAY       = @"inAppDisplaySettings";
 NSString *const ITBL_KEY_ITEMS               = @"items";
@@ -32,6 +33,8 @@ @implementation IterableConstants : NSObject
 NSString *const ITBL_KEY_TOKEN               = @"token";
 NSString *const ITBL_KEY_TEMPLATE_ID         = @"templateId";
 NSString *const ITBL_KEY_TOTAL               = @"total";
+NSString *const ITBL_KEY_UNSUB_CHANNEL       = @"unsubscribedChannelIds";
+NSString *const ITBL_KEY_UNSUB_MESSAGE       = @"unsubscribedMessageTypeIds";
 NSString *const ITBL_KEY_USER                = @"user";
 NSString *const ITBL_KEY_USER_ID             = @"userId";