Add Receiving and Send Attachment (#89)

Author: filipetoscano

src/Resend/IResend.cs

@@ -170,6 +170,24 @@ public interface IResend
     /// <see href="https://www.resend.com/docs/api-reference/emails/cancel-email"/>
     Task<ResendResponse> EmailCancelAsync( Guid emailId, CancellationToken cancellationToken = default );
 
+    /// <summary>
+    /// Lists email attachments from a sent email.
+    /// </summary>
+    /// <param name="emailId">Sent email identifier.</param>
+    /// <param name="query">Paginated query.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>List of attachments.</returns>
+    Task<ResendResponse<PaginatedResult<SentEmailAttachment>>> EmailAttachmentListAsync( Guid emailId, PaginatedQuery? query = null, CancellationToken cancellationToken = default );
+
+    /// <summary>
+    /// Retrieves an email attachment of a sent email.
+    /// </summary>
+    /// <param name="emailId">Sent email identifier.</param>
+    /// <param name="attachmentId">Sent email attachment identifier.</param>
+    /// <param name="cancellationToken">Cancellation token.</param>
+    /// <returns>Email attachment.</returns>
+    Task<ResendResponse<SentEmailAttachment>> EmailAttachmentRetrieveAsync( Guid emailId, Guid attachmentId, CancellationToken cancellationToken = default );
+
     #endregion
 
     #region Domains

src/Resend/README.md

@@ -13,15 +13,16 @@ Functionality
 
 The `ResendClient` supports the following objects (and methods):
 
-* Email (Send, Batch, Retrieve, Reschedule, Cancel)
+* Email (Send, Batch, Retrieve, Reschedule, Cancel, Attachment List, Attachment Retrieve)
 * Receiving (List, Retrieve, Attachment List, Attachment Retrieve)
 * Domain (List, Add, Retrieve, Update, Verify, Delete)
 * API key (List, Create, Delete)
-* Topics (List, Create, Retrieve, Update, Delete)
-* Templates (List, Create, Retrieve, Update, Delete, Publish, Duplicate)
-* Contact (List, Add, Retrieve, Update, Delete)
 * Broadcast (List, Add, Retrieve, Update, Send, Schedule, Delete)
 * Audience (List, Add, Retrieve, Delete)
+* Contact (List, Add, Retrieve, Update, Delete)
+* Segment (List, Create, Retrieve, Delete)
+* Topics (List, Create, Retrieve, Update, Delete)
+* Templates (List, Create, Retrieve, Update, Delete, Publish, Duplicate)
 * Webhooks (List, Create, Retrieve, Update, Delete)
 
 

src/Resend/ResendClient.Receiving.cs

@@ -7,7 +7,7 @@ public partial class ResendClient
     /// <inheritdoc />
     public Task<ResendResponse<PaginatedResult<ReceivedEmail>>> ReceivedEmailListAsync( PaginatedQuery? query = null, CancellationToken cancellationToken = default )
     {
-        var baseUrl = "/emails/receiving/";
+        var baseUrl = "/emails/receiving";
         var url = baseUrl;
 
         if ( query != null )

src/Resend/ResendClient.Sending.cs

@@ -0,0 +1,43 @@
+using Microsoft.AspNetCore.WebUtilities;
+
+namespace Resend;
+
+public partial class ResendClient
+{
+    /// <inheritdoc />
+    public Task<ResendResponse<PaginatedResult<SentEmailAttachment>>> EmailAttachmentListAsync( Guid emailId, PaginatedQuery? query = null, CancellationToken cancellationToken = default )
+    {
+        var baseUrl = $"/emails/{emailId}/attachments";
+        var url = baseUrl;
+
+        if ( query != null )
+        {
+            var qs = new Dictionary<string, string?>();
+
+            if ( query.Limit.HasValue == true )
+                qs.Add( "limit", query.Limit.Value.ToString() );
+
+            if ( query.Before != null )
+                qs.Add( "before", query.Before );
+
+            if ( query.After != null )
+                qs.Add( "after", query.After );
+
+            url = QueryHelpers.AddQueryString( baseUrl, qs );
+        }
+
+        var req = new HttpRequestMessage( HttpMethod.Get, url );
+
+        return Execute<PaginatedResult<SentEmailAttachment>, PaginatedResult<SentEmailAttachment>>( req, ( x ) => x, cancellationToken );
+    }
+
+
+    /// <inheritdoc />
+    public Task<ResendResponse<SentEmailAttachment>> EmailAttachmentRetrieveAsync( Guid emailId, Guid attachmentId, CancellationToken cancellationToken = default )
+    {
+        var path = $"/emails/{emailId}/attachments/{attachmentId}";
+        var req = new HttpRequestMessage( HttpMethod.Get, path );
+
+        return Execute<SentEmailAttachment, SentEmailAttachment>( req, ( x ) => x, cancellationToken );
+    }
+}

src/Resend/SentEmailAttachment.cs

@@ -0,0 +1,64 @@
+using System.Text.Json.Serialization;
+
+namespace Resend;
+
+/// <summary />
+public class SentEmailAttachment
+{
+    /// <summary>
+    /// Sent email attachment identifier.
+    /// </summary>
+    [JsonPropertyName( "id" )]
+    public Guid Id { get; set; }
+
+    /// <summary>
+    /// Attachment filename.
+    /// </summary>
+    [JsonPropertyName( "filename" )]
+    public string Filename { get; set; } = default!;
+
+    /// <summary>
+    /// Inline content identifier.
+    /// </summary>
+    /// <remarks>
+    /// Value can then be used as reference in HTML body using <code>cid</code>
+    /// scheme, e.g. <code>&lt;img src="cid:property-value" &gt; /></code>.
+    /// </remarks>
+    [JsonPropertyName( "content_id" )]
+    [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
+    public string? ContentId { get; set; }
+
+    /// <summary>
+    /// MIME content type.
+    /// </summary>
+    [JsonPropertyName( "content_type" )]
+    public string ContentType { get; set; } = default!;
+
+    /// <summary>
+    /// Content disposition.
+    /// </summary>
+    [JsonPropertyName( "content_disposition" )]
+    [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
+    public AttachmentContentDisposition? ContentDisposition { get; set; }
+
+    /// <summary>
+    /// Attachment file size.
+    /// </summary>
+    [JsonPropertyName( "size" )]
+    public long? FileSize { get; set; }
+
+    /// <summary>
+    /// URL to download attachment.
+    /// </summary>
+    [JsonPropertyName( "download_url" )]
+    [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
+    public string? DownloadUrl { get; set; }
+
+    /// <summary>
+    /// Moment in which the email attachment shall expire.
+    /// </summary>
+    [JsonPropertyName( "expires_at" )]
+    [JsonConverter( typeof( JsonUtcDateTimeConverter ) )]
+    [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
+    public DateTime? MomentExpiration { get; set; }
+}

src/Resend/WebhookEventType.cs

@@ -19,6 +19,9 @@ public enum WebhookEventType
     /// <summary>
     /// An email was received by Resend.
     /// </summary>
+    /// <remarks>
+    /// See https://resend.com/docs/dashboard/receiving/introduction
+    /// </remarks>
     [JsonStringValue( "email.received" )]
     EmailReceived,
 
@@ -62,6 +65,17 @@ public enum WebhookEventType
     [JsonStringValue( "email.opened" )]
     EmailOpened,
 
+    /// <summary>
+    /// Email failed to be sent due to an error.
+    /// </summary>
+    /// <remarks>
+    /// This event is triggered when there are issues such as invalid
+    /// recipients, API key problems, domain verification issues,
+    /// quota limits, or other sending failures.
+    /// </remarks>
+    [JsonStringValue( "email.failed" )]
+    EmailFailed,
+
 
     /// <summary>
     /// A contact was successfully created.

tools/Resend.Cli/Email/EmailAttachmentCommand.cs

@@ -0,0 +1,17 @@
+using McMaster.Extensions.CommandLineUtils;
+
+namespace Resend.Cli.Email;
+
+/// <summary />
+[Command( "attach", Description = "Attachment of sent emails" )]
+[Subcommand( typeof( EmailAttachmentListCommand ) )]
+[Subcommand( typeof( EmailAttachmentRetrieveCommand ) )]
+public class EmailAttachmentCommand
+{
+    /// <summary />
+    public int OnExecute( CommandLineApplication app )
+    {
+        app.ShowHelp();
+        return 1;
+    }
+}

tools/Resend.Cli/Email/EmailAttachmentListCommand.cs

@@ -0,0 +1,68 @@
+using McMaster.Extensions.CommandLineUtils;
+using Spectre.Console;
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json;
+
+namespace Resend.Cli.Email;
+
+/// <summary />
+[Command( "list", Description = "List all attachments in a sent email" )]
+public class EmailAttachmentListCommand
+{
+    private readonly IResend _resend;
+
+    /// <summary />
+    [Argument( 0, Description = "Email identifier" )]
+    [Required]
+    public Guid? EmailId { get; set; }
+
+    /// <summary />
+    [Option( "-j|--json", CommandOptionType.NoValue, Description = "Emit output as JSON array" )]
+    public bool InJson { get; set; }
+
+
+    /// <summary />
+    public EmailAttachmentListCommand( IResend resend )
+    {
+        _resend = resend;
+    }
+
+
+    /// <summary />
+    public async Task<int> OnExecuteAsync()
+    {
+        var res = await _resend.EmailAttachmentListAsync( this.EmailId!.Value );
+        var attachs = res.Content.Data;
+
+        if ( this.InJson == true )
+        {
+            var jso = new JsonSerializerOptions() { WriteIndented = true };
+            var json = JsonSerializer.Serialize( attachs, jso );
+
+            Console.WriteLine( json );
+        }
+        else
+        {
+            var table = new Table();
+            table.Border = TableBorder.SimpleHeavy;
+            table.AddColumn( "Attach Id" );
+            table.AddColumn( "Filename" );
+            table.AddColumn( "File size" );
+            table.AddColumn( "Expiration" );
+
+            foreach ( var c in attachs )
+            {
+                table.AddRow(
+                   new Markup( c.Id.ToString() ),
+                   new Markup( c.Filename ),
+                   new Markup( c.FileSize?.ToString() ?? "" ),
+                   new Markup( c.MomentExpiration?.ToString() ?? "" )
+                );
+            }
+
+            AnsiConsole.Write( table );
+        }
+
+        return 0;
+    }
+}

tools/Resend.Cli/Email/EmailAttachmentRetrieveCommand.cs

@@ -0,0 +1,49 @@
+using McMaster.Extensions.CommandLineUtils;
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json;
+
+namespace Resend.Cli.Email;
+
+/// <summary />
+[Command( "get", Description = "Retrieves an attachment from a sent email" )]
+public class EmailAttachmentRetrieveCommand
+{
+    private readonly IResend _resend;
+
+
+    /// <summary />
+    [Argument( 0, Description = "Email identifier" )]
+    [Required]
+    public Guid? EmailId { get; set; }
+
+    /// <summary />
+    [Argument( 1, Description = "Attachment identifier" )]
+    [Required]
+    public Guid? AttachmentId { get; set; }
+
+
+    /// <summary />
+    public EmailAttachmentRetrieveCommand( IResend resend )
+    {
+        _resend = resend;
+    }
+
+
+    /// <summary />
+    public async Task<int> OnExecuteAsync()
+    {
+        var res = await _resend.EmailAttachmentRetrieveAsync( this.EmailId!.Value, this.AttachmentId!.Value );
+        var attach = res.Content;
+
+
+        /*
+         * 
+         */
+        var jso = new JsonSerializerOptions() { WriteIndented = true };
+        var json = JsonSerializer.Serialize( attach, jso );
+
+        Console.WriteLine( json );
+
+        return 0;
+    }
+}

tools/Resend.Cli/EmailCommand.cs

@@ -4,6 +4,7 @@ namespace Resend.Cli;
 
 /// <summary />
 [Command( "email", Description = "Send emails" )]
+[Subcommand( typeof( Email.EmailAttachmentCommand ) )]
 [Subcommand( typeof( Email.EmailBatchCommand ) )]
 [Subcommand( typeof( Email.EmailCancelCommand ) )]
 [Subcommand( typeof( Email.EmailListCommand ) )]