ExNylas.Notetakers (ExNylas v0.11.0)

Copy Markdown View Source

Interface for Notetaker.

Nylas docs

Summary

Functions

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

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

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

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

Cancel a scheduled notetaker.

Cancel a scheduled notetaker.

Create a(n) notetaker.

Create a(n) notetaker.

Find a(n) notetaker.

Find a(n) notetaker.

Get the first notetaker.

Get the first notetaker.

Remove a notetaker from a meeting.

Remove a notetaker from a meeting.

Fetch notetaker(s), optionally provide query params.

Fetch notetaker(s), optionally provide query params.

Get media for a notetaker.

Get media for a notetaker.

Functions

all(conn, opts \\ [])

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

Fetch all notetaker(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.Notetakers.all(conn, opts)

all!(conn, opts \\ [])

@spec all!(ExNylas.Connection.t(), Keyword.t() | map()) :: [struct()]

Fetch all notetaker(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.Notetakers.all!(conn, opts)

build(payload)

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

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

Examples

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

build!(payload)

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

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

Examples

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

cancel(conn, id)

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

Cancel a scheduled notetaker.

Examples

iex> {:ok, response} = ExNylas.Notetakers.cancel(conn, id)

cancel!(conn, id)

Cancel a scheduled notetaker.

Examples

iex> response = ExNylas.Notetakers.cancel!(conn, id)

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

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

Create a(n) notetaker.

Examples

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

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

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

Create a(n) notetaker.

Examples

iex> result = ExNylas.Notetakers.create(conn, body, 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) notetaker.

Examples

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

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

Find a(n) notetaker.

Examples

iex> result = ExNylas.Notetakers.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 notetaker.

Examples

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

first!(conn, params \\ [])

Get the first notetaker.

Examples

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

leave(conn, id)

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

Remove a notetaker from a meeting.

Examples

iex> {:ok, response} = ExNylas.Notetakers.leave(conn, id)

leave!(conn, id)

Remove a notetaker from a meeting.

Examples

iex> response = ExNylas.Notetakers.leave!(conn, id)

list(conn, params \\ [])

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

Fetch notetaker(s), optionally provide query params.

Examples

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

list!(conn, params \\ [])

Fetch notetaker(s), optionally provide query params.

Examples

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

media(conn, id)

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

Get media for a notetaker.

Examples

iex> {:ok, response} = ExNylas.Notetakers.media(conn, id)

media!(conn, id)

Get media for a notetaker.

Examples

iex> response = ExNylas.Notetakers.media!(conn, id)

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) notetaker.

Examples

iex> {:ok, result} = ExNylas.Notetakers.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) notetaker.

Examples

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