feat(tem): add email list order (#183)

Author: scaleway-bot

scaleway-async/scaleway_async/tem/v1alpha1/__init__.py

@@ -3,6 +3,7 @@
 from .types import DomainStatus
 from .types import EmailRcptType
 from .types import EmailStatus
+from .types import ListEmailsRequestOrderBy
 from .types import CreateEmailRequestAddress
 from .types import CreateEmailRequestAttachment
 from .types import CreateEmailResponse
@@ -21,6 +22,7 @@
     "DomainStatus",
     "EmailRcptType",
     "EmailStatus",
+    "ListEmailsRequestOrderBy",
     "CreateEmailRequestAddress",
     "CreateEmailRequestAttachment",
     "CreateEmailResponse",

scaleway-async/scaleway_async/tem/v1alpha1/api.py

@@ -17,6 +17,7 @@
 from .types import (
     DomainStatus,
     EmailStatus,
+    ListEmailsRequestOrderBy,
     CreateEmailRequestAddress,
     CreateEmailRequestAttachment,
     CreateEmailResponse,
@@ -196,28 +197,46 @@ async def list_emails(
         project_id: Optional[str] = None,
         domain_id: Optional[str] = None,
         message_id: Optional[str] = None,
-        subject: Optional[str] = None,
         since: Optional[datetime] = None,
         until: Optional[datetime] = None,
         mail_from: Optional[str] = None,
         mail_to: Optional[str] = None,
+        mail_rcpt: Optional[str] = None,
         statuses: Optional[List[EmailStatus]] = None,
+        subject: Optional[str] = None,
+        order_by: ListEmailsRequestOrderBy = ListEmailsRequestOrderBy.CREATED_AT_DESC,
     ) -> ListEmailsResponse:
         """
         List emails.
         Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
+        You can filter your emails in ascending or descending order using:
+          - created_at
+          - updated_at
+          - status
+          - mail_from
+          - mail_rcpt
+          - subject
         :param region: Region to target. If none is passed will use default region from the config.
         :param page:
         :param page_size:
-        :param project_id: ID of the Project in which to list the emails (optional).
-        :param domain_id: ID of the domain for which to list the emails (optional).
-        :param message_id: ID of the message for which to list the emails (optional).
-        :param subject: Subject of the email.
-        :param since: List emails created after this date (optional).
-        :param until: List emails created before this date (optional).
-        :param mail_from: List emails sent with this `mail_from` sender's address (optional).
-        :param mail_to: List emails sent with this `mail_to` recipient's address (optional).
-        :param statuses: List emails having any of this status (optional).
+        :param project_id: (Optional) ID of the Project in which to list the emails.
+        :param domain_id: (Optional) ID of the domain for which to list the emails.
+        :param message_id: (Optional) ID of the message for which to list the emails.
+        :param since: (Optional) List emails created after this date.
+        :param until: (Optional) List emails created before this date.
+        :param mail_from: (Optional) List emails sent with this sender's email address.
+        :param mail_to: (Deprecated) List emails sent to this recipient's email address.
+        :param mail_rcpt: (Optional) List emails sent to this recipient's email address.
+        :param statuses: (Optional) List emails with any of these statuses.
+        :param subject: (Optional) List emails with this subject.
+        :param order_by: (Optional) List emails corresponding to specific criteria.
+        You can filter your emails in ascending or descending order using:
+          - created_at
+          - updated_at
+          - status
+          - mail_from
+          - mail_rcpt
+          - subject.
         :return: :class:`ListEmailsResponse <ListEmailsResponse>`
 
         Usage:
@@ -236,8 +255,10 @@ async def list_emails(
             params={
                 "domain_id": domain_id,
                 "mail_from": mail_from,
+                "mail_rcpt": mail_rcpt,
                 "mail_to": mail_to,
                 "message_id": message_id,
+                "order_by": order_by,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
                 "project_id": project_id or self.client.default_project_id,
@@ -260,28 +281,46 @@ async def list_emails_all(
         project_id: Optional[str] = None,
         domain_id: Optional[str] = None,
         message_id: Optional[str] = None,
-        subject: Optional[str] = None,
         since: Optional[datetime] = None,
         until: Optional[datetime] = None,
         mail_from: Optional[str] = None,
         mail_to: Optional[str] = None,
+        mail_rcpt: Optional[str] = None,
         statuses: Optional[List[EmailStatus]] = None,
+        subject: Optional[str] = None,
+        order_by: Optional[ListEmailsRequestOrderBy] = None,
     ) -> List[Email]:
         """
         List emails.
         Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
+        You can filter your emails in ascending or descending order using:
+          - created_at
+          - updated_at
+          - status
+          - mail_from
+          - mail_rcpt
+          - subject
         :param region: Region to target. If none is passed will use default region from the config.
         :param page:
         :param page_size:
-        :param project_id: ID of the Project in which to list the emails (optional).
-        :param domain_id: ID of the domain for which to list the emails (optional).
-        :param message_id: ID of the message for which to list the emails (optional).
-        :param subject: Subject of the email.
-        :param since: List emails created after this date (optional).
-        :param until: List emails created before this date (optional).
-        :param mail_from: List emails sent with this `mail_from` sender's address (optional).
-        :param mail_to: List emails sent with this `mail_to` recipient's address (optional).
-        :param statuses: List emails having any of this status (optional).
+        :param project_id: (Optional) ID of the Project in which to list the emails.
+        :param domain_id: (Optional) ID of the domain for which to list the emails.
+        :param message_id: (Optional) ID of the message for which to list the emails.
+        :param since: (Optional) List emails created after this date.
+        :param until: (Optional) List emails created before this date.
+        :param mail_from: (Optional) List emails sent with this sender's email address.
+        :param mail_to: (Deprecated) List emails sent to this recipient's email address.
+        :param mail_rcpt: (Optional) List emails sent to this recipient's email address.
+        :param statuses: (Optional) List emails with any of these statuses.
+        :param subject: (Optional) List emails with this subject.
+        :param order_by: (Optional) List emails corresponding to specific criteria.
+        You can filter your emails in ascending or descending order using:
+          - created_at
+          - updated_at
+          - status
+          - mail_from
+          - mail_rcpt
+          - subject.
         :return: :class:`List[ListEmailsResponse] <List[ListEmailsResponse]>`
 
         Usage:
@@ -301,12 +340,14 @@ async def list_emails_all(
                 "project_id": project_id,
                 "domain_id": domain_id,
                 "message_id": message_id,
-                "subject": subject,
                 "since": since,
                 "until": until,
                 "mail_from": mail_from,
                 "mail_to": mail_to,
+                "mail_rcpt": mail_rcpt,
                 "statuses": statuses,
+                "subject": subject,
+                "order_by": order_by,
             },
         )
 
@@ -324,11 +365,11 @@ async def get_statistics(
         Email statuses.
         Get information on your emails' statuses.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param project_id: Number of emails for this Project (optional).
-        :param domain_id: Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`) (optional).
-        :param since: Number of emails created after this date (optional).
-        :param until: Number of emails created before this date (optional).
-        :param mail_from: Number of emails sent with this `mail_from` sender's address (optional).
+        :param project_id: (Optional) Number of emails for this Project.
+        :param domain_id: (Optional) Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`).
+        :param since: (Optional) Number of emails created after this date.
+        :param until: (Optional) Number of emails created before this date.
+        :param mail_from: (Optional) Number of emails sent with this sender's email address.
         :return: :class:`Statistics <Statistics>`
 
         Usage:

scaleway-async/scaleway_async/tem/v1alpha1/marshalling.py

@@ -142,6 +142,9 @@ def unmarshal_Email(data: Any) -> Email:
     field = data.get("mail_from")
     args["mail_from"] = field
 
+    field = data.get("mail_rcpt")
+    args["mail_rcpt"] = field
+
     field = data.get("message_id")
     args["message_id"] = field
 

scaleway-async/scaleway_async/tem/v1alpha1/types.py

@@ -47,6 +47,24 @@ def __str__(self) -> str:
         return str(self.value)
 
 
+class ListEmailsRequestOrderBy(str, Enum):
+    CREATED_AT_DESC = "created_at_desc"
+    CREATED_AT_ASC = "created_at_asc"
+    UPDATED_AT_DESC = "updated_at_desc"
+    UPDATED_AT_ASC = "updated_at_asc"
+    STATUS_DESC = "status_desc"
+    STATUS_ASC = "status_asc"
+    MAIL_FROM_DESC = "mail_from_desc"
+    MAIL_FROM_ASC = "mail_from_asc"
+    MAIL_RCPT_DESC = "mail_rcpt_desc"
+    MAIL_RCPT_ASC = "mail_rcpt_asc"
+    SUBJECT_DESC = "subject_desc"
+    SUBJECT_ASC = "subject_asc"
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+
 @dataclass
 class CreateEmailRequestAddress:
     """
@@ -209,7 +227,13 @@ class Email:
     Email address of the sender.
     """
 
-    rcpt_to: str
+    rcpt_to: Optional[str]
+    """
+    (Deprecated) Email address of the recipient.
+    :deprecated
+    """
+
+    mail_rcpt: str
     """
     Email address of the recipient.
     """
@@ -304,7 +328,7 @@ class ListEmailsResponse:
 
     total_count: int
     """
-    Count of all emails matching the requested criteria.
+    Number of emails matching the requested criteria.
     """
 
     emails: List[Email]
@@ -434,47 +458,65 @@ class ListEmailsRequest:
 
     project_id: Optional[str]
     """
-    ID of the Project in which to list the emails (optional).
+    (Optional) ID of the Project in which to list the emails.
     """
 
     domain_id: Optional[str]
     """
-    ID of the domain for which to list the emails (optional).
+    (Optional) ID of the domain for which to list the emails.
     """
 
     message_id: Optional[str]
     """
-    ID of the message for which to list the emails (optional).
-    """
-
-    subject: Optional[str]
-    """
-    Subject of the email.
+    (Optional) ID of the message for which to list the emails.
     """
 
     since: Optional[datetime]
     """
-    List emails created after this date (optional).
+    (Optional) List emails created after this date.
     """
 
     until: Optional[datetime]
     """
-    List emails created before this date (optional).
+    (Optional) List emails created before this date.
     """
 
     mail_from: Optional[str]
     """
-    List emails sent with this `mail_from` sender's address (optional).
+    (Optional) List emails sent with this sender's email address.
     """
 
     mail_to: Optional[str]
     """
-    List emails sent with this `mail_to` recipient's address (optional).
+    (Deprecated) List emails sent to this recipient's email address.
+    :deprecated
+    """
+
+    mail_rcpt: Optional[str]
+    """
+    (Optional) List emails sent to this recipient's email address.
     """
 
     statuses: Optional[List[EmailStatus]]
     """
-    List emails having any of this status (optional).
+    (Optional) List emails with any of these statuses.
+    """
+
+    subject: Optional[str]
+    """
+    (Optional) List emails with this subject.
+    """
+
+    order_by: Optional[ListEmailsRequestOrderBy]
+    """
+    (Optional) List emails corresponding to specific criteria.
+    You can filter your emails in ascending or descending order using:
+      - created_at
+      - updated_at
+      - status
+      - mail_from
+      - mail_rcpt
+      - subject.
     """
 
 
@@ -487,27 +529,27 @@ class GetStatisticsRequest:
 
     project_id: Optional[str]
     """
-    Number of emails for this Project (optional).
+    (Optional) Number of emails for this Project.
     """
 
     domain_id: Optional[str]
     """
-    Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`) (optional).
+    (Optional) Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`).
     """
 
     since: Optional[datetime]
     """
-    Number of emails created after this date (optional).
+    (Optional) Number of emails created after this date.
     """
 
     until: Optional[datetime]
     """
-    Number of emails created before this date (optional).
+    (Optional) Number of emails created before this date.
     """
 
     mail_from: Optional[str]
     """
-    Number of emails sent with this `mail_from` sender's address (optional).
+    (Optional) Number of emails sent with this sender's email address.
     """
 
 

scaleway/scaleway/tem/v1alpha1/__init__.py

@@ -3,6 +3,7 @@
 from .types import DomainStatus
 from .types import EmailRcptType
 from .types import EmailStatus
+from .types import ListEmailsRequestOrderBy
 from .types import CreateEmailRequestAddress
 from .types import CreateEmailRequestAttachment
 from .types import CreateEmailResponse
@@ -21,6 +22,7 @@
     "DomainStatus",
     "EmailRcptType",
     "EmailStatus",
+    "ListEmailsRequestOrderBy",
     "CreateEmailRequestAddress",
     "CreateEmailRequestAttachment",
     "CreateEmailResponse",