module SendGrid4r::REST::IpAccessManagement

SendGrid Web API v3 IpAccessManagement

Constants

IpActivities
IpActivity
WhitelistedIp
WhitelistedIpResult
WhitelistedIps

Public Class Methods

create_ip_activities(resp) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 31
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 39
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 61
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 68
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 53
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() click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 21
def self.url_activity
  "#{BASE_URL}/access_settings/activity"
end
url_whitelist(rule_id = nil) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 25
def self.url_whitelist(rule_id = nil)
  url = "#{BASE_URL}/access_settings/whitelist"
  url = "#{url}/#{rule_id}" unless rule_id.nil?
  url
end

Public Instance Methods

delete_whitelisted_ip(rule_id:, &block) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 112
def delete_whitelisted_ip(rule_id:, &block)
  delete(@auth, IpAccessManagement.url_whitelist(rule_id), nil, &block)
end
delete_whitelisted_ips(ids:, &block) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 100
def delete_whitelisted_ips(ids:, &block)
  payload = { ids: ids }
  delete(@auth, IpAccessManagement.url_whitelist, nil, payload, &block)
end
get_ip_activities(limit: nil, &block) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 75
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 105
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 84
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) click to toggle source
# File lib/sendgrid4r/rest/ip_access_management.rb, line 91
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