HookSniffAPI.Api.Templates (HookSniff v0.3.0)

API calls for all endpoints tagged Templates.

Summary

Functions

templates_get(connection, opts \\ [])

List available templates

templates_id_apply_post(connection, id, apply_template_request, opts \\ [])

Apply template to an endpoint

templates_id_get(connection, id, opts \\ [])

Get template by ID

Functions

templates_get(connection, opts \\ [])

@spec templates_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [HookSniffAPI.Model.WebhookTemplate.t()]} | {:error, Tesla.Env.t()}

List available templates

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :category (String.t):

Returns

{:ok, [%WebhookTemplate{}, ...]} on success
{:error, Tesla.Env.t} on failure

templates_id_apply_post(connection, id, apply_template_request, opts \\ [])

@spec templates_id_apply_post(
  Tesla.Env.client(),
  String.t(),
  HookSniffAPI.Model.ApplyTemplateRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.ApplyTemplateResponse.t()} | {:error, Tesla.Env.t()}

Apply template to an endpoint

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
apply_template_request (ApplyTemplateRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.ApplyTemplateResponse.t} on success
{:error, Tesla.Env.t} on failure

templates_id_get(connection, id, opts \\ [])

@spec templates_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.WebhookTemplate.t()} | {:error, Tesla.Env.t()}

Get template by ID

Parameters

connection (HookSniffAPI.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.WebhookTemplate.t} on success
{:error, Tesla.Env.t} on failure