Add delete whatsapp template (#72)

* Added new delete template method

* Updated whatsapp tests

Author: dlozina

infobip_channels/core/channel.py

@@ -7,10 +7,12 @@
 from infobip_channels.core.http_client import _HttpClient
 from infobip_channels.core.models import (
     Authentication,
+    DeleteHeaders,
     GetHeaders,
     MessageBodyBase,
     PathParameter,
     PostHeaders,
+    PutHeaders,
     QueryParameter,
     ResponseBase,
 )
@@ -105,6 +107,16 @@ def build_post_request_headers(api_key: str) -> Dict:
         """
         return PostHeaders(authorization=api_key).dict(by_alias=True)
 
+    @staticmethod
+    def build_put_request_headers(api_key: str) -> Dict:
+        """Build the request headers dictionary which has to be used for each of the
+        put requests.
+
+        :param api_key: Key used for populating Authorization header
+        :return: Dictionary of headers to be used for post requests
+        """
+        return PutHeaders(authorization=api_key).dict(by_alias=True)
+
     @staticmethod
     def build_get_request_headers(api_key: str) -> Dict:
         """Build the request headers dictionary which has to be used for each of the
@@ -115,6 +127,16 @@ def build_get_request_headers(api_key: str) -> Dict:
         """
         return GetHeaders(authorization=api_key).dict(by_alias=True)
 
+    @staticmethod
+    def build_delete_request_headers(api_key: str) -> Dict:
+        """Build the request headers dictionary which has to be used for each of the
+        delete requests.
+
+        :param api_key: Key used for populating Authorization header
+        :return: Dictionary of headers to be used for get requests
+        """
+        return DeleteHeaders(authorization=api_key).dict(by_alias=True)
+
     @staticmethod
     def convert_model_to_dict(
         model: BaseModel, by_alias: bool = True, exclude_unset: bool = True, **kwargs

infobip_channels/whatsapp/channel.py

@@ -21,6 +21,9 @@
 from infobip_channels.whatsapp.models.body.template_message import TemplateMessageBody
 from infobip_channels.whatsapp.models.body.text_message import TextMessageBody
 from infobip_channels.whatsapp.models.body.video_message import VideoMessageBody
+from infobip_channels.whatsapp.models.path_parameters.delete_template import (
+    DeleteTemplatePathParameters,
+)
 from infobip_channels.whatsapp.models.path_parameters.manage_templates import (
     ManageTemplatesPathParameters,
 )
@@ -44,6 +47,7 @@ class WhatsAppChannel(Channel):
 
     SEND_MESSAGE_URL_TEMPLATE = "/whatsapp/1/message/"
     MANAGE_URL_TEMPLATE = "/whatsapp/1/senders/"
+    DELETE_URL_TEMPLATE = "/whatsapp/2/senders/"
 
     def _get_custom_response_class(
         self,
@@ -337,3 +341,29 @@ def create_template(
             message.dict(by_alias=True),
         )
         return self._construct_response(response, CreateTemplateResponseOK)
+
+    def delete_template(
+        self, parameter: Union[DeleteTemplatePathParameters, Dict]
+    ) -> Union[ResponseBase, Any]:
+        """Delete a WhatsApp template. If registered in multiple languages, deleting
+        the message template will also delete all its languages. The template will be
+        deleted for all senders registered under the same WhatsApp Business Account (
+        WABA). The system will attempt to deliver sent messages for 30 days,
+        regardless of the template deletion. Once deleted, the name of the approved
+        template cannot be reused for 30 days.
+
+        :param parameter: Registered WhatsApp sender number, must be in international
+        format. Template name of WhatsApp template.
+        :return: Received response
+        """
+        path_parameter = self.validate_path_parameter(
+            parameter, DeleteTemplatePathParameters
+        )
+
+        response = self._client.delete(
+            self.DELETE_URL_TEMPLATE
+            + "".join(
+                [path_parameter.sender, "/templates/", path_parameter.template_name]
+            )
+        )
+        return response

infobip_channels/whatsapp/models/path_parameters/core.py

@@ -0,0 +1,5 @@
+from infobip_channels.core.models import PathParameter
+
+
+class WhatsAppPathParameters(PathParameter):
+    sender: str

infobip_channels/whatsapp/models/path_parameters/delete_template.py

@@ -0,0 +1,5 @@
+from infobip_channels.whatsapp.models.path_parameters.core import WhatsAppPathParameters
+
+
+class DeleteTemplatePathParameters(WhatsAppPathParameters):
+    template_name: str

infobip_channels/whatsapp/models/path_parameters/manage_templates.py

@@ -1,5 +1,5 @@
-from infobip_channels.core.models import PathParameter
+from infobip_channels.whatsapp.models.path_parameters.core import WhatsAppPathParameters
 
 
-class ManageTemplatesPathParameters(PathParameter):
-    sender: str
+class ManageTemplatesPathParameters(WhatsAppPathParameters):
+    pass

tests/conftest.py

@@ -33,6 +33,10 @@ def get(self, endpoint, headers=None):
         headers = headers or self.headers
         return requests.get(url=f"{self.url}" + endpoint, headers=headers)
 
+    def delete(self, endpoint, headers=None):
+        headers = headers or self.headers
+        return requests.delete(url=f"{self.url}" + endpoint, headers=headers)
+
 
 class Address(CamelCaseModel):
     street: str

tests/whatsapp/conftest.py

@@ -22,6 +22,9 @@
 from infobip_channels.whatsapp.models.body.template_message import TemplateMessageBody
 from infobip_channels.whatsapp.models.body.text_message import TextMessageBody
 from infobip_channels.whatsapp.models.body.video_message import VideoMessageBody
+from infobip_channels.whatsapp.models.path_parameters.delete_template import (
+    DeleteTemplatePathParameters,
+)
 from infobip_channels.whatsapp.models.path_parameters.manage_templates import (
     ManageTemplatesPathParameters,
 )
@@ -187,6 +190,10 @@ class CreateTemplatesPathParametersFactory(ModelFactory):
     __model__ = ManageTemplatesPathParameters
 
 
+class DeleteTemplatePathParametersFactory(ModelFactory):
+    __model__ = DeleteTemplatePathParameters
+
+
 @pytest.fixture
 def authentication():
     return AuthenticationFactory.build()
@@ -211,6 +218,11 @@ def get(self, endpoint):
             "GET", url=f"{self.url}" + endpoint, headers=self.headers
         )
 
+    def delete(self, endpoint):
+        return self.pool.request(
+            "DELETE", url=f"{self.url}" + endpoint, headers=self.headers
+        )
+
 
 @pytest.fixture
 def http_test_client_unofficial():

tests/whatsapp/integration/test_delete_template_integration.py

@@ -0,0 +1,106 @@
+from pytest_cases import parametrize_with_cases
+
+from infobip_channels.core.models import ResponseBase
+from infobip_channels.whatsapp.channel import WhatsAppChannel
+from infobip_channels.whatsapp.models.path_parameters.delete_template import (
+    DeleteTemplatePathParameters,
+)
+from tests.conftest import get_expected_delete_headers, get_response_object
+from tests.whatsapp.conftest import (
+    get_response_object_unofficial,
+    get_whatsapp_channel_instance,
+)
+
+
+def delete_template_request(
+    http_server,
+    response,
+    instantiation_type,
+    path_parameters_type,
+    **kwargs,
+):
+    path_parameter_instance = path_parameter = DeleteTemplatePathParameters(
+        sender="38598765321", template_name="test"
+    )
+    http_server.expect_request(
+        "/whatsapp/2/senders/38598765321/templates/test",
+        method="DELETE",
+        headers=get_expected_delete_headers(),
+    ).respond_with_response(response)
+
+    whatsapp_channel = get_whatsapp_channel_instance(instantiation_type, **kwargs)
+
+    if path_parameters_type == "dict":
+        path_parameter = path_parameter_instance.dict()
+
+    return whatsapp_channel.delete_template(path_parameter)
+
+
+@parametrize_with_cases(
+    "status_code, response_content, path_parameters_type, "
+    "whatsapp_channel_instantiation_type",
+    prefix="from_all_instantiation_types_case__valid_content",
+)
+def test_delete_template_from_all_instantiation_types_case__valid_content(
+    httpserver,
+    http_test_client,
+    status_code,
+    response_content,
+    path_parameters_type,
+    whatsapp_channel_instantiation_type,
+):
+    response = delete_template_request(
+        http_server=httpserver,
+        response=get_response_object(status_code, response_content),
+        instantiation_type=whatsapp_channel_instantiation_type,
+        path_parameters_type=path_parameters_type,
+        server_url=httpserver.url_for("/"),
+        client=http_test_client(
+            url=httpserver.url_for("/"),
+            headers=WhatsAppChannel.build_delete_request_headers("secret"),
+        ),
+    )
+
+    assert response is not None
+    assert response.status_code == status_code
+
+
+@parametrize_with_cases(
+    "status_code, response_content, path_parameters_type, "
+    "whatsapp_channel_instantiation_type",
+    prefix="from_all_instantiation_types_case__invalid_content",
+)
+def test_create_template_from_all_instantiation_types_case__invalid_content(
+    httpserver,
+    http_test_client,
+    http_test_client_unofficial,
+    status_code,
+    response_content,
+    path_parameters_type,
+    whatsapp_channel_instantiation_type,
+):
+    if whatsapp_channel_instantiation_type == "client_unofficial":
+        client = http_test_client_unofficial
+        response_object = get_response_object_unofficial
+    else:
+        client = http_test_client
+        response_object = get_response_object
+
+    response = delete_template_request(
+        http_server=httpserver,
+        response=response_object(status_code, response_content),
+        instantiation_type=whatsapp_channel_instantiation_type,
+        path_parameters_type=path_parameters_type,
+        server_url=httpserver.url_for("/"),
+        client=client(
+            url=httpserver.url_for("/"),
+            headers=WhatsAppChannel.build_delete_request_headers("secret"),
+        ),
+    )
+
+    assert isinstance(response, ResponseBase) is False
+    assert response is not None
+
+    if whatsapp_channel_instantiation_type != "client_unofficial":
+        assert response.status_code == status_code
+        assert response.json() == response_content

tests/whatsapp/integration/test_delete_template_integration_cases.py

@@ -0,0 +1,61 @@
+from pytest_cases import parametrize
+
+from tests.whatsapp.conftest import get_response_error_content
+
+
+def get_delete_template_ok_content():
+    return {}
+
+
+@parametrize(
+    path_parameters_type=("path_parameter_instance", "dict"),
+    whatsapp_channel_instantiation_type=("auth_params", "auth_instance", "client"),
+    responses=(
+        [200, get_delete_template_ok_content()],
+        [202, get_delete_template_ok_content()],
+        [400, get_response_error_content()],
+        [401, get_response_error_content()],
+        [403, get_response_error_content()],
+        [429, get_response_error_content()],
+    ),
+)
+def from_all_instantiation_types_case__valid_content(
+    responses,
+    path_parameters_type,
+    whatsapp_channel_instantiation_type,
+):
+    return (
+        responses[0],
+        responses[1],
+        path_parameters_type,
+        whatsapp_channel_instantiation_type,
+    )
+
+
+@parametrize(
+    path_parameters_type=("path_parameter_instance", "dict"),
+    whatsapp_channel_instantiation_type=(
+        "auth_params",
+        "auth_instance",
+        "client",
+        "client_unofficial",
+    ),
+    responses=(
+        [201, get_delete_template_ok_content()],
+        [202, get_delete_template_ok_content()],
+        [403, get_response_error_content()],
+        [405, get_response_error_content()],
+        [500, get_response_error_content()],
+    ),
+)
+def from_all_instantiation_types_case__invalid_content(
+    responses,
+    path_parameters_type,
+    whatsapp_channel_instantiation_type,
+):
+    return (
+        responses[0],
+        responses[1],
+        path_parameters_type,
+        whatsapp_channel_instantiation_type,
+    )

tests/whatsapp/models/test_delete_template.py

@@ -0,0 +1,16 @@
+import pytest
+from pydantic.error_wrappers import ValidationError
+
+from tests.whatsapp.conftest import DeleteTemplatePathParametersFactory
+
+
+@pytest.mark.parametrize("sender", [None, {}])
+def test_when_sender_is_invalid__validation_error_is_raised(sender):
+    with pytest.raises(ValidationError):
+        DeleteTemplatePathParametersFactory.build(**{"sender": sender})
+
+
+@pytest.mark.parametrize("template_name", [None, {}])
+def test_when_template_name_is_invalid__validation_error_is_raised(template_name):
+    with pytest.raises(ValidationError):
+        DeleteTemplatePathParametersFactory.build(**{"templateName": template_name})