View Source OpenApiTypesense.Presets (OpenApiTypesense v0.3.0)

Provides API endpoints related to presets

Summary

Functions

delete_preset(presetId, opts \\ [])

@spec delete_preset(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.PresetDeleteSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a preset.

Permanently deletes a preset, given it's name.

delete_preset(conn, presetId, opts)

retrieve_all_presets(opts \\ [])

@spec retrieve_all_presets(keyword()) ::
  {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error

Retrieves all presets.

Retrieve the details of all presets

retrieve_all_presets(conn, opts)

@spec retrieve_all_presets(
  OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error

retrieve_preset(presetId, opts \\ [])

@spec retrieve_preset(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.PresetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieves a preset.

Retrieve the details of a preset, given it's name.

retrieve_preset(conn, presetId, opts)

upsert_preset(presetId, body, opts \\ [])

Upserts a preset.

Create or update an existing preset.

upsert_preset(conn, presetId, body, opts)