HookSniffAPI.Api.RateLimits (HookSniff v0.3.0)

API calls for all endpoints tagged RateLimits.

Summary

Functions

rate_limits_endpoint_id_delete(connection, endpoint_id, opts \\ [])

Delete rate limit for endpoint

rate_limits_endpoint_id_get(connection, endpoint_id, opts \\ [])

Get rate limit for endpoint

rate_limits_endpoint_id_post(connection, endpoint_id, opts \\ [])

Set rate limit for endpoint

rate_limits_get(connection, opts \\ [])

List rate limits

Functions

rate_limits_endpoint_id_delete(connection, endpoint_id, opts \\ [])

@spec rate_limits_endpoint_id_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete rate limit for endpoint

Parameters

connection (HookSniffAPI.Connection): Connection to server
endpoint_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rate_limits_endpoint_id_get(connection, endpoint_id, opts \\ [])

@spec rate_limits_endpoint_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get rate limit for endpoint

Parameters

connection (HookSniffAPI.Connection): Connection to server
endpoint_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rate_limits_endpoint_id_post(connection, endpoint_id, opts \\ [])

@spec rate_limits_endpoint_id_post(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Set rate limit for endpoint

Parameters

connection (HookSniffAPI.Connection): Connection to server
endpoint_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rate_limits_get(connection, opts \\ [])

@spec rate_limits_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

List rate limits

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure