mailersend-ruby 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fbf1a6547aaabba0b217c571b89b104abb308b89fe7d724cd3012d97fd82c3
-  data.tar.gz: c9c28ef41fc5421c7ff83aac95ae4a9463922e85efc2302457c91307ba427d35
+  metadata.gz: 119a856edc8f4a572776df083628ac9e91b03ad7d84c010d000f659dea7c5d02
+  data.tar.gz: e8c4db7ef5ee7753acdeef7fb2e6696c215b614dc0c84c4c78b1e8dbeeb4b069
 SHA512:
-  metadata.gz: a54404f2272a93c30d049a54fd6179cce1e8057c90274a8001680ca73d703835fbd14f5fdacc8fb991ea3013d6ddd55fc5ae308838404914065f38d11feb1f65
-  data.tar.gz: 0c4b04107b5cfd6952d80f07732e86e779c94e1dfc615956f9458bc55601c4fde1cd44c537799d7adf2e94e73f61c3b70a7b7f6b57cc8537d18642f5617e0b41
+  metadata.gz: ce60ac31b7af6e94b5b1ea51b9d7f4e0fa16b56bc870576b4ed49df45f93f032e6bcf68870d591ee84518dc248918086c5723e9bcf23b9b039d69276ebf6cbd5
+  data.tar.gz: da94cb3b0fa6c9e92037401bb0d0adf6e70a84d9a066266bdcdef0bc038d9c01eb8db42280fac757853bb9e50d55942cc23c159dab358d6c5df1acb5db29f906

data/.github/workflows/main.yml

@@ -8,9 +8,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1.148.0
       with:
-        ruby-version: 3.0.1
+        ruby-version: 3.0
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Released]
 
+## [1.5.0] - 2023-05-08
+
+- API Quota
+- Single eMail Verification
+
+## [1.4.0] - 2023-01-17
+
+- Sender Identities
+
 ## [1.3.2] - 2022-11-22
 
 - Fixes add_tags method in MailerSend::Email class

data/README.md

