sendgrid-ruby 4.0.8 → 6.0.0

data/lib/sendgrid/helpers/mail/mail_settings.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module SendGrid
+  class MailSettings
+    def initialize
+      @bcc = nil
+      @bypass_list_management = nil
+      @footer = nil
+      @sandbox_mode = nil
+      @spam_check = nil
+    end
+
+    def sandbox_mode=(sandbox_mode)
+      @sandbox_mode = sandbox_mode
+    end
+
+    def sandbox_mode
+      @sandbox_mode.nil? ? nil : @sandbox_mode.to_json
+    end
+
+    def bypass_list_management=(bypass_list_management)
+      @bypass_list_management = bypass_list_management
+    end
+
+    def bypass_list_management
+      @bypass_list_management.nil? ? nil : @bypass_list_management.to_json
+    end
+
+    def footer=(footer)
+      @footer = footer
+    end
+
+    def footer
+      @footer.nil? ? nil : @footer.to_json
+    end
+
+    def bcc=(bcc)
+      @bcc = bcc
+    end
+
+    def bcc
+      @bcc.nil? ? nil : @bcc.to_json
+    end
+
+    def spam_check=(spam_check)
+      @spam_check = spam_check
+    end
+
+    def spam_check
+      @spam_check.nil? ? nil : @spam_check.to_json
+    end
+
+    def to_json(*)
+      {
+        'bcc' => self.bcc,
+        'bypass_list_management' => self.bypass_list_management,
+        'footer' => self.footer,
+        'sandbox_mode' => self.sandbox_mode,
+        'spam_check' => self.spam_check
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/open_tracking.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module SendGrid
+  class OpenTracking
+    def initialize(enable: nil, substitution_tag: nil)
+      @enable = enable
+      @substitution_tag = substitution_tag
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def substitution_tag=(substitution_tag)
+      @substitution_tag = substitution_tag
+    end
+
+    def substitution_tag
+      @substitution_tag
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable,
+        'substitution_tag' => self.substitution_tag
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/personalization.rb

@@ -0,0 +1,82 @@
+require 'json'
+
+module SendGrid
+  class Personalization
+
+    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
+      :dynamic_template_data
+
+    def initialize
+      @tos = []
+      @ccs = []
+      @bccs = []
+      @subject = nil
+      @headers = {}
+      @substitutions = {}
+      @custom_args = {}
+      @dynamic_template_data = {}
+      @send_at = nil
+    end
+
+    def add_to(to)
+      @tos << to.to_json
+    end
+
+    def add_cc(cc)
+      @ccs << cc.to_json
+    end
+
+    def add_bcc(bcc)
+      @bccs << bcc.to_json
+    end
+
+    def subject=(subject)
+      @subject = subject
+    end
+
+    def subject
+      @subject
+    end
+
+    def add_header(header)
+      header = header.to_json
+      @headers = @headers.merge(header['header'])
+    end
+
+    def add_substitution(substitution)
+      substitution = substitution.to_json
+      @substitutions = @substitutions.merge(substitution['substitution'])
+    end
+
+    def add_custom_arg(custom_arg)
+      custom_arg = custom_arg.to_json
+      @custom_args = @custom_args.merge(custom_arg['custom_arg'])
+    end
+
+    def add_dynamic_template_data(dynamic_template_data)
+      @dynamic_template_data.merge!(dynamic_template_data)
+    end
+
+    def send_at=(send_at)
+      @send_at = send_at
+    end
+
+    def send_at
+      @send_at
+    end
+
+    def to_json(*)
+      {
+        'to' => self.tos,
+        'cc' => self.ccs,
+        'bcc' => self.bccs,
+        'subject' => self.subject,
+        'headers' => self.headers,
+        'substitutions' => self.substitutions,
+        'custom_args' => self.custom_args,
+        'dynamic_template_data' => self.dynamic_template_data,
+        'send_at' => self.send_at
+      }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/section.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module SendGrid
+  class Section
+    def initialize(key: nil, value: nil)
+      @section = {}
+      (key.nil? || value.nil?) ? @section = nil : @section[key] = value
+    end
+
+    def section=(section)
+      @section = section
+    end
+
+    def section
+      @section
+    end
+
+    def to_json(*)
+      {
+        'section' => self.section
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/spam_check.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module SendGrid
+  class SpamCheck
+    def initialize(enable: nil, threshold: nil, post_to_url: nil)
+      @enable = enable
+      @threshold = threshold
+      @post_to_url = post_to_url
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def threshold=(threshold)
+      @threshold = threshold
+    end
+
+    def threshold
+      @threshold
+    end
+
+    def post_to_url=(post_to_url)
+      @post_to_url = post_to_url
+    end
+
+    def post_to_url
+      @post_to_url
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable,
+        'threshold' => self.threshold,
+        'post_to_url' => self.post_to_url
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/subscription_tracking.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module SendGrid
+  class SubscriptionTracking
+    def initialize(enable: nil, text: nil, html: nil, substitution_tag: nil)
+      @enable = enable
+      @text = text
+      @html = html
+      @substitution_tag = substitution_tag
+    end
+
+    def enable=(enable)
+      @enable = enable
+    end
+
+    def enable
+      @enable
+    end
+
+    def text=(text)
+      @text = text
+    end
+
+    def text
+      @text
+    end
+
+    def html=(html)
+      @html = html
+    end
+
+    def html
+      @html
+    end
+
+    def substitution_tag=(substitution_tag)
+      @substitution_tag = substitution_tag
+    end
+
+    def substitution_tag
+      @substitution_tag
+    end
+
+    def to_json(*)
+      {
+        'enable' => self.enable,
+        'text' => self.text,
+        'html' => self.html,
+        'substitution_tag' => self.substitution_tag
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/substitution.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module SendGrid
+  class Substitution
+    def initialize(key: nil, value: nil)
+      @substitution = {}
+      (key.nil? || value.nil?) ? @substitution = nil : @substitution[key] = value
+    end
+
+    def substitution=(substitution)
+      @substitution = substitution
+    end
+
+    def substitution
+      @substitution
+    end
+
+    def to_json(*)
+      {
+        'substitution' => self.substitution
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/mail/tracking_settings.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module SendGrid
+  class TrackingSettings
+    def initialize
+      @click_tracking = nil
+      @open_tracking = nil
+      @subscription_tracking = nil
+      @ganalytics = nil
+    end
+
+    def click_tracking=(click_tracking)
+      @click_tracking = click_tracking
+    end
+
+    def click_tracking
+      @click_tracking.nil? ? nil : @click_tracking.to_json
+    end
+
+    def open_tracking=(open_tracking)
+      @open_tracking = open_tracking
+    end
+
+    def open_tracking
+      @open_tracking.nil? ? nil : @open_tracking.to_json
+    end
+
+    def subscription_tracking=(subscription_tracking)
+      @subscription_tracking = subscription_tracking
+    end
+
+    def subscription_tracking
+      @subscription_tracking.nil? ? nil : @subscription_tracking.to_json
+    end
+
+    def ganalytics=(ganalytics)
+      @ganalytics = ganalytics
+    end
+
+    def ganalytics
+      @ganalytics.nil? ? nil : @ganalytics.to_json
+    end
+
+    def to_json(*)
+      {
+        'click_tracking' => self.click_tracking,
+        'open_tracking' => self.open_tracking,
+        'subscription_tracking' => self.subscription_tracking,
+        'ganalytics' => self.ganalytics
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

data/lib/sendgrid/helpers/permissions/scope.rb

@@ -0,0 +1,28 @@
+# This is used for getting scopes
+require 'yaml'
+
+module SendGrid
+  class Scope
+    SCOPES = YAML.load_file(File.dirname(__FILE__) + '/scopes.yml').freeze
+    
+    class << self
+      def admin_permissions
+        SCOPES.values.map(&:values).flatten
+      end
+
+      def read_only_permissions
+        SCOPES.map { |_, v| v[:read] }.flatten
+      end
+
+      SCOPES.each_key do |endpoint|
+        define_method "#{endpoint}_read_only_permissions" do
+          SCOPES[endpoint][:read]
+        end
+
+        define_method "#{endpoint}_full_access_permissions" do
+          SCOPES[endpoint].values.flatten
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/helpers/permissions/scopes.yml

@@ -0,0 +1,309 @@
+---
+:alerts:
+  :create:
+  - alerts.create
+  :delete:
+  - alerts.delete
+  :read:
+  - alerts.read
+  :update:
+  - alerts.update
+:api_keys:
+  :create:
+  - api_keys.create
+  :delete:
+  - api_keys.delete
+  :read:
+  - api_keys.read
+  :update:
+  - api_keys.update
+:asm_groups:
+  :create:
+  - asm.groups.create
+  :delete:
+  - asm.groups.delete
+  :read:
+  - asm.groups.read
+  :update:
+  - asm.groups.update
+:billing:
+  :create:
+  - billing.create
+  :delete:
+  - billing.delete
+  :read:
+  - billing.read
+  :update:
+  - billing.update
+:categories:
+  :create:
+  - categories.create
+  :delete:
+  - categories.delete
+  :read:
+  - categories.read
+  - categories.stats.read
+  - categories.stats.sums.read
+  :update:
+  - categories.update
+:credentials:
+  :create:
+  - credentials.create
+  :delete:
+  - credentials.delete
+  :read:
+  - credentials.read
+  :update:
+  - credentials.update
+:stats:
+  :create: []
+  :delete: []
+  :read:
+  - email_activity.read
+  - stats.read
+  - stats.global.read
+  - browsers.stats.read
+  - devices.stats.read
+  - geo.stats.read
+  - mailbox_providers.stats.read
+  - clients.desktop.stats.read
+  - clients.phone.stats.read
+  - clients.stats.read
+  - clients.tablet.stats.read
+  - clients.webmail.stats.read
+  :update: []
+:ips:
+  :create:
+  - ips.pools.create
+  - ips.pools.ips.create
+  - ips.warmup.create
+  :delete:
+  - ips.pools.delete
+  - ips.pools.ips.delete
+  - ips.warmup.delete
+  :read:
+  - ips.assigned.read
+  - ips.read
+  - ips.pools.read
+  - ips.pools.ips.read
+  - ips.warmup.read
+  :update:
+  - ips.pools.update
+  - ips.pools.ips.update
+  - ips.warmup.update
+:mail_settings:
+  :create: []
+  :delete: []
+  :read:
+  - mail_settings.address_whitelist.read
+  - mail_settings.bcc.read
+  - mail_settings.bounce_purge.read
+  - mail_settings.footer.read
+  - mail_settings.forward_bounce.read
+  - mail_settings.forward_spam.read
+  - mail_settings.plain_content.read
+  - mail_settings.read
+  - mail_settings.spam_check.read
+  - mail_settings.template.read
+  :update:
+  - mail_settings.address_whitelist.update
+  - mail_settings.bcc.update
+  - mail_settings.bounce_purge.update
+  - mail_settings.footer.update
+  - mail_settings.forward_bounce.update
+  - mail_settings.forward_spam.update
+  - mail_settings.plain_content.update
+  - mail_settings.spam_check.update
+  - mail_settings.template.update
+:mail:
+  :create:
+  - mail.send
+  - mail.batch.create
+  :delete:
+  - mail.batch.delete
+  :read:
+  - mail.batch.read
+  :update:
+  - mail.batch.update
+:marketing_campaigns:
+  :create:
+  - marketing_campaigns.create
+  :delete:
+  - marketing_campaigns.delete
+  :read:
+  - marketing_campaigns.read
+  :update:
+  - marketing_campaigns.update
+:partner_settings:
+  :create: []
+  :delete: []
+  :read:
+  - partner_settings.new_relic.read
+  - partner_settings.read
+  - partner_settings.sendwithus.read
+  :update:
+  - partner_settings.new_relic.update
+  - partner_settings.sendwithus.update
+:scheduled_sends:
+  :create:
+  - user.scheduled_sends.create
+  :delete:
+  - user.scheduled_sends.delete
+  :read:
+  - user.scheduled_sends.read
+  :update:
+  - user.scheduled_sends.update
+:subusers:
+  :create:
+  - subusers.create
+  - subusers.credits.create
+  - subusers.credits.remaining.create
+  - subusers.monitor.create
+  :delete:
+  - subusers.delete
+  - subusers.credits.delete
+  - subusers.credits.remaining.delete
+  - subusers.monitor.delete
+  :read:
+  - subusers.read
+  - subusers.credits.read
+  - subusers.stats.read
+  - subusers.credits.remaining.read
+  - subusers.monitor.read
+  - subusers.reputations.read
+  - subusers.stats.monthly.read
+  - subusers.stats.sums.read
+  - subusers.summary.read
+  :update:
+  - subusers.update
+  - subusers.credits.update
+  - subusers.credits.remaining.update
+  - subusers.monitor.update
+:suppression:
+  :create:
+  - suppression.create
+  - suppression.bounces.create
+  - suppression.blocks.create
+  - suppression.invalid_emails.create
+  - suppression.spam_reports.create
+  - suppression.unsubscribes.create
+  :delete:
+  - suppression.delete
+  - suppression.bounces.delete
+  - suppression.blocks.delete
+  - suppression.invalid_emails.delete
+  - suppression.spam_reports.delete
+  - suppression.unsubscribes.delete
+  :read:
+  - suppression.read
+  - suppression.bounces.read
+  - suppression.blocks.read
+  - suppression.invalid_emails.read
+  - suppression.spam_reports.read
+  - suppression.unsubscribes.read
+  :update:
+  - suppression.update
+  - suppression.bounces.update
+  - suppression.blocks.update
+  - suppression.invalid_emails.update
+  - suppression.spam_reports.update
+  - suppression.unsubscribes.update
+:teammates:
+  :create:
+  - teammates.create
+  :delete:
+  - teammates.delete
+  :read:
+  - teammates.read
+  :update:
+  - teammates.update
+:templates:
+  :create:
+  - templates.create
+  - templates.versions.activate.create
+  - templates.versions.create
+  :delete:
+  - templates.delete
+  - templates.versions.activate.delete
+  - templates.versions.delete
+  :read:
+  - templates.read
+  - templates.versions.activate.read
+  - templates.versions.read
+  :update:
+  - templates.update
+  - templates.versions.activate.update
+  - templates.versions.update
+:tracking_settings:
+  :create: []
+  :delete: []
+  :read:
+  - tracking_settings.click.read
+  - tracking_settings.google_analytics.read
+  - tracking_settings.open.read
+  - tracking_settings.read
+  - tracking_settings.subscription.read
+  :update:
+  - tracking_settings.click.update
+  - tracking_settings.google_analytics.update
+  - tracking_settings.open.update
+  - tracking_settings.subscription.update
+:user_settings:
+  :create:
+  - user.email.create
+  - user.multifactor_authentication.create
+  :delete:
+  - user.email.delete
+  - user.multifactor_authentication.delete
+  :read:
+  - user.account.read
+  - user.credits.read
+  - user.email.read
+  - user.multifactor_authentication.read
+  - user.password.read
+  - user.profile.read
+  - user.timezone.read
+  - user.settings.enforced_tls.read
+  - user.username.read
+  :update:
+  - user.email.update
+  - user.multifactor_authentication.update
+  - user.password.update
+  - user.profile.update
+  - user.settings.enforced_tls.update
+  - user.timezone.update
+  - user.username.update
+:webhooks:
+  :create:
+  - user.webhooks.event.test.create
+  - user.webhooks.parse.settings.create
+  :delete:
+  - user.webhooks.parse.settings.delete
+  :read:
+  - user.webhooks.event.settings.read
+  - user.webhooks.event.test.read
+  - user.webhooks.parse.settings.read
+  - user.webhooks.parse.stats.read
+  :update:
+  - user.webhooks.event.settings.update
+  - user.webhooks.event.test.update
+  - user.webhooks.parse.settings.update
+:whitelabel:
+  :create:
+  - whitelabel.create
+  :delete:
+  - whitelabel.delete
+  :read:
+  - whitelabel.read
+  :update:
+  - whitelabel.update
+:access_settings:
+  :create:
+  - access_settings.whitelist.create
+  :delete:
+  - access_settings.whitelist.delete
+  :read:
+  - access_settings.activity.read
+  - access_settings.whitelist.read
+  :update:
+  - access_settings.whitelist.update