View Source ExNylas.Scheduling.Configurations (ExNylas v0.9.0)

Interface for Nylas scheduling configurations.

Nylas docs

Summary

Functions

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

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

Create a(n) scheduling configuration.

Create a(n) scheduling configuration.

Delete a(n) scheduling configuration.

Delete a(n) scheduling configuration.

Find a(n) scheduling configuration.

Find a(n) scheduling configuration.

Get the first scheduling configuration.

Get the first scheduling configuration.

Fetch scheduling configuration(s), optionally provide query params.

Fetch scheduling configuration(s), optionally provide query params.

Update a(n) scheduling configuration.

Update a(n) scheduling configuration.

Functions

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

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

Examples

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

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

Examples

iex> result = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

iex> {:ok, result} = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

iex> result = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

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

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

View Source

Delete a(n) scheduling configuration.

Examples

iex> result = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

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

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

View Source

Find a(n) scheduling configuration.

Examples

iex> result = ExNylas.Scheduling.Configurations.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 scheduling configuration.

Examples

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

first!(conn, params \\ [])

View Source

Get the first scheduling configuration.

Examples

iex> result = ExNylas.Scheduling.Configurations.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 scheduling configuration(s), optionally provide query params.

Examples

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

list!(conn, params \\ [])

View Source

Fetch scheduling configuration(s), optionally provide query params.

Examples

iex> result = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

iex> {:ok, result} = ExNylas.Scheduling.Configurations.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) scheduling configuration.

Examples

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