sendgrid4r 0.5.0 → 1.0.0

data/lib/sendgrid4r/rest/templates/versions.rb

@@ -39,8 +39,8 @@ module SendGrid4r
           url
         end
 
-        def post_version(temp_id, version, &block)
-          endpoint = SendGrid4r::REST::Templates::Versions.url(temp_id)
+        def post_version(template_id:, version:, &block)
+          endpoint = SendGrid4r::REST::Templates::Versions.url(template_id)
           resp = post(
             @auth,
             endpoint,
@@ -50,35 +50,37 @@ module SendGrid4r
           SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def activate_version(temp_id, ver_id, &block)
-          url = SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id)
+        def activate_version(template_id:, version_id:, &block)
+          url = SendGrid4r::REST::Templates::Versions.url(
+            template_id, version_id
+          )
           resp = post(@auth, "#{url}/activate", &block)
           SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def get_version(temp_id, ver_id, &block)
+        def get_version(template_id:, version_id:, &block)
           resp = get(
             @auth,
-            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            SendGrid4r::REST::Templates::Versions.url(template_id, version_id),
             &block
           )
           SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def patch_version(temp_id, ver_id, version, &block)
+        def patch_version(template_id:, version_id:, version:, &block)
           resp = patch(
             @auth,
-            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            SendGrid4r::REST::Templates::Versions.url(template_id, version_id),
             remove_uneditable_keys(version.to_h),
             &block
           )
           SendGrid4r::REST::Templates::Versions.create_version(resp)
         end
 
-        def delete_version(temp_id, ver_id, &block)
+        def delete_version(template_id:, version_id:, &block)
           delete(
             @auth,
-            SendGrid4r::REST::Templates::Versions.url(temp_id, ver_id),
+            SendGrid4r::REST::Templates::Versions.url(template_id, version_id),
             &block
           )
         end

data/lib/sendgrid4r/rest/whitelabel/domains.rb

