dwolla v1.0.3

View Source Dwolla.WebhookSubscription (dwolla v1.0.3)

Functions for webhook-subscriptions endpoint.

Link to this section Summary

Types

error()
id()
location()
params()
t()
token()

Functions

create(token, params)

Creates a webhook subscription.

delete(token, id)

Deletes a webhook subscription.

get(token, id)

Gets a webhook subscription by id.

list(token)

Lists webhook subscriptions.

pause(token, id)

Pauses a webhook subscription.

resume(token, id)

Resume a webhook subscription.

webhooks(token, id, params \\ %{})

Lists webhooks for a given webhook subscription.

Link to this section Types

Link to this type

error()

View Source

Specs

error() :: HTTPoison.Error.t() | Dwolla.Errors.t() | tuple()
Link to this type

id()

View Source

Specs

id() :: String.t()
Link to this type

location()

View Source

Specs

location() :: %{id: String.t()}
Link to this type

params()

View Source

Specs

params() :: %{required(atom()) => any()}
Link to this type

t()

View Source

Specs

t() :: %Dwolla.WebhookSubscription{
  created: String.t(),
  id: String.t(),
  paused: boolean(),
  url: String.t()
}
Link to this type

token()

View Source

Specs

token() :: String.t()

Link to this section Functions

Link to this function

create(token, params)

View Source

Specs

create(token(), map()) :: {:ok, location()} | {:error, error()}

Creates a webhook subscription.

Parameters

%{
  url: "http://myapplication.com/webhooks",
  secret: "s3cret"
}
Link to this function

delete(token, id)

View Source

Specs

delete(token(), id()) :: {:ok, t()} | {:error, error()}

Deletes a webhook subscription.

Link to this function

get(token, id)

View Source

Specs

get(token(), id()) :: {:ok, t()} | {:error, error()}

Gets a webhook subscription by id.

Link to this function

list(token)

View Source

Specs

list(token()) :: {:ok, [t()]} | {:error, error()}

Lists webhook subscriptions.

Link to this function

pause(token, id)

View Source

Specs

pause(token(), id()) :: {:ok, t()} | {:error, error()}

Pauses a webhook subscription.

Link to this function

resume(token, id)

View Source

Specs

resume(token(), id()) :: {:ok, t()} | {:error, error()}

Resume a webhook subscription.

Link to this function

webhooks(token, id, params \\ %{})

View Source

Specs

webhooks(token(), id(), params() | nil) ::
  {:ok, [Dwolla.Webhook.t()]} | {:error, error()}

Lists webhooks for a given webhook subscription.

Parameters (optional)

%{
  limit: 50,
  offset: 0
}