Ruby SDK

boundry provides an ergonomic emails.send helper and the complete generated API through client.api.

Install

Browse the published package or inspect its public generated source.

terminalShell

Shell

gem install boundry

Quickstart

Set BOUNDRY_API_KEY, keep it on the server, and send from a domain verified in this project.

send.rbRuby

Ruby

require 'boundry'

client = Boundry::Client.new(api_key: ENV['BOUNDRY_API_KEY'])

email = client.emails.send(
  from: 'Acme <hello@acme.com>',
  to: 'ava@northwind.com.au',
  subject: 'Welcome to Acme',
  html: '<p>It works.</p>'
)

puts email.id

Complete API

The low-level client is generated from the canonical Laravel OpenAPI contract, so every public operation remains available even when it does not have a convenience helper.

SDK method	What it does	API reference
`client.api.list_api_keys(...)`	listApiKeys	View endpoint →
`client.api.create_api_key(...)`	createApiKey	View endpoint →
`client.api.delete_api_key(...)`	deleteApiKey	View endpoint →
`client.api.list_broadcasts(...)`	listBroadcasts	View endpoint →
`client.api.create_broadcast(...)`	createBroadcast	View endpoint →
`client.api.delete_broadcast(...)`	deleteBroadcast	View endpoint →
`client.api.get_broadcast(...)`	getBroadcast	View endpoint →
`client.api.update_broadcast(...)`	updateBroadcast	View endpoint →
`client.api.cancel_broadcast(...)`	cancelBroadcast	View endpoint →
`client.api.list_broadcast_clicked_links(...)`	listBroadcastClickedLinks	View endpoint →
`client.api.get_broadcast_metrics(...)`	getBroadcastMetrics	View endpoint →
`client.api.list_broadcast_recipients(...)`	listBroadcastRecipients	View endpoint →
`client.api.send_broadcast(...)`	sendBroadcast	View endpoint →
`client.api.list_contact_properties(...)`	listContactProperties	View endpoint →
`client.api.create_contact_property(...)`	createContactProperty	View endpoint →
`client.api.delete_contact_property(...)`	deleteContactProperty	View endpoint →
`client.api.get_contact_property(...)`	getContactProperty	View endpoint →
`client.api.update_contact_property(...)`	updateContactProperty	View endpoint →
`client.api.list_contacts(...)`	listContacts	View endpoint →
`client.api.create_contact(...)`	createContact	View endpoint →
`client.api.delete_contact(...)`	deleteContact	View endpoint →
`client.api.get_contact(...)`	getContact	View endpoint →
`client.api.update_contact(...)`	updateContact	View endpoint →
`client.api.list_contact_segments(...)`	listContactSegments	View endpoint →
`client.api.remove_contact_from_segment(...)`	removeContactFromSegment	View endpoint →
`client.api.add_contact_to_segment(...)`	addContactToSegment	View endpoint →
`client.api.get_contact_topics(...)`	getContactTopics	View endpoint →
`client.api.update_contact_topics(...)`	updateContactTopics	View endpoint →
`client.api.list_domains(...)`	listDomains	View endpoint →
`client.api.create_domain(...)`	createDomain	View endpoint →
`client.api.delete_domain(...)`	deleteDomain	View endpoint →
`client.api.get_domain(...)`	getDomain	View endpoint →
`client.api.update_domain(...)`	updateDomain	View endpoint →
`client.api.verify_domain(...)`	verifyDomain	View endpoint →
`client.api.create_domain_claim(...)`	createDomainClaim	View endpoint →
`client.api.get_domain_claim(...)`	getDomainClaim	View endpoint →
`client.api.verify_domain_claim(...)`	verifyDomainClaim	View endpoint →
`client.api.list_emails(...)`	listEmails	View endpoint →
`client.api.send_email(...)`	sendEmail	View endpoint →
`client.api.get_email(...)`	getEmail	View endpoint →
`client.api.update_scheduled_email(...)`	updateScheduledEmail	View endpoint →
`client.api.list_email_attachments(...)`	listEmailAttachments	View endpoint →
`client.api.get_email_attachment(...)`	getEmailAttachment	View endpoint →
`client.api.cancel_email(...)`	cancelEmail	View endpoint →
`client.api.retry_email(...)`	retryEmail	View endpoint →
`client.api.get_email_source(...)`	getEmailSource	View endpoint →
`client.api.send_batch_emails(...)`	sendBatchEmails	View endpoint →
`client.api.get_email_metrics(...)`	getEmailMetrics	View endpoint →
`client.api.list_received_emails(...)`	listReceivedEmails	View endpoint →
`client.api.get_received_email(...)`	getReceivedEmail	View endpoint →
`client.api.list_received_email_attachments(...)`	listReceivedEmailAttachments	View endpoint →
`client.api.get_received_email_attachment(...)`	getReceivedEmailAttachment	View endpoint →
`client.api.get_received_email_source(...)`	getReceivedEmailSource	View endpoint →
`client.api.get_received_email_thread(...)`	getReceivedEmailThread	View endpoint →
`client.api.health(...)`	health	View endpoint →
`client.api.list_logs(...)`	listLogs	View endpoint →
`client.api.get_log(...)`	getLog	View endpoint →
`client.api.authorize_oauth(...)`	authorizeOAuth	View endpoint →
`client.api.authorize_oauth_post(...)`	authorizeOAuthPost	View endpoint →
`client.api.list_oauth_grants(...)`	listOAuthGrants	View endpoint →
`client.api.revoke_oauth_grant(...)`	revokeOAuthGrant	View endpoint →
`client.api.register_oauth_client(...)`	registerOAuthClient	View endpoint →
`client.api.revoke_oauth_token(...)`	revokeOAuthToken	View endpoint →
`client.api.exchange_oauth_token(...)`	exchangeOAuthToken	View endpoint →
`client.api.list_segments(...)`	listSegments	View endpoint →
`client.api.create_segment(...)`	createSegment	View endpoint →
`client.api.delete_segment(...)`	deleteSegment	View endpoint →
`client.api.get_segment(...)`	getSegment	View endpoint →
`client.api.list_segment_contacts(...)`	listSegmentContacts	View endpoint →
`client.api.get_segment_metrics(...)`	getSegmentMetrics	View endpoint →
`client.api.list_suppressions(...)`	listSuppressions	View endpoint →
`client.api.create_suppression(...)`	createSuppression	View endpoint →
`client.api.delete_suppression(...)`	deleteSuppression	View endpoint →
`client.api.get_suppression(...)`	getSuppression	View endpoint →
`client.api.delete_batch_suppressions(...)`	deleteBatchSuppressions	View endpoint →
`client.api.create_batch_suppressions(...)`	createBatchSuppressions	View endpoint →
`client.api.list_templates(...)`	listTemplates	View endpoint →
`client.api.create_template(...)`	createTemplate	View endpoint →
`client.api.delete_template(...)`	deleteTemplate	View endpoint →
`client.api.get_template(...)`	getTemplate	View endpoint →
`client.api.update_template(...)`	updateTemplate	View endpoint →
`client.api.duplicate_template(...)`	duplicateTemplate	View endpoint →
`client.api.publish_template(...)`	publishTemplate	View endpoint →
`client.api.list_topics(...)`	listTopics	View endpoint →
`client.api.create_topic(...)`	createTopic	View endpoint →
`client.api.delete_topic(...)`	deleteTopic	View endpoint →
`client.api.get_topic(...)`	getTopic	View endpoint →
`client.api.update_topic(...)`	updateTopic	View endpoint →
`client.api.list_project_webhook_events(...)`	listProjectWebhookEvents	View endpoint →
`client.api.list_webhooks(...)`	listWebhooks	View endpoint →
`client.api.create_webhook(...)`	createWebhook	View endpoint →
`client.api.delete_webhook(...)`	deleteWebhook	View endpoint →
`client.api.get_webhook(...)`	getWebhook	View endpoint →
`client.api.update_webhook(...)`	updateWebhook	View endpoint →
`client.api.list_webhook_events(...)`	listWebhookEvents	View endpoint →
`client.api.get_webhook_event(...)`	getWebhookEvent	View endpoint →
`client.api.list_webhook_attempts(...)`	listWebhookAttempts	View endpoint →