Skip to content

Fix Python code examples in OpenAPI specifications to align with mailtrap-python SDK #10

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
yanchuk merged 3 commits into from
Jan 1, 2026
Merged

Fix Python code examples in OpenAPI specifications to align with mailtrap-python SDK #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc05334
Minor fixes for Python examples
Dec 29, 2025
c4f09f7
Added minor fixes to python examples for billing and contact_imports
Dec 29, 2025
076ab16
Added fixes for sanbox docs
Dec 31, 2025
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
118 changes: 79 additions & 39 deletions specs/contacts.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_TOKEN",
account_id=ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

contact = client.contacts_api.contacts.create(
Expand Down Expand Up @@ -347,7 +347,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_TOKEN",
account_id=ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

# Get by contact ID
Expand Down Expand Up @@ -703,8 +703,14 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
event = client.contacts_api.contacts.create_event("contact_id", name="UserLogin", params={"user_id": 101, "is_active": True})
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
event = client.contacts_api.contact_events.create(
contact_identifier="contact_id",
contact_event_params=mt.ContactEventParams(
name="UserLogin",
params={"user_id": 101, "is_active": True}
)
)
print(event)
- lang: csharp
label: C#
Expand Down Expand Up @@ -811,8 +817,12 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
export_job = client.contacts_api.exports.create(filters=[{"name": "list_id", "operator": "equal", "value": [1, 2]}])
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
export_job = client.contacts_api.contact_exports.create(
filters=[
mt.ContactExportFilter(name="list_id", operator="equal", value=[1, 2])
]
)
print(f"Export started: {export_job.id}")
- lang: csharp
label: C#
Expand Down Expand Up @@ -914,8 +924,11 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
export_status = client.contacts_api.exports.get(export_id)
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

export_id = 12345

export_status = client.contacts_api.contact_exports.get_by_id(export_id)
print(f"Status: {export_status.status}, URL: {export_status.url}")
- lang: csharp
label: C#
Expand Down Expand Up @@ -1023,11 +1036,13 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
import_job = client.contacts_api.imports.create(contacts=[
{"email": "user1@example.com", "fields": {"first_name": "John"}, "list_ids_included": [1, 2]},
{"email": "user2@example.com", "fields": {"first_name": "Jane"}, "list_ids_included": [1]}
])
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
import_job = client.contacts_api.contact_imports.import_contacts(
contacts=[
mt.ImportContactParams(email="user1@example.com", fields={"first_name": "John"}, list_ids_included=[1, 2]),
mt.ImportContactParams(email="user2@example.com", fields={"first_name": "Jane"}, list_ids_included=[1])
]
)
print(f"Import started: {import_job.id}")
- lang: ruby
label: Ruby
Expand Down Expand Up @@ -1140,8 +1155,11 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
import_status = client.contacts_api.imports.get(import_id)
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

import_id = 12345

import_status = client.contacts_api.contact_imports.get_by_id(import_id)
print(f"Status: {import_status.status}")
- lang: ruby
label: Ruby
Expand Down Expand Up @@ -1233,10 +1251,10 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
lists = client.contacts_api.lists.get_all()
for lst in lists:
print(f"{lst.id}: {lst.name}")
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
contact_lists = client.contacts_api.contact_lists.get_list()
for contact_list in contact_lists:
print(f"{contact_list.id}: {contact_list.name}")
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -1319,9 +1337,9 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
list = client.contacts_api.lists.create(name="Customers")
print(f"Created list: {list.id}")
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
contact_list = client.contacts_api.contact_lists.create(mt.ContactListParams(name="Customers"))
print(f"Created list: {contact_list.id}")
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -1411,9 +1429,10 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
list = client.contacts_api.lists.get(list_id)
print(f"List: {list.name}")
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
list_id = 12345
contact_list = client.contacts_api.contact_lists.get_by_id(list_id)
print(f"List: {contact_list.name}")
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -1488,8 +1507,15 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
list = client.contacts_api.lists.update(list_id, name="Former Customers")

client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

list_id = 12345
contact_list = client.contacts_api.contact_lists.update(
list_id,
mt.ContactListParams(name="Former Customers")
)
print(f"Updated list: {contact_list.name}")
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -1577,8 +1603,11 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
client.contacts_api.lists.delete(list_id)

client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

list_id = 12345
client.contacts_api.contact_lists.delete(list_id)
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -1653,8 +1682,8 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
fields = client.contacts_api.fields.get_all()
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
fields = client.contacts_api.contact_fields.get_list()
for field in fields:
print(f"{field.name}: {field.data_type}")
- lang: ruby
Expand Down Expand Up @@ -1744,8 +1773,10 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
field = client.contacts_api.fields.create(name="Company", data_type="text", merge_tag="company")
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
field = client.contacts_api.contact_fields.create(
mt.CreateContactFieldParams(name="Company", data_type="text", merge_tag="company")
)
print(f"Field created: {field.id}")
- lang: ruby
label: Ruby
Expand Down Expand Up @@ -1872,8 +1903,10 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
field = client.contacts_api.fields.get(field_id)
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

field_id = 12345
field = client.contacts_api.contact_fields.get_by_id(field_id)
print(f"Field: {field.name} ({field.data_type})")
- lang: ruby
label: Ruby
Expand Down Expand Up @@ -1952,8 +1985,13 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
field = client.contacts_api.fields.update(field_id, name="Updated Name", merge_tag="updated_name")
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

field_id = 12345
field = client.contacts_api.contact_fields.update(
field_id,
mt.UpdateContactFieldParams(name="Updated Name", merge_tag="updated_name")
)
- lang: ruby
label: Ruby
source: |
Expand Down Expand Up @@ -2065,8 +2103,10 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
client.contacts_api.fields.delete(field_id)
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")

field_id = 12345
client.contacts_api.contact_fields.delete(field_id)
- lang: ruby
label: Ruby
source: |
Expand Down
57 changes: 48 additions & 9 deletions specs/email-api.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

params = mt.CreateSendingDomainParams(domain_name="example.com")
Expand Down Expand Up @@ -233,7 +233,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

domains = client.sending_domains_api.sending_domains.get_list()
Expand Down Expand Up @@ -336,7 +336,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

domain_id = 12345
Expand Down Expand Up @@ -437,7 +437,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

domain_id = 12345
Expand Down Expand Up @@ -546,7 +546,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

domain_id = 12345
Expand Down Expand Up @@ -697,7 +697,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

# Get all suppressions
Expand Down Expand Up @@ -852,7 +852,7 @@ paths:

client = mt.MailtrapClient(
token="YOUR_API_KEY",
account_id=YOUR_ACCOUNT_ID
account_id="YOUR_ACCOUNT_ID"
)

suppression_id = "abc123-def456"
Expand Down Expand Up @@ -960,7 +960,7 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id="YOUR_ACCOUNT_ID")
templates = client.email_templates_api.templates.get_list()
for tpl in templates:
print(f"{tpl.name}: {tpl.uuid}")
Expand Down Expand Up @@ -1059,7 +1059,7 @@ paths:
label: Python
source: |
import mailtrap as mt
client = mt.MailtrapClient(token="YOUR_API_TOKEN", account_id=YOUR_ACCOUNT_ID)
client = mt.MailtrapClient(token="YOUR_API_TOKEN", account_id="YOUR_ACCOUNT_ID")
template = client.email_templates_api.templates.create(
mt.CreateEmailTemplateParams(
name="Welcome Email",
Expand Down Expand Up @@ -1194,6 +1194,16 @@ paths:
$templateId = $_ENV['MAILTRAP_TEMPLATE_ID'];
$response = $emailTemplates->getEmailTemplate($templateId);
var_dump(ResponseHelper::toArray($response));
- lang: python
label: Python
source: |
import mailtrap as mt

client = mt.MailtrapClient(token="YOUR_API_TOKEN", account_id="YOUR_ACCOUNT_ID")

template_id = 12345
template = client.email_templates_api.templates.get_by_id(template_id)
print(f"Template: {template.name} (ID: {template.id})")
- lang: shell
label: cURL
source: |
Expand Down Expand Up @@ -1263,6 +1273,24 @@ paths:
)
);
var_dump(ResponseHelper::toArray($response));
- lang: python
label: Python
source: |
import mailtrap as mt

email_template_id = "YOUR_TEMPLATE_ID"

client = mt.MailtrapClient(token="YOUR_API_TOKEN", account_id="YOUR_ACCOUNT_ID")
template = client.email_templates_api.templates.update(
template_id=email_template_id,
template_params=mt.UpdateEmailTemplateParams(
name="Edited Welcome Email",
subject="Edited Welcome to {{company_name}}!",
category="onboarding",
body_html="<h1>Edited Welcome {{user_name}}!</h1>",
body_text="Edited Welcome {{user_name}}!"
)
)
- lang: shell
label: cURL
source: |
Expand Down Expand Up @@ -1335,6 +1363,17 @@ paths:
$templateId = $_ENV['MAILTRAP_TEMPLATE_ID'];
$response = $emailTemplates->deleteEmailTemplate($templateId);
var_dump($response->getStatusCode());
- lang: python
label: Python
source: |
import mailtrap as mt

email_template_id = "YOUR_TEMPLATE_ID"

client = mt.MailtrapClient(token="YOUR_API_TOKEN", account_id="YOUR_ACCOUNT_ID")
deleted_template = client.email_templates_api.templates.delete(
template_id=email_template_id
)
- lang: shell
label: cURL
source: |
Expand Down
Loading