Gemini.Auth.Strategy behaviour (GeminiEx v0.2.0)

View Source

Behavior for authentication strategies.

Summary

Callbacks

base_url(credentials)
build_path(model, endpoint, credentials)
headers(credentials)
refresh_credentials(credentials)

Callbacks

base_url(credentials)

@callback base_url(credentials :: map()) :: String.t()

build_path(model, endpoint, credentials)

@callback build_path(model :: String.t(), endpoint :: String.t(), credentials :: map()) ::
  String.t()

headers(credentials)

@callback headers(credentials :: map()) :: [{String.t(), String.t()}]

refresh_credentials(credentials)

@callback refresh_credentials(credentials :: map()) :: {:ok, map()} | {:error, term()}