Add email channel (#66)

* Added validate email addresses endpoint

* Added get all domains for account endpoint

* Added get domain details endpoint

* Added add new domain endpoint

* Added add delete existing domain endpoint

* Added add verify domain endpoint

* Added added integration tests for verify and delete domain

* Added update tracking events method

* Added update tracking events tests

* Changed README.md and updated version number

* Changed conftest.py comments

Author: dlozina

README.md

@@ -14,6 +14,7 @@ Python client for Infobip's  API channels.
 ## 📡 Supported channels
 - [SMS Reference](https://www.infobip.com/docs/api#channels/sms)
 - [Whatsapp Reference](https://www.infobip.com/docs/api#channels/whatsapp)
+- [Email Reference](https://www.infobip.com/docs/api#channels/email)
 - [WebRTC Reference](https://www.infobip.com/docs/api#channels/webrtc/)
 - [MMS Reference](https://www.infobip.com/docs/api#channels/mms)
 - [RCS Reference](https://www.infobip.com/docs/api#channels/rcs)

infobip_channels/__init__.py

@@ -1,7 +1,15 @@
+from .email.channel import EmailChannel
 from .mms.channel import MMSChannel
 from .rcs.channel import RCSChannel
 from .sms.channel import SMSChannel
 from .web_rtc.channel import WebRtcChannel
 from .whatsapp.channel import WhatsAppChannel
 
-__all__ = ["WhatsAppChannel", "WebRtcChannel", "MMSChannel", "RCSChannel", "SMSChannel"]
+__all__ = [
+    "WhatsAppChannel",
+    "WebRtcChannel",
+    "MMSChannel",
+    "RCSChannel",
+    "SMSChannel",
+    "EmailChannel",
+]

infobip_channels/core/channel.py

@@ -9,11 +9,11 @@
     Authentication,
     GetHeaders,
     MessageBodyBase,
+    PathParameter,
     PostHeaders,
     QueryParameter,
     ResponseBase,
 )
-from infobip_channels.web_rtc.models.path_parameters.core import PathParameter
 
 
 class Channel(ABC):
@@ -137,7 +137,7 @@ def convert_model_to_dict(
     @staticmethod
     def validate_path_parameter(
         parameter: Union[PathParameter, Dict], parameter_type: Type[PathParameter]
-    ) -> PathParameter:
+    ) -> Union[PathParameter]:
         """
         Validate path parameter by trying to instantiate the provided class and
         extract valid path parameter.

infobip_channels/core/http_client.py

@@ -37,7 +37,10 @@ def __init__(
         )
 
     def post(
-        self, endpoint: str, body: Union[Dict, bytes], headers: RequestHeaders = None
+        self,
+        endpoint: str,
+        body: Union[Dict, bytes] = None,
+        headers: RequestHeaders = None,
     ) -> requests.Response:
         """Send an HTTP post request to base_url + endpoint.
 

infobip_channels/core/models.py

@@ -186,7 +186,7 @@ class DeleteHeaders(RequestHeaders):
 
 
 class PathParameter(CamelCaseModel):
-    sender: str
+    pass
 
 
 class QueryParameter(CamelCaseModel):

infobip_channels/email/channel.py

@@ -5,16 +5,38 @@
 
 from infobip_channels.core.channel import Channel
 from infobip_channels.core.models import PostHeaders, ResponseBase
+from infobip_channels.email.models.body.add_new_domain import AddNewDomainMessageBody
 from infobip_channels.email.models.body.reschedule_messages import (
     RescheduleMessagesMessageBody,
 )
 from infobip_channels.email.models.body.send_email import EmailMessageBody
 from infobip_channels.email.models.body.update_scheduled_status import (
     UpdateScheduledStatusMessageBody,
 )
+from infobip_channels.email.models.body.update_tracking_events import (
+    UpdateTrackingEventsMessageBody,
+)
+from infobip_channels.email.models.body.validate_email_adresses import (
+    ValidateEmailAddressesMessageBody,
+)
+from infobip_channels.email.models.path_paramaters.delete_existing_domain import (
+    DeleteExistingDomainPathParameter,
+)
+from infobip_channels.email.models.path_paramaters.get_domain_details import (
+    GetDomainDetailsPathParameter,
+)
+from infobip_channels.email.models.path_paramaters.update_tracking_events import (
+    UpdateTrackingEventsPathParameter,
+)
+from infobip_channels.email.models.path_paramaters.verify_domain import (
+    VerifyDomainPathParameter,
+)
 from infobip_channels.email.models.query_parameters.delivery_reports import (
     DeliveryReportsQueryParameters,
 )
+from infobip_channels.email.models.query_parameters.get_all_domains import (
+    GetAllDomainsForAccountQueryParameters,
+)
 from infobip_channels.email.models.query_parameters.get_logs import (
     GetLogsQueryParameters,
 )
@@ -30,10 +52,17 @@
 from infobip_channels.email.models.query_parameters.update_scheduled_status import (
     UpdateScheduledStatusQueryParameters,
 )
+from infobip_channels.email.models.response.add_new_domain import AddNewDomainResponse
 from infobip_channels.email.models.response.core import EmailResponseError
 from infobip_channels.email.models.response.delivery_reports import (
     DeliveryReportsResponse,
 )
+from infobip_channels.email.models.response.get_all_domains import (
+    GetAllDomainsForAccountResponse,
+)
+from infobip_channels.email.models.response.get_domain_details import (
+    GetDomainDetailsResponse,
+)
 from infobip_channels.email.models.response.get_logs import GetLogsResponse
 from infobip_channels.email.models.response.get_sent_bulk_status import (
     GetSentEmailBulksStatusResponse,
@@ -48,6 +77,12 @@
 from infobip_channels.email.models.response.update_scheduled_status import (
     UpdateScheduledStatusResponse,
 )
+from infobip_channels.email.models.response.update_tracking_events import (
+    UpdateTrackingEventsResponse,
+)
+from infobip_channels.email.models.response.validate_email_adresses import (
+    ValidateEmailAddressesResponse,
+)
 
 
 class EmailChannel(Channel):
@@ -230,3 +265,149 @@ def update_scheduled_email_messages(
             params=query_parameters.dict(by_alias=True),
         )
         return self._construct_response(response, UpdateScheduledStatusResponse)
+
+    def validate_email_addresses(
+        self, message: Union[ValidateEmailAddressesMessageBody, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        Run validation to identify poor quality emails to clean up your recipient list.
+
+        :param message: Body of the message to send
+        :return: Received response
+        """
+        message = self.validate_message_body(message, ValidateEmailAddressesMessageBody)
+
+        response = self._client.post(
+            self.EMAIL_URL_TEMPLATE_V2 + "validation",
+            message.dict(by_alias=True),
+        )
+        return self._construct_response(response, ValidateEmailAddressesResponse)
+
+    def get_all_domains_for_account(
+        self,
+        query_parameters: Union[GetAllDomainsForAccountQueryParameters, Dict] = None,
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        This API is to get all domain associated with the account. It also provides
+        details of the retrieved domain like the DNS records, Tracking details,
+        Active/Blocked status,etc.
+
+        :param query_parameters: Query parameters to send with the request
+        :return: Received response
+        """
+
+        query_parameters = self.validate_query_parameter(
+            query_parameters or {}, GetAllDomainsForAccountQueryParameters
+        )
+
+        response = self._client.get(
+            self.EMAIL_URL_TEMPLATE_V1 + "domains",
+            params=query_parameters.dict(by_alias=True),
+        )
+        return self._construct_response(response, GetAllDomainsForAccountResponse)
+
+    def get_domain_details(
+        self,
+        parameter: Union[GetDomainDetailsPathParameter, Dict],
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        This API provides with the details of the domain like the DNS records,
+        Tracking details, Active/Blocked status,etc.
+
+        :param parameter: Domain for which the details need to be viewed.
+        :return: Received response
+        """
+        path_parameter = self.validate_path_parameter(
+            parameter, GetDomainDetailsPathParameter
+        )
+
+        response = self._client.get(
+            self.EMAIL_URL_TEMPLATE_V1 + "domains/" + path_parameter.domain_name,
+        )
+        return self._construct_response(response, GetDomainDetailsResponse)
+
+    def add_new_domain(
+        self, message: Union[AddNewDomainMessageBody, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        This method allows you to add new domains with a limit to create a maximum of
+        10 domains in a day.
+
+        :param message: Body of the message to send
+        :return: Received response
+        """
+        message = self.validate_message_body(message, AddNewDomainMessageBody)
+
+        response = self._client.post(
+            self.EMAIL_URL_TEMPLATE_V1 + "domains",
+            message.dict(by_alias=True),
+        )
+        return self._construct_response(response, AddNewDomainResponse)
+
+    def delete_existing_domain(
+        self, parameter: Union[DeleteExistingDomainPathParameter, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        This method allows you to delete an existing domain.
+
+        :param parameter: Domain name which needs to be deleted.
+        :return: Received response
+        """
+        path_parameter = self.validate_path_parameter(
+            parameter, DeleteExistingDomainPathParameter
+        )
+
+        response = self._client.delete(
+            self.EMAIL_URL_TEMPLATE_V1 + "domains/" + path_parameter.domain_name,
+        )
+        return response
+
+    def verify_domain(
+        self, parameter: Union[VerifyDomainPathParameter, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        API request to verify records(TXT, MX, DKIM) associated with the provided
+        domain.
+
+        :param parameter: Domain name which needs to be deleted.
+        :return: Received response
+        """
+        path_parameter = self.validate_path_parameter(
+            parameter, VerifyDomainPathParameter
+        )
+
+        response = self._client.post(
+            self.EMAIL_URL_TEMPLATE_V1
+            + "domains/"
+            + path_parameter.domain_name
+            + "/verify"
+        )
+        return response
+
+    def update_tracking_events(
+        self,
+        parameter: Union[UpdateTrackingEventsPathParameter, Dict],
+        message: Union[UpdateTrackingEventsMessageBody, Dict],
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        API to update tracking events for the provided domain. Tracking events can be
+        updated only for CLICKS, OPENS and UNSUBSCRIBES.
+
+        :param parameter: Domain name which needs to be deleted.
+        :param message: Body of the message to send
+        :return: Received response
+        """
+        path_parameter = self.validate_path_parameter(
+            parameter, UpdateTrackingEventsPathParameter
+        )
+
+        message = self.validate_message_body(message, UpdateTrackingEventsMessageBody)
+
+        response = self._client.put(
+            self.EMAIL_URL_TEMPLATE_V1
+            + "domains/"
+            + path_parameter.domain_name
+            + "/tracking",
+            message.dict(by_alias=True),
+        )
+        return self._construct_response(response, UpdateTrackingEventsResponse)

infobip_channels/email/models/body/add_new_domain.py

@@ -0,0 +1,5 @@
+from infobip_channels.core.models import MessageBodyBase
+
+
+class AddNewDomainMessageBody(MessageBodyBase):
+    domain_name: str

infobip_channels/email/models/body/update_tracking_events.py

@@ -0,0 +1,11 @@
+from typing import Optional
+
+from pydantic import StrictBool
+
+from infobip_channels.core.models import MessageBodyBase
+
+
+class UpdateTrackingEventsMessageBody(MessageBodyBase):
+    open: Optional[StrictBool] = None
+    clicks: Optional[StrictBool] = None
+    unsubscribe: Optional[StrictBool] = None

infobip_channels/email/models/body/validate_email_adresses.py

@@ -0,0 +1,5 @@
+from infobip_channels.core.models import MessageBodyBase
+
+
+class ValidateEmailAddressesMessageBody(MessageBodyBase):
+    to: str