fix(specs): Add customSearchParameters to Variant schema, and add direction query param for GET abtests (generated)

algolia/api-clients-automation#5130

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Leonardo Gavaudan <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: 3 people

packages/abtesting/model/clientMethodProps.ts

@@ -1,5 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { Direction } from '../model/direction';
+
 import type { MetricName } from '../model/metricName';
 
 /**
@@ -128,6 +130,10 @@ export type ListABTestsProps = {
    * Index name suffix. Only A/B tests for indices ending with this string are included in the response.
    */
   indexSuffix?: string | undefined;
+  /**
+   * Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
+   */
+  direction?: Direction | undefined;
 };
 
 /**

packages/abtesting/model/direction.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
+ */
+export type Direction = 'asc' | 'desc';

packages/abtesting/model/index.ts

@@ -10,6 +10,7 @@ export * from './addABTestsVariant';
 export * from './clientMethodProps';
 export * from './createMetric';
 export * from './customSearchParams';
+export * from './direction';
 export * from './effectMetric';
 export * from './emptySearchFilter';
 export * from './errorBase';

packages/abtesting/model/variant.ts

@@ -30,4 +30,9 @@ export type Variant = {
   metrics: Array<MetricResult>;
 
   metadata?: VariantMetadata | undefined;
+
+  /**
+   * Search parameters applied to this variant when the same index is used for multiple variants. Only present if custom search parameters were provided during test creation.
+   */
+  customSearchParameters?: Record<string, unknown> | undefined;
 };

packages/abtesting/src/abtestingClient.ts

@@ -433,10 +433,11 @@ export function createAbtestingClient({
      * @param listABTests.limit - Number of items to return.
      * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
      * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
+     * @param listABTests.direction - Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listABTests(
-      { offset, limit, indexPrefix, indexSuffix }: ListABTestsProps = {},
+      { offset, limit, indexPrefix, indexSuffix, direction }: ListABTestsProps = {},
       requestOptions: RequestOptions | undefined = undefined,
     ): Promise<ListABTestsResponse> {
       const requestPath = '/3/abtests';
@@ -459,6 +460,10 @@ export function createAbtestingClient({
         queryParameters['indexSuffix'] = indexSuffix.toString();
       }
 
+      if (direction !== undefined) {
+        queryParameters['direction'] = direction.toString();
+      }
+
       const request: Request = {
         method: 'GET',
         path: requestPath,