@spec bulk_apply_templates(non_neg_integer(), String.t()) ::
  {:ok, any()} | {:error, any()}

Bulk applying templates from CSV

@spec change_session_template(Glific.Templates.SessionTemplate.t(), map()) ::
  Ecto.Changeset.t()

Returns an %Ecto.Changeset{} for tracking session_template changes.

examples

Examples

iex> change_session_template(session_template)
%Ecto.Changeset{data: %SessionTemplate{}}

@spec count_session_templates(map()) :: integer()

Return the count of session_templates, using the same filter as list_session_templates

@spec create_session_template(map()) ::
  {:ok, Glific.Templates.SessionTemplate.t()} | {:error, Ecto.Changeset.t()}

Creates a session_template.

examples

Examples

iex> create_session_template(%{field: value})
{:ok, %SessionTemplate{}}

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

@spec create_template_from_message(%{message_id: integer(), input: map()}) ::
  {:ok, Glific.Templates.SessionTemplate.t()} | {:error, String.t()}

Create a session template form message Body and type will be the message attributes

@spec delete(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.result()

Perform a DELETE request.

See request/1 or request/2 for options definition.

delete("/users")
delete("/users", query: [scope: "admin"])
delete(client, "/users")
delete(client, "/users", query: [scope: "admin"])
delete(client, "/users", body: %{name: "Jon"})

@spec delete!(Tesla.Env.client(), Tesla.Env.url(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a DELETE request.

See request!/1 or request!/2 for options definition.

delete!("/users")
delete!("/users", query: [scope: "admin"])
delete!(client, "/users")
delete!(client, "/users", query: [scope: "admin"])
delete!(client, "/users", body: %{name: "Jon"})

@spec delete_session_template(Glific.Templates.SessionTemplate.t()) ::
  {:ok, Glific.Templates.SessionTemplate.t()} | {:error, Ecto.Changeset.t()}

Deletes a session_template.

examples

Examples

iex> delete_session_template(session_template)
{:ok, %SessionTemplate{}}

iex> delete_session_template(session_template)
{:error, %Ecto.Changeset{}}

@spec get(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.result()

Perform a GET request.

See request/1 or request/2 for options definition.

get("/users")
get("/users", query: [scope: "admin"])
get(client, "/users")
get(client, "/users", query: [scope: "admin"])
get(client, "/users", body: %{name: "Jon"})

@spec get!(Tesla.Env.client(), Tesla.Env.url(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a GET request.

See request!/1 or request!/2 for options definition.

get!("/users")
get!("/users", query: [scope: "admin"])
get!(client, "/users")
get!(client, "/users", query: [scope: "admin"])
get!(client, "/users", body: %{name: "Jon"})

@spec get_session_template!(integer()) :: Glific.Templates.SessionTemplate.t()

Gets a single session_template.

Raises Ecto.NoResultsError if the SessionTemplate does not exist.

examples

Examples

iex> get_session_template!(123)
%SessionTemplate{}

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

@spec head(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.result()

Perform a HEAD request.

See request/1 or request/2 for options definition.

head("/users")
head("/users", query: [scope: "admin"])
head(client, "/users")
head(client, "/users", query: [scope: "admin"])
head(client, "/users", body: %{name: "Jon"})

@spec head!(Tesla.Env.client(), Tesla.Env.url(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a HEAD request.

See request!/1 or request!/2 for options definition.

head!("/users")
head!("/users", query: [scope: "admin"])
head!(client, "/users")
head!(client, "/users", query: [scope: "admin"])
head!(client, "/users", body: %{name: "Jon"})

@spec import_templates(non_neg_integer(), String.t()) ::
  {:ok, any()} | {:error, any()}

Imports pre approved templates from bsp

@spec list_session_templates(map()) :: [Glific.Templates.SessionTemplate.t()]

Returns the list of session_templates.

examples

Examples

iex> list_session_templates()
[%SessionTemplate{}, ...]

@spec options(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.result()

Perform a OPTIONS request.

See request/1 or request/2 for options definition.

options("/users")
options("/users", query: [scope: "admin"])
options(client, "/users")
options(client, "/users", query: [scope: "admin"])
options(client, "/users", body: %{name: "Jon"})

@spec options!(Tesla.Env.client(), Tesla.Env.url(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a OPTIONS request.

See request!/1 or request!/2 for options definition.

options!("/users")
options!("/users", query: [scope: "admin"])
options!(client, "/users")
options!(client, "/users", query: [scope: "admin"])
options!(client, "/users", body: %{name: "Jon"})

@spec patch(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.result()

Perform a PATCH request.

See request/1 or request/2 for options definition.

patch("/users", %{name: "Jon"})
patch("/users", %{name: "Jon"}, query: [scope: "admin"])
patch(client, "/users", %{name: "Jon"})
patch(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec patch!(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a PATCH request.

See request!/1 or request!/2 for options definition.

patch!("/users", %{name: "Jon"})
patch!("/users", %{name: "Jon"}, query: [scope: "admin"])
patch!(client, "/users", %{name: "Jon"})
patch!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec post(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.result()

Perform a POST request.

See request/1 or request/2 for options definition.

post("/users", %{name: "Jon"})
post("/users", %{name: "Jon"}, query: [scope: "admin"])
post(client, "/users", %{name: "Jon"})
post(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec post!(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a POST request.

See request!/1 or request!/2 for options definition.

post!("/users", %{name: "Jon"})
post!("/users", %{name: "Jon"}, query: [scope: "admin"])
post!(client, "/users", %{name: "Jon"})
post!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec put(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.result()

Perform a PUT request.

See request/1 or request/2 for options definition.

put("/users", %{name: "Jon"})
put("/users", %{name: "Jon"}, query: [scope: "admin"])
put(client, "/users", %{name: "Jon"})
put(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec put!(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a PUT request.

See request!/1 or request!/2 for options definition.

put!("/users", %{name: "Jon"})
put!("/users", %{name: "Jon"}, query: [scope: "admin"])
put!(client, "/users", %{name: "Jon"})
put!(client, "/users", %{name: "Jon"}, query: [scope: "admin"])

@spec request(Tesla.Env.client(), [option()]) :: Tesla.Env.result()

Perform a request.

options

Options

• :method - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]
• :url - either full url e.g. "http://example.com/some/path" or just "/some/path" if using Tesla.Middleware.BaseUrl
• :query - a keyword list of query params, e.g. [page: 1, per_page: 100]
• :headers - a keyworld list of headers, e.g. [{"content-type", "text/plain"}]
• :body - depends on used middleware:
  • by default it can be a binary
  • if using e.g. JSON encoding middleware it can be a nested map
  • if adapter supports it it can be a Stream with any of the above
• :opts - custom, per-request middleware or adapter options

examples

Examples

ExampleApi.request(method: :get, url: "/users/path")

# use shortcut methods
ExampleApi.get("/users/1")
ExampleApi.post(client, "/users", %{name: "Jon"})

@spec request!(Tesla.Env.client(), [option()]) :: Tesla.Env.t() | no_return()

Perform request and raise in case of error.

This is similar to request/2 behaviour from Tesla 0.x

See request/2 for list of available options.

@spec sync_hsms_from_bsp(non_neg_integer()) :: :ok | {:error, String.t()}

get and update list of hsm of an organization

@spec template_parameters_count(map()) :: non_neg_integer()

Returns the count of variables in template

@spec trace(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.result()

Perform a TRACE request.

See request/1 or request/2 for options definition.

trace("/users")
trace("/users", query: [scope: "admin"])
trace(client, "/users")
trace(client, "/users", query: [scope: "admin"])
trace(client, "/users", body: %{name: "Jon"})

@spec trace!(Tesla.Env.client(), Tesla.Env.url(), [option()]) ::
  Tesla.Env.t() | no_return()

Perform a TRACE request.

See request!/1 or request!/2 for options definition.

trace!("/users")
trace!("/users", query: [scope: "admin"])
trace!(client, "/users")
trace!(client, "/users", query: [scope: "admin"])
trace!(client, "/users", body: %{name: "Jon"})

@spec update_session_template(Glific.Templates.SessionTemplate.t(), map()) ::
  {:ok, Glific.Templates.SessionTemplate.t()} | {:error, Ecto.Changeset.t()}

Updates a session_template.

examples

Examples

iex> update_session_template(session_template, %{field: new_value})
{:ok, %SessionTemplate{}}

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