IncidentIo.Client (IncidentIo v0.3.0)

Creates a HTTP client for interacting with the Incident.io API.

Summary

auth()

t()

new()

Creates a client with no authentication and the default endpoint.

new(endpoint)

Creates a client with a custom endpoint and no authentication, or with API key authentication and the default endpoint.

Creates a client with API key authentication and a custom endpoint.

@type auth() :: %{api_key: binary()}

@type t() :: %IncidentIo.Client{auth: auth() | nil, endpoint: binary()}

@spec new() :: t()

Creates a client with no authentication and the default endpoint.

IncidentIo.Client.new()

@spec new(binary()) :: t()

@spec new(map()) :: t()

Creates a client with a custom endpoint and no authentication, or with API key authentication and the default endpoint.

The endpoint must be a binary URL. A trailing / is appended automatically if not present.

IncidentIo.Client.new("https://api.example.com/")

IncidentIo.Client.new(%{api_key: "your-api-key"})

@spec new(map(), binary()) :: t()

@spec new(auth(), binary()) :: t()

Creates a client with API key authentication and a custom endpoint.

The endpoint must be a binary URL. A trailing / is appended automatically if not present.

IncidentIo.Client.new(%{api_key: "your-api-key"}, "https://api.example.com/")