SMSFactor.Webhooks (SMSFactor v0.5.0)

View Source

Wrappers around Webhooks section of SMSFactor API.

Summary

Types

Webhook Type can be any of the following

Types

webhook_params()

@type webhook_params() :: %{webhook: %{type: webhook_type(), url: String.t()}}

webhook_type()

@type webhook_type() :: String.t()

Webhook Type can be any of the following :

  • "MO"
  • "DLR"
  • "STOP"
  • "CLICKER"
  • "BALANCE_ALERT"

Functions

create_webhook(client, params)

@spec create_webhook(Tesla.Client.t(), webhook_params()) :: Tesla.Env.result()

delete_webhook(client, webhook_id)

@spec delete_webhook(Tesla.Client.t(), String.t()) :: Tesla.Env.result()

retrieve_webhooks(client)

@spec retrieve_webhooks(Tesla.Client.t()) :: Tesla.Env.result()

update_webhook(client, webhook_id, params)

@spec update_webhook(Tesla.Client.t(), integer(), webhook_params()) ::
  Tesla.Env.result()