@@ -42,6 +42,12 @@ MailerSend Ruby SDK
     - [Update domain settings](#update-domain-settings)
     - [Get DNS Records](#get-dns-records)
     - [Get verification status](#get-verification-status)
+  - [Sender Identities](#sender-identities)
+    - [Get a list of sender identities](#get-a-list-of-sender-identities)
+    - [Get a single sender identity](#get-a-single-sender-identity)
+    - [Add a sender identity](#add-a-sender-identity)
+    - [Update a sender identity](#update-a-sender-identity)
+    - [Delete a sender identity](#delete-a-sender-identity)
   - [Messages](#messages)
     - [Get a list of messages](#get-a-list-of-messages)
     - [Get info for a single message](#get-info-for-a-single-message)
@@ -68,6 +74,7 @@ MailerSend Ruby SDK
     - [Get a single template](#get-a-single-template)
     - [Delete template](#delete-template)
   - [Email Verification](#email-verification)
+    - [Verify an email](#verify-an-email)
     - [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)
@@ -100,6 +107,8 @@ MailerSend Ruby SDK
     - [Create an SMS webhook](#create-an-sms-webhook)
     - [Update an SMS webhook](#update-an-sms-webhook)
     - [Delete an SMS webhook](#delete-an-sms-webhook)
+  - [Other endpoints](#other-endpoints)
+    - [Get API quota](#get-api-quota)
 - [Support and Feedback](#support-and-feedback)
 - [License](#license)
 
@@ -501,6 +510,53 @@ ms_domains = Mailersend::Domains.new
 ms_domains.verify(domain_id: "idofdomain12412")
 ```
 
+## Sender Identities
+
+### Get a list of sender identities
+
+```ruby
+require "mailersend-ruby"
+
+ms_sender_identity = Mailersend::SenderIdentity.new
+ms_sender_identity.list
+```
+
+### Get a single sender identity
+
+```ruby
+require "mailersend-ruby"
+
+ms_sender_identity = Mailersend::SenderIdentity.new
+ms_sender_identity.single(identity_id: 'idofidentity123')
+```
+
+### Add a sender identity
+
+```ruby
+require "mailersend-ruby"
+
+ms_sender_identity = Mailersend::SenderIdentity.new
+ms_sender_identity.add(domain_id: 'idofdomain12412', name: 'yourname', email: 'youremail')
+```
+
+### Update a sender identity
+
+```ruby
+require "mailersend-ruby"
+
+ms_sender_identity = Mailersend::SenderIdentity.new
+ms_sender_identity.update(identity_id: 'idofidentity123', reply_to_email: 'replyemail', reply_to_name: 'replyname')
+```
+
+### Delete a sender identity
+
+```ruby
+require "mailersend-ruby"
+
+ms_sender_identity = Mailersend::SenderIdentity.new
+ms_sender_identity.delete(identity_id: 'idofidentity123')
+```
+
 ## Messages
 
 ### Get a list of messages
@@ -717,6 +773,15 @@ ms_templates.delete(template_id: "id124")
 
 ## Email Verification
 
+### Verify an email
+
+```ruby
+require "mailersend-ruby"
+
+ms_email_verification = Mailersend::EmailVerification.new
+ms_email_verification.verify_an_email(email: 'example@email.com')
+```
+
 ### Get all email verification lists
 
 ```ruby
@@ -1067,6 +1132,20 @@ ms_sms_webhooks = Mailersend::SMSWebhooks.new
 ms_sms_webhooks.delete_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
 ```
 
+## Other endpoints
+
+### Get API quota
+
+```ruby
+require "mailersend-ruby"
+
+# Intialize the API Quota class
+ms_api_quota = Mailersend::APIQuota.new
+
+# Add parameters
+ms_api_quota.get_api_quota
+```
+
 # Support and Feedback
 
 In case you find any bugs, submit an issue directly here in GitHub.

data/lib/mailersend/api_quota/api_quota.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # API Quota endpoint from MailerSend API
+  class APIQuota
+    attr_accessor :client
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+    end
+
+    def get_api_quota(*)
+      client.http.get("#{API_URL}/api-quota")
+    end
+  end
+end

data/lib/mailersend/email_verification/email_verification.rb

@@ -15,6 +15,13 @@ module Mailersend
       @email_verification_id = email_verification_id
     end
 
+    def verify_an_email(email: nil)
+      hash = {
+        'email' => email
+      }
+      client.http.post("#{API_URL}/email-verification/verify", json: hash.compact)
+    end
+
     def list(page: nil, limit: nil)
       hash = {
         'page' => page,

data/lib/mailersend/sender_identity/sender_identity.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # SenderIdentity endpoint from MailerSend API
+  class SenderIdentity
+    attr_accessor :client,
+                  :domain_id,
+                  :identity_id,
+                  :page,
+                  :limit
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @domain_id = domain_id
+      @identity_id = identity_id
+      @page = page
+      @limit = limit
+    end
+
+    def list(domain_id: nil, page: nil, limit: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'page' => page,
+        'limit' => limit
+      }
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/identities',
+                                       query: URI.encode_www_form(hash.compact)))
+      puts response
+    end
+
+    def single(identity_id:)
+      hash = {
+        'identity_id' => identity_id
+      }
+      client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: "/v1/identities/#{identity_id}",
+                                       query: URI.encode_www_form(hash.compact)))
+    end
+
+    def add(domain_id: nil, name: nil, email: nil, reply_to_email: nil, reply_to_name: nil, add_note: nil, personal_note: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'name' => name,
+        'email' => email,
+        'reply_to_email' => reply_to_email,
+        'reply_to_name' => reply_to_name,
+        'add_note' => add_note,
+        'personal_note' => personal_note
+      }
+      client.http.post("#{API_URL}/identities", json: hash.compact)
+    end
+
+    def update(identity_id:, domain_id: nil, name: nil, email: nil, reply_to_email: nil, reply_to_name: nil, add_note: nil, personal_note: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'name' => name,
+        'email' => email,
+        'reply_to_email' => reply_to_email,
+        'reply_to_name' => reply_to_name,
+        'add_note' => add_note,
+        'personal_note' => personal_note
+      }
+      client.http.put("#{API_URL}/identities/#{identity_id}", json: hash.compact)
+    end
+
+    def delete(identity_id:)
+      client.http.delete(URI::HTTPS.build(host: API_BASE_HOST, path: "/v1/identities/#{identity_id}"))
+    end
+  end
+end

data/lib/mailersend/sms_messages/sms_messages.rb

@@ -22,7 +22,7 @@ module Mailersend
       }
 
       client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: '/v1/sms-messages',
-                                                  query: URI.encode_www_form(hash)))
+                                       query: URI.encode_www_form(hash)))
     end
 
     def get(sms_message_id:)

data/lib/mailersend/version.rb

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

data/lib/mailersend.rb

@@ -3,6 +3,7 @@
 require_relative 'mailersend/client'
 require_relative 'mailersend/version'
 require_relative 'mailersend/activity/activity'
+require_relative 'mailersend/api_quota/api_quota'
 require_relative 'mailersend/analytics/analytics'
 require_relative 'mailersend/bulk_email/bulk_email'
 require_relative 'mailersend/domains/domains'
@@ -12,6 +13,7 @@ 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/sender_identity/sender_identity'
 require_relative 'mailersend/sms/sms'
 require_relative 'mailersend/sms_activity/sms_activity'
 require_relative 'mailersend/sms_messages/sms_messages'

data/mailersend-ruby.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.3.4'
+  spec.add_development_dependency 'bundler', '~> 2.4.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 1.7'
   spec.add_dependency 'dotenv', '~> 2.7'
   spec.add_dependency 'http', '~> 5.0'
   spec.add_dependency 'json', '~> 2.5'
-  spec.add_dependency 'uri', '~> 0.10.1'
+  spec.add_dependency 'uri', '~> 0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailersend-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Nikola Milojević
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.12.0
 description: MailerSend's official Ruby SDK. Interacts with all endpoints at MailerSend
   API.
 email:
@@ -135,6 +135,7 @@ files:
 - lib/mailersend.rb
 - lib/mailersend/activity/activity.rb
 - lib/mailersend/analytics/analytics.rb
+- lib/mailersend/api_quota/api_quota.rb
 - lib/mailersend/bulk_email/bulk_email.rb
 - lib/mailersend/client.rb
 - lib/mailersend/domains/domains.rb
@@ -144,6 +145,7 @@ files:
 - lib/mailersend/messages/messages.rb
 - lib/mailersend/recipients/recipients.rb
 - lib/mailersend/scheduled_messages/scheduled_messages.rb
+- lib/mailersend/sender_identity/sender_identity.rb
 - lib/mailersend/sms/sms.rb
 - lib/mailersend/sms_activity/sms_activity.rb
 - lib/mailersend/sms_inbounds/sms_inbounds.rb
@@ -182,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: MailerSend's official Ruby SDK