module SendGrid4r::REST::Sm::Suppressions
SendGrid Web API
v3 Suppression
Management - Suppressions
Constants
- Group
- Groups
- Suppression
Public Class Methods
create_group(resp)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 29 def self.create_group(resp) return resp if resp.nil? Group.new( resp['id'], resp['name'], resp['description'], resp['suppressed'], resp['is_default'] ) end
create_groups(resp)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 21 def self.create_groups(resp) return resp if resp.nil? suppressions = resp['suppressions'].map do |suppression| Sm::Suppressions.create_group(suppression) end Groups.new(suppressions) end
create_suppression(resp)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 50 def self.create_suppression(resp) return resp if resp.nil? created_at = Time.at(resp['created_at']) Suppression.new( resp['email'], resp['group_id'], resp['group_name'], created_at ) end
suppressions_url(email = nil)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 44 def self.suppressions_url(email = nil) url = "#{BASE_URL}/asm/suppressions" url = "#{url}/#{email}" unless email.nil? url end
url(group_id, email_address = nil)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 15 def self.url(group_id, email_address = nil) url = "#{BASE_URL}/asm/groups/#{group_id}/suppressions" url = "#{url}/#{email_address}" unless email_address.nil? url end
Public Instance Methods
delete_suppressed_email(group_id:, email_address:, &block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 95 def delete_suppressed_email(group_id:, email_address:, &block) delete( @auth, Sm::Suppressions.url(group_id, email_address), &block ) end
get_groups_by_email(email_address:, &block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 71 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
get_suppressed_emails(group_id:, &block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 89 def get_suppressed_emails(group_id:, &block) endpoint = Sm::Suppressions.url(group_id) resp = get(@auth, endpoint, &block) finish(resp, @raw_resp) { |r| r } end
get_suppressions(&block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 61 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
post_suppressed_emails(group_id:, recipient_emails:, &block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 79 def post_suppressed_emails(group_id:, recipient_emails:, &block) resp = post( @auth, Sm::Suppressions.url(group_id), recipient_emails: recipient_emails, &block ) finish(resp, @raw_resp) { |r| Sm.create_recipient_emails(r) } end
search_suppressed_emails(group_id:, recipient_emails:, &block)
click to toggle source
# File lib/sendgrid4r/rest/sm/suppressions.rb, line 103 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