IP Whitelist da conta (/ip-whitelist/*).
Restringe de quais IPs o Bearer Token pode ser usado.
alias ApiBrasil.Platform.IpWhitelist
{:ok, _} = IpWhitelist.set(client, ["200.0.0.1", "10.0.0.0/8"])
{:ok, _} = IpWhitelist.add_current(client)Summary
Functions
Adiciona uma entrada: POST /ip-whitelist/add.
Como add/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Adiciona o IP atual: POST /ip-whitelist/add-current.
Como add_current/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
IP atual visto pelo gateway: GET /ip-whitelist/current-ip.
Como current_ip/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Configuração atual: GET /ip-whitelist.
Como get/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Remove uma entrada: DELETE /ip-whitelist/remove.
Como remove/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Libera todos os IPs (wildcard): POST /ip-whitelist/reset.
Como reset/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Substitui a lista inteira: PUT /ip-whitelist.
Como set/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Valida uma entrada: POST /ip-whitelist/validate.
Como validate/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec add(ApiBrasil.Client.t(), String.t(), keyword()) :: result()
Adiciona uma entrada: POST /ip-whitelist/add.
@spec add!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()
Como add/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec add_current( ApiBrasil.Client.t(), keyword() ) :: result()
Adiciona o IP atual: POST /ip-whitelist/add-current.
@spec add_current!( ApiBrasil.Client.t(), keyword() ) :: map()
Como add_current/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec current_ip( ApiBrasil.Client.t(), keyword() ) :: result()
IP atual visto pelo gateway: GET /ip-whitelist/current-ip.
@spec current_ip!( ApiBrasil.Client.t(), keyword() ) :: map()
Como current_ip/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec get( ApiBrasil.Client.t(), keyword() ) :: result()
Configuração atual: GET /ip-whitelist.
@spec get!( ApiBrasil.Client.t(), keyword() ) :: map()
Como get/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec remove(ApiBrasil.Client.t(), String.t(), keyword()) :: result()
Remove uma entrada: DELETE /ip-whitelist/remove.
@spec remove!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()
Como remove/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec reset( ApiBrasil.Client.t(), keyword() ) :: result()
Libera todos os IPs (wildcard): POST /ip-whitelist/reset.
@spec reset!( ApiBrasil.Client.t(), keyword() ) :: map()
Como reset/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec set(ApiBrasil.Client.t(), [String.t()], keyword()) :: result()
Substitui a lista inteira: PUT /ip-whitelist.
entries é a lista completa de IPs/faixas (envia ip_whitelist no body).
@spec set!(ApiBrasil.Client.t(), [String.t()], keyword()) :: map()
Como set/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec validate(ApiBrasil.Client.t(), String.t(), keyword()) :: result()
Valida uma entrada: POST /ip-whitelist/validate.
@spec validate!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()
Como validate/3, mas levanta ApiBrasil.Core.Error em caso de falha.