ApolloSignal.Domains.Webhooks (apollo_signal v4.0.0)

Copy Markdown View Source

webhooks API operations.

Summary

Types

t()

@type t() :: %ApolloSignal.Domains.Webhooks{client: ApolloSignal.Client.t()}

Functions

create_webhook(domain, project_id, body, options \\ [])

@spec create_webhook(
  domain :: t(),
  project_id :: String.t(),
  body :: ApolloSignal.Types.CreateWebhookBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookCreateResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

delete_webhook(domain, project_id, endpoint_id, options \\ [])

@spec delete_webhook(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}

get_webhook(domain, project_id, endpoint_id, options \\ [])

@spec get_webhook(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

get_webhook_delivery(domain, project_id, endpoint_id, delivery_id, options \\ [])

@spec get_webhook_delivery(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  delivery_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookDeliveryResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

list_webhook_deliveries(domain, project_id, endpoint_id, options \\ [])

@spec list_webhook_deliveries(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookDeliveryPageResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

list_webhooks(domain, project_id, options \\ [])

@spec list_webhooks(domain :: t(), project_id :: String.t(), options :: keyword()) ::
  {:ok, ApolloSignal.Types.WebhookPageResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

new(client)

@spec new(ApolloSignal.Client.t()) :: t()

replay_webhook_delivery(domain, project_id, endpoint_id, delivery_id, options \\ [])

@spec replay_webhook_delivery(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  delivery_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Transport.metadata()} | {:error, ApolloSignal.Errors.t()}

test_webhook(domain, project_id, endpoint_id, options \\ [])

@spec test_webhook(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookDeliveryResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}

update_webhook(domain, project_id, endpoint_id, body, options \\ [])

@spec update_webhook(
  domain :: t(),
  project_id :: String.t(),
  endpoint_id :: String.t(),
  body :: ApolloSignal.Types.UpdateWebhookBody.t(),
  options :: keyword()
) ::
  {:ok, ApolloSignal.Types.WebhookResponse.t(),
   ApolloSignal.Transport.metadata()}
  | {:error, ApolloSignal.Errors.t()}