Skip to content

Remove inexistent examples and update some Ruby SDK mistakes #8

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

Open
DagonWat wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove inexistent examples and update some Ruby SDK mistakes #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 17 additions & 38 deletions specs/contacts.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
contacts = Mailtrap::ContactsAPI.new(12345, client)
contacts = Mailtrap::ContactsAPI.new(YOUR_ACCOUNT_ID, client)
updated = contacts.upsert("contact_id", email: "[email protected]", fields: { first_name: "John" })
- lang: csharp
label: C#
Expand Down Expand Up @@ -610,7 +610,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
contacts = Mailtrap::ContactsAPI.new(12345, client)
contacts = Mailtrap::ContactsAPI.new(YOUR_ACCOUNT_ID, client)
contacts.delete("contact_id")
- lang: csharp
label: C#
Expand Down Expand Up @@ -698,13 +698,6 @@
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})
print(event)
- lang: ruby
label: Ruby
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
contacts = Mailtrap::ContactsAPI.new(12345, client)
event = contacts.create_event("contact_id", name: "UserLogin", params: { user_id: 101, is_active: true })
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -810,13 +803,6 @@
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]}])
print(f"Export started: {export_job.id}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
exports = Mailtrap::ContactExportsAPI.new(12345, client)
export_job = exports.create(filters: [{ name: "list_id", operator: "equal", value: [1, 2] }])
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -917,13 +903,6 @@
client = mt.MailtrapClient(token="YOUR_API_KEY", account_id=YOUR_ACCOUNT_ID)
export_status = client.contacts_api.exports.get(export_id)
print(f"Status: {export_status.status}, URL: {export_status.url}")
- lang: ruby
label: Ruby
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
exports = Mailtrap::ContactExportsAPI.new(12345, client)
export_status = exports.get(export_id)
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1040,8 +1019,8 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
imports = Mailtrap::ContactImportsAPI.new(12345, client)
import_job = imports.create(contacts: [
imports = Mailtrap::ContactImportsAPI.new(YOUR_ACCOUNT_ID, client)
import_job = imports.create([
{ email: "[email protected]", fields: { first_name: "John" }, list_ids_included: [1, 2] }
])
- lang: csharp
Expand Down Expand Up @@ -1151,7 +1130,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
imports = Mailtrap::ContactImportsAPI.new(12345, client)
imports = Mailtrap::ContactImportsAPI.new(YOUR_ACCOUNT_ID, client)
import_status = imports.get(import_id)
- lang: csharp
label: C#
Expand Down Expand Up @@ -1244,8 +1223,8 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(12345, client)
all_lists = lists.get_all
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
all_lists = lists.list
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1328,7 +1307,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(12345, client)
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
new_list = lists.create(name: "Customers")
- lang: csharp
label: C#
Expand Down Expand Up @@ -1419,7 +1398,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(12345, client)
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
list = lists.get(list_id)
- lang: csharp
label: C#
Expand Down Expand Up @@ -1494,7 +1473,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(12345, client)
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
lists.update(list_id, name: "Former Customers")
- lang: csharp
label: C#
Expand Down Expand Up @@ -1582,7 +1561,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
lists = Mailtrap::ContactListsAPI.new(12345, client)
lists = Mailtrap::ContactListsAPI.new(YOUR_ACCOUNT_ID, client)
lists.delete(list_id)
- lang: csharp
label: C#
Expand Down Expand Up @@ -1659,8 +1638,8 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(12345, client)
all_fields = fields.get_all
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
all_fields = fields.list
- lang: csharp
label: C#
source: |
Expand Down Expand Up @@ -1748,7 +1727,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(12345, client)
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
new_field = fields.create(name: "Company", data_type: "text", merge_tag: "company")
- lang: csharp
label: C#
Expand Down Expand Up @@ -1872,7 +1851,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(12345, client)
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
field = fields.get(field_id)
- lang: csharp
label: C#
Expand Down Expand Up @@ -1950,7 +1929,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(12345, client)
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
fields.update(field_id, name: "Updated Name", merge_tag: "updated_name")
- lang: csharp
label: C#
Expand Down Expand Up @@ -2061,7 +2040,7 @@
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
fields = Mailtrap::ContactFieldsAPI.new(12345, client)
fields = Mailtrap::ContactFieldsAPI.new(YOUR_ACCOUNT_ID, client)
fields.delete(field_id)
- lang: csharp
label: C#
Expand Down Expand Up @@ -2120,15 +2099,15 @@
scheme: bearer
bearerFormat: JWT
schemas:
Contact:

Check warning on line 2102 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 2104 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 2106 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 2108 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 2110 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
115 changes: 36 additions & 79 deletions specs/email-api.openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,19 +107,6 @@ 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: 'YOUR_API_KEY')
sending_domains = Mailtrap::SendingDomainsAPI.new(
YOUR_ACCOUNT_ID,
client
)

domain = sending_domains.create(domain_name: 'example.com')
puts domain
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -253,21 +240,6 @@ 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: 'YOUR_API_KEY')
sending_domains = Mailtrap::SendingDomainsAPI.new(
YOUR_ACCOUNT_ID,
client
)

domains = sending_domains.list
domains.each do |domain|
puts "Domain: #{domain.domain_name}"
end
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -372,21 +344,6 @@ 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: 'YOUR_API_KEY')
sending_domains = Mailtrap::SendingDomainsAPI.new(
YOUR_ACCOUNT_ID,
client
)

