[signups] adding support for creating listing and updating signups

Author: david-lev

README.md

@@ -20,7 +20,7 @@
   <a href="https://pywa.readthedocs.io"><img src="https://readthedocs.org/projects/pywa/badge/?version=latest&" alt="Docs"/></a>
   <a href="https://github.com/david-lev/pywa/blob/master/LICENSE"><img src="https://img.shields.io/github/license/david-lev/pywa?color=%2334D058" alt="License"/></a>
   <a href="https://www.codefactor.io/repository/github/david-lev/pywa/overview/master"><img src="https://www.codefactor.io/repository/github/david-lev/pywa/badge/master" alt="Code Quality"/></a>
-  <a href="https://t.me/py_wa"><img src="https://badges.aleen42.com/src/telegram.svg" /></a></p>
+  <a href="https://t.me/py_wa"><img src="https://badges.aleen42.com/src/telegram.svg"  alt="Updates"/></a></p>
 
 ---
 

.readthedocs.yaml docs/.readthedocs.yaml.readthedocs.yaml renamed to docs/.readthedocs.yaml

@@ -83,7 +83,10 @@ Client Reference
 .. automethod:: WhatsApp.get_current_username
 .. automethod:: WhatsApp.get_reserved_usernames
 .. automethod:: WhatsApp.delete_username
-.. automethod:: WhatsApp.delete_qr_code
+.. automethod:: WhatsApp.create_signup
+.. automethod:: WhatsApp.get_signup
+.. automethod:: WhatsApp.get_signups
+.. automethod:: WhatsApp.update_signup
 .. automethod:: WhatsApp.get_call_permissions
 .. automethod:: WhatsApp.pre_accept_call
 .. automethod:: WhatsApp.accept_call

docs/source/content/client/client_reference.rst

@@ -365,6 +365,23 @@ QR Codes
    * - :meth:`~WhatsApp.delete_qr_code`
      - Delete a QR code
 
