mailersend-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8d67b989e26722f62ec3b556872643721be50947b67392f899f75115bb5dd9b
-  data.tar.gz: 5b9ee2fe25d34a07f71f38ff5a88137abcf22cfd1619b88b4505646e1f8facc2
+  metadata.gz: '09a27b08a3b4c39332875fd10dd414301eeb58d5fcf06b5ec5001a3f76d51933'
+  data.tar.gz: 3a687d31a6723878adec8bb954cf6091e3bcfa8a1c783a80cb9e1b9289ca1ac4
 SHA512:
-  metadata.gz: 5f59c4b41f8134c36df9e0dd8c3365444719d942a6a6c57e1643bd58c3973dfbb768c922b3df2291eb1e2fbb8d99df14df40e3a4dd26ebb0caade3c999cb45d0
-  data.tar.gz: ebcb98375a4a56f3d6033dd93fecd22bef6019ac58d2338701aaa061a6579306ccf44311a202df5194a142ac0ae55f2bc880aa6595f98e09774503ce2359a298
+  metadata.gz: 34c6e84ebc65b91cb20d863ddec721ef9e03fb441fcec512fc0098dfc391937f10db637fa87e93812f10c01426ddaa6bb58c841f49242951b13578753208d51d
+  data.tar.gz: 4a5beef9b3ed82618befff3655fe62866c4bff50a4c86a1a3a832ab5527d1d46bd7f0dcffccb0405edba4754d607ccacd7bad6a3126b991f0a196742753835eb

data/.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/publish_gem.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')

data/.rubocop.yml

@@ -23,3 +23,6 @@ Metrics/AbcSize:
 
 Naming/FileName:
   Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Released]
 
+## [1.2.0] - 2022-06-15
+
+- SMS Sending
+- SMS Activity
+- SMS Phone Numbers
+- SMS Recipients
+
 ## [1.1.0] - 2022-02-18
 
 - Domains endpoint improvements

data/README.md

