algoliasearch.analytics.GetTopHitsResponse.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-scala_3 Show documentation
Scala client for Algolia Search API
There is a newer version: 2.9.2
Show newest version
/** Analytics API The Analytics API gives you access to metrics related to your Algolia search experience. ## Base URLs
  * The base URLs for requests to the Analytics API are: - `https://analytics.us.algolia.com` (alias:
  * `https://analytics.algolia.com`) - `https://analytics.de.algolia.com` Use the URL that matches your [analytics
  * region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
  * Availability and authentication Access to the Analytics API is available as part of the [Premium or Elevate
  * plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
  * `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
  * permissions to make the request. The required access control list (ACL) to make a request is listed in each
  * endpoint's reference. You can find your application ID and API key in the [Algolia
  * dashboard](https://dashboard.algolia.com/account). ## Rate limits You can make up to **100 requests per minute per
  * app** to the Analytics API. The response includes headers with information about the limits. ## Parameters Query
  * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
  * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
  * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
  * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
  *
  * The version of the OpenAPI document: 2.0.0
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech Do not edit the class manually.
  */
package algoliasearch.analytics

import org.json4s._

/** GetTopHitsResponse
  */
sealed trait GetTopHitsResponse

trait GetTopHitsResponseTrait extends GetTopHitsResponse

object GetTopHitsResponse {}

object GetTopHitsResponseSerializer extends Serializer[GetTopHitsResponse] {
  override def deserialize(implicit format: Formats): PartialFunction[(TypeInfo, JValue), GetTopHitsResponse] = {

    case (TypeInfo(clazz, _), json) if clazz == classOf[GetTopHitsResponse] =>
      json match {
        case value: JObject => Extraction.extract[TopHitsResponse](value)
        case value: JObject => Extraction.extract[TopHitsResponseWithAnalytics](value)
        case value: JObject => Extraction.extract[TopHitsResponseWithRevenueAnalytics](value)
        case _              => throw new MappingException("Can't convert " + json + " to GetTopHitsResponse")
      }
  }

  override def serialize(implicit format: Formats): PartialFunction[Any, JValue] = { case value: GetTopHitsResponse =>
    value match {
      case value: TopHitsResponse                     => Extraction.decompose(value)(format - this)
      case value: TopHitsResponseWithAnalytics        => Extraction.decompose(value)(format - this)
      case value: TopHitsResponseWithRevenueAnalytics => Extraction.decompose(value)(format - this)
    }
  }
}