domain_id = 12345
domain = sending_domains.get(domain_id)

puts "Domain: #{domain.domain_name}"
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -487,21 +444,6 @@ 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: 'YOUR_API_KEY')
sending_domains = Mailtrap::SendingDomainsAPI.new(
YOUR_ACCOUNT_ID,
client
)

domain_id = 12345
sending_domains.delete(domain_id)

puts "Domain deleted successfully"
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -614,24 +556,6 @@ paths:
)

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

client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
sending_domains = Mailtrap::SendingDomainsAPI.new(
YOUR_ACCOUNT_ID,
client
)

domain_id = 12345
sending_domains.send_setup_instructions(
domain_id,
'[email protected]'
)

puts "Setup instructions sent"
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -1045,8 +969,8 @@ paths:
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
templates = Mailtrap::EmailTemplatesAPI.new(12345, client)
all_templates = templates.get_all
templates = Mailtrap::EmailTemplatesAPI.new(YOUR_ACCOUNT_ID, client)
all_templates = templates.list
- lang: csharp
label: .NET
source: |
Expand Down Expand Up @@ -1150,7 +1074,7 @@ paths:
source: |
require 'mailtrap'
client = Mailtrap::Client.new(api_key: 'YOUR_API_TOKEN')
templates = Mailtrap::EmailTemplatesAPI.new(account_id, client)
templates = Mailtrap::EmailTemplatesAPI.new(YOUR_ACCOUNT_ID, client)
template = templates.create(
name: 'Welcome Email',
subject: 'Welcome to {{company_name}}!',
Expand Down Expand Up @@ -1242,6 +1166,17 @@ paths:
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const template = await client.templates.get(templateId);
console.log(`Template: ${template.name} (UUID: ${template.uuid})`);
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
templates = Mailtrap::EmailTemplatesAPI.new(
YOUR_ACCOUNT_ID,
client
)
template = templates.get(template_id)
- lang: php
label: PHP
source: |
Expand Down Expand Up @@ -1290,6 +1225,17 @@ paths:
const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const template = await client.templates.update(templateId, { name: "Updated Template", subject: "New Subject" });
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
templates = Mailtrap::EmailTemplatesAPI.new(
YOUR_ACCOUNT_ID,
client
)
templates.update(EMAIL_TEMPLATE_ID, name: 'Welcome Updated')
- lang: php
label: PHP
source: |
Expand Down Expand Up @@ -1362,6 +1308,17 @@ paths:
const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
await client.templates.delete(templateId);
- lang: ruby
label: Ruby
source: |
require 'mailtrap'

client = Mailtrap::Client.new(api_key: 'YOUR_API_KEY')
templates = Mailtrap::EmailTemplatesAPI.new(
YOUR_ACCOUNT_ID,
client
)
templates.delete(EMAIL_TEMPLATE_ID)
- lang: php
label: PHP
source: |
Expand Down
Loading
Loading