HookSniffAPI.Api.Search (hooksniff v1.0.0)

API calls for all endpoints tagged Search.

Summary

Functions

search_get(connection, q, opts \\ [])

@spec search_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.SearchResult.t()} | {:error, Tesla.Env.t()}

Search deliveries

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • q (String.t):
  • opts (keyword): Optional parameters
    • :status (String.t):
    • :endpoint_id (String.t):
    • :page (integer()):
    • :per_page (integer()):

Returns

  • {:ok, HookSniffAPI.Model.SearchResult.t} on success
  • {:error, Tesla.Env.t} on failure