Skip to content

Updated imports and namings for Java SDK examples #6

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 2 commits into from
Dec 25, 2025
Merged

Updated imports and namings for Java SDK examples #6

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
662c674
Updated imports and namings for Java SDK examples
vitalii-t Dec 24, 2025
b56453b
add missing semicolon
vitalii-t Dec 25, 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
97 changes: 77 additions & 20 deletions specs/contacts.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contact.CreateContactRequest;
import io.mailtrap.model.request.contacts.CreateContactRequest;
import java.util.HashMap;

var config = new MailtrapConfig.Builder()
.token("YOUR_API_TOKEN")
Expand Down Expand Up @@ -516,10 +517,13 @@
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contacts.*;
import java.util.Map;

MailtrapConfig config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);

var request = new UpdateContactRequest(new UpdateContact("new@example.com", Map.of("first_name", "John"), List.of(), List.of(), false));
var response = client.contactsApi().contacts().updateContact(12345L, "contact_id_or_email", request);
var response = client.contactsApi().contacts().updateContact(accountId, "contact_id_or_email", request);
summary: Update contact
tags:
- Contacts
Expand Down Expand Up @@ -621,9 +625,11 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

MailtrapConfig config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
client.contactsApi().contacts().deleteContact(12345L, "contact_id_or_email");

client.contactsApi().contacts().deleteContact(accountId, "contact_id_or_email");
summary: Delete contact
tags:
- Contacts
Expand Down Expand Up @@ -711,10 +717,15 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contactevents.CreateContactEventRequest;
import java.util.Map;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var params = Map.of("user_id", 101, "is_active", true);
var response = client.contactsApi().contacts().createEvent(accountId, "contact_id", "UserLogin", params);

Map<String, Object> params = Map.of("user_id", 101, "is_active", true);
var request = new CreateContactEventRequest("UserLogin", params);
var response = client.contactsApi().contactEvents().createContactEvent(accountId, "contact_id", request);
requestBody:
content:
application/json:
Expand Down Expand Up @@ -818,10 +829,17 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contactexports.ContactExportFilter;
import io.mailtrap.model.request.contactexports.ContactExportFilterOperator;
import io.mailtrap.model.request.contactexports.CreateContactsExportRequest;
import java.util.List;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var filters = List.of(Map.of("name", "list_id", "operator", "equal", "value", List.of(1, 2)));
var response = client.contactsApi().exports().create(accountId, filters);

var idsFilter = ContactExportFilter.listIds(ContactExportFilterOperator.EQUAL, 1L, 2L);
var request = new CreateContactsExportRequest(List.of(idsFilter));
var response = client.contactsApi().contactExports().createContactExport(accountId, request);
requestBody:
content:
application/json:
Expand Down Expand Up @@ -917,8 +935,10 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);

var response = client.contactsApi().exports().get(accountId, exportId);
responses:
'200':
Expand Down Expand Up @@ -1036,10 +1056,15 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contactimports.Contact;
import io.mailtrap.model.request.contactimports.ImportContactsRequest;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var contacts = List.of(Map.of("email", "user1@example.com", "fields", Map.of("first_name", "John")));
var response = client.contactsApi().imports().create(accountId, contacts);

var contact = new Contact("user1@example.com", Map.of("first_name", "John"), Collections.emptyList(), Collections.emptyList());
var importContactsRequest = new ImportContactsRequest(List.of(contact));
client.contactsApi().contactImports().importContacts(accountId, importContactsRequest);
requestBody:
content:
application/json:
Expand Down Expand Up @@ -1141,7 +1166,8 @@
import io.mailtrap.factory.MailtrapClientFactory;
var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().imports().get(accountId, importId);

var response = client.contactsApi().contactImports().getContactImport(accountId, importId);
responses:
'200':
description: OK.
Expand Down Expand Up @@ -1231,9 +1257,11 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().lists().getAll(accountId);

var response = client.contactsApi().contactLists().findAll(accountId);
responses:
'200':
description: OK.
Expand Down Expand Up @@ -1313,9 +1341,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contactlists.CreateUpdateContactListRequest;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().lists().create(accountId, "Customers");

