ApiBrasil.Platform.BearerRateLimit (APIBrasil v0.0.1)

Copy Markdown View Source

Rate limit por Bearer Token (/bearer-rate-limit).

alias ApiBrasil.Platform.BearerRateLimit

{:ok, limite} = BearerRateLimit.get(client)
{:ok, _} = BearerRateLimit.set(client, %{"limit" => 120})

Summary

Functions

Limite atual: GET /bearer-rate-limit.

Como get/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Define o limite por minuto: PUT /bearer-rate-limit.

Como set/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Types

result()

@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}

Functions

get(client, opts \\ [])

@spec get(
  ApiBrasil.Client.t(),
  keyword()
) :: result()

Limite atual: GET /bearer-rate-limit.

get!(client, opts \\ [])

@spec get!(
  ApiBrasil.Client.t(),
  keyword()
) :: map()

Como get/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

set(client, body \\ nil, opts \\ [])

@spec set(ApiBrasil.Client.t(), term(), keyword()) :: result()

Define o limite por minuto: PUT /bearer-rate-limit.

set!(client, body \\ nil, opts \\ [])

@spec set!(ApiBrasil.Client.t(), term(), keyword()) :: map()

Como set/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.