Add Accounts API

CHANGELOG.md

@@ -1,6 +1,7 @@
 - Add Sandbox Messages API
 - Add Sending Domains API
 - Add Sandbox Attachments API
+- Add Accounts API
 
 ## [2.6.0] - 2026-01-27
 - Add Inboxes API

README.md

@@ -189,10 +189,11 @@ Contact management:
 
 - Contacts CRUD & Listing – [`contacts_api.rb`](examples/contacts_api.rb)
 
-General API:
+General:
 
 - Templates CRUD – [`email_templates_api.rb`](examples/email_templates_api.rb)
 - Action Mailer – [`action_mailer.rb`](examples/action_mailer.rb)
+- Accounts API – [`accounts_api.rb`](examples/accounts_api.rb)
 
 ## Migration guide v1 → v2
 

examples/accounts_api.rb

@@ -0,0 +1,15 @@
+require 'mailtrap'
+
+client = Mailtrap::Client.new(api_key: 'your-api-key')
+account_id = 3229
+accounts = Mailtrap::AccountsAPI.new(account_id, client)
+
+# Set your API credentials as environment variables
+# export MAILTRAP_API_KEY='your-api-key'
+# export MAILTRAP_ACCOUNT_ID=your-account-id
+
+# accounts = Mailtrap::AccountsAPI.new
+
+# Get all accounts
+accounts.list
+# => [#<struct Mailtrap::Account id=123456, name="My Account", access_levels=[1000]>]

lib/mailtrap.rb

@@ -4,17 +4,18 @@
 require_relative 'mailtrap/mail'
 require_relative 'mailtrap/errors'
 require_relative 'mailtrap/version'
-require_relative 'mailtrap/email_templates_api'
+require_relative 'mailtrap/accounts_api'
 require_relative 'mailtrap/contacts_api'
 require_relative 'mailtrap/contact_lists_api'
 require_relative 'mailtrap/contact_fields_api'
 require_relative 'mailtrap/contact_imports_api'
-require_relative 'mailtrap/suppressions_api'
-require_relative 'mailtrap/sending_domains_api'
-require_relative 'mailtrap/projects_api'
+require_relative 'mailtrap/email_templates_api'
 require_relative 'mailtrap/inboxes_api'
+require_relative 'mailtrap/projects_api'
 require_relative 'mailtrap/sandbox_messages_api'
 require_relative 'mailtrap/sandbox_attachments_api'
+require_relative 'mailtrap/suppressions_api'
+require_relative 'mailtrap/sending_domains_api'
 
 module Mailtrap
   # @!macro api_errors

lib/mailtrap/account.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Фссщгте
+  # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/d26921ca2a48f-get-all-accounts
+  # @attr_reader id [Integer] The account ID
+  # @attr_reader name [String] The account name
+  # @attr_reader access_levels [Array] The account access levels
+  #
+  Account = Struct.new(
+    :id,
+    :name,
+    :access_levels,
+    keyword_init: true
+  )
+end

lib/mailtrap/accounts_api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'account'
+
+module Mailtrap
+  class AccountsAPI
+    include BaseAPI
+
+    self.response_class = Account
+
+    # Lists all accounts
+    # @return [Array<Account>] Array of accounts
+    # @!macro api_errors
+    def list
+      base_list
+    end
+
+    private
+
+    def base_path
+      '/api/accounts'
+    end
+  end
+end

spec/mailtrap/account_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe Mailtrap::Account do
+  describe '#initialize' do
+    subject(:account) { described_class.new(attributes) }
+
+    let(:attributes) do
+      {
+        id: '123456',
+        name: 'Account 1',
+        access_levels: [
+          1000
+        ]
+      }
+    end
+
+    it 'creates a project with all attributes' do
+      expect(account).to match_struct(
+        id: '123456',
+        name: 'Account 1',
+        access_levels: [1000]
+      )
+    end
+  end
+end

spec/mailtrap/accounts_api_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.describe Mailtrap::AccountsAPI, :vcr do
+  subject(:accounts_api) { described_class.new(account_id, client) }
+
+  let(:account_id) { ENV.fetch('MAILTRAP_ACCOUNT_ID', 1_111_111) }
+  let(:client) { Mailtrap::Client.new(api_key: ENV.fetch('MAILTRAP_API_KEY', 'local-api-key')) }
+
+  describe '#list' do
+    subject(:list) { accounts_api.list }
+
+    it 'maps response data to Account objects' do
+      expect(list).to all(be_a(Mailtrap::Account))
+      expect(list.size).to eq(1)
+    end
+
+    context 'when api key is incorrect' do
+      let(:client) { Mailtrap::Client.new(api_key: 'incorrect-api-key') }
+
+      it 'raises authorization error' do
+        expect { list }.to raise_error do |error|
+          expect(error).to be_a(Mailtrap::AuthorizationError)
+          expect(error.message).to include('Incorrect API token')
+          expect(error.messages.any? { |msg| msg.include?('Incorrect API token') }).to be true
+        end
+      end
+    end
+  end
+end