Phone number and SMS subscription APIs

CHANGELOG.md

@@ -2,16 +2,20 @@ UPCOMING
 ----
 
 **Plugin**
-
+* Updated Batch to 2.1
+* Batch requires iOS 13.0 or higher.
+* Batch requires to compile with SDK 35 (Android 15).
 * Added support for React-Native [New Architecture](https://reactnative.dev/docs/the-new-architecture/landing-page) Turbo Module. This requires React-Native 0.71+ when running with new architecture enabled, as Codegen and Turbo Module are fully supported. Batch is still backwards compatible with legacy Native Modules.
 
-**Push**
+**Expo**
+* Batch now automatically adds Apple push notification entitlement since it was removed from Expo SDK 51.
 
+**Push**
 * Removed deprecated API `registerForRemoteNotifications`. Please use `requestNotificationAuthorization` to request permission when needed, and `requestToken` at each app launch.
 
-**Expo**
-
-* Batch now automatically adds Apple push notification entitlement since it was removed from Expo SDK 51.
+**Profile**
+- Added `setPhoneNumber` API to the `BatchProfileAttributeEditor` class. This requires to have a user identifier registered or to call the `identify` method beforehand.
+- Added `setSMSMarketingSubscription` API to the `BatchProfileAttributeEditor` class.
 
 
 9.0.2

RNBatchPush.podspec

@@ -15,6 +15,6 @@ Pod::Spec.new do |s|
   install_modules_dependencies(s)
 
   s.dependency "React"
-  s.dependency 'Batch', '~> 2.0.0'
+  s.dependency 'Batch', '~> 2.1.0'
 
 end

android/build.gradle

@@ -2,7 +2,7 @@ def DEFAULT_MIN_SDK_VERSION                 = 21
 def DEFAULT_COMPILE_SDK_VERSION             = 34
 def DEFAULT_BUILD_TOOLS_VERSION             = "34.0.0"
 def DEFAULT_TARGET_SDK_VERSION              = 34
-def DEFAULT_BATCH_SDK_VERSION               = "2.0.+"
+def DEFAULT_BATCH_SDK_VERSION               = "2.1.+"
 
 def safeExtGet(prop, fallback) {
     rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback

android/src/main/java/com/batch/batch_rn/RNBatchModuleImpl.java

@@ -23,6 +23,7 @@
 import com.batch.android.BatchPushRegistration;
 import com.batch.android.BatchTagCollectionsFetchListener;
 import com.batch.android.BatchEmailSubscriptionState;
+import com.batch.android.BatchSMSSubscriptionState;
 import com.batch.android.BatchUserAttribute;
 import com.batch.android.PushNotificationType;
 import com.batch.android.BatchInboxFetcher;
@@ -654,6 +655,17 @@ public void profile_saveEditor(ReadableArray actions) {
             } else if (type.equals("setEmailMarketingSubscription")) {
                 String value = action.getString("value");
                 editor.setEmailMarketingSubscription(BatchEmailSubscriptionState.valueOf(value));
+            } else if (type.equals("setPhoneNumber")) {
+                ReadableType valueType = action.getType("value");
+                if (valueType.equals(ReadableType.Null)) {
+                    editor.setPhoneNumber(null);
+                } else {
+                    String value = action.getString("value");
+                    editor.setPhoneNumber(value);
+                }
+            } else if (type.equals("setSMSMarketingSubscription")) {
+                String value = action.getString("value");
+                editor.setSMSMarketingSubscription(BatchSMSSubscriptionState.valueOf(value));
             } else if (type.equals("setLanguage")) {
                 ReadableType valueType = action.getType("value");
                 if (valueType.equals(ReadableType.Null)) {

ios/RNBatch.mm

@@ -583,6 +583,19 @@ - (BatchEventAttributes*) convertSerializedEventDataToEventAttributes:(NSDiction
             }
         }
 
+        else if([type isEqualToString:@"setPhoneNumber"]) {
+            [editor setPhoneNumber:[self safeNilValue:action[@"value"]] error:nil];
+        }
+
+        else if([type isEqualToString:@"setSMSMarketingSubscription"]) {
+            NSString* value = action[@"value"];
+            if([value isEqualToString:@"SUBSCRIBED"]) {
+                [editor setSMSMarketingSubscriptionState:BatchSMSSubscriptionStateSubscribed];
+            } else if ([value isEqualToString:@"UNSUBSCRIBED"]) {
+                 [editor setSMSMarketingSubscriptionState: BatchSMSSubscriptionStateUnsubscribed];
+            }
+        }
+
         else if([type isEqualToString:@"setLanguage"]) {
             [editor setLanguage:[self safeNilValue:action[@"value"]] error:nil];
         }

src/BatchProfileAttributeEditor.ts

@@ -8,6 +8,14 @@ export enum BatchEmailSubscriptionState {
   UNSUBSCRIBED = 'UNSUBSCRIBED',
 }
 
+/**
+ * Enum defining the state of an SMS subscription
+ */
+export enum BatchSMSSubscriptionState {
+  SUBSCRIBED = 'SUBSCRIBED',
+  UNSUBSCRIBED = 'UNSUBSCRIBED',
+}
+
 interface IUserSettingsSetAttributeAction {
   type: 'setAttribute';
   key: string;
@@ -51,6 +59,16 @@ interface IUserSettingsSetEmailMarketingSubscriptionAction {
   value: BatchEmailSubscriptionState;
 }
 
+interface IUserSettingsSetPhoneNumberAction {
+  type: 'setPhoneNumber';
+  value: string | null;
+}
+
+interface IUserSettingsSetSMSMarketingSubscriptionAction {
+  type: 'setSMSMarketingSubscription';
+  value: BatchSMSSubscriptionState;
+}
+
 interface IUserSettingsAddToArrayAction {
   type: 'addToArray';
   key: string;
@@ -73,12 +91,14 @@ type IUserSettingsAction =
   | IUserSettingsAddToArrayAction
   | IUserSettingsRemoveFromArrayAction
   | IUserSettingsSetEmailAddressAction
-  | IUserSettingsSetEmailMarketingSubscriptionAction;
+  | IUserSettingsSetEmailMarketingSubscriptionAction
+  | IUserSettingsSetPhoneNumberAction
+  | IUserSettingsSetSMSMarketingSubscriptionAction;
 
 type IUserSettingsActions = IUserSettingsAction[];
 
 /**
- * Editor class used to create and save user tags and attributes
+ * Editor class used to create and save profile attributes
  */
 export class BatchProfileAttributeEditor {
   private _settings: IUserSettingsActions;
@@ -92,6 +112,12 @@ export class BatchProfileAttributeEditor {
     return this;
   }
 
+  /**
+   * Set an attribute for a key
+   * @param key Attribute key. Cannot be null, empty or undefined. It should be made of letters, numbers or underscores
+   * ([a-z0-9_]) and can't be longer than 30 characters.
+   * @param value Attribute value. Accepted types are strings, numbers, booleans and array of strings.
+   */
   public setAttribute(key: string, value: string | boolean | number | string[] | null): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setAttribute',
@@ -100,6 +126,19 @@ export class BatchProfileAttributeEditor {
     });
   }
 
+  /**
+   * Set a Date attribute for a key
+   *
+   * @param key Attribute key. Cannot be null, empty or undefined. It should be made of letters, numbers or underscores
+   * ([a-z0-9_]) and can't be longer than 30 characters.
+   * @param value The date value
+   *
+   * Example:
+   * ```js
+   *  // Set a date attribute with a timestamp
+   *  BatchProfile.editor().setDateAttribute("birthday", new Date('July 20, 69 00:20:18 GMT+00:00').getTime())
+   * ```
+   */
   public setDateAttribute(key: string, value: number): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setDateAttribute',
@@ -108,6 +147,19 @@ export class BatchProfileAttributeEditor {
     });
   }
 
+  /**
+   * Set an URL attribute for a key
+   *
+   * @param key Attribute key. Cannot be null, empty or undefined. It should be made of letters, numbers or underscores
+   * ([a-z0-9_]) and can't be longer than 30 characters.
+   * @param value The URL value
+   *
+   * Example:
+   * ```js
+   *  // set an url attribute
+   *  BatchProfile.editor().setURLAttribute('website', 'https://example.com')
+   * ```
+   */
   public setURLAttribute(key: string, value: string): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setURLAttribute',
@@ -116,41 +168,104 @@ export class BatchProfileAttributeEditor {
     });
   }
 
