HookSniffAPI.Connection (hooksniff v1.0.0)

Handle Tesla connections for HookSniffAPI.

Additional middleware can be set in the compile-time or runtime configuration:

config :tesla, HookSniffAPI.Connection,
  base_url: "https://hooksniff-api-1046140057667.europe-west1.run.app/v1",
  adapter: Tesla.Adapter.Hackney

The default base URL can also be set as:

config :hooksniff,
  :base_url, "https://hooksniff-api-1046140057667.europe-west1.run.app/v1"

Summary

Types

options()

The list of options that can be passed to new/1.

Functions

adapter()

Returns the default adapter for this API.

middleware(options \\ [])

Returns fully configured middleware for passing to Tesla.client/2.

new(options \\ [])

Configure a HookSniffAPI client.

request(client, options)

Forward requests to Tesla.

Types

options()

@type options() :: [
  base_url: String.t(),
  user_agent: String.t(),
  bearer_token: String.t() | nil
]

The list of options that can be passed to new/1.

  • base_url: Overrides the base URL on a per-client basis.
  • user_agent: Overrides the User-Agent header.
  • bearer_token: A bearer token for bearer authentication.

Functions

adapter()

Returns the default adapter for this API.

middleware(options \\ [])

@spec middleware(options()) :: [Tesla.Client.middleware()]

Returns fully configured middleware for passing to Tesla.client/2.

new(options \\ [])

@spec new(options()) :: Tesla.Env.client()

Configure a HookSniffAPI client.

Parameters

  • options: an optional keyword list of HookSniffAPI.Connection.options.

Returns

Tesla.Env.client

request(client, options)

@spec request(Tesla.Client.t(), [Tesla.option()]) :: Tesla.Env.result()

Forward requests to Tesla.