sendgrid4r 1.12.0 → 1.13.0

data/lib/sendgrid4r/cli/suppressions/block.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class Block < SgThor
       desc 'list', 'List blocks'
-      option :start_time, type: :numeric
-      option :end_time, type: :numeric
+      option :start_time, banner: SgThor::UTS, type: :numeric
+      option :end_time, banner: SgThor::UTS, type: :numeric
       option :limit, type: :numeric
       option :offset, type: :numeric
       def list

data/lib/sendgrid4r/cli/suppressions/bounce.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class Bounce < SgThor
       desc 'list', 'List bounces'
-      option :start_time, type: :numeric
-      option :end_time, type: :numeric
+      option :start_time, banner: SgThor::UTS, type: :numeric
+      option :end_time, banner: SgThor::UTS, type: :numeric
       def list
         puts @client.get_bounces(parameterise(options))
       rescue RestClient::ExceptionWithResponse => e

data/lib/sendgrid4r/cli/suppressions/global_unsubscribe.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class GlobalUnsubscribe < SgThor
       desc 'list', 'List global unsubscribes'
-      option :start_time, type: :numeric
-      option :end_time, type: :numeric
+      option :start_time, banner: SgThor::UTS, type: :numeric
+      option :end_time, banner: SgThor::UTS, type: :numeric
       option :limit, type: :numeric
       option :offset, type: :numeric
       def list

data/lib/sendgrid4r/cli/suppressions/group.rb

@@ -15,8 +15,13 @@ module SendGrid4r::CLI
       end
 
       desc 'list', 'List supression groups'
+      option :email_address
       def list
-        puts @client.get_groups
+        if options[:email_address].nil?
+          puts @client.get_groups
+        else
+          puts @client.get_groups_by_email(parameterise(options))
+        end
       rescue RestClient::ExceptionWithResponse => e
         puts e.inspect
       end

data/lib/sendgrid4r/cli/suppressions/group_unsubscribe.rb

@@ -21,6 +21,15 @@ module SendGrid4r::CLI
         puts e.inspect
       end
 
