ExNylas.CustomAuthentication (ExNylas v0.11.0)

Copy Markdown View Source

Interface for Nylas custom authentication

Nylas docs

Summary

Functions

Create and validate a custom authentication, use create/update to send to Nylas.

Create and validate a custom authentication, use create/update to send to Nylas.

Connect a grant using custom authentication.

Connect a grant using custom authentication.

Functions

build(payload)

@spec build(map() | struct()) :: {:ok, struct()} | {:error, Ecto.Changeset.t()}

Create and validate a custom authentication, use create/update to send to Nylas.

Examples

iex> {:ok, result} = ExNylas.CustomAuthentication.build(payload)

build!(payload)

@spec build!(map() | struct()) :: struct()

Create and validate a custom authentication, use create/update to send to Nylas.

Examples

iex> result = ExNylas.CustomAuthentication.build!(payload)

connect(conn, body)

@spec connect(ExNylas.Connection.t(), map()) ::
  {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}

Connect a grant using custom authentication.

Examples

iex> {:ok, grant} = ExNylas.CustomAuthentication.connect(conn, body)

connect!(conn, body)

@spec connect!(ExNylas.Connection.t(), map()) :: ExNylas.Response.t()

Connect a grant using custom authentication.

Examples

iex> grant = ExNylas.CustomAuthentication.connect!(conn, body)