+  /**
+   * Remove an attribute
+   * @param key The key of the attribute to remove
+   */
   public removeAttribute(key: string): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'removeAttribute',
       key,
     });
   }
 
+  /**
+   * Set the profile email address.
+   *
+   * This requires to have a custom user ID registered
+   * or to call the `setIdentifier` method on the editor instance beforehand.
+   * @param value A valid email address. Null to erase.
+   */
   public setEmailAddress(value: string | null): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setEmailAddress',
       value,
     });
   }
 
+  /**
+   * Set the profile email marketing subscription state
+   *
+   * @param value The state of the marketing email subscription. Must be "subscribed" or "unsubscribed".
+   */
   public setEmailMarketingSubscription(value: BatchEmailSubscriptionState): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setEmailMarketingSubscription',
       value,
     });
   }
 
+  /**
+   * Set the profile phone number.
+   *
+   * This requires to have a custom profile ID registered or to call the `identify` method beforehand.
+   * @param value  A valid E.164 formatted string. Must start with a `+` and not be longer than 15 digits
+   * without special characters (eg: "+33123456789"). Null to reset.
+   */
+  public setPhoneNumber(value: string | null): BatchProfileAttributeEditor {
+    return this.addAction({
+      type: 'setPhoneNumber',
+      value,
+    });
+  }
+
+  /**
+   * Set the profile SMS marketing subscription state.
+   *
+   * Note that profile's subscription status is automatically set to unsubscribed when users send a STOP message.
+   * @param value The state of the SMS marketing subscription. Must be "subscribed" or "unsubscribed".
+   */
+  public setSMSMarketingSubscription(value: BatchSMSSubscriptionState): BatchProfileAttributeEditor {
+    return this.addAction({
+      type: 'setSMSMarketingSubscription',
+      value,
+    });
+  }
+
+  /**
+   * Set the application language. Overrides Batch's automatically detected language.
+   *
+   * Send null to let Batch autodetect it again.
+   * @param value Language code. 2 chars minimum, or null
+   */
   public setLanguage(value: string | null): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setLanguage',
       value,
     });
   }
 
