View Source ExNylas.StandaloneNotetakers (ExNylas v0.9.0)
Interface for Standalone Notetakers (Notetakers not associated with a grant).
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.
Update a(n) notetaker.
Update a(n) notetaker.
Functions
@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.StandaloneNotetakers.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.StandaloneNotetakers.all!(conn, opts)
@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.StandaloneNotetakers.build(payload)
Create and validate a notetaker, use create/update to send to Nylas.
Examples
iex> result = ExNylas.StandaloneNotetakers.build!(payload)
@spec cancel(ExNylas.Connection.t(), String.t()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Cancel a scheduled notetaker.
Examples
iex> {:ok, response} = ExNylas.StandaloneNotetakers.cancel(conn, id)
@spec cancel!(ExNylas.Connection.t(), String.t()) :: ExNylas.Response.t()
Cancel a scheduled notetaker.
Examples
iex> response = ExNylas.StandaloneNotetakers.cancel!(conn, id)
@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.StandaloneNotetakers.create(conn, body, params)
@spec create!(ExNylas.Connection.t(), map(), Keyword.t() | map()) :: ExNylas.Response.t()
Create a(n) notetaker.
Examples
iex> result = ExNylas.StandaloneNotetakers.create(conn, body, 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.StandaloneNotetakers.find(conn, id, params)
@spec find!(ExNylas.Connection.t(), String.t(), Keyword.t() | map()) :: ExNylas.Response.t()
Find a(n) notetaker.
Examples
iex> result = ExNylas.StandaloneNotetakers.find!(conn, id, 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.StandaloneNotetakers.first(conn, params)
@spec first!(ExNylas.Connection.t(), Keyword.t() | map()) :: ExNylas.Response.t()
Get the first notetaker.
Examples
iex> result = ExNylas.StandaloneNotetakers.first!(conn, params)
@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.StandaloneNotetakers.leave(conn, id)
@spec leave!(ExNylas.Connection.t(), String.t()) :: ExNylas.Response.t()
Remove a notetaker from a meeting.
Examples
iex> response = ExNylas.StandaloneNotetakers.leave!(conn, id)
@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.StandaloneNotetakers.list(conn, params)
@spec list!(ExNylas.Connection.t(), Keyword.t() | map()) :: ExNylas.Response.t()
Fetch notetaker(s), optionally provide query params.
Examples
iex> result = ExNylas.StandaloneNotetakers.list!(conn, params)
@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.StandaloneNotetakers.media(conn, id)
@spec media!(ExNylas.Connection.t(), String.t()) :: ExNylas.Response.t()
Get media for a notetaker.
Examples
iex> response = ExNylas.StandaloneNotetakers.media!(conn, id)
@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.StandaloneNotetakers.update(conn, id, body, params)
@spec update!(ExNylas.Connection.t(), String.t(), map(), Keyword.t() | map()) :: ExNylas.Response.t()
Update a(n) notetaker.
Examples
iex> result = ExNylas.StandaloneNotetakers.update!(conn, id, body, params)