feat(specs): merge composition & composition-full (generated)

algolia/api-clients-automation#5333

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clara Muller <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 4 people

src/main/scala/algoliasearch/api/CompositionClient.scala

@@ -0,0 +1,64 @@
+/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
+  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
+  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
+  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+  * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
+  * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
+  * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
+  * Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
+  * your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
+  * `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
+  * DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
+  * All Algolia API clients implement this retry strategy. ## Authentication 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). ## Request format Depending on the endpoint, request bodies are
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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 Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 1.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.composition
+
+import org.json4s._
+
+sealed trait Action
+
+/** Type of Composition Batch operation.
+  */
+object Action {
+  case object Upsert extends Action {
+    override def toString = "upsert"
+  }
+  case object Delete extends Action {
+    override def toString = "delete"
+  }
+  val values: Seq[Action] = Seq(Upsert, Delete)
+
+  def withName(name: String): Action = Action.values
+    .find(_.toString == name)
+    .getOrElse(throw new MappingException(s"Unknown Action value: $name"))
+}
+
+class ActionSerializer
+    extends CustomSerializer[Action](_ =>
+      (
+        {
+          case JString(value) => Action.withName(value)
+          case JNull          => null
+        },
+        { case value: Action =>
+          JString(value.toString)
+        }
+      )
+    )

src/main/scala/algoliasearch/composition/Action.scala

@@ -0,0 +1,64 @@
+/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
+  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
+  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
+  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+  * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
+  * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
+  * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
+  * Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
+  * your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
+  * `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
+  * DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
+  * All Algolia API clients implement this retry strategy. ## Authentication 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). ## Request format Depending on the endpoint, request bodies are
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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 Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 1.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.composition
+
+import org.json4s._
+
+sealed trait AdvancedSyntaxFeatures
+
+/** AdvancedSyntaxFeatures enumeration
+  */
+object AdvancedSyntaxFeatures {
+  case object ExactPhrase extends AdvancedSyntaxFeatures {
+    override def toString = "exactPhrase"
+  }
+  case object ExcludeWords extends AdvancedSyntaxFeatures {
+    override def toString = "excludeWords"
+  }
+  val values: Seq[AdvancedSyntaxFeatures] = Seq(ExactPhrase, ExcludeWords)
+
+  def withName(name: String): AdvancedSyntaxFeatures = AdvancedSyntaxFeatures.values
+    .find(_.toString == name)
+    .getOrElse(throw new MappingException(s"Unknown AdvancedSyntaxFeatures value: $name"))
+}
+
+class AdvancedSyntaxFeaturesSerializer
+    extends CustomSerializer[AdvancedSyntaxFeatures](_ =>
+      (
+        {
+          case JString(value) => AdvancedSyntaxFeatures.withName(value)
+          case JNull          => null
+        },
+        { case value: AdvancedSyntaxFeatures =>
+          JString(value.toString)
+        }
+      )
+    )

src/main/scala/algoliasearch/composition/AdvancedSyntaxFeatures.scala

@@ -0,0 +1,70 @@
+/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
+  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
+  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
+  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+  * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
+  * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
+  * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
+  * Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
+  * your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
+  * `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
+  * DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
+  * All Algolia API clients implement this retry strategy. ## Authentication 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). ## Request format Depending on the endpoint, request bodies are
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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 Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 1.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.composition
+
+import org.json4s._
+
+sealed trait AlternativesAsExact
+
+/** AlternativesAsExact enumeration
+  */
+object AlternativesAsExact {
+  case object IgnorePlurals extends AlternativesAsExact {
+    override def toString = "ignorePlurals"
+  }
+  case object SingleWordSynonym extends AlternativesAsExact {
+    override def toString = "singleWordSynonym"
+  }
+  case object MultiWordsSynonym extends AlternativesAsExact {
+    override def toString = "multiWordsSynonym"
+  }
+  case object IgnoreConjugations extends AlternativesAsExact {
+    override def toString = "ignoreConjugations"
+  }
+  val values: Seq[AlternativesAsExact] = Seq(IgnorePlurals, SingleWordSynonym, MultiWordsSynonym, IgnoreConjugations)
+
+  def withName(name: String): AlternativesAsExact = AlternativesAsExact.values
+    .find(_.toString == name)
+    .getOrElse(throw new MappingException(s"Unknown AlternativesAsExact value: $name"))
+}
+
+class AlternativesAsExactSerializer
+    extends CustomSerializer[AlternativesAsExact](_ =>
+      (
+        {
+          case JString(value) => AlternativesAsExact.withName(value)
+          case JNull          => null
+        },
+        { case value: AlternativesAsExact =>
+          JString(value.toString)
+        }
+      )
+    )

src/main/scala/algoliasearch/composition/AlternativesAsExact.scala

@@ -0,0 +1,73 @@
+/** Composition API The Algolia Composition API lets you run composed search requests on your Compositions. ## Client
+  * libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. See:
+  * [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ##
+  * Base URLs The base URLs for requests to the Composition API are: - `https://{APPLICATION_ID}.algolia.net` -
+  * `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
+  * Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
+  * URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
+  * Retry strategy To guarantee high availability, implement a retry strategy for all API requests using the URLs of
+  * your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
+  * `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
+  * DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
+  * All Algolia API clients implement this retry strategy. ## Authentication 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). ## Request format Depending on the endpoint, request bodies are
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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 Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 1.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.composition
+
+import org.json4s._
+
+sealed trait Anchoring
+
+/** Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the
+  * query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly.
+  * \- `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with
+  * `anchoring: is`.
+  */
+object Anchoring {
+  case object Is extends Anchoring {
+    override def toString = "is"
+  }
+  case object StartsWith extends Anchoring {
+    override def toString = "startsWith"
+  }
+  case object EndsWith extends Anchoring {
+    override def toString = "endsWith"
+  }
+  case object Contains extends Anchoring {
+    override def toString = "contains"
+  }
+  val values: Seq[Anchoring] = Seq(Is, StartsWith, EndsWith, Contains)
+
+  def withName(name: String): Anchoring = Anchoring.values
+    .find(_.toString == name)
+    .getOrElse(throw new MappingException(s"Unknown Anchoring value: $name"))
+}
+
+class AnchoringSerializer
+    extends CustomSerializer[Anchoring](_ =>
+      (
+        {
+          case JString(value) => Anchoring.withName(value)
+          case JNull          => null
+        },
+        { case value: Anchoring =>
+          JString(value.toString)
+        }
+      )
+    )

src/main/scala/algoliasearch/composition/Anchoring.scala

@@ -14,14 +14,12 @@
   * 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). ## Request format Depending on the endpoint, request bodies are
-  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed as query parameters for GET and
-  * DELETE requests, and in the request body for POST and PUT requests. Query parameters must be
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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. Arrays as query parameters must be one of: - A
-  * comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array:
-  * `attributesToRetrieve=%5B%22title%22,%22description%22%D` ## Response status and errors The Composition 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
+  * UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
   *

src/main/scala/algoliasearch/composition/AroundPrecision.scala

@@ -14,14 +14,12 @@
   * 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). ## Request format Depending on the endpoint, request bodies are
-  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed as query parameters for GET and
-  * DELETE requests, and in the request body for POST and PUT requests. Query parameters must be
+  * either JSON objects or arrays of JSON objects, ## Parameters Parameters are passed in the request body for POST and
+  * PUT requests. 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. Arrays as query parameters must be one of: - A
-  * comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array:
-  * `attributesToRetrieve=%5B%22title%22,%22description%22%D` ## Response status and errors The Composition 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
+  * UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The Composition 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 Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
   *