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

Deletes a dynamic search rule by UID.

Examples

Meili.DynamicSearchRules.delete("rule-1")
Meili.DynamicSearchRules.delete(client, "rule-1")

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

Deletes a dynamic search rule, raising on error.

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

Retrieves a single dynamic search rule by UID.

Examples

Meili.DynamicSearchRules.get("rule-1")
Meili.DynamicSearchRules.get(client, "rule-1")

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

Retrieves a single dynamic search rule, raising on error.

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

Lists all dynamic search rules.

Queries the rules via POST.

Examples

Meili.DynamicSearchRules.list()
Meili.DynamicSearchRules.list(limit: 5)
Meili.DynamicSearchRules.list(client, limit: 5)

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

Lists all dynamic search rules, raising on error.

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

Creates or updates a dynamic search rule (upsert).

Examples

params = %{
  description: "Promote support docs",
  conditions: [%{scope: "query", contains: "help"}]
}
Meili.DynamicSearchRules.update("rule-1", params)
Meili.DynamicSearchRules.update(client, "rule-1", params)

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

Creates or updates a dynamic search rule, raising on error.