var response = client.contactsApi().contactLists().createContactList(accountId, new CreateUpdateContactListRequest("Customers"));
requestBody:
content:
application/json:
Expand Down Expand Up @@ -1401,9 +1432,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().lists().get(accountId, listId);

long listId = 1L;
var response = client.contactsApi().contactLists().getContactList(accountId, listId);
responses:
'200':
description: Returns attributes of the contact list.
Expand Down Expand Up @@ -1473,9 +1507,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().lists().update(accountId, listId, "Former Customers");

long listId = 1L;
var response = client.contactsApi().contactLists().updateContactList(accountId, listId, new CreateUpdateContactListRequest("Former Customers"));
requestBody:
content:
application/json:
Expand Down Expand Up @@ -1558,9 +1595,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
client.contactsApi().lists().delete(accountId, listId);

long listId = 1L;
client.contactsApi().contactLists().deleteContactList(accountId, listId);
responses:
'204':
description: Contact List successfully deleted
Expand Down Expand Up @@ -1632,9 +1672,11 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().fields().getAll(accountId);

var response = client.contactsApi().contactFields().getAllContactFields(accountId);
responses:
'200':
description: OK.
Expand Down Expand Up @@ -1719,9 +1761,14 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.ContactFieldDataType;
import io.mailtrap.model.request.contactfields.CreateContactFieldRequest;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().fields().create(accountId, "Company", "text", "company");

var request = new CreateContactFieldRequest("Company", ContactFieldDataType.TEXT, "company");
var response = client.contactsApi().contactFields().createContactField(accountId, request);
requestBody:
content:
application/json:
Expand Down Expand Up @@ -1838,9 +1885,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().fields().get(accountId, fieldId);

long fieldId = 2L;
var response = client.contactsApi().contactFields().getContactField(accountId, fieldId);
responses:
'200':
description: Returns attributes of the contact field.
Expand Down Expand Up @@ -1913,9 +1963,13 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.contactfields.UpdateContactFieldRequest;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.contactsApi().fields().update(accountId, fieldId, "Updated Name", "updated_name");

var request = new UpdateContactFieldRequest("Updated Name", "updated_name");
var response = client.contactsApi().contactFields().updateContactField(accountId, fieldId, request);
requestBody:
content:
application/json:
Expand Down Expand Up @@ -2020,9 +2074,12 @@
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
client.contactsApi().fields().delete(accountId, fieldId);

long fieldId = 2L;
client.contactsApi().contactFields().deleteContactField(accountId, fieldId);
responses:
'204':
description: Contact Field successfully deleted
Expand Down Expand Up @@ -2063,15 +2120,15 @@
scheme: bearer
bearerFormat: JWT
schemas:
Contact:

Check warning on line 2123 in specs/contacts.openapi.yml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI files with Spectral 

oas3-unused-component  Potentially unused component has been detected.
$ref: '#/components/schemas/Contact_2'
ContactUpdateRequest:

Check warning on line 2125 in specs/contacts.openapi.yml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI files with Spectral 

oas3-unused-component  Potentially unused component has been detected.
$ref: '#/components/schemas/ContactUpdateRequest_2'
ContactUpdateResponse:

Check warning on line 2127 in specs/contacts.openapi.yml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI files with Spectral 

oas3-unused-component  Potentially unused component has been detected.
$ref: '#/components/schemas/ContactUpdateResponse_2'
ContactCreateRequest:

Check warning on line 2129 in specs/contacts.openapi.yml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI files with Spectral 

oas3-unused-component  Potentially unused component has been detected.
$ref: '#/components/schemas/ContactCreateRequest_2'
ContactList:

Check warning on line 2131 in specs/contacts.openapi.yml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI files with Spectral 

