Skip to content

MT-20050: Add new examples #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DagonWat merged 2 commits into from
Mar 18, 2026
Merged

MT-20050: Add new examples #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09d3d11
MT-20050: Add new examples
DagonWat Mar 13, 2026
fd14e1d
Add more puts messages to correspond to standard
DagonWat Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions specs/account-management.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,18 @@ paths:
print(f"Account: {account.name}")
print(f"ID: {account.id}")
print(f"Access Level: {account.access_levels[0]}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
accounts = Mailtrap::AccountsAPI.new(client)

accounts.list.each do |account|
puts "Account: #{account.name}"
puts "ID: #{account.id}"
end
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -212,6 +224,22 @@ paths:
accesses = client.general_api.account_accesses.get_list(account_id)
for access in accesses:
print(f"User: {access.specifier.email}, Level: {access.permission_level}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
account_accesses = Mailtrap::AccountAccessesAPI.new(YOUR_ACCOUNT_ID, client)

account_accesses.list.each do |access|
puts access.specifier
end

# With optional filters
puts account_accesses.list(domain_ids: [1, 2])
puts account_accesses.list(inbox_ids: [12, 34])
puts account_accesses.list(project_ids: [100, 200])
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -326,6 +354,15 @@ paths:

client = mt.MailtrapClient(token="YOUR_API_KEY")
client.general_api.account_accesses.delete(account_id, access_id)
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
account_accesses = Mailtrap::AccountAccessesAPI.new(YOUR_ACCOUNT_ID, client)

account_accesses.delete(ACCOUNT_ACCESS_ID)
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -881,6 +918,15 @@ paths:
client = mt.MailtrapClient(token="YOUR_API_KEY")
usage = client.general_api.billing.get_current_billing_usage(account_id)
print(f"Sandbox sent: {usage.testing.usage.sent_messages_count.current}/{usage.testing.usage.sent_messages_count.limit}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
billing = Mailtrap::BillingAPI.new(YOUR_ACCOUNT_ID, client)

puts "Usage: #{billing.usage}"
- lang: csharp
label: C#
source: |
Expand Down
8 changes: 8 additions & 0 deletions specs/contacts.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1073,6 +1073,7 @@ paths:
import_job = imports.create([
{ email: "user1@example.com", fields: { first_name: "John" }, list_ids_included: [1, 2] }
])
puts "Import job: #{import_job}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1193,6 +1194,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
imports = Mailtrap::ContactImportsAPI.new(YOUR_ACCOUNT_ID, client)
import_status = imports.get(import_id)
puts "Import status: #{import_status}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1292,6 +1294,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
all_lists = lists.list
puts "Lists: #{all_lists}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1384,6 +1387,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
new_list = lists.create(name: "Customers")
puts "List: #{new_list}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1482,6 +1486,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
list = lists.get(list_id)
puts "List: #{list}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1752,6 +1757,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
all_fields = fields.list
puts "All fields: #{all_fields}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1851,6 +1857,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
new_field = fields.create(name: "Company", data_type: "text", merge_tag: "company")
puts "New field: #{new_field}"
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1986,6 +1993,7 @@ paths:
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
field = fields.get(field_id)
puts field
- lang: csharp
label: C#
source: |
Expand Down
96 changes: 96 additions & 0 deletions specs/email-sending.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ paths:
domain = client.sending_domains_api.sending_domains.create(params)

print(f"Created domain: {domain}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)

domain = sending_domains.create(domain_name: 'example.com')

puts "Created domain: #{domain.name}"
- lang: csharp
Comment on lines +124 to 135
Copy link

@coderabbitai coderabbitai bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Verify Mailtrap Ruby SendingDomain fields from the official SDK source.
curl -fsSL https://raw.githubusercontent.com/mailtrap/mailtrap-ruby/main/lib/mailtrap/sending_domain.rb | sed -n '1,120p'

Repository: mailtrap/mailtrap-openapi

Length of output: 1900

Use domain.domain_name instead of domain.name in Ruby sending-domain samples.

The Ruby Mailtrap::SendingDomain struct defines the field as domain_name, not name. Update the three code samples at lines 124-135, 267-277, and 385-395.

Required changes 
-            puts "Created domain: #{domain.name}"
+            puts "Created domain: #{domain.domain_name}"
-              puts "Domain: #{domain.name}"
+              puts "Domain: #{domain.domain_name}"
-            puts "Domain: #{domain.name}"
+            puts "Domain: #{domain.domain_name}"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- lang: ruby
label: Ruby
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)
domain = sending_domains.create(domain_name: 'example.com')
puts "Created domain: #{domain.name}"
- lang: csharp
- lang: ruby
label: Ruby
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)
domain = sending_domains.create(domain_name: 'example.com')
puts "Created domain: #{domain.domain_name}"
- lang: csharp
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@specs/email-sending.openapi.yml` around lines 124 - 135, The Ruby examples
that create a sending domain use the wrong field name: replace domain.name with
domain.domain_name in every Ruby snippet that instantiates Mailtrap::Client and
uses Mailtrap::SendingDomainsAPI#create (look for the snippets that call
Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client) and assign the result
to domain); update all three occurrences so the output prints domain.domain_name
instead of domain.name.

label: .NET
source: |
Expand Down Expand Up @@ -253,6 +264,17 @@ paths:

for domain in domains:
print(f"Domain: {domain.domain_name}, Verified: {domain.dns_verified}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)

sending_domains.list.each do |domain|
puts "Domain: #{domain.name}"
end
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -360,6 +382,17 @@ paths:

print(f"Domain: {domain.domain_name}")
print(f"DNS Verified: {domain.dns_verified}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)

domain = sending_domains.get(DOMAIN_ID)

puts "Domain: #{domain.name}"
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -464,6 +497,15 @@ paths:
client.sending_domains_api.sending_domains.delete(domain_id)

print("Domain deleted successfully")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)

sending_domains.delete(DOMAIN_ID)
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -583,6 +625,15 @@ paths:
)

print("Setup instructions sent")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
sending_domains = Mailtrap::SendingDomainsAPI.new(YOUR_ACCOUNT_ID, client)

sending_domains.send_setup_instructions(DOMAIN_ID, email: 'devops@example.com')
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -980,6 +1031,15 @@ paths:
source: |
curl -X GET 'https://mailtrap.io/api/accounts/{account_id}/stats?start_date=2025-01-01&end_date=2025-12-31' \
-H 'Authorization: Bearer YOUR_API_KEY'
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
stats = Mailtrap::StatsAPI.new(YOUR_ACCOUNT_ID, client)

puts "Stats: #{stats.get(start_date: '2026-01-01', end_date: '2026-01-31')}"
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/StartDateQueryFilter'
Expand Down Expand Up @@ -1016,6 +1076,15 @@ paths:
source: |
curl -X GET 'https://mailtrap.io/api/accounts/{account_id}/stats/domains?start_date=2025-01-01&end_date=2025-12-31' \
-H 'Authorization: Bearer YOUR_API_KEY'
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
stats = Mailtrap::StatsAPI.new(YOUR_ACCOUNT_ID, client)

puts "Stats: #{stats.by_domain(start_date: '2026-01-01', end_date: '2026-01-31')}"
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/StartDateQueryFilter'
Expand Down Expand Up @@ -1061,6 +1130,15 @@ paths:
source: |
curl -X GET 'https://mailtrap.io/api/accounts/{account_id}/stats/categories?start_date=2025-01-01&end_date=2025-12-31' \
-H 'Authorization: Bearer YOUR_API_KEY'
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
stats = Mailtrap::StatsAPI.new(YOUR_ACCOUNT_ID, client)

puts "Stats: #{stats.by_category(start_date: '2026-01-01', end_date: '2026-01-31')}"
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/StartDateQueryFilter'
Expand Down Expand Up @@ -1105,6 +1183,15 @@ paths:
source: |
curl -X GET 'https://mailtrap.io/api/accounts/{account_id}/stats/email_service_providers?start_date=2025-01-01&end_date=2025-12-31' \
-H 'Authorization: Bearer YOUR_API_KEY'
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
stats = Mailtrap::StatsAPI.new(YOUR_ACCOUNT_ID, client)

puts "Stats: #{stats.by_email_service_provider(start_date: '2026-01-01', end_date: '2026-01-31')}"
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/StartDateQueryFilter'
Expand Down Expand Up @@ -1149,6 +1236,15 @@ paths:
source: |
curl -X GET 'https://mailtrap.io/api/accounts/{account_id}/stats/date?start_date=2025-01-01&end_date=2025-12-31' \
-H 'Authorization: Bearer YOUR_API_KEY'
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: ENV['MAILTRAP_API_KEY'])
stats = Mailtrap::StatsAPI.new(YOUR_ACCOUNT_ID, client)

puts "Stats: #{stats.by_date(start_date: '2026-01-01', end_date: '2026-01-31')}"
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/StartDateQueryFilter'
Expand Down
Loading
Loading