Add Sandbox Attachments API

lib/mailtrap.rb

@@ -11,6 +11,7 @@
 require_relative 'mailtrap/contact_imports_api'
 require_relative 'mailtrap/suppressions_api'
 require_relative 'mailtrap/projects_api'
+require_relative 'mailtrap/sandbox_attachments_api'
 
 module Mailtrap
   # @!macro api_errors

lib/mailtrap/sandbox_attachment.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for SandboxAttachment
+  # @see https://docs.mailtrap.io/developers/email-sandbox/email-sandbox-api/attachments
+  # @attr_reader id [Integer] The project ID
+  # @attr_reader message_id [Integer] The message ID
+  # @attr_reader filename [String] The attachment filename
+  # @attr_reader attachment_type [String] The attachment type
+  # @attr_reader content_type [String] The attachment content type
+  # @attr_reader content_id [String] The attachment content ID
+  # @attr_reader transfer_encoding [String] The attachment transfer encoding
+  # @attr_reader attachment_size [Integer] The attachment size in bytes
+  # @attr_reader created_at [String] The attachment creation timestamp
+  # @attr_reader updated_at [String] The attachment update timestamp
+  # @attr_reader attachment_human_size [String] The attachment size in human-readable format
+  # @attr_reader download_path [String] The attachment download path
+  #
+  SandboxAttachment = Struct.new(
+    :id,
+    :message_id,
+    :filename,
+    :attachment_type,
+    :content_type,
+    :content_id,
+    :transfer_encoding,
+    :attachment_size,
+    :created_at,
+    :updated_at,
+    :attachment_human_size,
+    :download_path,
+    keyword_init: true
+  ) do
+    # @return [Hash] The Project attributes as a hash
+    def to_h
+      super.compact
+    end
+  end
+end

lib/mailtrap/sandbox_attachments_api.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'sandbox_attachment'
+
+module Mailtrap
+  class SandboxAttachmentsAPI
+    include BaseAPI
+
+    self.response_class = SandboxAttachment
+
+    # Retrieves a specific sandbox attachment
+    # @param inbox_id [Integer] The inbox ID
+    # @param sandbox_message_id [Integer] The sandbox message ID
+    # @param sandbox_attachment_id [Integer] The sandbox attachment ID
+    # @return [SandboxAttachment] Sandbox attachment object
+    # @!macro api_errors
+    def get(inbox_id, sandbox_message_id, sandbox_attachment_id)
+      response = client.get(
+        "#{base_path}/inboxes/#{inbox_id}/messages/#{sandbox_message_id}/attachments/#{sandbox_attachment_id}"
+      )
+      handle_response(response)
+    end
+
+    # Lists all sandbox messages for the account, limited up to 30 at once
+    # @param inbox_id [Integer] The inbox ID
+    # @param sandbox_message_id [Integer] The sandbox message ID
+    # @return [Array<SandboxAttachment>] Array of sandbox message objects
+    # @!macro api_errors
+    def list(inbox_id, sandbox_message_id)
+      response = client.get("#{base_path}/inboxes/#{inbox_id}/messages/#{sandbox_message_id}/attachments")
+      response.map { |item| handle_response(item) }
+    end
+
+    private
+
+    def base_path
+      "/api/accounts/#{account_id}"
+    end
+  end
+end