@spec count_sheets(map()) :: integer()

Return the count of sheets, using the same filter as list_sheets

@spec create_sheet(map()) :: {:ok, Glific.Sheets.Sheet.t()} | {:error, any()}

Creates a sheet

examples

Examples

iex> create_sheet(%{field: value})
{:ok, %Sheet{}}

iex> create_sheet(%{field: bad_value})
{:error, %Ecto.Changeset{}}

@spec create_sheet_data(map()) ::
  {:ok, Glific.Sheets.Sheet.t()} | {:error, Ecto.Changeset.t()}

Creates a sheet

examples

Examples

iex> create_sheet_data(%{field: value})
{:ok, %Sheet{}}

iex> create_sheet_data(%{field: bad_value})
{:error, %Ecto.Changeset{}}

@spec delete_sheet(Glific.Sheets.Sheet.t()) ::
  {:ok, Glific.Sheets.Sheet.t()} | {:error, Ecto.Changeset.t()}

Deletes a sheet.

examples

Examples

iex> delete_sheet(sheet)
{:ok, %Sheet{}}

iex> delete_sheet(sheet)
{:error, %Ecto.Changeset{}}

@spec execute(Glific.Flows.Action.t() | any(), Glific.Flows.FlowContext.t()) ::
  {Glific.Flows.FlowContext.t(), Glific.Messages.Message.t()}

Execute a sheet action

@spec get_sheet!(integer()) :: Glific.Sheets.Sheet.t()

Gets a single sheet.

Raises Ecto.NoResultsError if the Sheet does not exist.

examples

Examples

iex> get_sheet!(123)
%Sheet{}

iex> get_sheet!(456)
** (Ecto.NoResultsError)

@spec list_sheets(map()) :: [Glific.Sheets.Sheet.t()]

Returns the list of sheets.

examples

Examples

iex> list_sheets()
[%Sheet{}, ...]

@spec sync_sheet_data(Glific.Sheets.Sheet.t()) ::
  {:ok, Glific.Sheets.Sheet.t()} | {:error, Ecto.Changeset.t()}

Sync a sheet

@spec update_sheet(Glific.Sheets.Sheet.t(), map()) ::
  {:ok, Glific.Sheets.Sheet.t()} | {:error, Ecto.Changeset.t()}

Updates a sheet.

examples

Examples

iex> update_sheet(sheet, %{field: new_value})
{:ok, %Sheet{}}

iex> update_sheet(sheet, %{field: bad_value})
{:error, %Ecto.Changeset{}}

@spec update_sheet_data(Glific.Sheets.SheetData.t(), map()) ::
  {:ok, Glific.Sheets.SheetData.t()} | {:error, Ecto.Changeset.t()}

Updates a sheet data

examples

Examples

iex> update_sheet_data(sheet_data, %{field: new_value})
{:ok, %SheetData{}}

iex> update_sheet_data(sheet_data, %{field: bad_value})
{:error, %Ecto.Changeset{}}