ExNylas.ApplicationRedirects (ExNylas v0.11.0)

Copy Markdown View Source

Interface for Nylas application redirects.

Nylas docs

Summary

Functions

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

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

Create a(n) application redirect.

Create a(n) application redirect.

Delete a(n) application redirect.

Delete a(n) application redirect.

Find a(n) application redirect.

Find a(n) application redirect.

Fetch application redirect(s), optionally provide query params.

Fetch application redirect(s), optionally provide query params.

Update a(n) application redirect.

Update a(n) application redirect.

Functions

build(payload)

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

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

Examples

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

build!(payload)

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

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

Examples

iex> result = ExNylas.ApplicationRedirects.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) application redirect.

Examples

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

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

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

Create a(n) application redirect.

Examples

iex> result = ExNylas.ApplicationRedirects.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) application redirect.

Examples

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

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

Delete a(n) application redirect.

Examples

iex> result = ExNylas.ApplicationRedirects.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) application redirect.

Examples

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

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

Find a(n) application redirect.

Examples

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

list(conn, params \\ [])

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

Fetch application redirect(s), optionally provide query params.

Examples

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

list!(conn, params \\ [])

Fetch application redirect(s), optionally provide query params.

Examples

iex> result = ExNylas.ApplicationRedirects.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) application redirect.

Examples

iex> {:ok, result} = ExNylas.ApplicationRedirects.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) application redirect.

Examples

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