OpenApiTypesense.Presets (OpenApiTypesense v1.0.3)

View Source

Provides API endpoints related to presets

Summary

Functions

delete_preset(preset_id, opts \\ [])

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

Delete a preset.

Permanently deletes a preset, given it's name.

retrieve_all_presets(opts \\ [])

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

Retrieves all presets.

Retrieve the details of all presets

retrieve_preset(preset_id, opts \\ [])

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

Retrieves a preset.

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

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

(since 0.4.0)
@spec upsert_preset(
  preset_id :: String.t(),
  body :: OpenApiTypesense.PresetUpsertSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.PresetSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Upserts a preset.

Create or update an existing preset.