Added scheduled email endpoints

Author: dlozina

infobip_channels/email/channel.py

@@ -5,19 +5,49 @@
 
 from infobip_channels.core.channel import Channel
 from infobip_channels.core.models import PostHeaders, ResponseBase
+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.query_parameters.delivery_reports import (
     DeliveryReportsQueryParameters,
 )
 from infobip_channels.email.models.query_parameters.get_logs import (
     GetLogsQueryParameters,
 )
+from infobip_channels.email.models.query_parameters.get_sent_bulks import (
+    GetSentBulksQueryParameters,
+)
+from infobip_channels.email.models.query_parameters.get_sent_bulks_status import (
+    GetSentBulksStatusQueryParameters,
+)
+from infobip_channels.email.models.query_parameters.reschedule_messages import (
+    RescheduleMessagesQueryParameters,
+)
+from infobip_channels.email.models.query_parameters.update_scheduled_status import (
+    UpdateScheduledStatusQueryParameters,
+)
 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_logs import GetLogsResponse
+from infobip_channels.email.models.response.get_sent_bulk_status import (
+    GetSentEmailBulksStatusResponse,
+)
+from infobip_channels.email.models.response.get_sent_bulks import (
+    GetSentEmailBulksResponse,
+)
+from infobip_channels.email.models.response.reschedule_messages import (
+    RescheduleMessagesResponse,
+)
 from infobip_channels.email.models.response.send_email import SendEmailResponse
+from infobip_channels.email.models.response.update_scheduled_status import (
+    UpdateScheduledStatusResponse,
+)
 
 
 class EmailChannel(Channel):
