odoo-addon-mail-gateway-whatsapp 16.0.1.0.0.11__py3-none-any.whl → 16.0.1.1.0__py3-none-any.whl

odoo/addons/mail_gateway_whatsapp/tests/test_mail_whatsapp_template.py

@@ -0,0 +1,170 @@
+# Copyright 2024 Tecnativa - Carlos López
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import json
+from unittest.mock import patch
+
+import requests
+
+from odoo.exceptions import UserError
+from odoo.tests.common import tagged
+
+from odoo.addons.mail_gateway.tests.common import MailGatewayTestCase
+
+
+@tagged("-at_install", "post_install")
+class TestMailWhatsAppTemplate(MailGatewayTestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.gateway = cls.env["mail.gateway"].create(
+            {
+                "name": "gateway",
+                "gateway_type": "whatsapp",
+                "token": "token",
+                "whatsapp_security_key": "key",
+                "webhook_secret": "MY-SECRET",
+                "member_ids": [(4, cls.env.user.id)],
+            }
+        )
+        cls.new_template_response_data = {
+            "id": "018273645",
+            "status": "APPROVED",
+        }
+        cls.new_template_full_response_data = {
+            "name": "new_template",
+            "parameter_format": "POSITIONAL",
+            "components": [
+                {"type": "HEADER", "format": "TEXT", "text": "Header 1"},
+                {"type": "BODY", "text": "Body 1"},
+                {"type": "FOOTER", "text": "Footer changed"},
+            ],
+            "language": "es",
+            "status": "APPROVED",
+            "category": "MARKETING",
+            "id": "018273645",
+        }
+        cls.template_1_data = {
+            "name": "test_odoo_1",
+            "parameter_format": "POSITIONAL",
+            "components": [
+                {"type": "HEADER", "format": "TEXT", "text": "Header 1"},
+                {"type": "BODY", "text": "Body 1"},
+                {"type": "FOOTER", "text": "Footer 1"},
+            ],
+            "language": "es",
+            "status": "APPROVED",
+            "category": "MARKETING",
+            "id": "1234567890",
+        }
+        cls.template_2_data = {
+            "name": "test_with_buttons",
+            "parameter_format": "POSITIONAL",
+            "components": [
+                {"type": "HEADER", "format": "TEXT", "text": "Header 2"},
+                {"type": "BODY", "text": "Body 2"},
+                {
+                    "type": "BUTTONS",
+                    "buttons": [{"type": "QUICK_REPLY", "text": "Button 1"}],
+                },
+            ],
+            "language": "es",
+            "status": "APPROVED",
+            "category": "MARKETING",
+            "sub_category": "CUSTOM",
+            "id": "0987654321",
+        }
+        cls.templates_download = {
+            "data": [cls.template_1_data, cls.template_2_data],
+        }
+
+    def _make_meta_requests(self, url, json_data, status_code=200):
+        """
+        Simulate a fake request to the Meta API:
+        :param json_data: Dictionary with the json data to return
+        :param status_code: Status code expected
+        :returns requests.Response object
+        """
+        response = requests.Response()
+        response.status_code = status_code
+        response._content = json.dumps(json_data).encode()
+        response.url = url
+        response.headers["Content-Type"] = "application/json"
+        return response
+
+    def test_download_templates(self):
+        def _patch_request_post(url, *args, **kwargs):
+            if "message_templates" in url:
+                return self._make_meta_requests(url, self.templates_download)
+            return original_get(url, *args, **kwargs)
+
+        with self.assertRaisesRegex(
+            UserError, "WhatsApp Account is required to import templates"
+        ):
+            self.gateway.button_import_whatsapp_template()
+        self.gateway.whatsapp_account_id = "123456"
+        original_get = requests.get
+        with patch.object(requests, "get", _patch_request_post):
+            self.gateway.button_import_whatsapp_template()
+        self.assertEqual(self.gateway.whatsapp_template_count, 2)
+        template_1 = self.gateway.whatsapp_template_ids.filtered(
+            lambda t: t.template_uid == "1234567890"
+        )
+        self.assertTrue(template_1.is_supported)
+        self.assertEqual(template_1.template_name, "test_odoo_1")
+        self.assertEqual(template_1.category, "marketing")
+        self.assertEqual(template_1.language, "es")
+        self.assertEqual(template_1.state, "approved")
+        self.assertEqual(template_1.header, "Header 1")
+        self.assertEqual(template_1.body, "Body 1")
+        self.assertEqual(template_1.footer, "Footer 1")
+        template_2 = self.gateway.whatsapp_template_ids.filtered(
+            lambda t: t.template_uid == "0987654321"
+        )
+        self.assertFalse(template_2.is_supported)
+        self.assertEqual(template_2.template_name, "test_with_buttons")
+        self.assertEqual(template_2.category, "marketing")
+        self.assertEqual(template_2.language, "es")
+        self.assertEqual(template_2.state, "approved")
+        self.assertEqual(template_2.header, "Header 2")
+        self.assertEqual(template_2.body, "Body 2")
+        self.assertFalse(template_2.footer)
+        self.assertFalse(template_2.is_supported)
+
+    def test_export_template(self):
+        def _patch_request_post(url, *args, **kwargs):
+            if "message_templates" in url:
+                return self._make_meta_requests(url, self.new_template_response_data)
+            return original_post(url, *args, **kwargs)
+
+        def _patch_request_get(url, *args, **kwargs):
+            if "018273645" in url:
+                return self._make_meta_requests(
+                    url, self.new_template_full_response_data
+                )
+            return original_get(url, *args, **kwargs)
+
+        original_post = requests.post
+        original_get = requests.get
+        self.gateway.whatsapp_account_id = "123456"
+        new_template = self.env["mail.whatsapp.template"].create(
+            {
+                "name": "New template",
+                "category": "marketing",
+                "language": "es",
+                "header": "Header 1",
+                "body": "Body 1",
+                "gateway_id": self.gateway.id,
+            }
+        )
+        self.assertEqual(new_template.template_name, "new_template")
+        with patch.object(requests, "post", _patch_request_post):
+            new_template.button_export_template()
+        self.assertTrue(new_template.template_uid)
+        self.assertTrue(new_template.is_supported)
+        self.assertFalse(new_template.footer)
+        self.assertEqual(new_template.state, "approved")
+        # sync templates, footer should be updated
+        with patch.object(requests, "get", _patch_request_get):
+            new_template.button_sync_template()
+        self.assertEqual(new_template.footer, "Footer changed")

odoo/addons/mail_gateway_whatsapp/tools/__init__.py

@@ -0,0 +1 @@
+from . import const

odoo/addons/mail_gateway_whatsapp/tools/const.py

@@ -0,0 +1,75 @@
+# https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/supported-languages # noqa: B950
+# res.lang not matching with supported languages(iso codes)
+supported_languages = [
+    ("af", "Afrikaans"),
+    ("sq", "Albanian"),
+    ("ar", "Arabic"),
+    ("az", "Azerbaijani"),
+    ("bn", "Bengali"),
+    ("bg", "Bulgarian"),
+    ("ca", "Catalan"),
+    ("zh_CN", "Chinese (CHN)"),
+    ("zh_HK", "Chinese (HKG)"),
+    ("zh_TW", "Chinese (TAI)"),
+    ("hr", "Croatian"),
+    ("cs", "Czech"),
+    ("da", "Danish"),
+    ("nl", "Dutch"),
+    ("en", "English"),
+    ("en_GB", "English (UK)"),
+    ("en_US", "English (US)"),
+    ("et", "Estonian"),
+    ("fil", "Filipino"),
+    ("fi", "Finnish"),
+    ("fr", "French"),
+    ("ka", "Georgian"),
+    ("de", "German"),
+    ("el", "Greek"),
+    ("gu", "Gujarati"),
+    ("ha", "Hausa"),
+    ("he", "Hebrew"),
+    ("hi", "Hindi"),
+    ("hu", "Hungarian"),
+    ("id", "Indonesian"),
+    ("ga", "Irish"),
+    ("it", "Italian"),
+    ("ja", "Japanese"),
+    ("kn", "Kannada"),
+    ("kk", "Kazakh"),
+    ("rw_RW", "Kinyarwanda"),
+    ("ko", "Korean"),
+    ("ky_KG", "Kyrgyz (Kyrgyzstan)"),
+    ("lo", "Lao"),
+    ("lv", "Latvian"),
+    ("lt", "Lithuanian"),
+    ("mk", "Macedonian"),
+    ("ms", "Malay"),
+    ("ml", "Malayalam"),
+    ("mr", "Marathi"),
+    ("nb", "Norwegian"),
+    ("fa", "Persian"),
+    ("pl", "Polish"),
+    ("pt_BR", "Portuguese (BR)"),
+    ("pt_PT", "Portuguese (POR)"),
+    ("pa", "Punjabi"),
+    ("ro", "Romanian"),
+    ("ru", "Russian"),
+    ("sr", "Serbian"),
+    ("sk", "Slovak"),
+    ("sl", "Slovenian"),
+    ("es", "Spanish"),
+    ("es_AR", "Spanish (ARG)"),
+    ("es_ES", "Spanish (SPA)"),
+    ("es_MX", "Spanish (MEX)"),
+    ("sw", "Swahili"),
+    ("sv", "Swedish"),
+    ("ta", "Tamil"),
+    ("te", "Telugu"),
+    ("th", "Thai"),
+    ("tr", "Turkish"),
+    ("uk", "Ukrainian"),
+    ("ur", "Urdu"),
+    ("uz", "Uzbek"),
+    ("vi", "Vietnamese"),
+    ("zu", "Zulu"),
+]

odoo/addons/mail_gateway_whatsapp/views/mail_gateway.xml

@@ -7,7 +7,35 @@
         <field name="model">mail.gateway</field>
         <field name="inherit_id" ref="mail_gateway.mail_gateway_form_view" />
         <field name="arch" type="xml">
+            <xpath expr="//header" position="inside">
+                <button
+                    type="object"
+                    name="button_import_whatsapp_template"
+                    string="Download Templates"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                    icon="fa-download"
+                />
+            </xpath>
+            <xpath expr="//div[@name='button_box']" position="inside">
+                <button
+                    type="action"
+                    name="%(mail_gateway_whatsapp.action_mail_whatsapp_template_gateway)d"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                    class="oe_stat_button"
+                    icon="fa-whatsapp"
+                >
+                    <field
+                        name="whatsapp_template_count"
+                        string="Templates"
+                        widget="statinfo"
+                    />
+                </button>
+            </xpath>
             <field name="webhook_user_id" position="after">
+                <field
+                    name="whatsapp_account_id"
+                    attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"
+                />
                 <field
                     name="whatsapp_security_key"
                     attrs="{'invisible': [('gateway_type', '!=', 'whatsapp')]}"

odoo/addons/mail_gateway_whatsapp/views/mail_whatsapp_template_views.xml

@@ -0,0 +1,154 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+
+    <record id="view_mail_whatsapp_template_tree" model="ir.ui.view">
+        <field name="name">view.mail.whatsapp.template.tree</field>
+        <field name="model">mail.whatsapp.template</field>
+        <field name="arch" type="xml">
+            <tree decoration-danger="not is_supported and template_uid">
+                <field name="name" />
+                <field name="template_name" />
+                <field name="template_uid" optional="show" />
+                <field name="category" />
+                <field name="language" />
+                <field name="gateway_id" />
+                <field
+                    name="company_id"
+                    options="{'no_create': True}"
+                    groups="base.group_multi_company"
+                />
+                <field
+                    name="state"
+                    decoration-success="state == 'approved'"
+                    decoration-danger="state == 'rejected'"
+                    widget="badge"
+                />
+                <field name="is_supported" optional="show" />
+            </tree>
+        </field>
+    </record>
+
+    <record id="view_mail_whatsapp_template_form" model="ir.ui.view">
+        <field name="name">view.mail.whatsapp.template.form</field>
+        <field name="model">mail.whatsapp.template</field>
+        <field name="arch" type="xml">
+            <form>
+                <header>
+                    <button
+                        string="Export Template"
+                        name="button_export_template"
+                        type="object"
+                        class="oe_highlight"
+                        attrs="{'invisible': [('template_uid', '!=', False)]}"
+                    />
+                    <button
+                        string="Sync Template"
+                        name="button_sync_template"
+                        type="object"
+                        attrs="{'invisible': [('template_uid', '=', False)]}"
+                    />
+                    <button
+                        string="Back to draft"
+                        name="button_back2draft"
+                        type="object"
+                        attrs="{'invisible': [('state', '=', 'draft')]}"
+                    />
+                    <field
+                        name="state"
+                        widget="statusbar"
+                        statusbar_visible="draft,pending,approved"
+                    />
+                </header>
+                <div
+                    class="alert alert-danger"
+                    role="alert"
+                    attrs="{'invisible': ['|',('is_supported', '=', True), ('template_uid', '=', False)]}"
+                >
+                    This template is not supported because has <strong
+                    >variables</strong> or <strong>buttons</strong>.
+                  </div>
+                <sheet>
+                    <div class="oe_title">
+                        <label for="name" />
+                        <h1>
+                            <field
+                                name="name"
+                                placeholder="Name"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                        </h1>
+                    </div>
+                    <group>
+                        <group>
+                            <field
+                                name="gateway_id"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                                options="{'no_create': True}"
+                            />
+                            <field
+                                name="category"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                            <field
+                                name="language"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                        </group>
+                        <group>
+                            <field
+                                name="header"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                            <field
+                                name="footer"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                            <field name="template_name" />
+                            <field name="template_uid" />
+                            <field
+                                name="company_id"
+                                options="{'no_create': True}"
+                                groups="base.group_multi_company"
+                            />
+                            <field name="is_supported" invisible="1" />
+                        </group>
+                    </group>
+                    <notebook>
+                        <page name="body" string="Body">
+                            <field
+                                name="body"
+                                attrs="{'readonly': [('state', '!=', 'draft')]}"
+                            />
+                        </page>
+                    </notebook>
+                </sheet>
+            </form>
+        </field>
+    </record>
+
+    <record id="view_mail_whatsapp_template_search" model="ir.ui.view">
+        <field name="name">view.mail.whatsapp.template.search</field>
+        <field name="model">mail.whatsapp.template</field>
+        <field name="arch" type="xml">
+            <search>
+                <field name="name" />
+                <field name="gateway_id" />
+                <filter
+                    name="group_by_state"
+                    string="State"
+                    context="{'group_by': 'state'}"
+                />
+            </search>
+        </field>
+    </record>
+
+    <record id="action_mail_whatsapp_template_gateway" model="ir.actions.act_window">
+        <field name="name">WhatsApp Templates</field>
+        <field name="type">ir.actions.act_window</field>
+        <field name="res_model">mail.whatsapp.template</field>
+        <field name="view_mode">tree,form</field>
+        <field name="domain">[('gateway_id', '=', active_id)]</field>
+        <field name="context">{'default_gateway_id': active_id}</field>
+    </record>
+
+</odoo>

odoo/addons/mail_gateway_whatsapp/wizards/__init__.py

@@ -1 +1,2 @@
+from . import mail_compose_gateway_message
 from . import whatsapp_composer

odoo/addons/mail_gateway_whatsapp/wizards/mail_compose_gateway_message.py

@@ -0,0 +1,30 @@
+# Copyright 2024 Tecnativa - Carlos López
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import markupsafe
+
+from odoo import api, fields, models
+
+
+class MailComposeGatewayMessage(models.TransientModel):
+    _inherit = "mail.compose.gateway.message"
+
+    whatsapp_template_id = fields.Many2one(
+        "mail.whatsapp.template",
+        domain="""[
+            ('state', '=', 'approved'),
+            ('is_supported', '=', True)
+        ]""",
+    )
+
+    @api.onchange("whatsapp_template_id")
+    def onchange_whatsapp_template_id(self):
+        if self.whatsapp_template_id:
+            self.body = markupsafe.Markup(self.whatsapp_template_id.body)
+
+    def _action_send_mail(self, auto_commit=False):
+        if self.whatsapp_template_id:
+            self = self.with_context(whatsapp_template_id=self.whatsapp_template_id.id)
+        return super(MailComposeGatewayMessage, self)._action_send_mail(
+            auto_commit=auto_commit
+        )

odoo/addons/mail_gateway_whatsapp/wizards/mail_compose_gateway_message.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2024 Tecnativa - Carlos López
+     License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -->
+<odoo>
+
+    <record model="ir.ui.view" id="mail_compose_gateway_message_form_view">
+        <field name="model">mail.compose.gateway.message</field>
+        <field
+            name="inherit_id"
+            ref="mail_gateway.mail_compose_gateway_message_form_view"
+        />
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='wizard_channel_ids']" position="after">
+                <field
+                    name="whatsapp_template_id"
+                    options="{'no_create': True, 'no_open': True}"
+                />
+            </xpath>
+            <xpath expr="//field[@name='template_id']" position="attributes">
+                <attribute
+                    name="attrs"
+                >{'invisible': [('whatsapp_template_id', '!=', False)]}</attribute>
+            </xpath>
+            <xpath expr="//field[@name='attachment_ids']" position="attributes">
+                <attribute
+                    name="attrs"
+                >{'invisible': [('whatsapp_template_id', '!=', False)]}</attribute>
+            </xpath>
+        </field>
+    </record>
+</odoo>