@@ -0,0 +1,257 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Whitelabel
+    #
+    module Whitelabel
+      #
+      # SendGrid Web API v3 Whitelabel Domains
+      #
+      module Domains
+        include SendGrid4r::REST::Request
+
+        Domain = Struct.new(
+          :id, :domain, :subdomain, :username, :user_id, :ips, :custom_spf,
+          :default, :legacy, :automatic_security, :valid, :dns
+        )
+        Dns = Struct.new(
+          # automatic_security:true
+          :mail_cname, :spf, :dkim1, :dkim2,
+          # automatic_security:false
+          :mail_server, :subdomain_spf, :domain_spf, :dkim
+        )
+        Record = Struct.new(:host, :type, :data, :valid)
+
+        def self.url(id = nil, ip = nil)
+          url = "#{BASE_URL}/whitelabel/domains"
+          url = "#{url}/#{id}" unless id.nil?
+          url = "#{url}/ips/#{ip}" unless ip.nil?
+          url
+        end
+
+        def self.create_domains(resp)
+          return resp if resp.nil?
+          domains = []
+          resp.each do |domain|
+            domains.push(
+              SendGrid4r::REST::Whitelabel::Domains.create_domain(domain)
+            )
+          end
+          domains
+        end
+
+        def self.create_domain(resp)
+          return resp if resp.nil?
+          Domain.new(
+            resp['id'],
+            resp['domain'],
+            resp['subdomain'],
+            resp['username'],
+            resp['user_id'],
+            resp['ips'],
+            resp['custom_spf'],
+            resp['default'],
+            resp['legacy'],
+            resp['automatic_security'],
+            resp['valid'],
+            SendGrid4r::REST::Whitelabel::Domains.create_dns(resp['dns'])
+          )
+        end
+
+        def self.create_dns(resp)
+          return resp if resp.nil?
+          Dns.new(
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['mail_cname']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['dkim1']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['dkim2']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['mail_server']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['subdomain_spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['domain_spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_record(
+              resp['dkim'])
+          )
+        end
+
+        def self.create_record(resp)
+          return resp if resp.nil?
+          Record.new(resp['host'], resp['type'], resp['data'], resp['valid'])
+        end
+
+        Result = Struct.new(:id, :valid, :validation_results)
+        ValidationResults = Struct.new(
+          # automatic_security:true
+          :mail_cname, :spf, :dkim1, :dkim2,
+          # automatic_security:false
+          :mail_server, :subdomain_spf, :domain_spf, :dkim
+        )
+        ValidationResult = Struct.new(:valid, :reason)
+
+        def self.create_result(resp)
+          return resp if resp.nil?
+          Result.new(
+            resp['id'],
+            resp['valid'],
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_results(
+              resp['validation_results']
+            )
+          )
+        end
+
+        def self.create_validation_results(resp)
+          return resp if resp.nil?
+          ValidationResults.new(
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['mail_cname']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['dkim1']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['dkim2']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['mail_server']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['subdomain_spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['domain_spf']),
+            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
+              resp['dkim'])
+          )
+        end
+
+        def self.create_validation_result(resp)
+          return resp if resp.nil?
+          ValidationResult.new(resp['valid'], resp['reason'])
+        end
+
+        def get_wl_domains(
+          limit: nil, offset: nil, exclude_subusers: nil, username: nil,
+          domain: nil, &block
+        )
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          unless exclude_subusers.nil?
+            params['exclude_subusers'] = exclude_subusers
+          end
+          params['username'] = username unless username.nil?
+          params['domain'] = domain unless domain.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domains(resp)
+        end
+
+        def post_wl_domain(
+          domain:, subdomain:, username: nil, ips: nil, automatic_security: nil,
+          custom_spf: nil, default: nil, &block
+        )
+          params = {}
+          params['domain'] = domain
+          params['subdomain'] = subdomain
+          params['username'] = username unless username.nil?
+          params['ips'] = ips unless ips.nil?
+          unless automatic_security.nil?
+            params['automatic_security'] = automatic_security
+          end
+          params['custom_spf'] = custom_spf unless custom_spf.nil?
+          params['default'] = default unless default.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def get_wl_domain(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          resp = get(@auth, endpoint, nil, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def patch_wl_domain(
+          id:, custom_spf: nil, default: nil, &block
+        )
+          params = {}
+          params['custom_spf'] = custom_spf unless custom_spf.nil?
+          params['default'] = default unless default.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          resp = patch(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def delete_wl_domain(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          delete(@auth, endpoint, &block)
+        end
+
+        def get_default_wl_domain(domain: nil, &block)
+          params = {}
+          params['domain'] = domain unless domain.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url
+          endpoint = "#{endpoint}/default"
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def add_ip_to_wl_domain(id:, ip:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          endpoint = "#{endpoint}/ips"
+          params = {}
+          params['ip'] = ip
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def remove_ip_from_wl_domain(id:, ip:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id, ip)
+          resp = delete(@auth, endpoint, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def validate_wl_domain(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          endpoint = "#{endpoint}/validate"
+          resp = post(@auth, endpoint, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_result(resp)
+        end
+
+        def get_associated_wl_domain(username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+
+        def disassociate_wl_domain(username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          delete(@auth, endpoint, params, &block)
+        end
+
+        def associate_wl_domain(id:, username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Domains.url(id)
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Domains.create_domain(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/whitelabel/ips.rb

@@ -0,0 +1,140 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Whitelabel
+    #
+    module Whitelabel
+      #
+      # SendGrid Web API v3 Whitelabel Ips
+      #
+      module Ips
+        include SendGrid4r::REST::Request
+
+        Ip = Struct.new(
+          :id, :ip, :rdns, :users, :subdomain, :domain, :valid, :legacy,
+          :a_record
+        )
+        User = Struct.new(:username, :user_id)
+        ARecord = Struct.new(:host, :type, :data, :valid)
+
+        def self.url(id = nil)
+          url = "#{BASE_URL}/whitelabel/ips"
+          url = "#{url}/#{id}" unless id.nil?
+          url
+        end
+
+        def self.create_ips(resp)
+          return resp if resp.nil?
+          ips = []
+          resp.each do |ip|
+            ips.push(
+              SendGrid4r::REST::Whitelabel::Ips.create_ip(ip)
+            )
+          end
+          ips
+        end
+
+        def self.create_ip(resp)
+          return resp if resp.nil?
+          Ip.new(
+            resp['id'],
+            resp['ip'],
+            resp['rdns'],
+            SendGrid4r::REST::Whitelabel::Ips.create_users(resp['users']),
+            resp['subdomain'],
+            resp['domain'],
+            resp['valid'],
+            resp['legacy'],
+            SendGrid4r::REST::Whitelabel::Ips.create_a_record(resp['a_record'])
+          )
+        end
+
+        def self.create_users(resp)
+          return resp if resp.nil?
+          users = []
+          resp.each do |user|
+            users.push(SendGrid4r::REST::Whitelabel::Ips.create_a_record(user))
+          end
+          users
+        end
+
+        def self.create_a_record(resp)
+          return resp if resp.nil?
+          ARecord.new(resp['host'], resp['type'], resp['data'], resp['valid'])
+        end
+
+        Result = Struct.new(:id, :valid, :validation_results)
+        ValidationResults = Struct.new(:a_record)
+        ValidationResult = Struct.new(:valid, :reason)
+
+        def self.create_result(resp)
+          return resp if resp.nil?
+          Result.new(
+            resp['id'],
+            resp['valid'],
+            SendGrid4r::REST::Whitelabel::Ips.create_validation_results(
+              resp['validation_results']
+            )
+          )
+        end
+
+        def self.create_validation_results(resp)
+          return resp if resp.nil?
+          ValidationResults.new(
+            SendGrid4r::REST::Whitelabel::Ips.create_validation_result(
+              resp['a_record']
+            )
+          )
+        end
+
+        def self.create_validation_result(resp)
+          return resp if resp.nil?
+          ValidationResult.new(resp['valid'], resp['reason'])
+        end
+
+        def get_wl_ips(ip: nil, limit: nil, offset: nil, &block)
+          params = {}
+          params['ip'] = ip unless ip.nil?
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Ips.url
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Ips.create_ips(resp)
+        end
+
+        def post_wl_ip(ip:, subdomain:, domain:, &block)
+          params = {}
+          params['ip'] = ip
+          params['subdomain'] = subdomain
+          params['domain'] = domain
+          endpoint = SendGrid4r::REST::Whitelabel::Ips.url
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Ips.create_ip(resp)
+        end
+
+        def get_wl_ip(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Ips.url(id)
+          resp = get(@auth, endpoint, nil, &block)
+          SendGrid4r::REST::Whitelabel::Ips.create_ip(resp)
+        end
+
+        def delete_wl_ip(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Ips.url(id)
+          delete(@auth, endpoint, &block)
+        end
+
+        def validate_wl_ip(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Ips.url(id)
+          endpoint = "#{endpoint}/validate"
+          resp = post(@auth, endpoint, &block)
+          SendGrid4r::REST::Whitelabel::Ips.create_result(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/whitelabel/links.rb

@@ -0,0 +1,185 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Whitelabel
+    #
+    module Whitelabel
+      #
+      # SendGrid Web API v3 Whitelabel Links
+      #
+      module Links
+        include SendGrid4r::REST::Request
+
+        Link = Struct.new(
+          :id, :domain, :subdomain, :username, :user_id, :default,
+          :valid, :legacy, :dns
+        )
+        Dns = Struct.new(:domain_cname, :owner_cname)
+        Record = Struct.new(:host, :type, :data, :valid)
+
+        def self.url(id = nil)
+          url = "#{BASE_URL}/whitelabel/links"
+          url = "#{url}/#{id}" unless id.nil?
+          url
+        end
+
+        def self.create_links(resp)
+          return resp if resp.nil?
+          links = []
+          resp.each do |link|
+            links.push(
+              SendGrid4r::REST::Whitelabel::Links.create_link(link)
+            )
+          end
+          links
+        end
+
+        def self.create_link(resp)
+          return resp if resp.nil?
+          Link.new(
+            resp['id'],
+            resp['domain'],
+            resp['subdomain'],
+            resp['username'],
+            resp['user_id'],
+            resp['default'],
+            resp['valid'],
+            resp['legacy'],
+            SendGrid4r::REST::Whitelabel::Links.create_dns(resp['dns'])
+          )
+        end
+
+        def self.create_dns(resp)
+          return resp if resp.nil?
+          Dns.new(
+            SendGrid4r::REST::Whitelabel::Links.create_record(
+              resp['domain_cname']
+            ),
+            SendGrid4r::REST::Whitelabel::Links.create_record(
+              resp['owner_cname']
+            )
+          )
+        end
+
+        def self.create_record(resp)
+          return resp if resp.nil?
+          Record.new(resp['host'], resp['type'], resp['data'], resp['valid'])
+        end
+
+        Result = Struct.new(:id, :valid, :validation_results)
+        ValidationResults = Struct.new(:domain_cname, :owner_cname)
+        ValidationResult = Struct.new(:valid, :reason)
+
+        def self.create_result(resp)
+          return resp if resp.nil?
+          Result.new(
+            resp['id'],
+            resp['valid'],
+            SendGrid4r::REST::Whitelabel::Links.create_validation_results(
+              resp['validation_results']
+            )
+          )
+        end
+
+        def self.create_validation_results(resp)
+          return resp if resp.nil?
+          ValidationResults.new(
+            SendGrid4r::REST::Whitelabel::Links.create_validation_result(
+              resp['domain_cname']
+            ),
+            SendGrid4r::REST::Whitelabel::Links.create_validation_result(
+              resp['owner_cname']
+            )
+          )
+        end
+
+        def self.create_validation_result(resp)
+          return resp if resp.nil?
+          ValidationResult.new(resp['valid'], resp['reason'])
+        end
+
+        def get_wl_links(&block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url
+          resp = get(@auth, endpoint, nil, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_links(resp)
+        end
+
+        def post_wl_link(subdomain:, domain:, default: nil, &block)
+          params = {}
+          params['subdomain'] = subdomain
+          params['domain'] = domain
+          params['default'] = default unless default.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+
+        def get_wl_link(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url(id)
+          resp = get(@auth, endpoint, nil, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+
+        def patch_wl_link(id:, default:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url(id)
+          params = {}
+          params['default'] = default
+          resp = patch(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+
+        def delete_wl_link(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url(id)
+          delete(@auth, endpoint, &block)
+        end
+
+        def get_default_wl_link(domain: nil, &block)
+          params = {}
+          params['domain'] = domain unless domain.nil?
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url
+          endpoint = "#{endpoint}/default"
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+
+        def validate_wl_link(id:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url(id)
+          endpoint = "#{endpoint}/validate"
+          resp = post(@auth, endpoint, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_result(resp)
+        end
+
+        def get_associated_wl_link(username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+
+        def disassociate_wl_link(username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          delete(@auth, endpoint, params, &block)
+        end
+
+        def associate_wl_link(id:, username:, &block)
+          endpoint = SendGrid4r::REST::Whitelabel::Links.url(id)
+          endpoint = "#{endpoint}/subuser"
+          params = {}
+          params['username'] = username
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Whitelabel::Links.create_link(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/version.rb

@@ -2,5 +2,5 @@
 # SendGrid API v3 wrapper implementation.
 #
 module SendGrid4r
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

data/sendgrid4r.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency('rest-client', '1.7.2')
+  spec.add_dependency('rest-client', '>=1.8.0', '<1.9.0')
   spec.add_development_dependency('rubocop', '>=0.29.0', '<0.30.0')
   spec.add_development_dependency('bundler', '>=1.6.0', '<1.8.0')
   spec.add_development_dependency('rspec', '3.1.0')