Module: SendGrid4r::REST::Sm::Groups

Includes:
Request
Included in:
API
Defined in:
lib/sendgrid4r/rest/sm/groups.rb

Overview

SendGrid Web API v3 Suppression Management - Groups

Defined Under Namespace

Classes: Group

Constant Summary

Constants included from Request

Request::BASE_URL

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Request

#create_args, #delete, #execute, #finish, #get, #patch, #post, #process_array_params, #process_url_params, #put

Class Method Details

.create_group(resp) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 27

def self.create_group(resp)
  return resp if resp.nil?
  Group.new(
    resp['id'],
    resp['name'],
    resp['description'],
    resp['last_email_sent_at'],
    resp['is_default'],
    resp['unsubscribes']
  )
end

.create_groups(resp) ⇒ Object 



22
23
24
25
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 22

def self.create_groups(resp)
  return resp if resp.nil?
  resp.map { |group| Sm::Groups.create_group(group) }
end

.url(group_id = nil) ⇒ Object 



16
17
18
19
20
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 16

def self.url(group_id = nil)
  url = "#{BASE_URL}/asm/groups"
  url = "#{url}/#{group_id}" unless group_id.nil?
  url
end

Instance Method Details

#delete_group(group_id:, &block) ⇒ Object 



62
63
64
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 62

def delete_group(group_id:, &block)
  delete(@auth, Sm::Groups.url(group_id), &block)
end

#get_group(group_id:, &block) ⇒ Object 



51
52
53
54
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 51

def get_group(group_id:, &block)
  resp = get(@auth, Sm::Groups.url(group_id), &block)
  finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
end

#get_groups(&block) ⇒ Object 



46
47
48
49
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 46

def get_groups(&block)
  resp = get(@auth, Sm::Groups.url, &block)
  finish(resp, @raw_resp) { |r| Sm::Groups.create_groups(r) }
end

#patch_group(group_id:, group:, &block) ⇒ Object 



56
57
58
59
60
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 56

def patch_group(group_id:, group:, &block)
  endpoint = Sm::Groups.url(group_id)
  resp = patch(@auth, endpoint, group.to_h, &block)
  finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
end

#post_group(name:, description:, is_default: nil, &block) ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/sendgrid4r/rest/sm/groups.rb', line 39

def post_group(name:, description:, is_default: nil, &block)
  params = { name: name, description: description }
  params[:is_default] = is_default unless is_default.nil?
  resp = post(@auth, Sm::Groups.url, params, &block)
  finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
end