View Source ExNylas.MessageSchedules (ExNylas v0.9.0)

Interface for Nylas message schedules.

Nylas docs

Summary

Functions

Fetch all message schedule(s) matching the provided query (the SDK will handle paging).

Fetch all message schedule(s) matching the provided query (the SDK will handle paging).

Delete a(n) message schedule.

Delete a(n) message schedule.

Find a(n) message schedule.

Find a(n) message schedule.

Get the first message schedule.

Get the first message schedule.

Fetch message schedule(s), optionally provide query params.

Fetch message schedule(s), optionally provide query params.

Functions

@spec all(ExNylas.Connection.t(), Keyword.t() | map()) ::
  {:ok, [struct()]} | {:error, ExNylas.Response.t()}

Fetch all message schedule(s) matching the provided query (the SDK will handle paging).

The second argument can be a keyword list of options + query parameters to pass to the Nylas API (map is also supported). Options supports:

  • :send_to - a single arity function to send each page of results (default is nil, e.g. results will be accumulated and returned as a list)
  • :delay - the number of milliseconds to wait between each page request (default is 0; strongly recommended to avoid rate limiting)
  • :query - a keyword list or map of query parameters to pass to the Nylas API (default is an empty list)

Examples

iex> opts = [send_to: &IO.inspect/1, delay: 3_000, query: [key: "value"]]
iex> {:ok, result} = ExNylas.MessageSchedules.all(conn, opts)
@spec all!(ExNylas.Connection.t(), Keyword.t() | map()) :: [struct()]

Fetch all message schedule(s) matching the provided query (the SDK will handle paging).

The second argument can be a keyword list of options + query parameters to pass to the Nylas API (map is also supported). Options supports:

  • :send_to - a single arity function to send each page of results (default is nil, e.g. results will be accumulated and returned as a list)
  • :delay - the number of milliseconds to wait between each page request (default is 0; strongly recommended to avoid rate limiting)
  • :query - a keyword list or map of query parameters to pass to the Nylas API (default is an empty list)

Examples

iex> opts = [send_to: &IO.inspect/1, delay: 3_000, query: [key: "value"]]
iex> result = ExNylas.MessageSchedules.all!(conn, opts)
Link to this function

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

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

Delete a(n) message schedule.

Examples

iex> {:ok, result} = ExNylas.MessageSchedules.delete(conn, id, params)
Link to this function

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

View Source

Delete a(n) message schedule.

Examples

iex> result = ExNylas.MessageSchedules.delete!(conn, id, params)
Link to this function

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

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

Find a(n) message schedule.

Examples

iex> {:ok, result} = ExNylas.MessageSchedules.find(conn, id, params)
Link to this function

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

View Source

Find a(n) message schedule.

Examples

iex> result = ExNylas.MessageSchedules.find!(conn, id, params)
Link to this function

first(conn, params \\ [])

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

Get the first message schedule.

Examples

iex> {:ok, result} = ExNylas.MessageSchedules.first(conn, params)
Link to this function

first!(conn, params \\ [])

View Source

Get the first message schedule.

Examples

iex> result = ExNylas.MessageSchedules.first!(conn, params)
Link to this function

list(conn, params \\ [])

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

Fetch message schedule(s), optionally provide query params.

Examples

iex> {:ok, result} = ExNylas.MessageSchedules.list(conn, params)
Link to this function

list!(conn, params \\ [])

View Source

Fetch message schedule(s), optionally provide query params.

Examples

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