+Signups
+--------
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.create_signup`
+     - Create a signup
+   * - :meth:`~WhatsApp.get_signup`
+     - Get details of a signup
+   * - :meth:`~WhatsApp.get_signups`
+     - List all signups
+   * - :meth:`~WhatsApp.update_signup`
+     - Update a signup
+
 
 Commerce
 --------

docs/source/content/client/overview.rst

@@ -57,6 +57,14 @@ Others
 
 .. autoclass:: QRCodeImageType()
 
+.. autoclass:: CreatedSignup()
+    :members:
+
+.. autoclass:: SignupDetails()
+    :members:
+
+.. autoclass:: SignupStatus()
+
 .. autoclass:: Command()
 
 .. autoclass:: CommerceSettings()

docs/source/content/types/others.rst

@@ -2856,3 +2856,131 @@ def delete_username(
             method="DELETE",
             endpoint=f"/{phone_id}/username",
         )
+
+    def create_signup(
+        self,
+        waba_id: str,
+        signup_message: str,
+        confirmation_message: str,
+        privacy_policy_url: str,
+        website_url: str | None = None,
+        promo_code: str | None = None,
+        display_name: str | None = None,
+        policy: dict[str, str | bool] | None = None,
+    ) -> dict:
+        """
+        Create a signup deep link.
+
+        - Read more at `developers.facebook.com <https://developers.facebook.com/documentation/business-messaging/whatsapp/in-app-signup#create-signup>`_.
+
+        Args:
+            waba_id: The ID of the WABA to create a signup for.
+            signup_message: The description shown on the pre-consent screen when a WhatsApp user opens the deep link. Supports WhatsApp formatting. Must be 1-300 characters.
+            confirmation_message: The message sent to the WhatsApp user immediately after a successful opt-in. Can contain the {{promo_code}} placeholder, which is replaced with the promo_code value in the delivered message. Must be 1-300 characters.
+            privacy_policy_url: A link to your privacy policy. Must start with http:// or https://. Immutable after creation.
+            website_url: Your business website URL. Must start with https://.
+            promo_code: A promotional code value. Must contain only alphanumeric characters (letters and numbers) and be 1-50 characters. Replaces {{promo_code}} in the confirmation message.
+            display_name: A business-facing nickname for the signup link. Not shown to WhatsApp users. Must be 1-256 characters.
+            policy: The policy object with "tos" and "accepted" fields.
+
+        Returns:
+            A dictionary containing the ID of the created signup.
+        """
+        return self._request(
+            method="POST",
+            endpoint=f"/{waba_id}/signups",
+            json=self._filter_none(
+                signup_message=signup_message,
+                confirmation_message=confirmation_message,
+                privacy_policy_url=privacy_policy_url,
+                website_url=website_url,
+                promo_code=promo_code,
+                display_name=display_name,
+                policy=policy,
+            ),
+        )
+
+    def get_signups(
+        self,
+        waba_id: str,
+        fields: tuple[str, ...] | None = None,
+        pagination: dict[str, str] | None = None,
+    ) -> dict:
+        """
+        List signup deep links for a WABA.
+
+        - Read more at `developers.facebook.com <https://developers.facebook.com/documentation/business-messaging/whatsapp/in-app-signup#list-signups>`_.
+
+        Args:
+            waba_id: The ID of the WABA to list signups for.
+            fields: Fields to retrieve.
+            pagination: Pagination parameters.
+
+        Returns:
+            A dictionary containing the list of signup deep links.
+        """
+        return self._request(
+            method="GET",
+            endpoint=f"/{waba_id}/signups",
+            params=self._filter_none(pagination, fields=self._join_fields(fields)),
+        )
+
+    def get_signup(
+        self,
+        signup_id: str,
+    ) -> dict:
+        """
+        Get a signup deep link.
+
+        - Read more at `developers.facebook.com <https://developers.facebook.com/documentation/business-messaging/whatsapp/in-app-signup#get-signup-details>`_.
+
+        Args:
+            signup_id: The ID of the signup deep link.
+
+        Returns:
+            A dictionary containing the signup deep link.
+        """
+        return self._request(
+            method="GET",
+            endpoint=f"/signups/{signup_id}",
+        )
+
+    def update_signup(
+        self,
+        signup_id: str,
+        status: str | None = None,
+        signup_message: str | None = None,
+        confirmation_message: str | None = None,
+        website_url: str | None = None,
+        promo_code: str | None = None,
+        display_name: str | None = None,
+    ) -> dict:
+        """
+        Update a signup deep link.
+
+        - Read more at `developers.facebook.com <https://developers.facebook.com/documentation/business-messaging/whatsapp/in-app-signup#get-signup-details>`_.
+
+        Args:
+            signup_id: The ID of the signup deep link.
+            status: Updated status: ACTIVE or DISABLED.
+            signup_message: The description shown on the pre-consent screen when a WhatsApp user opens the deep link. Supports WhatsApp formatting. Must be 1-300 characters.
+            confirmation_message: The message sent to the WhatsApp user immediately after a successful opt-in. Can contain the {{promo_code}} placeholder, which is replaced with the promo_code value in the delivered message. Must be 1-300 characters.
+            website_url: Your business website URL. Must start with https://.
+            promo_code: A promotional code value. Must contain only alphanumeric characters (letters and numbers) and be 1-50 characters. Replaces {{promo_code}} in the confirmation message.
+            display_name: A business-facing nickname for the signup link. Not shown to WhatsApp users. Must be 1-256 characters.
+
+        Returns:
+            A dictionary containing the ID of the updated signup.
+        """
+        return self._request(
+            method="POST",
+            endpoint=f"/signups/{signup_id}",
+            json=self._filter_none(
+                status=status,
+                signup_message=signup_message,
+                confirmation_message=confirmation_message,
+                website_url=website_url,
+                promo_code=promo_code,
+                display_name=display_name,
+            ),
+        )