mailersend-ruby 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09a27b08a3b4c39332875fd10dd414301eeb58d5fcf06b5ec5001a3f76d51933'
-  data.tar.gz: 3a687d31a6723878adec8bb954cf6091e3bcfa8a1c783a80cb9e1b9289ca1ac4
+  metadata.gz: f95531e933a67ec27b789aa68008030393aceafd92f8a267ef6e69ea0684dba1
+  data.tar.gz: 8a292cb132a367a2d654a65dd9141faae370491614b87135ec442f3d9f04983d
 SHA512:
-  metadata.gz: 34c6e84ebc65b91cb20d863ddec721ef9e03fb441fcec512fc0098dfc391937f10db637fa87e93812f10c01426ddaa6bb58c841f49242951b13578753208d51d
-  data.tar.gz: 4a5beef9b3ed82618befff3655fe62866c4bff50a4c86a1a3a832ab5527d1d46bd7f0dcffccb0405edba4754d607ccacd7bad6a3126b991f0a196742753835eb
+  metadata.gz: 33071f4961960a37b6732ab45905e3ea2060d82080d7289e793d72dea84014f91cfe245b12a8055800a85adfebdc44b28f4a2010d71b59bb3f04dda56077450f
+  data.tar.gz: 238d96acbe53f2d95b8326fe091baff168aef20eb7f3b64e68924fc6e53f4b5aa1620b92d88507ae151c4b5de1475cb7660403067d572b9f4769627a4b32af38

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @mailersend/ruby-sdk-maintainers

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Released]
 
+## [1.3.1] - 2022-09-28
+
+- Added attachment content disposition
+
+## [1.3.0] - 2022-08-03
+
+- SMS Personalization
+- SMS Messages
+- SMS Inbounds
+- SMS Webhooks
+- Email Verification
+
 ## [1.2.0] - 2022-06-15
 
 - SMS Sending

data/README.md

