View Source ExNylas.Contacts (ExNylas v0.9.0)

A module for interacting with the Nylas Contacts API.

Nylas docs

Summary

Functions

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

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

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

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

Create a(n) contact.

Create a(n) contact.

Delete a(n) contact.

Delete a(n) contact.

Find a(n) contact.

Find a(n) contact.

Get the first contact.

Get the first contact.

Fetch contact(s), optionally provide query params.

Fetch contact(s), optionally provide query params.

Functions

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

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

Fetch all contact(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.Contacts.all!(conn, opts)
@spec build(map() | struct()) :: {:ok, struct()} | {:error, Ecto.Changeset.t()}

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

Examples

iex> {:ok, result} = ExNylas.Contacts.build(payload)
@spec build!(map() | struct()) :: struct()

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

Examples

iex> result = ExNylas.Contacts.build!(payload)
Link to this function

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

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

Create a(n) contact.

Examples

iex> {:ok, result} = ExNylas.Contacts.create(conn, body, params)
Link to this function

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

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

Create a(n) contact.

Examples

iex> result = ExNylas.Contacts.create(conn, body, params)
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) contact.

Examples

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

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

View Source

Delete a(n) contact.

Examples

iex> result = ExNylas.Contacts.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) contact.

Examples

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

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

View Source

Find a(n) contact.

Examples

iex> result = ExNylas.Contacts.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 contact.

Examples

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

first!(conn, params \\ [])

View Source

Get the first contact.

Examples

iex> result = ExNylas.Contacts.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 contact(s), optionally provide query params.

Examples

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

list!(conn, params \\ [])

View Source

Fetch contact(s), optionally provide query params.

Examples

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

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

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

Update a(n) contact.

Examples

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

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

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

Update a(n) contact.

Examples

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