OpenApiTypesense.Presets (OpenApiTypesense v0.6.5)
View SourceProvides API endpoints related to presets
Summary
Functions
Delete a preset.
Either one of
Either one of
Retrieves all presets.
Either one of
Either one of
Retrieves a preset.
Either one of
Either one of
Upserts a preset.
Either one of
Either one of
Functions
@spec delete_preset(String.t()) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete a preset.
Permanently deletes a preset, given it's name.
@spec delete_preset( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | keyword() ) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
delete_preset(presetId, opts)
delete_preset(%{api_key: xyz, host: ...}, presetId)
delete_preset(Connection.new(), presetId)
@spec delete_preset(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec delete_preset(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
delete_preset(%{api_key: xyz, host: ...}, presetId, opts)
delete_preset(Connection.new(), presetId, opts)
@spec retrieve_all_presets() :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieves all presets.
Retrieve the details of all presets
@spec retrieve_all_presets(map() | OpenApiTypesense.Connection.t() | keyword()) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_all_presets(opts)
retrieve_all_presets(%{api_key: xyz, host: ...})
retrieve_all_presets(Connection.new())
@spec retrieve_all_presets( map() | OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_all_presets(%{api_key: xyz, host: ...}, opts)
retrieve_all_presets(Connection.new(), opts)
@spec retrieve_preset(String.t()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieves a preset.
Retrieve the details of a preset, given it's name.
@spec retrieve_preset( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_preset(presetId, opts)
retrieve_preset(%{api_key: xyz, host: ...}, presetId)
retrieve_preset(Connection.new(), presetId)
@spec retrieve_preset(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
retrieve_preset(%{api_key: xyz, host: ...}, presetId, opts)
retrieve_preset(Connection.new(), presetId, opts)
@spec upsert_preset(String.t(), map()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Upserts a preset.
Create or update an existing preset.
@spec upsert_preset( map() | OpenApiTypesense.Connection.t() | String.t(), String.t() | map(), map() | keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
upsert_preset(presetId, payload, opts)
upsert_preset(%{api_key: xyz, host: ...}, presetId, payload)
upsert_preset(Connection.new(), presetId, payload)
@spec upsert_preset( map() | OpenApiTypesense.Connection.t(), String.t(), map(), keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Either one of:
upsert_preset(%{api_key: xyz, host: ...}, presetId, payload, opts)
upsert_preset(Connection.new(), presetId, payload, opts)