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

Gets settings for a specific index.

Examples

Meili.Settings.get("movies")
Meili.Settings.get(client, "movies")

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

Gets settings for a specific index, raising on error.

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

Resets all settings for a specific index to their default values.

Examples

Meili.Settings.reset("movies")
Meili.Settings.reset(client, "movies")

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

Resets all settings for a specific index, 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()}

Updates settings for a specific index.

Keys are automatically camelized from snake_case to camelCase.

Examples

settings = %{
  searchable_attributes: ["title", "overview"],
  filterable_attributes: ["genre"],
  ranking_rules: ["words", "typo", "proximity"]
}
Meili.Settings.update("movies", settings)
Meili.Settings.update(client, "movies", settings)

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

Updates settings for a specific index, raising on error.