View Source ExNylas.ContactGroups (ExNylas v0.9.0)

A module for interacting with the Nylas Contacts API.

Nylas docs

Summary

Functions

Fetch all contact group(s) matching the provided query (the SDK will handle paging).

Fetch all contact group(s) matching the provided query (the SDK will handle paging).

Fetch contact group(s), optionally provide query params.

Fetch contact group(s), optionally provide query params.

Functions

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

Fetch all contact group(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.ContactGroups.all(conn, opts)
@spec all!(ExNylas.Connection.t(), Keyword.t() | map()) :: [struct()]

Fetch all contact group(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.ContactGroups.all!(conn, opts)
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 contact group(s), optionally provide query params.

Examples

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

list!(conn, params \\ [])

View Source

Fetch contact group(s), optionally provide query params.

Examples

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