Merchant.Webhooks (Merchant v0.2.0)

View Source

Provides functions for working with webhooks

Summary

Types

create_params()
update_params()

Functions

create(params)
delete(id)
retrieve(id)
retrieve_list()
rotate_signing_secret(id)
update(id, params)

Types

create_params()

@type create_params() :: %{events: [String.t()], url: String.t()}

update_params()

@type update_params() :: %{events: [String.t()], url: String.t()}

Functions

create(params)

@spec create(create_params()) ::
  {:ok, Merchant.WebhookWithSigningSecret.t()} | Merchant.Client.error()

delete(id)

@spec delete(String.t()) :: :ok | Merchant.Client.error()

retrieve(id)

@spec retrieve(String.t()) ::
  {:ok, Merchant.WebhookWithSigningSecret.t()} | Merchant.Client.error()

retrieve_list()

@spec retrieve_list() :: {:ok, [Merchant.Webhook.t()]} | Merchant.Client.error()

rotate_signing_secret(id)

@spec rotate_signing_secret(String.t()) ::
  {:ok, Merchant.WebhookWithSigningSecret.t()} | Merchant.Client.error()

update(id, params)

@spec update(String.t(), update_params()) ::
  {:ok, Merchant.Webhook.t()} | Merchant.Client.error()