[user_preferences] adding support for signups

Author: david-lev

pywa/filters.py

@@ -1026,12 +1026,12 @@ def failed_with(
 """Filter for user marketing preferences updates."""
 
 user_marketing_preferences_stop = new(
-    lambda _, m: bool(m),
+    lambda _, m: not bool(m),
     name="user_marketing_preferences_stop",
 )
 """Filter for user marketing preferences updates that indicate the user has requested to stop receiving marketing messages."""
 user_marketing_preferences_resume = new(
-    lambda _, m: not bool(m),
+    lambda _, m: bool(m),
     name="user_marketing_preferences_resume",
 )
 """Filter for user marketing preferences updates that indicate the user has requested to resume receiving marketing messages."""

pywa/server.py

@@ -21,7 +21,6 @@
 if TYPE_CHECKING:
     from .client import WhatsApp
 
-
 _MESSAGE_TYPES: dict[MessageType, type[handlers.Handler]] = {
     MessageType.BUTTON: handlers.CallbackButtonHandler,
     MessageType.EDIT: handlers.EditedMessageHandler,
@@ -33,22 +32,25 @@
 }
 _SYSTEM_TYPES: dict[SystemType | str, type[handlers.Handler]] = {
     SystemType.USER_CHANGED_NUMBER: handlers.PhoneNumberChangeHandler,
-    SystemType.USER_CHANGED_USER_ID: handlers.PhoneNumberChangeHandler,  # That's the new system message type for phone number changes, according to BSUID documentation
-    "customer_changed_number": handlers.PhoneNumberChangeHandler,  # https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object
+    SystemType.USER_CHANGED_USER_ID: handlers.PhoneNumberChangeHandler,
+    # That's the new system message type for phone number changes, according to BSUID documentation
+    "customer_changed_number": handlers.PhoneNumberChangeHandler,
+    # https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object
     SystemType.CUSTOMER_IDENTITY_CHANGED: handlers.IdentityChangeHandler,
 }
 _INTERACTIVE_TYPES: dict[str, type[handlers.Handler]] = {
     "button_reply": handlers.CallbackButtonHandler,
     "list_reply": handlers.CallbackSelectionHandler,
-    "nfm_reply": handlers.FlowCompletionHandler,
     "call_permission_reply": handlers.CallPermissionUpdateHandler,
 }
+_NFM_REPLY_TYPES: dict[str, type[handlers.Handler]] = {
+    "flow": handlers.FlowCompletionHandler,
+}
 _CALL_EVENTS: dict[str, type[handlers.Handler]] = {
     "connect": handlers.CallConnectHandler,
     "terminate": handlers.CallTerminateHandler,
 }
 
-
 _logger = logging.getLogger(__name__)
 
 MAX_PROCESSED_UPDATES = 100_000
@@ -567,12 +569,14 @@ def _handle_messages_field(
         if msg_type == MessageType.INTERACTIVE:
             try:
                 interactive_type = value["messages"][0]["interactive"]["type"]
-            except (
-                KeyError
-            ):  # value with errors, when a user tries to send the interactive msg again
+            except KeyError:  # value has `errors`, when a user tries to send the interactive msg again
                 return handlers.MessageHandler
             if (handler := _INTERACTIVE_TYPES.get(interactive_type)) is not None:
                 return handler
+            if interactive_type == "nfm_reply":
+                return _NFM_REPLY_TYPES.get(
+                    value["messages"][0]["interactive"]["nfm_reply"]["name"]
+                )
             _logger.warning(
                 "Webhook ('%s'): Unknown interactive message type: %s. Falling back to MessageHandler.",
                 wa._webhook_endpoint,

pywa/types/user_preferences.py

@@ -37,11 +37,13 @@ class UserMarketingPreferences(BaseUserUpdate):
         value: The marketing preference chosen by the user, either ``stop`` or ``resume``.
         detail: A description of the marketing preference change (e.g. `User requested to stop marketing messages`).
         category: The category of the user preference, which is always ``marketing_messages``.
+        signup_id: The signup id the user click on.
     """
 
     value: MarketingPreference
     detail: str
     category: UserPreferenceCategory
+    signup_id: str | None
 
     _webhook_field = "user_preferences"
 
@@ -70,6 +72,7 @@ def from_update(
             value=MarketingPreference(prefs["value"]),
             detail=prefs["detail"],
             category=UserPreferenceCategory(prefs["category"]),
+            signup_id=prefs.get("signup_id"),
         )
 
     def __bool__(self):
@@ -84,13 +87,15 @@ class MarketingPreference(helpers.StrEnum):
     Attributes:
         STOP: The user has requested to stop receiving marketing messages.
         RESUME: The user has requested to resume receiving marketing messages.
+        SIGNUP: The user signed up via signup link.
     """
 
     _check_value = str.islower
     _modify_value = str.lower
 
     STOP = "stop"
     RESUME = "resume"
+    SIGNUP = "signup"
 
     UNKNOWN = "UNKNOWN"
 

pywa_async/types/user_preferences.py

@@ -13,7 +13,6 @@
     UserMarketingPreferences as _UserMarketingPreferences,
 )  # noqa MUST BE IMPORTED FIRST
 
-
 from .base_update import BaseUserUpdateAsync  # noqa
 
 
@@ -31,4 +30,5 @@ class UserMarketingPreferences(BaseUserUpdateAsync, _UserMarketingPreferences):
         value: The marketing preference chosen by the user, either ``stop`` or ``resume``.
         detail: A description of the marketing preference change (e.g. `User requested to stop marketing messages`).
         category: The category of the user preference, which is always ``marketing_messages``.
+        signup_id: The signup id the user click on.
     """

tests/data/updates/user_marketing_preferences.json

@@ -37,5 +37,45 @@
         ]
       }
     ]
+  },
+  "signup": {
+    "object": "whatsapp_business_account",
+    "entry": [
+      {
+        "id": "102290129340398",
+        "changes": [
+          {
+            "value": {
+              "messaging_product": "whatsapp",
+              "metadata": {
+                "display_phone_number": "15550783881",
+                "phone_number_id": "106540352242922"
+              },
+              "contacts": [
+                {
+                  "profile": {
+                    "name": "Test Name"
+                  },
+                  "wa_id": "972987654321",
+                  "user_id": "US.13491208655302741918",
+                  "parent_user_id": "US.ENT.11815799212886844830"
+                }
+              ],
+              "user_preferences": [
+                {
+                  "wa_id": "16505551234",
+                  "detail": "User signed up via signup link",
+                  "category": "marketing_messages",
+                  "value": "signup",
+                  "signup_id": "13176843987434774",
+                  "timestamp": 1731705721
+                }
+              ]
+            },
+            "field": "user_preferences"
+          }
+        ]
+      }
+    ]
   }
 }

tests/test_updates.py

@@ -162,6 +162,7 @@
     },
     "user_marketing_preferences": {
         "resume": [lambda u: u.value == MarketingPreference.RESUME],
+        "signup": [lambda u: u.value == MarketingPreference.SIGNUP],
     },
     "account_update": {
         "account_deleted": [],