README.md in mailersend-ruby-1.0.1 vs README.md in mailersend-ruby-1.1.0

- old
+ new

@@ -26,19 +26,31 @@ - [Analytics](#analytics) - [Activity data by date](#activity-data-by-date) - [Opens by country](#opens-by-country) - [Opens by user-agent name](#opens-by-user-agent-name) - [Opens by reading environment](#opens-by-reading-environment) + - [Inbound Routes](#inbound-routes) + - [Get a list of inbound routes](#get-a-list-of-inbound-routes) + - [Get a single inbound route](#get-a-single-inbound-route) + - [Add an inbound route](#add-an-inbound-route) + - [Update an inbound route](#update-an-inbound-route) + - [Delete an inbound route](#delete-an-inbound-route) - [Domains](#domains) - [Get a list of domains](#get-a-list-of-domains) - [Get a single domain](#get-a-single-domain) - [Delete a domain](#delete-a-domain) - [Get recipients for a domain](#get-recipients-for-a-domain) - [Update domain settings](#update-domain-settings) + - [Get DNS Records](#get-dns-records) + - [Get verification status](#get-verification-status) - [Messages](#messages) - [Get a list of messages](#get-a-list-of-messages) - [Get info for a single message](#get-info-for-a-single-message) + - [Scheduled Messages](#scheduled-messages) + - [Get a list of scheduled messages](#get-a-list-of-scheduled-messages) + - [Get a single scheduled message](#get-a-single-scheduled-message) + - [Delete a scheduled message](#delete-a-scheduled-message) - [Recipients](#recipients) - [Get recipients](#get-recipients) - [Get a single recipient](#get-a-single-recipient) - [Delete a recipient](#delete-a-recipient) - [Suppressions](#suppressions) @@ -326,10 +338,73 @@ ms_analytics = Mailersend::Analytics.new ms_analytics.ua_type(date_from: 1620643567, date_to: 1623321967) ``` +## Inbound Routes + +### Get a list of inbound routes + +```ruby +require "mailersend-ruby" + +ms_inbound_routes = Mailersend::InboundRouting.new +ms_inbound_routes.get_inbound_routes +``` + +### Get a single inbound route + +```ruby +require "mailersend-ruby" + +ms_inbound_routes = Mailersend::InboundRouting.new +ms_inbound_routes.get_single_route(inbound_id: 'idofroute12412') +``` + +### Add an inbound route + +```ruby +require "mailersend-ruby" + +ms_inbound_routes = Mailersend::InboundRouting.new +ms_inbound_routes.settings = + { + 'domain_id' => 'yourdomainid', + 'name' => 'inbound_name', + 'domain_enabled' => false, + 'match_filter' => { 'type' => 'match_all' }, + 'forwards' => [{ 'type' => 'webhook', 'value' => 'https://example.com' }] + } +puts ms_inbound_routes.add_inbound_route +``` + +### Update an inbound route + +```ruby +require "mailersend-ruby" + +ms_inbound_routes = Mailersend::InboundRouting.new +ms_inbound_routes.settings = + { + 'domain_id' => 'yourdomainid', + 'name' => 'inbound_updated', + 'domain_enabled' => false, + 'match_filter' => { 'type' => 'match_all' }, + 'forwards' => [{ 'type' => 'webhook', 'value' => 'https://example.com' }] + } +puts ms_inbound_routes.update_inbound_route(inbound_id: 'idofroute12412') +``` + +### Delete an inbound route + +```ruby +require "mailersend-ruby" + +ms_inbound_routes = Mailersend::InboundRouting.new +ms_inbound_routes.delete_route(inbound_id: 'idofroute12412') +``` + ## Domains ### Get a list of domains ```ruby @@ -373,10 +448,28 @@ ms_domains = Mailersend::Domains.new ms_domains.settings(domain_id: "idofdomain12412", track_clicks: true, track_unsubscribe: false) ``` +### Get DNS Records + +```ruby +require "mailersend-ruby" + +ms_domains = Mailersend::Domains.new +ms_domains.dns(domain_id: "idofdomain12412") +``` + +### Get verification status + +```ruby +require "mailersend-ruby" + +ms_domains = Mailersend::Domains.new +ms_domains.verify(domain_id: "idofdomain12412") +``` + ## Messages ### Get a list of messages ```ruby @@ -391,9 +484,38 @@ ```ruby require "mailersend-ruby" ms_messages = Mailersend::Messages.new ms_messages.single(message_id: "mess11454") +``` + +## Scheduled Messages + +### Get a list of scheduled messages + +```ruby +require "mailersend-ruby" + +ms_scheduled_messages = Mailersend::ScheduledMessages.new +ms_scheduled_messages.get_list +``` + +### Get a single scheduled message + +```ruby +require "mailersend-ruby" + +ms_scheduled_messages = Mailersend::ScheduledMessages.new +ms_scheduled_messages.get_signle(message_id: 'mess11454') +``` + +### Delete a scheduled message + +```ruby +require "mailersend-ruby" + +ms_scheduled_messages = Mailersend::ScheduledMessages.new +ms_scheduled_messages.delete(message_id: 'mess11454') ``` ## Recipients ### Get recipients