oas3-unused-component  Potentially unused component has been detected.
$ref: '#/components/schemas/ContactList_2'
Contact_2:
type: object
Expand Down
16 changes: 12 additions & 4 deletions specs/email-api.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,9 @@ paths:
suppressions.forEach(suppression ->
System.out.println("Email: " + suppression.getEmail())
);
filtered.forEach(filteredSuppression ->
System.out.println("Email: " + filteredSuppression.getEmail())
);
- lang: shell
label: 'cURL'
source: |
Expand Down Expand Up @@ -1055,9 +1058,11 @@ paths:
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_KEY").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var response = client.emailTemplatesApi().templates().getAll(accountId);

var response = client.emailTemplatesApi().emailTemplates().getAllTemplates(accountId);
- lang: shell
label: cURL
source: |
Expand Down Expand Up @@ -1171,11 +1176,14 @@ paths:
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;

var config = new MailtrapConfig.Builder().token("YOUR_API_TOKEN").build();
var client = MailtrapClientFactory.createMailtrapClient(config);
var request = new CreateTemplateRequest(
"Welcome Email", "Welcome to {{company_name}}!", "onboarding",
"<h1>Welcome {{user_name}}!</h1>", "Welcome {{user_name}}!"

var request = new CreateEmailTemplateRequest(
new EmailTemplate(
"Welcome Email", "onboarding", "Welcome to {{company_name}}!",
"Welcome {{user_name}}!", "<h1>Welcome {{user_name}}!</h1>")
);
var template = client.emailTemplatesApi().emailTemplates().createEmailTemplate(accountId, request);
- lang: shell
Expand Down
19 changes: 9 additions & 10 deletions specs/email-batch.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,35 +207,34 @@ paths:
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.Address;
import io.mailtrap.model.BatchMail;
import io.mailtrap.model.request.emails.Address;
import io.mailtrap.model.request.emails.BatchEmailBase;
import io.mailtrap.model.request.emails.MailtrapBatchMail;
import io.mailtrap.model.request.emails.MailtrapMail;
import java.util.List;
import java.util.Map;

var config = new MailtrapConfig.Builder()
.token("YOUR_API_KEY")
// Add .bulk(true) for Bulk Stream
.build();

var client = MailtrapClientFactory
.createMailtrapClient(config);
var client = MailtrapClientFactory.createMailtrapClient(config);

var base = BatchMail.Base.builder()
var base = BatchEmailBase.builder()
.from(new Address("sender@example.com"))
.subject("Monthly Newsletter")
.text("Check out our latest updates!")
.build();

var requests = List.of(
BatchMail.Request.builder()
MailtrapMail.builder()
.to(List.of(new Address("user1@example.com")))
.build(),
BatchMail.Request.builder()
MailtrapMail.builder()
.to(List.of(new Address("user2@example.com")))
.build()
);

var batchMail = BatchMail.builder()
var batchMail = MailtrapBatchMail.builder()
.base(base)
.requests(requests)
.build();
Expand Down
9 changes: 4 additions & 5 deletions specs/email-sending-bulk.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,17 +172,16 @@ paths:
source: |
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.Address;
import io.mailtrap.model.MailtrapMail;
import io.mailtrap.model.request.emails.Address;
import io.mailtrap.model.request.emails.MailtrapMail;
import java.util.List;

var config = new MailtrapConfig.Builder()
.token("YOUR_API_KEY")
.bulk(true) // Enable bulk sending
.build();

var client = MailtrapClientFactory
.createMailtrapClient(config);
var client = MailtrapClientFactory.createMailtrapClient(config);

var mail = MailtrapMail.builder()
.from(new Address("marketing@example.com"))
Expand All @@ -195,7 +194,7 @@ paths:
.category("newsletter")
.build();

client.bulkApi().emails().send(mail);
client.bulkSendingApi().emails().send(mail);
- lang: shell
label: 'cURL'
source: |
Expand Down
3 changes: 1 addition & 2 deletions specs/email-sending-transactional.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,7 @@ paths:
.token("YOUR_API_KEY")
.build();

var client = MailtrapClientFactory
.createMailtrapClient(config);
var client = MailtrapClientFactory.createMailtrapClient(config);

var mail = MailtrapMail.builder()
.from(new Address("sender@example.com", "Sender Name"))
Expand Down
Loading
Loading