View Source OpenApiTypesense.Presets (OpenApiTypesense v0.3.0)
Provides API endpoints related to presets
Summary
Functions
@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.
@spec delete_preset(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec retrieve_all_presets(keyword()) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error
Retrieves all presets.
Retrieve the details of all presets
@spec retrieve_all_presets( OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error
@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.
@spec retrieve_preset(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec upsert_preset( String.t(), OpenApiTypesense.PresetUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Upserts a preset.
Create or update an existing preset.
@spec upsert_preset( OpenApiTypesense.Connection.t(), String.t(), OpenApiTypesense.PresetUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}