Meili.Webhook (Meili v0.2.0)

Copy Markdown View Source

Manages Meilisearch webhooks.

Summary

Functions

create(client_or_params, params_or_nil \\ nil)

Creates a new webhook.

create!(client_or_params, params_or_nil \\ nil)

Creates a new webhook, raising on error.

delete(client_or_uuid, uuid_or_nil \\ nil)

Deletes a webhook by UUID.

delete!(client_or_uuid, uuid_or_nil \\ nil)

Deletes a webhook, raising on error.

get(client_or_uuid, uuid_or_nil \\ nil)

Retrieves details of a single webhook by UUID.

get!(client_or_uuid, uuid_or_nil \\ nil)

Retrieves details of a single webhook, raising on error.

list(client \\ nil)

Lists all webhooks.

list!(client \\ nil)

Lists all webhooks, raising on error.

update(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

Updates an existing webhook.

update!(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

Updates an existing webhook, raising on error.

Functions

create(client_or_params, params_or_nil \\ nil)

@spec create(Meili.Client.t() | map() | list(), map() | list() | nil) ::
  {:ok, term()} | {:error, Meili.Error.t()}

Creates a new webhook.

Examples

params = %{
  url: "https://my-api.com/webhook",
  events: ["task.succeeded", "task.failed"]
}
Meili.Webhook.create(params)
Meili.Webhook.create(client, params)

create!(client_or_params, params_or_nil \\ nil)

@spec create!(Meili.Client.t() | map() | list(), map() | list() | nil) ::
  term() | no_return()

Creates a new webhook, raising on error.

Examples

params = %{
  url: "https://my-api.com/webhook",
  events: ["task.succeeded"]
}
Meili.Webhook.create!(params)
Meili.Webhook.create!(client, params)

delete(client_or_uuid, uuid_or_nil \\ nil)

@spec delete(Meili.Client.t() | String.t(), String.t() | nil) ::
  {:ok, term()} | {:error, Meili.Error.t()}

Deletes a webhook by UUID.

Examples

Meili.Webhook.delete("some-uuid")
Meili.Webhook.delete(client, "some-uuid")

delete!(client_or_uuid, uuid_or_nil \\ nil)

@spec delete!(Meili.Client.t() | String.t(), String.t() | nil) :: term() | no_return()

Deletes a webhook, raising on error.

Examples

Meili.Webhook.delete!("some-uuid")
Meili.Webhook.delete!(client, "some-uuid")

get(client_or_uuid, uuid_or_nil \\ nil)

@spec get(Meili.Client.t() | String.t(), String.t() | nil) ::
  {:ok, term()} | {:error, Meili.Error.t()}

Retrieves details of a single webhook by UUID.

Examples

Meili.Webhook.get("some-uuid")
Meili.Webhook.get(client, "some-uuid")

get!(client_or_uuid, uuid_or_nil \\ nil)

@spec get!(Meili.Client.t() | String.t(), String.t() | nil) :: term() | no_return()

Retrieves details of a single webhook, raising on error.

Examples

Meili.Webhook.get!("some-uuid")
Meili.Webhook.get!(client, "some-uuid")

list(client \\ nil)

@spec list(Meili.Client.t() | nil) :: {:ok, term()} | {:error, Meili.Error.t()}

Lists all webhooks.

Examples

Meili.Webhook.list()
Meili.Webhook.list(client)

list!(client \\ nil)

@spec list!(Meili.Client.t() | nil) :: term() | no_return()

Lists all webhooks, raising on error.

Examples

Meili.Webhook.list!()
Meili.Webhook.list!(client)

update(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

@spec update(
  Meili.Client.t() | String.t(),
  String.t() | map() | list() | nil,
  map() | list() | nil
) :: {:ok, term()} | {:error, Meili.Error.t()}

Updates an existing webhook.

Examples

Meili.Webhook.update("some-uuid", url: "https://new-url.com")
Meili.Webhook.update(client, "some-uuid", %{events: ["*"]})

update!(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

@spec update!(
  Meili.Client.t() | String.t(),
  String.t() | map() | list() | nil,
  map() | list() | nil
) :: term() | no_return()

Updates an existing webhook, raising on error.

Examples

Meili.Webhook.update!("some-uuid", url: "https://new-url.com")
Meili.Webhook.update!(client, "some-uuid", %{events: ["*"]})