+  /**
+   * Set the application region. Overrides Batch's automatically detected region.
+   *
+   * Send "null" to let Batch autodetect it again.
+   * @param value Region code. 2 chars minimum, or null
+   */
   public setRegion(value: string | null): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'setRegion',
       value,
     });
   }
 
+  /**
+   * Add value to an array attribute. If the array doesn't exist it will be created.
+   *
+   * @param key Attribute key. Cannot be null, empty or undefined. It should be made of letters, numbers or underscores
+   * ([a-z0-9_]) and can't be longer than 30 characters.
+   * @param value The value to add. Cannot be null, undefined or empty. Must be an array of string or a string no longer
+   * than 64 characters.
+   */
   public addToArray(key: string, value: string | string[]): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'addToArray',
@@ -159,6 +274,13 @@ export class BatchProfileAttributeEditor {
     });
   }
 
+  /**
+   * Remove a value from an array attribute.
+   *
+   * @param key Attribute key. Cannot be null, empty or undefined. It should be made of letters, numbers or underscores
+   * ([a-z0-9_]) and can't be longer than 30 characters.
+   * @param value The value to remove. Can be a String or an Array of String. Cannot be null, empty or undefined.
+   */
   public removeFromArray(key: string, value: string | string[]): BatchProfileAttributeEditor {
     return this.addAction({
       type: 'removeFromArray',
@@ -167,6 +289,9 @@ export class BatchProfileAttributeEditor {
     });
   }
 
+  /**
+   * Save all the pending changes made in that editor. This action cannot be undone.
+   */
   public save(): void {
     RNBatch.profile_saveEditor(this._settings);
   }