Module: SendGrid4r::REST::IpAccessManagement

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

Overview

SendGrid Web API v3 IpAccessManagement

Defined Under Namespace

Classes: IpActivities, IpActivity, WhitelistedIp, WhitelistedIpResult, WhitelistedIps

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_ip_activities(resp) ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 32

def self.create_ip_activities(resp)
  return resp if resp.nil?
  result = resp['result'].map do |activity|
    IpAccessManagement.create_ip_activity(activity)
  end
  IpActivities.new(result)
end

.create_ip_activity(resp) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 40

def self.create_ip_activity(resp)
  return resp if resp.nil?
  first_at = Time.at(resp['first_at']) unless resp['first_at'].nil?
  last_at = Time.at(resp['last_at']) unless resp['last_at'].nil?
  IpActivity.new(
    resp['allowed'],
    resp['auth_method'],
    first_at,
    resp['ip'],
    last_at,
    resp['location']
  )
end

.create_whitelisted_ip(resp) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 62

def self.create_whitelisted_ip(resp)
  return resp if resp.nil?
  WhitelistedIp.new(
    IpAccessManagement.create_whitelisted_ip_result(resp['result'])
  )
end

.create_whitelisted_ip_result(resp) ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 69

def self.create_whitelisted_ip_result(resp)
  return resp if resp.nil?
  created_at = Time.at(resp['created_at']) unless resp['created_at'].nil?
  updated_at = Time.at(resp['updated_at']) unless resp['updated_at'].nil?
  WhitelistedIpResult.new(resp['id'], resp['ip'], created_at, updated_at)
end

.create_whitelisted_ips(resp) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 54

def self.create_whitelisted_ips(resp)
  return resp if resp.nil?
  result = resp['result'].map do |whitelisted_ip|
    IpAccessManagement.create_whitelisted_ip_result(whitelisted_ip)
  end
  WhitelistedIps.new(result)
end

.url_activity ⇒ Object 



22
23
24
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 22

def self.url_activity
  "#{BASE_URL}/access_settings/activity"
end

.url_whitelist(rule_id = nil) ⇒ Object 



26
27
28
29
30
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 26

def self.url_whitelist(rule_id = nil)
  url = "#{BASE_URL}/access_settings/whitelist"
  url = "#{url}/#{rule_id}" unless rule_id.nil?
  url
end

Instance Method Details

#delete_whitelisted_ip(rule_id:, &block) ⇒ Object 



113
114
115
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 113

def delete_whitelisted_ip(rule_id:, &block)
  delete(@auth, IpAccessManagement.url_whitelist(rule_id), nil, &block)
end

#delete_whitelisted_ips(ids:, &block) ⇒ Object 



101
102
103
104
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 101

def delete_whitelisted_ips(ids:, &block)
  payload = { ids: ids }
  delete(@auth, IpAccessManagement.url_whitelist, nil, payload, &block)
end

#get_ip_activities(limit: nil, &block) ⇒ Object 



76
77
78
79
80
81
82
83
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 76

def get_ip_activities(limit: nil, &block)
  params = {}
  params[:limit] = limit unless limit.nil?
  resp = get(@auth, IpAccessManagement.url_activity, params, &block)
  finish(resp, @raw_resp) do |r|
    IpAccessManagement.create_ip_activities(r)
  end
end

#get_whitelisted_ip(rule_id:, &block) ⇒ Object 



106
107
108
109
110
111
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 106

def get_whitelisted_ip(rule_id:, &block)
  resp = get(@auth, IpAccessManagement.url_whitelist(rule_id), nil, &block)
  finish(resp, @raw_resp) do |r|
    IpAccessManagement.create_whitelisted_ip(r)
  end
end

#get_whitelisted_ips(&block) ⇒ Object 



85
86
87
88
89
90
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 85

def get_whitelisted_ips(&block)
  resp = get(@auth, IpAccessManagement.url_whitelist, &block)
  finish(resp, @raw_resp) do |r|
    IpAccessManagement.create_whitelisted_ips(r)
  end
end

#post_whitelisted_ips(ips:, &block) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/sendgrid4r/rest/ip_access_management.rb', line 92

def post_whitelisted_ips(ips:, &block)
  ips_param = ips.map { |ip| { ip: ip } }
  params = { ips: ips_param }
  resp = post(@auth, IpAccessManagement.url_whitelist, params, &block)
  finish(resp, @raw_resp) do |r|
    IpAccessManagement.create_whitelisted_ips(r)
  end
end