Knock.Client (Knock v0.4.5) View Source

Sets up a configurable client that can interface with the Knock API. Expects at least an API key to be provided.

Example usage

# Setup a client instance directly
client = Knock.Client.new(api_key: "sk_test_12345")

Link to this section Summary

Types

t()

Describes a Knock client

Functions

Creates a new client struct with the provided options. The options provided must at least contain an API secret key, which can be obtained in the Knock dashboard.

Link to this section Types

Specs

t() :: %Knock.Client{
  adapter: atom(),
  api_key: String.t(),
  host: String.t(),
  json_client: atom()
}

Describes a Knock client

Link to this section Functions

Specs

new(Keyword.t()) :: t()

Creates a new client struct with the provided options. The options provided must at least contain an API secret key, which can be obtained in the Knock dashboard.