@@ -51,7 +81,8 @@ def _get_custom_response_class(
     def send_email_message(
         self, message: Union[EmailMessageBody, Dict]
     ) -> Union[ResponseBase, requests.Response, Any]:
-        """Send an email or multiple emails to a recipient or multiple recipients
+        """
+        Send an email or multiple emails to a recipient or multiple recipients
         with CC/BCC enabled.
 
         :param message: Body of the message to send
@@ -75,7 +106,7 @@ def email_delivery_reports(
         """
         Get one-time delivery reports for all sent emails.
 
-        :param query_parameters: Body of the message to send
+        :param query_parameters: Query parameters to send with the request
         :return: Received response
         """
 
@@ -96,7 +127,7 @@ def get_email_logs(
         This method allows you to get email logs of sent Email messagesId for
         request. Email logs are available for the last 48 hours.
 
-        :param query_parameters: Body of the message to send
+        :param query_parameters: Query parameters to send with the request
         :return: Received response
         """
 
@@ -109,3 +140,93 @@ def get_email_logs(
             params=query_parameters.dict(by_alias=True),
         )
         return self._construct_response(response, GetLogsResponse)
+
+    def get_sent_email_bulks(
+        self, query_parameters: Union[GetSentBulksQueryParameters, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        See the scheduled time of your Email messages.
+
+        :param query_parameters: Query parameters to send with the request
+        :return: Received response
+        """
+
+        query_parameters = self.validate_query_parameter(
+            query_parameters, GetSentBulksQueryParameters
+        )
+
+        response = self._client.get(
+            self.EMAIL_URL_TEMPLATE_V1 + "bulks",
+            params=query_parameters.dict(by_alias=True),
+        )
+        return self._construct_response(response, GetSentEmailBulksResponse)
+
+    def get_sent_email_bulks_status(
+        self, query_parameters: Union[GetSentBulksStatusQueryParameters, Dict]
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        See the status of scheduled email messages.
+
+        :param query_parameters: Query parameters to send with the request
+        :return: Received response
+        """
+
+        query_parameters = self.validate_query_parameter(
+            query_parameters, GetSentBulksStatusQueryParameters
+        )
+
+        response = self._client.get(
+            self.EMAIL_URL_TEMPLATE_V1 + "bulks/status",
+            params=query_parameters.dict(by_alias=True),
+        )
+        return self._construct_response(response, GetSentEmailBulksStatusResponse)
+
+    def reschedule_email_messages(
+        self,
+        query_parameters: Union[RescheduleMessagesQueryParameters, Dict],
+        message: Union[RescheduleMessagesMessageBody, Dict],
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        Change the date and time for sending scheduled Email messages.
+
+        :param query_parameters: Query parameters to send with the request
+        :param message: Body of the message to send
+        :return: Received response
+        """
+        query_parameters = self.validate_query_parameter(
+            query_parameters, RescheduleMessagesQueryParameters
+        )
+
+        message = self.validate_message_body(message, RescheduleMessagesMessageBody)
+
+        response = self._client.put(
+            self.EMAIL_URL_TEMPLATE_V1 + "bulks",
+            message.dict(by_alias=True),
+            params=query_parameters.dict(by_alias=True),
+        )
+        return self._construct_response(response, RescheduleMessagesResponse)
+
+    def update_scheduled_email_messages(
+        self,
+        query_parameters: Union[UpdateScheduledStatusQueryParameters, Dict],
+        message: Union[UpdateScheduledStatusMessageBody, Dict],
+    ) -> Union[ResponseBase, requests.Response, Any]:
+        """
+        Change status or completely cancel sending of scheduled Email messages.
+
+        :param query_parameters: Query parameters to send with the request
+        :param message: Body of the message to send
+        :return: Received response
+        """
+        query_parameters = self.validate_query_parameter(
+            query_parameters, UpdateScheduledStatusQueryParameters
+        )
+
+        message = self.validate_message_body(message, UpdateScheduledStatusMessageBody)
+
+        response = self._client.put(
+            self.EMAIL_URL_TEMPLATE_V1 + "bulks/status",
+            message.dict(by_alias=True),
+            params=query_parameters.dict(by_alias=True),
+        )
+        return self._construct_response(response, UpdateScheduledStatusResponse)

infobip_channels/email/models/body/reschedule_messages.py

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

infobip_channels/email/models/body/send_email.py

@@ -1,8 +1,7 @@
-from datetime import datetime
 from io import IOBase
-from typing import Optional, Union
+from typing import Optional
 
-from pydantic import AnyHttpUrl, Field, StrictBool, constr, validator
+from pydantic import AnyHttpUrl, Field, StrictBool, constr
 
 from infobip_channels.core.models import (
     CamelCaseModel,
@@ -37,13 +36,9 @@ class EmailMessageBody(MultipartMixin, MessageBodyBase, DateTimeValidator):
     intermediateReport: Optional[StrictBool] = False
     notify_url: Optional[AnyHttpUrl] = None
     notify_content_type: Optional[ContentTypeEnum] = None
-    send_at: Optional[Union[datetime, str]] = None
+    send_at: Optional[str] = None
     landing_page_placeholders: Optional[str] = None
     landing_page_id: Optional[str] = None
 
     class Config(CamelCaseModel.Config):
         arbitrary_types_allowed = True
-
-    @validator("send_at")
-    def convert_send_at_to_correct_format(cls, value):
-        return super().convert_time_to_correct_format(value)

infobip_channels/email/models/body/update_scheduled_status.py

@@ -0,0 +1,5 @@
+from infobip_channels.core.models import MessageBodyBase, MessageStatus
+
+
+class UpdateScheduledStatusMessageBody(MessageBodyBase):
+    status: MessageStatus

infobip_channels/email/models/query_parameters/core.py

@@ -0,0 +1,5 @@
+from infobip_channels.core.models import QueryParameter
+
+
+class BulksQueryParameters(QueryParameter):
+    bulk_id: str

infobip_channels/email/models/query_parameters/get_logs.py

@@ -1,7 +1,6 @@
-from datetime import datetime
-from typing import Optional, Union
+from typing import Optional
 
-from pydantic import Field, validator
+from pydantic import Field
 
 from infobip_channels.core.models import (
     DateTimeValidator,
@@ -16,14 +15,6 @@ class GetLogsQueryParameters(QueryParameter, DateTimeValidator):
     to: Optional[str] = None
     bulk_id: Optional[str] = None
     general_status: Optional[GeneralStatus] = None
-    sent_since: Optional[Union[datetime, str]] = None
-    sent_until: Optional[Union[datetime, str]] = None
+    sent_since: Optional[str] = None
+    sent_until: Optional[str] = None
     limit: Optional[int] = None
-
-    @validator("sent_since")
-    def convert_sent_since_to_correct_format(cls, value):
-        return super().convert_time_to_correct_format(value)
-
-    @validator("sent_until")
-    def convert_sent_until_to_correct_format(cls, value):
-        return super().convert_time_to_correct_format(value)

infobip_channels/email/models/query_parameters/get_sent_bulks.py

@@ -0,0 +1,5 @@
+from infobip_channels.email.models.query_parameters.core import BulksQueryParameters
+
+
+class GetSentBulksQueryParameters(BulksQueryParameters):
+    pass

infobip_channels/email/models/query_parameters/get_sent_bulks_status.py

@@ -0,0 +1,5 @@
+from infobip_channels.email.models.query_parameters.core import BulksQueryParameters
+
+
+class GetSentBulksStatusQueryParameters(BulksQueryParameters):
+    pass

infobip_channels/email/models/query_parameters/reschedule_messages.py

@@ -0,0 +1,5 @@
+from infobip_channels.email.models.query_parameters.core import BulksQueryParameters
+
+
+class RescheduleMessagesQueryParameters(BulksQueryParameters):
+    pass

infobip_channels/email/models/query_parameters/update_scheduled_status.py

@@ -0,0 +1,5 @@
+from infobip_channels.email.models.query_parameters.core import BulksQueryParameters
+
+
+class UpdateScheduledStatusQueryParameters(BulksQueryParameters):
+    pass