algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/PersonalizationClient

PersonalizationClient

algoliasearch.api.PersonalizationClient
See thePersonalizationClient companion object
class PersonalizationClient(appId: String, apiKey: String, region: String, clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$2: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$3: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$4: Manifest[T], ec: ExecutionContext): Future[T]

This method allow you to send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteUserProfile(userToken: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeleteUserProfileResponse]

Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.

Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.

Required API Key ACLs:

  • recommendation

Value parameters

userToken

Unique identifier representing a user for which to fetch the personalization profile.

Attributes

def getPersonalizationStrategy(requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[PersonalizationStrategyParams]

Retrieves the current personalization strategy.

Retrieves the current personalization strategy.

Required API Key ACLs:

  • recommendation

Attributes

def getUserTokenProfile(userToken: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[GetUserTokenResponse]

Retrieves a user profile and their affinities for different facets.

Retrieves a user profile and their affinities for different facets.

Required API Key ACLs:

  • recommendation

Value parameters

userToken

Unique identifier representing a user for which to fetch the personalization profile.

Attributes

def setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SetPersonalizationStrategyResponse]

Creates a new personalization strategy.

Creates a new personalization strategy.

Required API Key ACLs:

  • recommendation

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
Generated with