Class: ApiBrasil::Services::Platform::IpWhitelistService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/api_brasil/services/platform/ip_whitelist_service.rb

Overview

IP Whitelist da conta (/ip-whitelist/*). Restringe de quais IPs o Bearer Token pode ser usado.

get/set seguem os nomes usados nas demais SDKs; por isso as chamadas internas usam http.* diretamente.

Instance Attribute Summary

Attributes inherited from BaseService

#http

Instance Method Summary collapse

Methods inherited from BaseService

#delete, #download, #initialize, #patch, #post, #put

Constructor Details

This class inherits a constructor from ApiBrasil::Services::BaseService

Instance Method Details

#add(entry, options = {}) ⇒ Object

Adiciona uma entrada: POST /ip-whitelist/add.

Returns:

  • (Object) 


32
33
34
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 32

def add(entry, options = {})
  http.post("/ip-whitelist/add", { "entry" => entry }, options)
end

#add_current(options = {}) ⇒ Object

Adiciona o IP atual: POST /ip-whitelist/add-current.

Returns:

  • (Object) 


46
47
48
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 46

def add_current(options = {})
  http.post("/ip-whitelist/add-current", nil, options)
end

#current_ip(options = {}) ⇒ Object

IP atual visto pelo gateway: GET /ip-whitelist/current-ip.

Returns:

  • (Object) 


67
68
69
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 67

def current_ip(options = {})
  http.get("/ip-whitelist/current-ip", options)
end

#get(options = {}) ⇒ Object

Configuracao atual: GET /ip-whitelist.

Returns:

  • (Object) 


17
18
19
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 17

def get(options = {})
  http.get("/ip-whitelist", options)
end

#remove(entry, options = {}) ⇒ Object

Remove uma entrada: DELETE /ip-whitelist/remove.

Returns:

  • (Object) 


39
40
41
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 39

def remove(entry, options = {})
  http.delete("/ip-whitelist/remove", { "entry" => entry }, options)
end

#reset(options = {}) ⇒ Object

Libera todos os IPs (wildcard): POST /ip-whitelist/reset.

Returns:

  • (Object) 


53
54
55
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 53

def reset(options = {})
  http.post("/ip-whitelist/reset", nil, options)
end

#set(ip_whitelist, options = {}) ⇒ Object

Substitui a lista inteira: PUT /ip-whitelist.

Parameters:

  • ip_whitelist (String, Array<String>)

Returns:

  • (Object) 


25
26
27
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 25

def set(ip_whitelist, options = {})
  http.put("/ip-whitelist", { "ip_whitelist" => ip_whitelist }, options)
end

#validate(entry, options = {}) ⇒ Object

Valida uma entrada: POST /ip-whitelist/validate.

Returns:

  • (Object) 


60
61
62
 
# File 'lib/api_brasil/services/platform/ip_whitelist_service.rb', line 60

def validate(entry, options = {})
  http.post("/ip-whitelist/validate", { "entry" => entry }, options)
end