View Source WorkOS.Client behaviour (WorkOS SDK for Elixir v1.0.0)

WorkOS API client.

Summary

response(type)

t()

request(t, t)

new(config)

Creates a new WorkOS client struct given a keyword list of config opts.

@type response(type) :: {:ok, type} | {:error, WorkOS.Error.t() | :client_error}

@type t() :: %WorkOS.Client{
  api_key: String.t(),
  base_url: String.t() | nil,
  client: module() | nil,
  client_id: String.t()
}

@callback request(t(), Keyword.t()) ::
  {:ok, %{body: map(), status: pos_integer()}} | {:error, any()}

@spec delete(t(), WorkOS.Castable.impl(), String.t(), map(), Keyword.t()) ::
  response(any())

@spec get(t(), WorkOS.Castable.impl(), String.t(), Keyword.t()) :: response(any())

@spec new(WorkOS.config()) :: t()

Creates a new WorkOS client struct given a keyword list of config opts.

@spec post(t(), WorkOS.Castable.impl(), String.t(), map(), Keyword.t()) ::
  response(any())

@spec put(t(), WorkOS.Castable.impl(), String.t(), map(), Keyword.t()) ::
  response(any())