@@ -67,6 +67,19 @@ MailerSend Ruby SDK
     - [Get templates](#get-templates)
     - [Get a single template](#get-a-single-template)
     - [Delete template](#delete-template)
+  - [SMS](#sms)
+    - [Send an SMS](#send-an-sms)
+  - [SMS Activity](#sms-activity)
+    - [Get a list of 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)
+    - [Update a single SMS phone number](#update-a-single-sms-phone-number)
+    - [Delete an SMS phone number](#delete-an-sms-phone-number)
+  - [SMS Recipients](#sms-recipients)
+    - [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)
 - [Support and Feedback](#support-and-feedback)
 - [License](#license)
 
@@ -682,6 +695,127 @@ ms_templates = Mailersend::Templates.new
 ms_templates.delete(template_id: "id124")
 ```
 
+## SMS 
+
+### Send an SMS
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS class
+ms_sms = Mailersend::SMS.new
+
+# Add parameters
+ms_sms.add_from('your-number')
+ms_sms.add_to('client-number')
+ms_sms.add_text('This is the message content')
+
+# Send the SMS
+ms_sms.send
+```
+
+## SMS Activity
+
+### Get a list of activities
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_activity = Mailersend::SMSActivity.new
+
+# Add parameters
+ms_sms_activity.list(page: 1, limit: 10)
+```
+
+## SMS phone numbers
+
+### Get a list of SMS phone numbers
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_number = Mailersend::SMSNumber.new
+
+# Add parameters
+ms_sms_number.list(page: 1, limit: 10)
+```
+
+### Get an SMS phone number
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_number = Mailersend::SMSNumber.new
+
+# Add parameters
+ms_sms_number.get(sms_number_id: 'your-sms-number-id')
+```
+
+### Update a single SMS phone number
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_number = Mailersend::SMSNumber.new
+
+# Add parameters
+ms_sms_number.update(sms_number_id: 'your-sms-number-id', paused: false)
+```
+
+### Delete an SMS phone number
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_number = Mailersend::SMSNumber.new
+
+# Add parameters
+ms_sms_number.delete(sms_number_id: 'your-sms-number-id')
+```
+
+## SMS recipients
+
+### Get a list of SMS recipients
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_recipient = Mailersend::SMSRecipient.new
+
+# Add parameters
+ms_sms_recipient.list(page: 1, limit: 10)
+```
+
+### Get an SMS recipient
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_recipient = Mailersend::SMSRecipient.new
+
+# Add parameters
+ms_sms_recipient.get(sms_recipient_id: 'your-sms-recipient-id')
+```
+
+### Update a single SMS recipient
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the SMS Recipient class
+ms_sms_recipient = Mailersend::SMSRecipient.new
+
+# Add parameters
+ms_sms_recipient.update(sms_recipient_id: 'your-sms-recipient-id', status: 'opt_out')
+```
+
 # Support and Feedback
 
 In case you find any bugs, submit an issue directly here in GitHub.

data/lib/mailersend/sms/sms.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # Send an SMS through MailerSend API
+  class SMS
+    attr_accessor :client,
+                  :from,
+                  :to,
+                  :text
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @from = {}
+      @to = []
+      @text = {}
+    end
+
+    def add_from(from)
+      @from = from
+    end
+
+    def add_to(to)
+      @to << to
+    end
+
+    def add_text(text)
+      @text = text
+    end
+
+    def send
+      message = {
+        'from' => @from,
+        'to' => @to,
+        'text' => @text
+      }
+
+      client.http.post("#{API_URL}/sms", json: message.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {} })
+    end
+  end
+end

data/lib/mailersend/sms_activity/sms_activity.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Activity endpoint from MailerSend API.
+  class SMSActivity
+    attr_accessor :client,
+                  :page,
+                  :limit
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+    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-activity',
+                                       query: URI.encode_www_form(hash)))
+    end
+  end
+end

data/lib/mailersend/sms_number/sms_number.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Number endpoint from MailerSend API.
+  class SMSNumber
+    attr_accessor :client,
+                  :paused,
+                  :page,
+                  :limit,
+                  :sms_number_id
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @paused = paused
+      @page = page
+      @limit = limit
+      @sms_number_id = sms_number_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-numbers',
+                                       query: URI.encode_www_form(hash)))
+    end
+
+    def get(sms_number_id:)
+      client.http.get("#{API_URL}/sms-numbers/#{sms_number_id}")
+    end
+
+    def update(sms_number_id:, paused: nil)
+      hash = {
+        'paused' => paused
+      }
+      client.http.put("#{API_URL}/sms-numbers/#{sms_number_id}", json: hash.compact)
+    end
+
+    def delete(sms_number_id:)
+      client.http.delete("#{API_URL}/sms-numbers/#{sms_number_id}")
+    end
+  end
+end

data/lib/mailersend/sms_recipient/sms_recipient.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SMS Recipient endpoint from MailerSend API.
+  class SMSRecipient
+    attr_accessor :client,
+                  :status,
+                  :sms_number_id,
+                  :sms_recipient_id,
+                  :page,
+                  :limit
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @status = status
+      @sms_number_id = sms_number_id
+      @sms_recipient_id = sms_recipient_id
+      @page = page
+      @limit = limit
+    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-recipients',
+                                       query: URI.encode_www_form(hash)))
+    end
+
+    def get(sms_recipient_id:)
+      client.http.get("#{API_URL}/sms-recipients/#{sms_recipient_id}")
+    end
+
+    def update(sms_recipient_id:, status: nil)
+      hash = {
+        'status' => status
+      }
+      client.http.put("#{API_URL}/sms-recipients/#{sms_recipient_id}", json: hash.compact)
+    end
+  end
+end

data/lib/mailersend/version.rb

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

data/lib/mailersend.rb

@@ -11,6 +11,10 @@ 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_number/sms_number'
+require_relative 'mailersend/sms_recipient/sms_recipient'
 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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nikola Milojević
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,10 @@ files:
 - 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_number/sms_number.rb
+- lib/mailersend/sms_recipient/sms_recipient.rb
 - lib/mailersend/suppressions/suppressions.rb
 - lib/mailersend/templates/templates.rb
 - lib/mailersend/tokens/tokens.rb
@@ -173,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: MailerSend's official Ruby SDK