Outkit (Outkit v0.0.5) View Source

Interface to Outkit's API.

Configuration

A configuration key is expected with a set of working Outkit API credentials.

config :outkit,
  key: "outkit_api_key",
  secret: "outkit_api_secret",
  passphrase: "outkit_api_passphrase"

Usage

This library is primarily used to render and/or send messages. Refer to Outkit.Message for full documentation and usage.

Link to this section Summary

Functions

client_from_config()

Assembles configuration data and creates a new Outkit.Client. This is used throughout the client library for functions that do not take an Outkit.Client as the first argument.

format_response(client, result, module)

to_struct(kind, attrs)

Link to this section Functions

client_from_config()

Assembles configuration data and creates a new Outkit.Client. This is used throughout the client library for functions that do not take an Outkit.Client as the first argument.

Examples

client = client_from_config()

format_response(client, result, module)