Typesensory
v0.1.0

Typesensory.Api.Override (Typesensory v0.1.0)

API calls for all endpoints tagged Override.

Link to this section Summary

Functions

get_search_override(connection, collection_name, override_id, opts \\ [])

Retrieve a single search override Retrieve the details of a search override, given its id.

Link to this section Functions

Link to this function

get_search_override(connection, collection_name, override_id, opts \\ [])

@spec get_search_override(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, Typesensory.Model.SearchOverride.t()} | {:error, Tesla.Env.t()}

Retrieve a single search override Retrieve the details of a search override, given its id.

parameters

 Parameters

  • connection (Typesensory.Connection): Connection to server
  • collection_name (String.t): The name of the collection
  • override_id (String.t): The id of the search override
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, Typesensory.Model.SearchOverride.t} on success
  • {:error, Tesla.Env.t} on failure