odoo/addons/mail_gateway_whatsapp/wizards/whatsapp_composer.py

@@ -1,5 +1,7 @@
 # Copyright 2022 CreuBlanca
+# Copyright 2024 Tecnativa - Carlos López
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from datetime import datetime
 
 from odoo import _, api, fields, models
 from odoo.exceptions import UserError
@@ -17,7 +19,57 @@ class WhatsappComposer(models.TransientModel):
     gateway_id = fields.Many2one(
         "mail.gateway", domain=[("gateway_type", "=", "whatsapp")], required=True
     )
+    template_id = fields.Many2one(
+        "mail.whatsapp.template",
+        domain="""[
+            ('gateway_id', '=', gateway_id),
+            ('state', '=', 'approved'),
+            ('is_supported', '=', True)
+        ]""",
+    )
     body = fields.Text("Message")
+    is_required_template = fields.Boolean(compute="_compute_is_required_template")
+
+    @api.depends("res_model", "res_id", "number_field_name", "gateway_id")
+    def _compute_is_required_template(self):
+        MailMessage = self.env["mail.message"]
+        for wizard in self:
+            if (
+                not wizard.res_model
+                or not wizard.gateway_id
+                or not wizard.number_field_name
+            ):
+                wizard.is_required_template = False
+                continue
+            record = self.env[wizard.res_model].browse(wizard.res_id)
+            is_required_template = True
+            channel = record._whatsapp_get_channel(
+                wizard.number_field_name, wizard.gateway_id
+            )
+            if channel:
+                last_message = MailMessage.search(
+                    [
+                        ("gateway_type", "=", "whatsapp"),
+                        ("model", "=", channel._name),
+                        ("res_id", "=", channel.id),
+                    ],
+                    order="date desc",
+                    limit=1,
+                )
+                if last_message:
+                    delta = (datetime.now() - last_message.date).total_seconds() / 3600
+                    if delta < 24.0:
+                        is_required_template = False
+            wizard.is_required_template = is_required_template
+
+    @api.onchange("gateway_id")
+    def onchange_gateway_id(self):
+        self.template_id = False
+
+    @api.onchange("template_id")
+    def onchange_template_id(self):
+        if self.template_id:
+            self.body = self.template_id.body
 
     @api.model
     def default_get(self, fields):
