Packages

knock

0.4.4
0.5.0 0.4.20 0.4.19 0.4.18 0.4.16 0.4.15 0.4.14 0.4.13 0.4.12 0.4.11 0.4.10 0.4.9 0.4.8 0.4.7 0.4.6 0.4.5 0.4.4 0.4.3 0.4.2 0.4.0 0.4.0-rc.1 0.3.1 0.3.0 0.2.1 0.2.0 0.1.3 0.1.2 0.1.1 0.1.0

Official Elixir SDK for interacting with the Knock API.

HexDocs

Current section

Files

Jump to
Readme
29 Versions
3 Dependencies
Dependants
Files
Activity
knock lib knock resources workflows.ex
Raw

lib/knock/resources/workflows.ex 

defmodule Knock.Workflows do

  @moduledoc """

  Functions for interacting with Knock notify resources.

  """

  alias Knock.Api



  @doc """

  Executes a notify call for the workflow with the given key.



  Note: properties must contain at least `recipents` for the call to be valid.

  """

  @spec trigger(Knock.Client.t(), String.t(), map()) :: Api.response()

  def trigger(client, key, properties) do

    Api.post(client, "/workflows/#{key}/trigger", properties)

  end



  @doc """

  Cancels the workflow with the given cancellation key.



  Can optionally be provided with:



  - `recipients`: A list of recipients to cancel the notify for

  """

  @spec cancel(Knock.Client.t(), String.t(), String.t(), map()) :: Api.response()

  def cancel(client, key, cancellation_key, properties \\ %{}) do

    attrs = Map.put(properties, "cancellation_key", cancellation_key)

    Api.post(client, "/workflows/#{key}/cancel", attrs)

  end

end