feat: make new attachments API conform to updated spec (#174)

Author: lucasfcosta

examples/receiving_email.py

@@ -2,7 +2,7 @@
 
 import resend
 # Type imports
-from resend import AttachmentsReceiving, EmailsReceiving
+from resend import EmailsReceiving
 
 if not os.environ["RESEND_API_KEY"]:
     raise EnvironmentError("RESEND_API_KEY is missing")
@@ -102,7 +102,7 @@
     print(f"Next page has more: {next_page['has_more']}")
 
 print("\n--- Listing All Attachments ---")
-all_attachments: AttachmentsReceiving.ListResponse = resend.Attachments.Receiving.list(
+all_attachments: EmailsReceiving.Attachments.ListResponse = resend.Emails.Receiving.Attachments.list(
     email_id=email_id
 )
 
@@ -123,8 +123,8 @@
 
     print(f"\n--- Retrieving Attachment Details: {first_attachment['filename']} ---")
 
-    attachment_details: resend.ReceivedEmailAttachmentDetails = (
-        resend.Attachments.Receiving.get(
+    attachment_details: resend.EmailAttachmentDetails = (
+        resend.Emails.Receiving.Attachments.get(
             email_id=email_id,
             attachment_id=attachment_id,
         )

resend/__init__.py

@@ -2,8 +2,6 @@
 
 from .api_keys._api_key import ApiKey
 from .api_keys._api_keys import ApiKeys
-from .attachments._attachments import Attachments
-from .attachments._receiving import Receiving as AttachmentsReceiving
 from .audiences._audience import Audience
 from .audiences._audiences import Audiences
 from .broadcasts._broadcast import Broadcast
@@ -13,12 +11,12 @@
 from .domains._domain import Domain
 from .domains._domains import Domains
 from .emails._attachment import Attachment, RemoteAttachment
+from .emails._attachments import Attachments as EmailAttachments
 from .emails._batch import Batch, BatchValidationError
 from .emails._email import Email
 from .emails._emails import Emails
-from .emails._received_email import (ListReceivedEmail, ReceivedEmail,
-                                     ReceivedEmailAttachment,
-                                     ReceivedEmailAttachmentDetails)
+from .emails._received_email import (EmailAttachment, EmailAttachmentDetails,
+                                     ListReceivedEmail, ReceivedEmail)
 from .emails._receiving import Receiving as EmailsReceiving
 from .emails._tag import Tag
 from .http_client import HTTPClient
@@ -53,7 +51,6 @@
     "Contacts",
     "Broadcasts",
     "Webhooks",
-    "Attachments",
     "Topics",
     # Types
     "Audience",
@@ -73,12 +70,12 @@
     "Topic",
     "BatchValidationError",
     "ReceivedEmail",
-    "ReceivedEmailAttachment",
-    "ReceivedEmailAttachmentDetails",
+    "EmailAttachment",
+    "EmailAttachmentDetails",
     "ListReceivedEmail",
     # Receiving types (for type hints)
     "EmailsReceiving",
-    "AttachmentsReceiving",
+    "EmailAttachments",
     # Default HTTP Client
     "RequestsClient",
 ]

resend/attachments/__init__.py

@@ -3,17 +3,11 @@
 from typing_extensions import NotRequired, TypedDict
 
 from resend import request
-from resend.emails._received_email import (ReceivedEmailAttachment,
-                                           ReceivedEmailAttachmentDetails)
+from resend.emails._received_email import (EmailAttachment,
+                                           EmailAttachmentDetails)
 from resend.pagination_helper import PaginationHelper
 
 
-# Internal wrapper type for get attachment API response
-class _GetAttachmentResponse(TypedDict):
-    object: str
-    data: ReceivedEmailAttachmentDetails
-
-
 class _ListParams(TypedDict):
     limit: NotRequired[int]
     """
@@ -34,7 +28,7 @@ class _ListResponse(TypedDict):
     """
     The object type: "list"
     """
-    data: List[ReceivedEmailAttachment]
+    data: List[EmailAttachment]
     """
     The list of attachment objects.
     """
@@ -44,9 +38,9 @@ class _ListResponse(TypedDict):
     """
 
 
-class Receiving:
+class Attachments:
     """
-    Receiving class that provides methods for retrieving attachments from received emails.
+    Attachments class that provides methods for retrieving attachments from sent emails.
     """
 
     class ListParams(_ListParams):
@@ -65,49 +59,48 @@ class ListResponse(_ListResponse):
 
         Attributes:
             object (str): The object type: "list"
-            data (List[ReceivedEmailAttachment]): The list of attachment objects.
+            data (List[EmailAttachment]): The list of attachment objects.
             has_more (bool): Whether there are more attachments available for pagination.
         """
 
     @classmethod
-    def get(cls, email_id: str, attachment_id: str) -> ReceivedEmailAttachmentDetails:
+    def get(cls, email_id: str, attachment_id: str) -> EmailAttachmentDetails:
         """
-        Retrieve a single attachment from a received email.
-        see more: https://resend.com/docs/api-reference/attachments/retrieve-attachment
+        Retrieve a single attachment from a sent email.
+        see more: https://resend.com/docs/api-reference/attachments/retrieve-sent-email-attachment
 
         Args:
-            email_id (str): The ID of the received email
+            email_id (str): The ID of the sent email
             attachment_id (str): The ID of the attachment to retrieve
 
         Returns:
-            ReceivedEmailAttachmentDetails: The attachment details including download URL
+            EmailAttachmentDetails: The attachment details including download URL
         """
-        path = f"/emails/receiving/{email_id}/attachments/{attachment_id}"
-        resp = request.Request[_GetAttachmentResponse](
+        path = f"/emails/{email_id}/attachments/{attachment_id}"
+        resp = request.Request[EmailAttachmentDetails](
             path=path,
             params={},
             verb="get",
         ).perform_with_content()
-        # Extract the data field from the wrapped response
-        return resp["data"]
+        return resp
 
     @classmethod
     def list(cls, email_id: str, params: Optional[ListParams] = None) -> ListResponse:
         """
-        Retrieve a list of attachments from a received email.
-        see more: https://resend.com/docs/api-reference/attachments/list-attachments
+        Retrieve a list of attachments from a sent email.
+        see more: https://resend.com/docs/api-reference/attachments/list-sent-email-attachments
 
         Args:
-            email_id (str): The ID of the received email
+            email_id (str): The ID of the sent email
             params (Optional[ListParams]): The list parameters for pagination
 
         Returns:
             ListResponse: A paginated list of attachment objects
         """
-        base_path = f"/emails/receiving/{email_id}/attachments"
+        base_path = f"/emails/{email_id}/attachments"
         query_params = cast(Dict[Any, Any], params) if params else None
         path = PaginationHelper.build_paginated_path(base_path, query_params)
-        resp = request.Request[Receiving.ListResponse](
+        resp = request.Request[Attachments.ListResponse](
             path=path,
             params={},
             verb="get",

resend/attachments/_attachments.py

@@ -4,6 +4,7 @@
 
 from resend import request
 from resend.emails._attachment import Attachment, RemoteAttachment
+from resend.emails._attachments import Attachments
 from resend.emails._email import Email
 from resend.emails._receiving import Receiving
 from resend.emails._tag import Tag
@@ -104,6 +105,7 @@ class _SendParamsDefault(_SendParamsFrom):
 
 
 class Emails:
+    Attachments = Attachments
     Receiving = Receiving
 
     class CancelScheduledEmailResponse(_CancelScheduledEmailResponse):

resend/attachments/_receiving.py resend/emails/_attachments.pyresend/attachments/_receiving.py renamed to resend/emails/_attachments.py

@@ -3,9 +3,9 @@
 from typing_extensions import NotRequired, TypedDict
 
 
-class ReceivedEmailAttachment(TypedDict):
+class EmailAttachment(TypedDict):
     """
-    ReceivedEmailAttachment type that wraps an attachment object from a received email.
+    EmailAttachment type that wraps an attachment object from an email.
 
     Attributes:
         id (str): The attachment ID.
@@ -42,11 +42,12 @@ class ReceivedEmailAttachment(TypedDict):
     """
 
 
-class ReceivedEmailAttachmentDetails(TypedDict):
+class EmailAttachmentDetails(TypedDict):
     """
-    ReceivedEmailAttachmentDetails type that wraps a received email attachment with download details.
+    EmailAttachmentDetails type that wraps an email attachment with download details.
 
     Attributes:
+        object (str): The object type.
         id (str): The attachment ID.
         filename (str): The filename of the attachment.
         content_type (str): The content type of the attachment.
@@ -56,6 +57,10 @@ class ReceivedEmailAttachmentDetails(TypedDict):
         expires_at (str): When the download URL expires.
     """
 
+    object: str
+    """
+    The object type.
+    """
     id: str
     """
     The attachment ID.
@@ -153,7 +158,7 @@ class _ReceivedEmailDefaultAttrs(_ReceivedEmailFromParam):
     """
     Email headers.
     """
-    attachments: List[ReceivedEmailAttachment]
+    attachments: List[EmailAttachment]
     """
     List of attachments.
     """
@@ -177,7 +182,7 @@ class ReceivedEmail(_ReceivedEmailDefaultAttrs):
         reply_to (Optional[List[str]]): Reply-to addresses.
         message_id (str): The message ID of the email.
         headers (NotRequired[Dict[str, str]]): Email headers.
-        attachments (List[ReceivedEmailAttachment]): List of attachments.
+        attachments (List[EmailAttachment]): List of attachments.
     """
 
 
@@ -214,7 +219,7 @@ class _ListReceivedEmailDefaultAttrs(_ListReceivedEmailFromParam):
     """
     The message ID of the email.
     """
-    attachments: List[ReceivedEmailAttachment]
+    attachments: List[EmailAttachment]
     """
     List of attachments.
     """
@@ -235,5 +240,5 @@ class ListReceivedEmail(_ListReceivedEmailDefaultAttrs):
         cc (Optional[List[str]]): Cc recipients.
         reply_to (Optional[List[str]]): Reply-to addresses.
         message_id (str): The message ID of the email.
-        attachments (List[ReceivedEmailAttachment]): List of attachments.
+        attachments (List[EmailAttachment]): List of attachments.
     """