@@ -33,7 +85,7 @@ class WhatsappComposer(models.TransientModel):
         if not record:
             return
         channel = record._whatsapp_get_channel(self.number_field_name, self.gateway_id)
-        channel.message_post(
+        channel.with_context(whatsapp_template_id=self.template_id.id).message_post(
             body=self.body, subtype_xmlid="mail.mt_comment", message_type="comment"
         )
 

odoo/addons/mail_gateway_whatsapp/wizards/whatsapp_composer.xml

@@ -13,11 +13,21 @@
                         name="gateway_id"
                         attrs="{'invisible': [('find_gateway', '=', False)]}"
                     />
+                    <field
+                        name="template_id"
+                        attrs="{'required': [('is_required_template', '=', True)]}"
+                        options="{'no_create': True, 'no_open': True}"
+                    />
                     <field name="find_gateway" invisible="1" />
                     <field name="res_model" invisible="1" />
                     <field name="res_id" invisible="1" />
                     <field name="number_field_name" invisible="1" />
-                    <field name="body" />
+                    <field name="is_required_template" invisible="1" />
+                    <field
+                        name="body"
+                        attrs="{'readonly': [('template_id', '!=', False)]}"
+                        force_save="1"
+                    />
                 </group>
                 <footer>
                     <button

{odoo_addon_mail_gateway_whatsapp-16.0.1.0.0.11.dist-info → odoo_addon_mail_gateway_whatsapp-16.0.1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: odoo-addon-mail_gateway_whatsapp
-Version: 16.0.1.0.0.11
+Version: 16.0.1.1.0
 Summary: Set a gateway for whatsapp
 Home-page: https://github.com/OCA/social
 Author: Creu Blanca, Dixmit, Odoo Community Association (OCA)
@@ -24,7 +24,7 @@ Mail Whatsapp Gateway
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:7e8914aa79754fb57cdfe774336f8ffe4c6784994839b64e09cf393ed7c2aa4a
+   !! source digest: sha256:70475641a2c7498a1ee67811eadb397e33c33435cdd2efb8edce729026ad09c4
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -79,6 +79,7 @@ In order to make it you must follow this steps:
 
   *  Use the Meta App authentication key as `Token` field
   *  Use the Meta App Phone Number ID as `Whatsapp from Phone` field
+  *  Use the Meta Account Business ID as `Whatsapp account` field (only if you need sync templates)
   *  Write your own `Webhook key`
   *  Use the Application Secret Key on `Whatsapp Security Key`. It will be used in order to validate the data
   *  Press the `Integrate Webhook Key`. In this case, it will not integrate it, we need to make it manually
@@ -96,6 +97,14 @@ Usage
 2. Wait until someone starts a conversation.
 3. Now you will be able to respond and receive messages to this person.
 
+Known issues / Roadmap
+======================
+
+**WhatsApp templates**
+
+*  Add support for `Variables`
+*  Add support for `Buttons`
+
 Bug Tracker
 ===========
 
@@ -120,6 +129,9 @@ Contributors
 
 * Olga Marco <olga.marco@creublanca.es>
 * Enric Tobella <etobella@creublanca.es>
+* `Tecnativa <https://www.tecnativa.com>`_:
+
+    * Carlos Lopez
 
 Other credits
 ~~~~~~~~~~~~~