HookSniff.ApiKeys (hooksniff v1.0.0)

API key management — list, create, delete.

Summary

Functions

Create a new API key

Delete an API key

List API keys (paginated). Accepts :limit and :offset opts.

List all API keys (auto-paginate). Accepts :limit and :max_pages opts.

Functions

create(client, params)

@spec create(HookSniff.t(), map()) :: {:ok, map()} | {:error, term()}

Create a new API key

delete(client, id)

@spec delete(HookSniff.t(), String.t()) :: {:ok, map()} | {:error, term()}

Delete an API key

list(client, opts \\ [])

@spec list(
  HookSniff.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

List API keys (paginated). Accepts :limit and :offset opts.

list_all(client, opts \\ [])

@spec list_all(
  HookSniff.t(),
  keyword()
) :: {:ok, list()} | {:error, term()}

List all API keys (auto-paginate). Accepts :limit and :max_pages opts.