ExNylas.Channels (ExNylas v0.11.0)

Copy Markdown View Source

Interface for Nylas channels.

Nylas docs

Summary

Functions

build(payload)

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

build!(payload)

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

create(conn, body, params \\ [])

Create a(n) channel.

create!(conn, body, params \\ [])

Create a(n) channel.

delete(conn, id, params \\ [])

Delete a(n) channel.

delete!(conn, id, params \\ [])

Delete a(n) channel.

find(conn, id, params \\ [])

Find a(n) channel.

find!(conn, id, params \\ [])

Find a(n) channel.

first(conn, params \\ [])

Get the first channel.

first!(conn, params \\ [])

Get the first channel.

list(conn, params \\ [])

Fetch channel(s), optionally provide query params.

list!(conn, params \\ [])

Fetch channel(s), optionally provide query params.

update(conn, id, changeset, params \\ [])

Update a(n) channel.

update!(conn, id, changeset, params \\ [])

Update a(n) channel.

Functions

build(payload)

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

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

Examples

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

build!(payload)

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

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

Examples

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

create(conn, body, params \\ [])

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

Create a(n) channel.

Examples

iex> {:ok, result} = ExNylas.Channels.create(conn, body, params)

create!(conn, body, params \\ [])

@spec create!(ExNylas.Connection.t(), map(), Keyword.t() | map()) ::
  ExNylas.Response.t()

Create a(n) channel.

Examples

iex> result = ExNylas.Channels.create(conn, body, params)

delete(conn, id, params \\ [])

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

Delete a(n) channel.

Examples

iex> {:ok, result} = ExNylas.Channels.delete(conn, id, params)

delete!(conn, id, params \\ [])

@spec delete!(ExNylas.Connection.t(), String.t(), Keyword.t() | map()) ::
  ExNylas.Response.t()

Delete a(n) channel.

Examples

iex> result = ExNylas.Channels.delete!(conn, id, params)

find(conn, id, params \\ [])

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

Find a(n) channel.

Examples

iex> {:ok, result} = ExNylas.Channels.find(conn, id, params)

find!(conn, id, params \\ [])

@spec find!(ExNylas.Connection.t(), String.t(), Keyword.t() | map()) ::
  ExNylas.Response.t()

Find a(n) channel.

Examples

iex> result = ExNylas.Channels.find!(conn, id, params)

first(conn, params \\ [])

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

Get the first channel.

Examples

iex> {:ok, result} = ExNylas.Channels.first(conn, params)

first!(conn, params \\ [])

@spec first!(ExNylas.Connection.t(), Keyword.t() | map()) :: ExNylas.Response.t()

Get the first channel.

Examples

iex> result = ExNylas.Channels.first!(conn, params)

list(conn, params \\ [])

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

Fetch channel(s), optionally provide query params.

Examples

iex> {:ok, result} = ExNylas.Channels.list(conn, params)

list!(conn, params \\ [])

@spec list!(ExNylas.Connection.t(), Keyword.t() | map()) :: ExNylas.Response.t()

Fetch channel(s), optionally provide query params.

Examples

iex> result = ExNylas.Channels.list!(conn, params)

update(conn, id, changeset, params \\ [])

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

Update a(n) channel.

Examples

iex> {:ok, result} = ExNylas.Channels.update(conn, id, body, params)

update!(conn, id, changeset, params \\ [])

@spec update!(ExNylas.Connection.t(), String.t(), map(), Keyword.t() | map()) ::
  ExNylas.Response.t()

Update a(n) channel.

Examples

iex> result = ExNylas.Channels.update!(conn, id, body, params)