+      desc 'search', 'Search suppressed addresses for a given group'
+      option :group_id, require: true
+      option :recipient_emails, type: :array, require: true
+      def search
+        puts @client.search_suppressed_emails(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
       desc 'remove', 'Remove an email address from the given group'
       option :group_id, require: true
       option :email_address, require: true

data/lib/sendgrid4r/cli/suppressions/invalid_email.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class InvalidEmail < SgThor
       desc 'list', 'List blocks'
-      option :start_time, type: :numeric
-      option :end_time, type: :numeric
+      option :start_time, banner: SgThor::UTS, type: :numeric
+      option :end_time, banner: SgThor::UTS, type: :numeric
       option :limit, type: :numeric
       option :offset, type: :numeric
       def list

data/lib/sendgrid4r/cli/suppressions/spam_report.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class SpamReport < SgThor
       desc 'list', 'List spam reports'
-      option :start_time, type: :numeric
-      option :end_time, type: :numeric
+      option :start_time, banner: SgThor::UTS, type: :numeric
+      option :end_time, banner: SgThor::UTS, type: :numeric
       option :limit, type: :numeric
       option :offset, type: :numeric
       def list

data/lib/sendgrid4r/cli/templates/version.rb

@@ -10,7 +10,7 @@ module SendGrid4r::CLI
       option :subject, require: true
       option :html_content, require: true
       option :plain_content, require: true
-      option :active, type: :numeric
+      option :active, type: :numeric, banner: '[0|1]'
       def create
         factory = SendGrid4r::Factory::VersionFactory.new
         params = parameterise(options)
@@ -49,7 +49,7 @@ module SendGrid4r::CLI
       option :subject
       option :html_content
       option :plain_content
-      option :active
+      option :active, type: :numeric, banner: '[0|1]'
       def update
         factory = SendGrid4r::Factory::VersionFactory.new
         params = parameterise(options)

data/lib/sendgrid4r/cli/user.rb

@@ -3,7 +3,7 @@ module SendGrid4r::CLI
   # SendGrid Web API v3 User
   #
   class User < SgThor
-    desc 'profile', 'Get or Update user Profile'
+    desc 'profile [get|update]', 'Get or Update user Profile'
     option :address
     option :city
     option :company
@@ -27,7 +27,7 @@ module SendGrid4r::CLI
       puts e.inspect
     end
 
-    desc 'account', 'Get user account'
+    desc 'account [get]', 'Get user account'
     def account(action)
       case action
       when 'get'
@@ -39,7 +39,7 @@ module SendGrid4r::CLI
       puts e.inspect
     end
 
-    desc 'email', 'Get or update user email'
+    desc 'email [get|update]', 'Get or update user email'
     option :email
     def email(action)
       case action
@@ -54,7 +54,7 @@ module SendGrid4r::CLI
       puts e.inspect
     end
 
-    desc 'username', 'Get or update username'
+    desc 'username [get|update]', 'Get or update username'
     option :username
     def username(action)
       case action
@@ -69,7 +69,7 @@ module SendGrid4r::CLI
       puts e.inspect
     end
 
-    desc('password', 'Update password')
+    desc('password [update]', 'Update password')
     option :new_password, require: true
     option :old_password, require: true
     def password(action)

data/lib/sendgrid4r/cli/webhooks/parse.rb

@@ -4,9 +4,49 @@ module SendGrid4r::CLI
     # SendGrid Web API v3 Webhook Parse
     #
     class Parse < SgThor
-      desc 'get', 'Get Parse Webhook Settings'
+      desc 'list', 'List parse webhook settings'
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def list
+        puts @client.get_parse_settings(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create a parse webhook setting'
+      option :hostname, require: true
+      option :url, require: true
+      option :spam_check, type: :boolean, require: true
+      option :send_raw, type: :boolean, require: true
+      def create
+        puts @client.post_parse_setting(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Get a parse webhook setting'
+      option :hostname
       def get
-        puts @client.get_parse_settings
+        puts @client.get_parse_setting(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update a parse webhook setting'
+      option :hostname, require: true
+      option :url
+      option :spam_check, type: :boolean
+      option :send_raw, type: :boolean
+      def update
+        puts @client.patch_parse_setting(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete a parse webhook setting'
+      option :hostname, require: true
+      def delete
+        puts @client.delete_parse_setting(parameterise(options))
       rescue RestClient::ExceptionWithResponse => e
         puts e.inspect
       end

data/lib/sendgrid4r/cli/whitelabel/domain.rb

@@ -5,9 +5,9 @@ module SendGrid4r::CLI
     #
     class Domain < SgThor
       desc 'list', 'List all Domain whitelabels'
-      option :limit
-      option :offset
-      option :exclude_subusers
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      option :exclude_subusers, type: :boolean
       option :username
       option :domain
       def list

data/lib/sendgrid4r/cli/whitelabel/link.rb

@@ -5,8 +5,8 @@ module SendGrid4r::CLI
     #
     class Link < SgThor
       desc 'list', 'List all Link whitelabels'
-      option :limit
-      option :offset
+      option :limit, type: :numeric
+      option :offset, type: :numeric
       option :exclude_subusers
       option :username
       option :domain

data/lib/sendgrid4r/rest/alerts.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Alerts
+  #
+  module Alerts
+    include Request
+
+    Alert = Struct.new(
+      :created_at,
+      :email_to,
+      :frequency,
+      :id,
+      :percentage,
+      :type,
+      :updated_at
+    )
+
+    def self.url(alert_id = nil)
+      url = "#{BASE_URL}/alerts"
+      url = "#{url}/#{alert_id}" unless alert_id.nil?
+      url
+    end
+
+    def self.create_alerts(resp)
+      return resp if resp.nil?
+      resp.map { |alert| Alerts.create_alert(alert) }
+    end
+
+    def self.create_alert(resp)
+      return resp if resp.nil?
+      created_at = Time.at(resp['created_at'])
+      updated_at = Time.at(resp['updated_at'])
+      Alert.new(
+        created_at,
+        resp['email_to'],
+        resp['frequency'],
+        resp['id'],
+        resp['percentage'],
+        resp['type'],
+        updated_at
+      )
+    end
+
+    def get_alerts(&block)
+      resp = get(@auth, Alerts.url, &block)
+      finish(resp, @raw_resp) { |r| Alerts.create_alerts(r) }
+    end
+
+    def post_alert(type:, email_to:, percentage: nil, frequency: nil, &block)
+      params = { type: type, email_to: email_to }
+      params[:percentage] = percentage unless percentage.nil?
+      params[:frequency] = frequency unless frequency.nil?
+      resp = post(@auth, Alerts.url, params, &block)
+      finish(resp, @raw_resp) { |r| Alerts.create_alert(r) }
+    end
+
+    def get_alert(alert_id:, &block)
+      endpoint = Alerts.url(alert_id)
+      resp = get(@auth, endpoint, &block)
+      finish(resp, @raw_resp) { |r| Alerts.create_alert(r) }
+    end
+
+    def delete_alert(alert_id:, &block)
+      delete(@auth, Alerts.url(alert_id), &block)
+    end
+
+    def patch_alert(
+      alert_id:, email_to: nil, frequency: nil, percentage: nil, &block
+    )
+      params = {}
+      params[:email_to] = email_to unless email_to.nil?
+      params[:frequency] = frequency unless frequency.nil?
+      params[:percentage] = percentage unless percentage.nil?
+      endpoint = Alerts.url(alert_id)
+      resp = patch(@auth, endpoint, params, &block)
+      finish(resp, @raw_resp) { |r| Alerts.create_alert(r) }
+    end
+  end
+end

data/lib/sendgrid4r/rest/api.rb

@@ -19,6 +19,7 @@ module SendGrid4r::REST
     include SendGrid4r::REST::Ips::Addresses
     include SendGrid4r::REST::Ips::Warmup
     include SendGrid4r::REST::Ips::Pools
+    include SendGrid4r::REST::Alerts
     include SendGrid4r::REST::Categories
     include SendGrid4r::REST::Stats::Global
     include SendGrid4r::REST::Stats::Category

data/lib/sendgrid4r/rest/blocks.rb

@@ -48,14 +48,12 @@ module SendGrid4r::REST
     end
 
     def get_block(email:, &block)
-      params = { email: email }
-      resp = get(@auth, Blocks.url(email), params, &block)
+      resp = get(@auth, Blocks.url(email), &block)
       finish(resp, @raw_resp) { |r| Blocks.create_blocks(r) }
     end
 
     def delete_block(email:, &block)
-      params = { email: email }
-      delete(@auth, Blocks.url(email), params, &block)
+      delete(@auth, Blocks.url(email), &block)
     end
   end
 end

data/lib/sendgrid4r/rest/bounces.rb

@@ -44,14 +44,12 @@ module SendGrid4r::REST
     end
 
     def get_bounce(email:, &block)
-      params = { email: email }
-      resp = get(@auth, Bounces.url(email), params, &block)
+      resp = get(@auth, Bounces.url(email), &block)
       finish(resp, @raw_resp) { |r| Bounces.create_bounces(r) }
     end
 
     def delete_bounce(email:, &block)
-      params = { email: email }
-      delete(@auth, Bounces.url(email), params, &block)
+      delete(@auth, Bounces.url(email), &block)
     end
   end
 end

data/lib/sendgrid4r/rest/invalid_emails.rb

@@ -50,14 +50,12 @@ module SendGrid4r::REST
     end
 
     def get_invalid_email(email:, &block)
-      params = { email: email }
-      resp = get(@auth, InvalidEmails.url(email), params, &block)
+      resp = get(@auth, InvalidEmails.url(email), &block)
       finish(resp, @raw_resp) { |r| InvalidEmails.create_invalid_emails(r) }
     end
 
     def delete_invalid_email(email:, &block)
-      params = { email: email }
-      delete(@auth, InvalidEmails.url(email), params, &block)
+      delete(@auth, InvalidEmails.url(email), &block)
     end
   end
 end

data/lib/sendgrid4r/rest/request.rb

@@ -61,14 +61,18 @@ module SendGrid4r::REST
     end
 
     def process_url_params(endpoint, params)
-      if params.nil? || params.empty?
-        endpoint
-      else
-        query_string = params.collect do |k, v|
+      return endpoint if params.nil? || params.empty?
+      if params.is_a?(Array)
+        ary_params = params
+      elsif params.is_a?(Hash)
+        ary_params = [params]
+      end
+      query_string = ary_params.collect do |hash|
+        hash.collect do |k, v|
           "#{k}=#{CGI.escape(process_array_params(v))}"
         end.join('&')
-        endpoint + "?#{query_string}"
-      end
+      end.join('&')
+      "#{endpoint}?#{query_string}"
     end
 
     def process_array_params(v)

data/lib/sendgrid4r/rest/sm/groups.rb

@@ -43,8 +43,9 @@ module SendGrid4r::REST
         finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
       end
 
-      def get_groups(&block)
-        resp = get(@auth, Sm::Groups.url, &block)
+      def get_groups(ids: nil, &block)
+        i = ids.map { |id| { id: id } } unless ids.nil?
+        resp = get(@auth, Sm::Groups.url, i, &block)
         finish(resp, @raw_resp) { |r| Sm::Groups.create_groups(r) }
       end
 

data/lib/sendgrid4r/rest/sm/suppressions.rb

@@ -8,8 +8,10 @@ module SendGrid4r::REST
     module Suppressions
       include Request
 
-      Suppression = Struct.new(:id, :name, :description, :suppressed)
-      Suppressions = Struct.new(:suppressions)
+      Group = Struct.new(
+        :id, :name, :description, :suppressed, :is_default
+      )
+      Groups = Struct.new(:suppressions)
 
       def self.url(group_id, email_address = nil)
         url = "#{BASE_URL}/asm/groups/#{group_id}/suppressions"
@@ -17,21 +19,64 @@ module SendGrid4r::REST
         url
       end
 
-      def self.create_suppressions(resp)
+      def self.create_groups(resp)
         return resp if resp.nil?
         suppressions = resp['suppressions'].map do |suppression|
-          Sm::Suppressions.create_suppression(suppression)
+          Sm::Suppressions.create_group(suppression)
         end
-        Suppressions.new(suppressions)
+        Groups.new(suppressions)
+      end
+
+      def self.create_group(resp)
+        return resp if resp.nil?
+        Group.new(
+          resp['id'],
+          resp['name'],
+          resp['description'],
+          resp['suppressed'],
+          resp['is_default']
+        )
+      end
+
+      Suppression = Struct.new(
+        :email, :group_id, :group_name, :created_at
+      )
+
+      def self.suppressions_url(email = nil)
+        url = "#{BASE_URL}/asm/suppressions"
+        url = "#{url}/#{email}" unless email.nil?
+        url
       end
 
       def self.create_suppression(resp)
         return resp if resp.nil?
+        created_at = Time.at(resp['created_at'])
         Suppression.new(
-          resp['id'], resp['name'], resp['description'], resp['suppressed']
+          resp['email'],
+          resp['group_id'],
+          resp['group_name'],
+          created_at
         )
       end
 
+      def get_suppressions(&block)
+        endpoint = Sm::Suppressions.suppressions_url
+        resp = get(@auth, endpoint, &block)
+        finish(resp, @raw_resp) do |r|
+          r.map do |suppression|
+            Sm::Suppressions.create_suppression(suppression)
+          end
+        end
+      end
+
+      def get_groups_by_email(email_address:, &block)
+        endpoint = Sm::Suppressions.suppressions_url(email_address)
+        resp = get(@auth, endpoint, &block)
+        finish(resp, @raw_resp) do |r|
+          Sm::Suppressions.create_groups(r)
+        end
+      end
+
       def post_suppressed_emails(group_id:, recipient_emails:, &block)
         resp = post(
           @auth,
@@ -48,14 +93,6 @@ module SendGrid4r::REST
         finish(resp, @raw_resp) { |r| r }
       end
 
-      def get_suppressions(email_address:, &block)
-        endpoint = "#{BASE_URL}/asm/suppressions/#{email_address}"
-        resp = get(@auth, endpoint, &block)
-        finish(resp, @raw_resp) do |r|
-          Sm::Suppressions.create_suppressions(r)
-        end
-      end
-
       def delete_suppressed_email(group_id:, email_address:, &block)
         delete(
           @auth,
@@ -63,6 +100,16 @@ module SendGrid4r::REST
           &block
         )
       end
+
+      def search_suppressed_emails(group_id:, recipient_emails:, &block)
+        resp = post(
+          @auth,
+          Sm::Suppressions.url(group_id, :search),
+          recipient_emails: recipient_emails,
+          &block
+        )
+        finish(resp, @raw_resp) { |r| r }
+      end
     end
   end
 end

data/lib/sendgrid4r/rest/spam_reports.rb

@@ -48,14 +48,12 @@ module SendGrid4r::REST
     end
 
     def get_spam_report(email:, &block)
-      params = { email: email }
-      resp = get(@auth, SpamReports.url(email), params, &block)
+      resp = get(@auth, SpamReports.url(email), &block)
       finish(resp, @raw_resp) { |r| SpamReports.create_spam_reports(r) }
     end
 
     def delete_spam_report(email:, &block)
-      params = { email: email }
-      delete(@auth, SpamReports.url(email), params, &block)
+      delete(@auth, SpamReports.url(email), &block)
     end
   end
 end

data/lib/sendgrid4r/rest/webhooks/parse.rb

@@ -12,10 +12,12 @@ module SendGrid4r::REST
       include Request
 
       ParseSettings = Struct.new(:result)
-      ParseSetting = Struct.new(:url, :hostname, :spam_check_outgoing)
+      ParseSetting = Struct.new(:url, :hostname, :spam_check, :send_raw)
 
-      def self.url
-        "#{BASE_URL}/user/webhooks/parse/settings"
+      def self.url(hostname = nil)
+        url = "#{BASE_URL}/user/webhooks/parse/settings"
+        url = "#{url}/#{hostname}" unless hostname.nil?
+        url
       end
 
       def self.create_parse_settings(resp)
@@ -29,14 +31,53 @@ module SendGrid4r::REST
       def self.create_parse_setting(resp)
         return resp if resp.nil?
         ParseSetting.new(
-          resp['url'], resp['hostname'], resp['spam_check_outgoing']
+          resp['url'],
+          resp['hostname'],
+          resp['spam_check'],
+          resp['send_raw']
         )
       end
 
-      def get_parse_settings(&block)
-        resp = get(@auth, Parse.url, &block)
+      def get_parse_settings(limit: nil, offset: nil, &block)
+        params = {}
+        params[:limit] = limit unless limit.nil?
+        params[:offset] = offset unless offset.nil?
+        resp = get(@auth, Parse.url, params, &block)
         finish(resp, @raw_resp) { |r| Parse.create_parse_settings(r) }
       end
+
+      def post_parse_setting(
+        hostname:, url:, spam_check:, send_raw:, &block
+      )
+        params = {
+          hostname: hostname,
+          url: url,
+          spam_check: spam_check,
+          send_raw: send_raw
+        }
+        resp = post(@auth, Parse.url, params, &block)
+        finish(resp, @raw_resp) { |r| Parse.create_parse_setting(r) }
+      end
+
+      def get_parse_setting(hostname:, &block)
+        resp = get(@auth, Parse.url(hostname), &block)
+        finish(resp, @raw_resp) { |r| Parse.create_parse_setting(r) }
+      end
+
+      def patch_parse_setting(
+        hostname:, url: nil, spam_check: nil, send_raw: nil, &block
+      )
+        params = {}
+        params[:url] = url unless url.nil?
+        params[:spam_check] = spam_check unless spam_check.nil?
+        params[:send_raw] = send_raw unless send_raw.nil?
+        resp = patch(@auth, Parse.url(hostname), params, &block)
+        finish(resp, @raw_resp) { |r| Parse.create_parse_setting(r) }
+      end
+
+      def delete_parse_setting(hostname:, &block)
+        delete(@auth, Parse.url(hostname), &block)
+      end
     end
   end
 end

data/lib/sendgrid4r/version.rb

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

data/lib/sendgrid4r.rb

@@ -32,6 +32,8 @@ require 'sendgrid4r/rest/marketing_campaigns/contacts/recipients'
 require 'sendgrid4r/rest/marketing_campaigns/contacts/reserved_fields'
 require 'sendgrid4r/rest/marketing_campaigns/contacts/segments'
 
+require 'sendgrid4r/rest/alerts'
+
 require 'sendgrid4r/rest/categories'
 
 require 'sendgrid4r/rest/email_activity'
@@ -126,6 +128,7 @@ require 'sendgrid4r/cli/whitelabel/ip'
 require 'sendgrid4r/cli/whitelabel/link'
 require 'sendgrid4r/cli/whitelabel/whitelabel'
 require 'sendgrid4r/cli/category'
+require 'sendgrid4r/cli/alert'
 require 'sendgrid4r/cli/user'
 require 'sendgrid4r/cli/campaign/contact/custom_field'
 require 'sendgrid4r/cli/campaign/contact/list'