@@ -67,10 +67,18 @@ MailerSend Ruby SDK
     - [Get templates](#get-templates)
     - [Get a single template](#get-a-single-template)
     - [Delete template](#delete-template)
+  - [Email Verification](#email-verification)
+    - [Get all email verification lists](#get-all-email-verification-lists)
+    - [Get an email verification list](#get-an-email-verification-list)
+    - [Create an email verification list](#create-an-email-verification-list)
+    - [Verify an email list](#verify-an-email-list)
+    - [Get email verification list results](#get-email-verification-list-results)
   - [SMS](#sms)
-    - [Send an SMS](#send-an-sms)
+  - [SMS Messages](#sms-messages)
+    - [Get a list of SMS messages](#get-a-list-of-sms-messages)
+    - [Get info on an SMS message](#get-info-on-an-sms-message)
   - [SMS Activity](#sms-activity)
-    - [Get a list of activities](#get-a-list-of-sms-activities)
+    - [Get a list of sms activities](#get-a-list-of-sms-activities)
   - [SMS Phone Numbers](#sms-phone-numbers)
     - [Get a list of SMS phone numbers](#get-a-list-of-sms-phone-numbers)
     - [Get an SMS phone number](#get-an-sms-phone-number)
@@ -80,6 +88,18 @@ MailerSend Ruby SDK
     - [Get a list of SMS recipients](#get-a-list-of-sms-recipients)
     - [Get an SMS recipient](#get-an-sms-recipient)
     - [Update a single SMS recipient](#update-a-single-sms-recipient)
+  - [SMS Inbounds](#sms-inbounds)
+    - [Get a list of SMS inbound routes](#get-a-list-of-sms-inbound-routes)
+    - [Get a single SMS inbound route](#get-a-single-sms-inbound-route)
+    - [Create an SMS inbound route](#create-an-sms-inbound-route)
+    - [Update an SMS inbound route](#update-an-sms-inbound-route)
+    - [Delete an SMS inbound route](#delete-an-sms-inbound-route)
+  - [SMS Webhooks](#sms-webhooks)
+    - [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks)
+    - [Get an SMS webhook](#get-an-sms-webhook)
+    - [Create an SMS webhook](#create-an-sms-webhook)
+    - [Update an SMS webhook](#update-an-sms-webhook)
+    - [Delete an SMS webhook](#delete-an-sms-webhook)
 - [Support and Feedback](#support-and-feedback)
 - [License](#license)
 
@@ -298,8 +318,8 @@ ms_email.add_text("Time is money, money is power, power is pizza, and pizza is k
 ms_email.add_html("<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")
 
 # You can add one or multiple attachments
-ms.add_attachment(content: "/Users/Jerry/Desktop/doc.pdf", filename: "doc.pdf")
-ms.add_attachment(content: "/Users/Jerry/Desktop/pic.png", filename: "pic.png")
+ms.add_attachment(content: "/Users/Jerry/Desktop/doc.pdf", filename: "doc.pdf", disposition: "attachment")
+ms.add_attachment(content: "/Users/Jerry/Desktop/pic.png", filename: "pic.png", disposition: "attachment")
 
 ms_email.send
 ```
@@ -695,6 +715,53 @@ ms_templates = Mailersend::Templates.new
 ms_templates.delete(template_id: "id124")
 ```
 
+## Email Verification
+
+### Get all email verification lists
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.list(page: 1, limit: 10)
+```
+
+### Get an email verification list
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.get_single_list(email_verification_id: 'your-email-verification-id')
+```
+
+### Create an email verification list
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.create_a_list(name: "name-your-list", emails: ["example@email.com"])
+```
+
+### Verify an email list
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.verify_a_list(email_verification_id: 'your-email-verification-id')
+```
+
+### Get email verification list results
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.get_list_results(email_verification_id: 'your-email-verification-id')
+```
+
 ## SMS 
 
 ### Send an SMS
@@ -709,14 +776,47 @@ ms_sms = Mailersend::SMS.new
 ms_sms.add_from('your-number')
 ms_sms.add_to('client-number')
 ms_sms.add_text('This is the message content')
+personalization = {
+  phone_number: 'client-number',
+  data: {
+    test: 'Test Value'
+  }
+}
+ms_sms.add_personalization(personalization)
 
 # Send the SMS
 ms_sms.send
 ```
 
+## SMS Messages
+
+### Get a list of SMS messages
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Messages class
+ms_sms_messages = Mailersend::SMSMessages.new
+
+# Add parameters
+ms_sms_messages.list(page: 1, limit: 10)
+```
+
+### Get info on an SMS message
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Messages class
+ms_sms_messages = Mailersend::SMSMessages.new
+
+# Add parameters
+ms_sms_messages.get_single_route(sms_message_id: 'your-sms-message-id')
+```
+
 ## SMS Activity
 
-### Get a list of activities
+### Get a list of sms activities
 
 ```ruby
 require "mailersend-ruby"
@@ -816,6 +916,157 @@ ms_sms_recipient = Mailersend::SMSRecipient.new
 ms_sms_recipient.update(sms_recipient_id: 'your-sms-recipient-id', status: 'opt_out')
 ```
 
+## SMS Inbounds
+
+### Get a list of SMS inbound routes
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Inbounds class
+ms_sms_inbounds = Mailersend::SMSInbounds.new
+
+ms_sms_inbounds.list
+```
+
+### Get a single SMS inbound route
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Inbounds class
+ms_sms_inbounds = Mailersend::SMSInbounds.new
+
+# Add parameters
+ms_sms_inbounds.get_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
+```
+
+### Create an SMS inbound route
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Inbounds class
+ms_sms_inbounds = Mailersend::SMSInbounds.new
+
+# Add parameters
+ms_sms_inbounds.settings =
+  {
+    'forward_url' => 'https://your-forward-url',
+    'name' => 'name',
+    'events' => ['sms.sent', 'sms.delivered'],
+    'sms_number_id' => 'your-sms-number-id'
+  }
+puts ms_sms_inbounds.add_sms_inbound_route
+```
+
+### Update an SMS inbound route
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Inbounds class
+ms_sms_inbounds = Mailersend::SMSInbounds.new
+
+# Add parameters
+ms_sms_inbounds.settings =
+  {
+    'forward_url' => 'https://your-forward-url',
+    'name' => 'name',
+    'events' => ['sms.sent', 'sms.delivered'],
+    'sms_number_id' => 'your-sms-number-id'
+  }
+puts ms_sms_inbounds.update_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
+```
+
+### Delete an SMS inbound route
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Inbounds class
+ms_sms_inbounds = Mailersend::SMSInbounds.new
+
+# Add parameters
+ms_sms_inbounds.delete_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
+```
+
+## SMS Webhooks
+
+### Get a list of SMS webhooks
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Webhooks class
+ms_sms_webhooks = Mailersend::SMSWebhooks.new
+
+# Add parameters
+ms_sms_webhooks.list(sms_number_id: 'your-sms-number-id')
+```
+
+### Get an SMS webhook
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Webhooks class
+ms_sms_webhooks = Mailersend::SMSWebhooks.new
+
+# Add parameters
+ms_sms_webhooks.get_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
+```
+
+### Create an SMS webhook
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Webhooks class
+ms_sms_webhooks = Mailersend::SMSWebhooks.new
+
+# Add parameters
+ms_sms_webhooks.settings =
+  {
+    'sms_number_id' => 'your-sms-number-id',
+    'name' => 'your-name',
+    'url' => 'https://your-url.com',
+    'events' => ['sms.sent', 'sms.delivered']
+  }
+puts ms_sms_webhooks.add_sms_webhook_route
+```
+
+### Update an SMS webhook
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Webhooks class
+ms_sms_webhooks = Mailersend::SMSWebhooks.new
+
+# Add parameters
+ms_sms_webhooks.settings =
+  {
+    'sms_number_id' => 'your-sms-number-id',
+    'name' => 'your-name',
+    'url' => 'https://your-url.com',
+    'events' => ['sms.sent', 'sms.delivered']
+  }
+puts ms_sms_webhooks.update_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
+```
+
+### Delete an SMS webhook
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Webhooks class
+ms_sms_webhooks = Mailersend::SMSWebhooks.new
+
+# Add parameters
+ms_sms_webhooks.delete_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
+```
+
 # Support and Feedback
 
 In case you find any bugs, submit an issue directly here in GitHub.

data/lib/mailersend/bulk_email/bulk_email.rb

@@ -13,12 +13,13 @@ module Mailersend
       @messages = []
     end
 
-    def add_attachment(content:, filename:)
+    def add_attachment(content:, filename:, disposition:)
       data = File.read(content.to_s)
       encoded = Base64.strict_encode64(data)
       @attachments << {
         'content' => encoded,
-        'filename' => filename
+        'filename' => filename,
+        'disposition' => disposition
       }
     end
 

data/lib/mailersend/email/email.rb

@@ -86,12 +86,13 @@ module Mailersend
       @tags << tags
     end
 
-    def add_attachment(content:, filename:)
+    def add_attachment(content:, filename:, disposition:)
       data = File.read(content.to_s)
       encoded = Base64.strict_encode64(data)
       @attachments << {
         'content' => encoded,
-        'filename' => filename
+        'filename' => filename,
+        'disposition' => disposition
       }
     end
 

data/lib/mailersend/email_verification/email_verification.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # Email verification endpoint from MailerSend API.
+  class EmailVerification
+    attr_accessor :client,
+                  :page,
+                  :limit,
+                  :email_verification_id
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+      @email_verification_id = email_verification_id
+    end
+
+    def list(page: nil, limit: nil)
+      hash = {
+        'page' => page,
+        'limit' => limit
+      }
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/email-verification',
+                                       query: URI.encode_www_form(hash)))
+    end
+
+    def get_single_list(email_verification_id:)
+      client.http.get("#{API_URL}/email-verification/#{email_verification_id}")
+    end
+
+    def create_a_list(name: nil, emails: nil)
+      hash = {
+        'name' => name,
+        'emails' => emails
+      }
+      client.http.post("#{API_URL}/email-verification", json: hash.compact)
+    end
+
+    def verify_a_list(email_verification_id:)
+      client.http.get("#{API_URL}/email-verification/#{email_verification_id}/verify")
+    end
+
+    def get_list_results(email_verification_id:)
+      client.http.get("#{API_URL}/email-verification/#{email_verification_id}/results")
+    end
+  end
+end

data/lib/mailersend/sms/sms.rb

@@ -6,13 +6,15 @@ module Mailersend
     attr_accessor :client,
                   :from,
                   :to,
-                  :text
+                  :text,
+                  :personalization
 
     def initialize(client = Mailersend::Client.new)
       @client = client
       @from = {}
       @to = []
       @text = {}
+      @personalization = []
     end
 
     def add_from(from)
@@ -27,14 +29,20 @@ module Mailersend
       @text = text
     end
 
+    def add_personalization(personalization)
+      @personalization << personalization
+    end
+
     def send
       message = {
         'from' => @from,
         'to' => @to,
-        'text' => @text
+        'text' => @text,
+        'personalization' => @personalization
       }
 
-      client.http.post("#{API_URL}/sms", json: message.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {} })
+      response = client.http.post("#{API_URL}/sms", json: message.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {} })
+      puts response
     end
   end
 end

data/lib/mailersend/sms_inbounds/sms_inbounds.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Inbound endpoint from MailerSend API.
+  class SMSInbounds
+    attr_accessor :client,
+                  :page,
+                  :limit,
+                  :sms_number_id,
+                  :sms_inbound_id,
+                  :settings
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+      @sms_number_id = sms_number_id
+      @sms_inbound_id = sms_inbound_id
+      @settings = []
+    end
+
+    def list(page: nil, limit: nil)
+      hash = {
+        'page' => page,
+        'limit' => limit
+      }
+
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/sms-inbounds',
+                                       query: URI.encode_www_form(hash)))
+    end
+
+    def get_sms_inbound_route(sms_inbound_id:)
+      client.http.get("#{API_URL}/sms-inbounds/#{sms_inbound_id}")
+    end
+
+    def add_sms_inbound_route
+      client.http.post("#{API_URL}/sms-inbounds", json: @settings)
+    end
+
+    def update_sms_inbound_route(sms_inbound_id:)
+      client.http.put("#{API_URL}/sms-inbounds/#{sms_inbound_id}", json: @settings)
+    end
+
+    def delete_sms_inbound_route(sms_inbound_id:)
+      client.http.delete("#{API_URL}/sms-inbounds/#{sms_inbound_id}")
+    end
+  end
+end

data/lib/mailersend/sms_messages/sms_messages.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Messages endpoint from MailerSend API.
+  class SMSMessages
+    attr_accessor :client,
+                  :page,
+                  :limit,
+                  :sms_message_id
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+      @sms_message_id = sms_message_id
+    end
+
+    def list(page: nil, limit: nil)
+      hash = {
+        'page' => page,
+        'limit' => limit
+      }
+
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/sms-messages',
+                                                  query: URI.encode_www_form(hash)))
+    end
+
+    def get(sms_message_id:)
+      client.http.get_single_route("#{API_URL}/sms-messages/#{sms_message_id}")
+    end
+  end
+end

data/lib/mailersend/sms_webhooks/sms_webhooks.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Webhook endpoint from MailerSend API.
+  class SMSWebhooks
+    attr_accessor :client,
+                  :page,
+                  :limit,
+                  :sms_webhook_id,
+                  :settings
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+      @sms_webhook_id = sms_webhook_id
+      @settings = []
+    end
+
+    def list(sms_number_id:)
+      hash = {
+        'sms_number_id' => sms_number_id
+      }
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/sms-webhooks',
+                                       query: URI.encode_www_form(hash)))
+    end
+
+    def get_sms_webhook_route(sms_webhook_id:)
+      client.http.get("#{API_URL}/sms-webhooks/#{sms_webhook_id}")
+    end
+
+    def add_sms_webhook_route
+      client.http.post("#{API_URL}/sms-webhooks", json: @settings)
+    end
+
+    def update_sms_webhook_route(sms_webhook_id:)
+      client.http.put("#{API_URL}/sms-webhooks/#{sms_webhook_id}", json: @settings)
+    end
+
+    def delete_sms_webhook_route(sms_webhook_id:)
+      client.http.delete("#{API_URL}/sms-webhooks/#{sms_webhook_id}")
+    end
+  end
+end

data/lib/mailersend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailersend
-  VERSION = '1.2.0'
+  VERSION = '1.3.1'
 end

data/lib/mailersend.rb

@@ -7,14 +7,18 @@ require_relative 'mailersend/analytics/analytics'
 require_relative 'mailersend/bulk_email/bulk_email'
 require_relative 'mailersend/domains/domains'
 require_relative 'mailersend/email/email'
+require_relative 'mailersend/email_verification/email_verification'
 require_relative 'mailersend/inbound_routing/inbound_routing'
 require_relative 'mailersend/messages/messages'
 require_relative 'mailersend/recipients/recipients'
 require_relative 'mailersend/scheduled_messages/scheduled_messages'
 require_relative 'mailersend/sms/sms'
 require_relative 'mailersend/sms_activity/sms_activity'
+require_relative 'mailersend/sms_messages/sms_messages'
 require_relative 'mailersend/sms_number/sms_number'
 require_relative 'mailersend/sms_recipient/sms_recipient'
+require_relative 'mailersend/sms_inbounds/sms_inbounds'
+require_relative 'mailersend/sms_webhooks/sms_webhooks'
 require_relative 'mailersend/suppressions/suppressions'
 require_relative 'mailersend/templates/templates'
 require_relative 'mailersend/tokens/tokens'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailersend-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nikola Milojević
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/CODEOWNERS"
 - ".github/workflows/main.yml"
 - ".github/workflows/publish_gem.yml"
 - ".gitignore"
@@ -138,14 +139,18 @@ files:
 - lib/mailersend/client.rb
 - lib/mailersend/domains/domains.rb
 - lib/mailersend/email/email.rb
+- lib/mailersend/email_verification/email_verification.rb
 - lib/mailersend/inbound_routing/inbound_routing.rb
 - lib/mailersend/messages/messages.rb
 - lib/mailersend/recipients/recipients.rb
 - lib/mailersend/scheduled_messages/scheduled_messages.rb
 - lib/mailersend/sms/sms.rb
 - lib/mailersend/sms_activity/sms_activity.rb
+- lib/mailersend/sms_inbounds/sms_inbounds.rb
+- lib/mailersend/sms_messages/sms_messages.rb
 - lib/mailersend/sms_number/sms_number.rb
 - lib/mailersend/sms_recipient/sms_recipient.rb
+- lib/mailersend/sms_webhooks/sms_webhooks.rb
 - lib/mailersend/suppressions/suppressions.rb
 - lib/mailersend/templates/templates.rb
 - lib/mailersend/tokens/tokens.rb