feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package (generated)

algolia/api-clients-automation#5157

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Leonardo Gavaudan <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 3 people

src/main/scala/algoliasearch/abtestingv3/ABTest.scala

@@ -0,0 +1,57 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+import algoliasearch.abtestingv3.Status._
+
+/** ABTest
+  *
+  * @param abTestID
+  *   Unique A/B test identifier.
+  * @param updatedAt
+  *   Date and time when the A/B test was last updated, in RFC 3339 format.
+  * @param createdAt
+  *   Date and time when the A/B test was created, in RFC 3339 format.
+  * @param endAt
+  *   End date and time of the A/B test, in RFC 3339 format.
+  * @param name
+  *   A/B test name.
+  * @param variants
+  *   A/B test variants. The first variant is your _control_ index, typically your production index. All of the
+  *   additional variants are indexes with changed settings that you want to test against the control.
+  * @param migratedAbTestID
+  *   Unique migrated A/B test identifier.
+  */
+case class ABTest(
+    abTestID: Int,
+    updatedAt: String,
+    createdAt: String,
+    endAt: String,
+    name: String,
+    status: Status,
+    variants: Seq[Variant],
+    configuration: Option[ABTestConfiguration] = scala.None,
+    migratedAbTestID: Option[Int] = scala.None
+)

src/main/scala/algoliasearch/abtestingv3/ABTestConfiguration.scala

@@ -0,0 +1,38 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+import algoliasearch.abtestingv3.ErrorCorrectionType._
+
+/** A/B test configuration.
+  *
+  * @param filters
+  *   List of metric filters applied to the test population.
+  */
+case class ABTestConfiguration(
+    minimumDetectableEffect: Option[MinimumDetectableEffect] = scala.None,
+    filters: Option[Seq[MetricsFilter]] = scala.None,
+    errorCorrection: Option[ErrorCorrectionType] = scala.None
+)

src/main/scala/algoliasearch/abtestingv3/ABTestResponse.scala

@@ -0,0 +1,42 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+/** ABTestResponse
+  *
+  * @param index
+  *   Index name of the A/B test variant (case-sensitive).
+  * @param abTestID
+  *   Unique A/B test identifier.
+  * @param taskID
+  *   Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run
+  *   immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and
+  *   this `taskID`.
+  */
+case class ABTestResponse(
+    index: String,
+    abTestID: Int,
+    taskID: Long
+)

src/main/scala/algoliasearch/abtestingv3/AbTestsVariant.scala

@@ -0,0 +1,40 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+/** AbTestsVariant
+  *
+  * @param index
+  *   Index name of the A/B test variant (case-sensitive).
+  * @param trafficPercentage
+  *   Percentage of search requests each variant receives.
+  * @param description
+  *   Description for this variant.
+  */
+case class AbTestsVariant(
+    index: String,
+    trafficPercentage: Int,
+    description: Option[String] = scala.None
+) extends AddABTestsVariantTrait

src/main/scala/algoliasearch/abtestingv3/AbTestsVariantSearchParams.scala

@@ -0,0 +1,41 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+/** AbTestsVariantSearchParams
+  *
+  * @param index
+  *   Index name of the A/B test variant (case-sensitive).
+  * @param trafficPercentage
+  *   Percentage of search requests each variant receives.
+  * @param description
+  *   Description for this variant.
+  */
+case class AbTestsVariantSearchParams(
+    index: String,
+    trafficPercentage: Int,
+    description: Option[String] = scala.None,
+    customSearchParameters: Any
+) extends AddABTestsVariantTrait

src/main/scala/algoliasearch/abtestingv3/AddABTestsRequest.scala

@@ -0,0 +1,44 @@
+/** A/B Testing API The Algolia A/B Testing API lets you manage your Algolia A/B tests to optimize your search
+  * experience. ## Base URLs The base URLs for requests to the A/B testing API are: - `https://analytics.us.algolia.com`
+  * \- `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above
+  * servers, based on your geographical location) 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 A/B testing 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 A/B testing 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
+  * A/B testing 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 A/B Testing API is version 3, as indicated by the `/3/` in each endpoint's URL.
+  *
+  * The version of the OpenAPI document: 3.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.abtestingv3
+
+/** AddABTestsRequest
+  *
+  * @param name
+  *   A/B test name.
+  * @param variants
+  *   A/B test variants.
+  * @param metrics
+  *   A/B test metrics involved in the test. Only these metrics will be considered when calculating results.
+  * @param endAt
+  *   End date and time of the A/B test, in RFC 3339 format.
+  */
+case class AddABTestsRequest(
+    name: String,
+    variants: Seq[AddABTestsVariant],
+    metrics: Seq[CreateMetric],
+    configuration: Option[ABTestConfiguration] = scala.None,
+    endAt: String
+)